Wizards

A wizard is an ordered sequence of screens (pages) through which you interact with Ooyala Flex in order to carry out work. Ooyala Flex's wizard framework is very extensible so that developers can create their own wizards with their own associated screens.

Wizards can be launched in three different ways:

From a User Task: If a wizard is referenced by a task definition, then the wizard is run when a user carries out a task instance as part of a workflow.

Stand-alone: If a wizard is set as stand-alone then it can be launched from a dashboard and run in the Ooyala Flex console. Example of a stand-alone wizard, is a wizard to create a new asset group. Clearly this does not need to happen as part of a workflow.

Remotely: A wizard page can be created in an external system. The wizard is then orchestrated through API calls to the Ooyala Flex platform.

A stand alone wizard can be found inside the I Want To... box on each dashboard for easy access.

Wizard Pages

Wizard pages are the individual screens through which you interact with in Ooyala Flex to get work done. When wizards are created, the specific pages are selected and the order in which the pages should be presented are also set.

Note: You will only be able to see and run wizards that you have permission to see.

Running a Wizard

To run a stand-alone wizard simply find the I Want To... box on any dashboard in the Ooyala Flex console. Click on the name of the wizard you wish to run.

Wizard Object Properties

Table 1.
Property Support Explanation
Scope Account The scoping of this object
Visibility Whether the object supports visibility
Plugins Supports plugins
Extended Config. Whether the object has an extended configuration tab
Scripting Whether the object can be configured using scripting
Enable / Disable Whether the object can be enabled and disabled
Start / Stop Whether the object can be started and stopped
Copy Whether the object can be copied
Export / Import Whether the object can be exported and imported
Delete Whether the object can be deleted
Unique Name Whether the object name must be unique within its scope
Variants Whether the object supports variants

Creating a New Wizard

1) On the toolbar, click the New option.

2) From the drop down, select Wizard.

3) In the Create new Wizard section, fill in the relevant details such as name, visibility, plugin, launch rules, and so on.

4) Click Save to finalise.

Adding Pages to a Wizard

1) Click the Pages sub-tab.

2) Click Add Page.

3) Assign a page path that relates to the task that you want to carry out (e.g. assigning metadata to a task).

4) Assign an action parameter: Some wizard plugin pages support action parameters which control their behaviour

5) Assign an asset context: An asset context expression can be used to ensure the page references the correct asset in an asset hierarchy.

6) Click Save to finalise.

Managing Pages

Once a page has been created, you have the option of editing, deleting, or re-ordering the sequence of the pages for a Wizard. To do this, hover over the chevrons to the right hand side of each page, and make your selection.

Working with Wizards

To run a stand-alone wizard simply find the I Want To... box on any dashboard in the Ooyala Flex Console. Then click on the name of the wizard you wish to run.

Running an "Add an asset to a group" Wizard

An example of how this functionality works, can be shown using the "Add an asset to a group" wizard, as follows:

1) To begin, select the Add an asset to a group wizard.

2) This will take you through to the Add an asset to a group screen pop-up.

3) Search and then select the desired group and select Next.

4) Assign members to the group and click Next.

5) View and approve the confirmation page, which confirms the group and the members of the group. Click Finished.

Was this article helpful?