WFD Ribbon & Quick Access Toolbar

This article covers the following topics:

Ribbon & Toolbar Overview

Home Tab Commands

Selection Tab Commands

Options Tab Commands

Quick Access Toolbar

Access Keys

Overview

The Workflow Designer encompasses a Ribbon design which houses the command buttons and icons as a set of tabs, each grouping relevant commands. The Ribbon-styled panel arrangement is designed to make WFD more discoverable and accessible with fewer mouse clicks, allowing you to easily perform a variety of activities and routines during the course of workflow creation. The Ribbon is categorized into contextual tabs, each composed of groups which are a labeled set of closely related commands. In addition to tabs and groups, the Ribbon consist of an Application Button located on the top-right section of the Ribbon which present a menu of commands that involve doing something to or with a specific workflow (i.e. Update, Close, Print) and a fully customizable Quick Access Toolbar, which is a small toolbar that displays frequently used commands. A short description regarding each command can be easily determined by hovering the mouse directly above the desired command.

 

Home Tab Commands


The Home tab (shown below) consists of commands that perform general workflow actions and operations such as Run, Stop, Pause, Update and Close. This tab also contains clipboard related commands to provide developers a convenient way to copy/paste objects to a workflow and as well as a command that allows you to select the default flow control arrow.

Properties

The following table describes the available Home tab commands as well as their associated hot-keys (if any).

Group

Command

Description

Hotkey

App

Update All and Exit

Updates any changes made to all open workflows and closes the Workflow Designer.

 

Workflow

Update

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

CTRL+S

Close

Closes the current workflow. If changes were made, a dialog box will appear prompting whether or not to save them.

 

Save Image

Saves the current workflow diagram as an image. Pressing this button opens a dialog box allowing specification of the drive, directory and name of the image 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 diagram. Only the Workspace section of the WFD will be printed.

CTRL+P

Run

Executes the current workflow. This is an ideal way to test all or part of a workflow during its design and construction. Developers can easily determine the status of a running workflow in real-time by viewing the workflow diagram in Main Workspace, viewing the information populated in the Output tab and examining the Shared Variables, Shared Datasets or Shared Arrays tab of the Output/Shared Objects pane.

NOTE: If the beginning of the workflow contains any triggering events or conditions, they are ignored during manual execution. However, other non-triggering conditions contained in the workflow will operate 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 test the triggering ability of a File Condition set to monitor for any text file to be added to C:\Folder1, simply add any text file to C:\Folder1.

CTRL+F5

Pause

Pauses execution of a running workflow.

 

Step

Steps through the current items in a running workflow.

NOTE: This option only appears when a Breakpoint is hit.

 

Stop

Stops execution of a 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.

CTRL+V

Cut

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

CTRL+T

Copy

Copies the selected object(s) to the clipboard. To select multiple objects, hold down CTRL during selection. This option is used to 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 option to paste an independent copy of the item and add a new unique repository object of that item.

CTRL+C

Select all

Selects all objects in the current workflow.

CTRL+A

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 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 Commands


The Selection tab (shown above) contains object specific commands. This tab becomes available upon selection of an object in the current workflow diagram.

Parameters

The table below describes the available Selection tab commands.

Group

Command

Description

Item

Edit

Edits the selected workflow object and opens the editor for that object.

Delete

Deletes the selected object(s). To select 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.

Repository Properties

Displays the properties of the selected object that are saved to the Repository

Workflow Properties

Displays the properties of the selected object as it relates to the workflow.

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 repository object. 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(s). This makes the object "unbuilt".

Agent

Select Agent

Shows the list of available agents, agent groups, process agents and system agents that the object can be assigned to.

Breakpoint

Breakpoint

Adds a Breakpoint to the selected item. Breakpoints provide a means of pausing execution at a specified point in order to examine certain aspects of the workflow. They take effect only when a workflow is run from the Workflow Designer and are ignored when the workflow is triggered or executed outside of the Workflow Designer.

Label

Use Label

Uses the object's label instead of the repository name. Pressing this command 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 object.

Options Tab Commands


The Options tab (shown below) contains commands that modify the "look and feel" of the Workflow Designer.

Parameters

The table below describes the available Selection tab commands.

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.

Horizontal Spacing

Increases or decreases the space between the horizontal grid points.

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 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).

Quick Access Toolbar


The Quick Access 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.

To move the toolbar below the Ribbon:

Or

To add items to the toolbar:

To remove items from the toolbar:

 

Parameters

The following table details the default buttons and lists their associated hot-keys.

Button

Description

Hotkey

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.

 

Access Keys


The Ribbon provides a feature that allows you access any Quick Access Toolbar or Ribbon command with a few keystrokes instead of using the mouse. These shortcut keys (shown below) are called as Access keys.

To use the Access Keys:

  1. Press and release the ALT key. The KeyTips are displayed over each feature that is available in the current view.

  1. Press the letter/number shown in the KeyTip over the feature that you want to use. Depending on which letter/number you pressed, you may be shown additional KeyTips.

  2. Continue pressing letters/numbers until you press the letter of the specific command or option that you want to use.  

See Also


WFD Available Objects Pane | WFD Main Workspace | WFD Output/Shared Objects Pane | WFD Ribbons & Toolbar


↑ Top of Page