• Articles
  • API Documentation
Show / Hide Table of Contents
  • Introduction
  • Wavefire Manager
    • Index
    • Concepts...
      • Organisations
      • Applications
      • Products
      • Tasks
      • Vendors
    • Wavefire Manager Walkthrough
    • How To...
      • Create a new Customer Organisation
      • Delete a Customer Organisation
      • Create a New User
      • Delete a User
      • Edit a User
      • Create a New Product
      • Delete a Product
      • Quota a Product to a Customer
      • Subscribe a User to a Product
    • Wavefire Manager Command Line
    • Tasks and Scripts
  • Cloud Client
    • Index
    • Cloud Client Installation Guide
    • Cloud Client Quick Start Guide
    • Command Line Switches
    • Error Codes
    • Version History

Scripting

Wavefire allows tasks to be attached to events that occur within Wavefire. Each task consists of multiple scripts which are written in Powershell and executed in order when the task is triggered.

A task may have a filter defined which restricts the task to running only when certain criteria are met (e.g. Only run the task when the new user is an administrator).

Events

The following events are supported by Wavefire:

  • CreateOrg Event - Triggered when a new organisation is created.
  • CreateUser Event - Triggered when a new user is created.
  • <xref:scriptingRemoveUser> - Triggered when an existing user is removed.
  • <xref:scriptingAddAppToOrg> - Triggered when an application is added to an organisation.
  • <xref:scriptingUserLogin> - Triggered when a user logs in to a new session.

Roles

Each script within a task (with the exception of UserLogin tasks) must be assigned one or more roles. These roles define which host (or hosts) the script will be executed on. When determining the list of applicable hosts, the specified role(s) are resolved for the organisation that gave rise to the event (e.g. the organisation that was created; the organisation to which a new user belongs and so forth).

Note

A given role may resolve to different hosts for different organisations.

For UserLogin tasks, the scripts are always executed within the user's session (and hence under the user's account) on the Client Server hosting the user session.

Back to top © Virium Innovations 2017