Overview of Functionality
- Open Documentation: This button will open a new tab that contains packages and classes that may be used in your workflow.
- Add: New workflows and folders can be created by clicking the Add button.
- Copy: Workflows can be copied by first selecting the workflow from the list and then clicking Copy.
- Delete: Workflows may be deleted by first selecting the workflow you would like to delete from the list and then clicking the Delete option.
- Enable All: All existing workflows may be enabled by clicking the Enable All button.
- Edit: A workflow may be edited by selecting it from the list. The panel on the right shows the editable options. All workflows are stored in the asset repository as .xmpwf files located in Renditions\Workflows
At the top of the Visual Workflow Editor, you will see the Tool Bar for controlling the workflow canvas.
- Zoom In: This zooms in the workflow canvas.
- Zoom Out: This zooms out the workflow canvas.
- Zoom to Fit: This zooms and pans the workflow canvas so that all nodes are visible.
- Pointer Tool: This allows you to interact with the nodes and transitions in the workflow canvas. Drag-and-drop a selection box around multiple nodes to select them.
- Panning Tool: This allows you to pan the workflow canvas.
- Undo: This undoes your last action.
- Redo: This redoes your last action.
- Remove Selected Node(s): This removes the selected node(s) from the workflow canvas.
A node represents a task that MediaBeacon will perform automatically. A node can edit metadata, move assets and other useful tasks.
Rename a Node
Double click a node’s name to rename node. To do this, you must be using the Pointer Tool.
Node Parameters Menu
Double click a node to open the node’s parameters menu. To do this, you must be using the Pointer Tool.
On the right side of the Visual Workflow Editor you can see a list of node types. To add them to your workflow, drag-and-drop them onto the workflow canvas.
Filter Nodes by Category
Choose an option from the dropdown above the Node List to filter the nodes that appear in the Node List by catagory.
Filter Nodes by Name
Filter the nodes that appear in the Node List by typing into the search field. The search field accepts * as a wildcard.
If an asset triggers a workflow, the asset that triggered the workflow is called the target asset. The target asset is the asset that workflow nodes will act on. For example, if a Move Asset node is executed, the asset that will be moved is the target asset.
The first node to be executed when the workflow is triggered.
This node ends the workflow.
Move or Copy Asset Node
The Move Asset node and Copy Asset node are used to respectively move or copy the target asset to a target folder that is specified in the node’s parameters menu. If the folder does not yet exist, it will be created.
- Target Folder: The folder where the target asset will be moved to.
Normalize Asset Node
This node will write the target assets's XMP packet to the data stream of the asset's file on disk. This node has no configurable options.
The REST node is used to make REST calls.
- Url:The url to send the REST request to.
- Method: Select whether your REST request will use the GET or POST method.
- Parameter Name: The name of a parameter to include with the REST request.
- Parameter Value: The value of the corresponding parameter name to include with the REST request.
- Add Parameter: Clicking the + button will add another parameter to the REST request.
- Remove Parameter: Hover your mouse over a parameter’s row to display the Remove Parameter button. Click Remove Parameter button to remove the corresponding parameter from the list.
The Router node automatically decides the route that your workflow will follow. In other words, this node is used to conditionally choose which Output Pin will be followed along the corresponding transition to the next node.
- Route based on: Choose a schema to be inspected.
- <Chosen Schema>: Choose a field to be inspected.
- Case sensitive: If this box is checked, matching will be done with case sensitivity.
- Rules: The rules are executed from top to bottom. The last rule, no match, will be applied when the other rules are not applicable. This will result in Error or a custom label.
- Adding a Rule: Click the + button at the bottom of the Router Node parameters menu. For each additional rule another Output Pin is added to the Router node.
- Removing a Rule: Hover your mouse over a rule’s row to display the Remove Rule button. Click Remove Rule button to remove the corresponding rule from the list.
- Comparison: Pick a comparison that the rule will check.
- Value to Compare: Pick a value that will be compared to the field value of the target asset. The leading and trailing spaces are always ignored. The wildcard * and regex are supported values for the “matches” and “does not match” comparisons.
- Example wildcard use: BookOneChapter*
- Example regex use: Book(One|Two)ChapterThree
- Route to: The label that will display when the mouse is hovered over the corresponding output pin.
Send Notification Node
The Send Notification node is used to send emails.
- To: The email address that will receive this notification. Use a semicolon as a separator between multiple receivers.
This parameter has a feature which will substitute an email address for a username when using a smart name with a field like http://mediabeacon.com/ns/default/1.0/ uploadUser.
- Subject: The content that will appear on the subject line of the email.
- Message: The content of the email.
- Attach the asset link: Include a link to the target asset in the notification.
Stamp Data Node
The Stamp Data node is used to stamp the triggered asset with metadata. Select schemas and enter the field values that will be stamped on the target asset.
A transition is a line that connects two nodes. It graphicaly represents the order in which nodes will be executed. A transition is made of two parts, the node it starts from, and the node it points to.
Nodes have one or more Output Pins to their right. These are where transitions start from. Clicking an Output Pin and dragging-and-dropping the line that appears onto another node will create a transition between the two nodes. The order of execution of a transition is from the Output Pin of one node to the other node which the transition points to. Moving the nodes will not break the transitions they are connected to.
By default, each node has an OK and an Error Output Pin. If the node is executed and ends in the OK state, the next node to be executed is the one that is pointed to by the transition that starts at the OK Output Pin. If the node is executed and ends in a failure state, the node connected by a transition to the Error Output Pin will be the next node to be executed.
Router Nodes have configurable Output Pins and they can control which transition will be picked based on matching conditions.
Pointer End Overlapping
Hover your mouse over the pointer end of a transition to space out multiple overlapping end pointers.
Removing a Transition
To remove a transition, drag-and-drop its pointer end to a blank area on the workflow canvas.
Certain parameters of certain nodes are SmartName enabled. This is a variable that will be resolved only when the node is executed. When the value is resolved (for example, an attribute value is found), this will be used as the value during the execution of the node.
- Click the green brackets button to the right of a text field.
- Select a schema field.
- The target asset’s value for the selected field will be inserted into the green bracketed placeholder in the field value when the node is executed.
Right click a node to display the context menu. From this menu you can remove, copy and cut nodes. Use Ctrl+V or Cmd+V to paste the nodes. Copy and cut keyboard shortcuts are also supported. Additionally, you can open a node’s parameters menu and add a sticky note.
Sticky notes are used to write messages directly on the workflow canvas. Click the top right trash icon to delete the sticky note. Click the top left pencil icon to begin editing. When editing, click the top left checkmark icon to save. Sticky notes can be moved by dragging-and-dropping the top bar. Sticky notes can be resized by dragging-and-dropping the bottom right corner.
Hold shift while dragging a node around the workflow canvas. You will see vertical alignment lines which the node you are dragging will snap to. If the node you are dragging is connected to another node by a transition, you will see horizontal alignment lines as well.
The workflow depicted above has been set to trigger when an asset is uploaded. This is done in the Asset-Based Triggers section below the workflow canvas. When a file is uploaded, this workflow is executed, and Start is the first node to execute. Immediately, the “Check File Format” Router node is executed. This is set to inspect the “File Format” field of the “MediaBeacon Default” schema. From here, the workflow will follow one of two cases. If the file is a JPG, the workflow’s execution will follow the top transition to the “Stamp JPG Data” Stamp Data node. This node is set to write some metadata based on knowing the asset is a JPG. Once the data is stamped, the next node to run is the “JPG Upload Email” Send Notification node. This node is set to send an email to a specific person who handles JPG assets. When the email is sent, the next node to run is the Completed node, which ends the workflow.
Looking back at the “Check File Format” Router node, if the uploaded asset was a PNG, the workflow’s execution would follow the bottom transition to the “Stamp PNG Data” Stamp Data node. This node is set to write some metadata based on knowing the asset is a PNG. Once the data is stamped, the next node to run is the “PNG Upload Email” Send Notification node. This node is set to send an email to a specific person who handles PNG assets. When the email is sent, the next node to run is the Completed node, which ends the workflow.
See explanation found in Advanced Workflow Editor.