Introduction
Wizards initiate actions or workflows within FlexMAM: such as purging assets, archiving or moving assets to another workspace. With wizards you can also enable user tasks, for example: request review or run QC with Baton. All the workflows are previously configured by administrators in Dalet FlexCORE.
In the Dalet FlexMAM interface, the wizard icon is represented as a magic wand, . You will only be able to see and run wizards that you have permission to see. You can launch wizards from 3 different locations:
1. From the toolbar, when clicking on the wizard icon, a dropdown list opens with different workflows. The workflow you will select will act upon the entire asset.
2. The green wizard icon is situated underneath the FlexMAM Player and only appears when an IN and/or OUT point is set. The green wizard icon is used to initiate an action or workflow on a range or region of media.
3. From the Wizard folders, you can launch wizards in a stand-alone workflow, when no asset is selected. A stand alone action is based on the run rule set in the wizard's configuration page. If a wizard is set as stand-alone then it can be launched from a dashboard and run in the Dalet Flex console. Example of a stand-alone wizard: Create a new asset group.
Wizards can also be launched as 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. Task Definition is a manual process that can be performed in the system, based on a wizard. A task definition defines the type of task and the work to be carried out by a user. For example, entering metadata to describe an asset.
How to create a wizard
In Dalet FlexCORE, on the toolbar, click New and select Wizard from the drop down menu.
In the Create new Wizard section, fill in the relevant details such as name, visibility, plugin, launch rules, and so on. Click save.
| Name | Name of the wizard |
| Description | Description of the wizard |
| Visibility | User workspaces and accounts where the wizards will be accessible |
| Plugin |
Generic Wizard Task: is typically used in the configuration of Task Definitions. External Wizard Task: is used for configuring interactive panels for users to fill in metadata and interact with FlexMAM. External Wizard types:
|
| Launch From |
It is the location in the Dalet FlexMAM interface, where you will trigger workflows from a wizard. Task: if selected, the wizard will be part as a user task. Stand alone: if selected, the wizard will appear in the wizard folder Toolbar: if selected, the wizard will appear on the asset tool bar, above the player. Timecode: if selected, the wizard will appear on the asset tool bar, under the player. |
| Run-Rule Expression |
When External Wizard Task plugin is selected, fill in with the appropriate run-rule expression: #{(objectType.name == "media-asset" || objectType.name == "image-asset") && !asset.archived} |
Once your wizard is created, enable it, you have to make sure that your user or user groups have access to it. Go to Access tab and select Roles.
Click on the relevant user group.
Go to Permissions tab, and look for Wizards in the Objects' list. Click on the edit pencil icon to change the permissions if needed.
How to launch a Workflow from a Wizard
Overview
A wizard can be launched from Flex Enterprise by providing a link to it. It launches a workflow in Flex Enterprise based on the workflowDefinitionId passed as a request parameter. It will set an object variable called triggerObjectId which is the object on which the wizard has run or set an object list variable called triggerObjectIds when choose bulk assets and execute single workflow.
This wizard can be launched from any flex object based on the run rule set in the wizard.
- A wizard can be launched from any flex object based on the run rule set in the wizard's configuration page.
- A wizard can be launched on a collection since version 2021.5.0.
How to create an external wizard plugin
- Create an external wizard in Dalet Flex, and specify the url as
<FLEX PANELS HOST>/flexPanels/launchWorkflow?triggerObjectId=${object.id}${objectIds}&userId=${user.id}&workflowDefinitionId=<workflow definition id>&message=<url encoded message>&metadataDefinitionId=<metadata definition id>&showProgress=<true/false>&showStringVariables=<var1,var2...>&launchWorkflowPerObject=<true/false>&prepopulateMetadataValues=<true/false>&workspaceId=<workspaceId>
Here, triggerObjectId and userId are templates which will be replaced before a wizard gets launched. All the parameters except metadataDefinitionId,showProgress,showStringVariables and launchWorkflowPerObject are mandatory in order to launch the wizard.
- If we set a request param metadataDefinitionId, a metadata form will be displayed. When launching the wizard, the JSON representation of the entered metadata will be set into a workflow variable called metadata.
- In case of bulk selection of asset, when a single object is selected, ${object.id} will evaluate to a single ID, and when multiple assets are selected ${objectIds} will evaluate into a comma separated string of IDs.
- If we want to launch a wizard on a collection, make sure triggerObjectId that contains the expression ${objectIds}. ${objectIds} will be evaluated to the collection uuid.
What is the difference between User Task Types and Wizards?
A user task is a workflow concept that links together a user and a wizard that comprises of pages. Hence a task type is synonymous with a wizard. Both refer to an ordered sequence of pages, through which you interact with Dalet Flex in order to carry out work.
Dalet Flex’s task definition and wizard framework is very extensible so that developers can create their own task types and wizards with their own associated pages.
Comments
0 comments
Please sign in to leave a comment.