Workflow Designer Ribbon

The Workflow Designer (WFD) encompasses a Ribbon design which houses the command buttons and icons as a set of tabs, each grouping relevant commands. The Ribbon-styled panel design is designed to make the WFD more discoverable and accessible with fewer mouse clicks, allowing you to easily perform a variety of actions and procedures during the course of workflow creation. Ribbons are categorized into three tabs, Home, Selection and Options. The WFD also contains a Quick Access Toolbar that can be placed above or below the Ribbon.  

Tabs, Groups & Commands


The Ribbon in WFD is categorized into three command groups separated by tabs. To view a description of each command and determine associated hot-keys (if applicable), hover the mouse directly above the desired command. The tables below further describes the available commands and buttons contained within each group.

Home Tab

The Home tab (shown above) consists of buttons that perform general workflow actions and procedures such as Run, Stop, Update and Close. Also includes Clipboard related buttons to allow developers to conveniently copy/paste objects to a workflow. The table below further describes each available button in this section as well as their associated hot keys.

Group

Command

Description

App

Update All and Exit

Updates changes made to all open workflows and at the same time, exits the Workflow Designer.

Workflow

Update

Updates any changes made to the current workflow (without closing the WFD).

Close

Closes the current workflow. If changes were made to any open workflows, a dialog box will appear prompting whether to save changes.

Save Image

Saves the current workflow as an image. Clicking this button opens a Save Image As dialog that lets the user specify the drive, directory, and the name of a file to save. Images can be saved in the following formats:

  • JPEG (.jpg)

  • Bitmap (.bmp)

  • Graphics Interchange Format (.gif)

  • Portable Network Graphics (.png)

Print

Prints the current workflow.

NOTE: Only the Workspace section of the WFD will be printed.

Run

Manually executes the current workflow. This is an ideal way to test all or part of a workflow during construction. Developers can easily determine the status of a running workflow by viewing real-time information that appears in the WFD's Output pane. Shared variables, arrays or datasets can also be tested by viewing their corresponding tabs.

NOTE: If the beginning of the workflow contains any triggering events or conditions, they are automatically skipped during manual execution. However, other non-triggering conditions contained in the workflow will execute as normal. The best way to test a workflow's triggering event or condition is to allow the monitored event or condition to occur. For example, to est a File condition set to monitor for any text files to be added to C:\Folder1, simply add a .txt file to C:\Folder1.

Stop

Manually stops the currently running workflow.

Clipboard

Paste

Pastes another instance of the clipboard object(s) onto the current workflow.

IMPORTANT: The Paste option generally creates another instance of the original object(s). However, it does not add an independent copy to the Repository. This means that you risk adversely affecting other workflows that use the object. The Paste option generally creates a new icon and not an entirely new independent Repository object. Therefore, any changes made to a "pasted" object will impact the original Repository item as well as all workflows that this item resides in.

In order to paste an independent copy of an object, use the Paste New Item option instead. This option creates a new Repository object which can be edited without impacting the original object.

Cut

Cuts the selected object(s). To cut multiple objects,

Copy

Copies the selected object(s) to the clipboard. To select multiple objects, press CTRL during selection. This option is used to conveniently create a copy of an existing workflow object. Use the Paste option to paste an instance of the original item onto a workflow. Use the Paste New Item to paste an independent copy of the item and add a new unique Repository object of that item.

Select all

Selects all objects in the current workflow.

Paste New Item

Pastes a copy of the clipboard object(s) onto the selected workflow and additionally saves a new copy to the Repository. The Paste New Item option creates a new and unique Repository object, which you can edit without compromising the original object as well as workflows that use it. This is ideal in situations where minor changes need to be performed to an existing object because it eliminates the tedious procedure of having to create a brand new object and setting its properties.   

Default Arrow Type

Success

Sets the Success Arrow as the default flow control arrow associated to new objects (default).

Failure

Sets the Failure Arrow as the default flow control arrow associated to new objects.

Result

Sets the Result Arrow as the default flow control arrow associated to new objects.

 

Selection Tab

The Selection tab (shown above) contains object specific commands. This tab becomes available upon selection of an object in the current workflow. The table below further describes each button contained in this section.

Group

Command

Description

Item

Build New/Edit

Builds a new Repository object and opens the editor for that object.

Delete

Deletes the selected object(s). To delete multiple objects, hold down CTRL during selection.

Rename

Renames the selected object.

Enabled

Use as a toggle to enable/disable selected objects. Disabled objects appear grayed-out.

Properties

Opens the properties dialog for the selected object.

Clipboard

Paste

Pastes another instance of the clipboard object(s) onto the current workflow.

IMPORTANT: This option generally creates a new icon representing the original object and not an entirely new independent Repository object. Therefore, any modifications made to a "pasted" object will impact the original Repository object as well as all workflows that this object resides in. In order to paste an independent copy of an object, use Paste New Item instead. This option creates a new Repository object which can be edited without impacting the original object.

Cut

Cuts the selected object(s). To cut multiple objects, hold down CTRL during selection.

Copy

Copies the selected object(s) to the clipboard. To select multiple objects, hold down CTRL during selection. Use the Paste option to paste an instance of the original item onto the workflow. Use Paste New Item to paste an independent copy of the item and add a new unique Repository object for that item.

Select all

Selects all objects in the workflow.

Paste New Item

Pastes a copy of the clipboard object(s) onto the selected workflow and additionally saves a new copy to the Repository. This option creates a new and unique Repository object, which you can edit without compromising the original object as well as other workflows that currently use it. This is ideal in situations where minor changes need to be performed to an existing object because it eliminates the tedious procedure of having to create a new object and setting its properties.   

 

Association

Associate Existing

Associates the properties of the selected object with an existing object in the Repository. This allows a quick and easy way to duplicate the contents and properties of pre-existing objects, eliminating repetition.

Disassociate

Removes the association set for the selected object. This makes the object unbuilt.

Agent

Select Agent

Shows the list of available Agents, Agent Groups and Process Agents that the object can be assigned to.

Label

Use Label

Uses the object's label instead of the Repository name. Clicking this button allows you to enter a unique name for the specified object. A label replaces the name of an object for the current workflow. This is useful in cases where an object is contained in two or more workflows because it provides a way to determine which workflow the object belongs to.

NOTE: This option creates an alias for the particular object as it relates to the specific workflow.  

Edit Label

Edits the current label used for an object. This provides a way to add specific information regarding the label.

 

Options Tab

The Options tab contains commands that modify the "look and feel" of the Workflow Designer. The table below describes the available controls.

Group

Command

Description

Grid

Show Grid

Displays a grid or graph layout in the WFD's workspace. The grid serves as a visual framework on which a developer can organize workflow objects in an organized, easy to view manner (disabled by default).

Snap to Grid

Causes the objects in the workflow to attach itself to the grid when selected.

Vertical Spacing

Increases or decreases the space between the vertical grid points (default vertical spacing is 4).

Horizontal Spacing

Increases or decreases the space between the horizontal grid points (default horizontal spacing is 4).

Behavior

Allow Unbuilt Items

If enabled, allows unbuilt objects to a workflow without automatically opening the object's properties editor. If disabled, launches the properties editor dialog for any unbuilt objects added to a workflow (enabled by default).

NOTE: Objects with empty or unset properties are considered "unbuilt."

Arrow Text

Show Success Arrow Text

If enabled, shows the text associated with the Success Arrow. If disabled, the arrow appears in the workflow without a text display (enabled by default).

Show Failure Arrow Text

If enabled, shows the text associated with the Failure Arrow. If disabled, the arrow appears in the workflow without a text display (enabled by default).

Show Result Arrow Text

If enabled shows the display text of the Result Arrow. If disabled, the arrow appears in the workflow without a text display (enabled by default).

 

Quicjk Access Toolbar


The WFD Toolbar (shown below) is a vertical column of buttons that provides users an easy way to select commonly used WFD features and commands. This toolbar is situated, by default, directly above the Ribbons panel, on the top left corner of the WFD interface. There's also an option to fit the toolbar directly below the Ribbons panel. The following table details the available toolbar buttons and lists their associated hot-keys.

 

Button

Description

Hot Key

Refresh

Refresh the Repository.

F5

Update All and Exit

Updates changes made to all open workflows and at the same time, closes the Workflow Designer.

 

Update

Updates changes made to all open workflows without exiting.

CTRL+ S

Undo

Undo the last action.

CTRL+Z

Redo

Redo the last action.

CTRL+Y

Run

Run the current workflow.

CTRL+F5

Move Toolbar

Moves the toolbar directly above or below the Ribbons panel.