/
Creating and Maintaining Workflows

Creating and Maintaining Workflows

Nov 15, 2024

Overview

A Workflow is a task comprised of one or more tasks of one or more task types, including other Workflows.

To create a Workflow, you enter task Details just as you would for any task, and then design the Workflow on the Workflow Editor, where you add, connect, and organize the tasks that will comprise the Workflow.

During and after a Workflow run, you can view detailed results of the run in the Workflow Task Instance Details, and monitor the status of the Workflow on the Workflow Monitor.

Although a typical Workflow is a single group of tasks, a Workflow can contain multiple groups of tasks and/or individual tasks. Each task in a group of tasks is connected to one or more other tasks in that group. Each connection is made from one task (the predecessor) to another task (the successor). There is no limit to the number of connections that can be made to or from a task.

The following sample Workflow contains a single group of tasks.
 


 

When you launch a Workflow, the first predecessor task in all task groups, and all individual tasks, begin to run. In this example, task stonebranch-saptask-01 would begin to run.

Built-In Variables

The following built-in variables can be used in a Workflow task to pass data where appropriate:

Creating a Workflow Task

Step 1

From the Automation Center navigation pane, select Tasks > Workflow Tasks. The Workflow Tasks list displays a list of all currently defined Workflow tasks.
 
Below the list, Workflow Task Details for a new Workflow task displays.
 

Step 2

Enter/select Details for a new Workflow task, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.

  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.

  • Temporarily hide the list above the Details.

  • Click the 

     button above the list to display a pop-up version of the Details.

Step 3

Click the 

 button. The Workflow task is added to the database, and all buttons and tabs in Workflow Task Details are enabled.

Step 4

Click the Edit Workflow button to display a blank Workflow Editor canvas.

Step 5

Follow the instructions provided below for designing the Workflow in the Workflow Editor.

Note

To open an existing record on the list, either:

  • Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the

     button that displays above and below the Details.)

  • Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.

  • Right-click a record in the list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Workflow Task Details

The following Workflow Task Details is for an existing Workflow task.

Depending on the values that you enter / select for these fields, and whether or not the Workflow task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the Workflow Task Details.
 

 

For information on how to access additional details - such as Metadata and complete database Details - for Workflows (or any type of record), see Records.

Workflow Task Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in Workflow Task Details.
 

Field Name

Description

Field Name

Description

General

This section contains general information about the Workflow task.

Name

User-defined name of this task (Maximum = 255 alphanumeric characters); variables supported. It is the responsibility of the user to develop a workable naming scheme for tasks.

Version

System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning.

Description

Description of this record. Maximum length is 255 characters.

Member of Business Services

User-defined; Allows you to select one or more Business Services that this record belongs to.  (You also can Check All or Uncheck All Business Services for this record.)

You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service.

If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.

Resolve Name Immediately

If enabled, the Instance Name of the task instance will be resolved immediately at trigger/launch time.

Time Zone Preference

User-defined; Allows you to specify the time zone that will be applied to the task.

Options:

  • -- System Default --
    Time zone is based on the value of the Task Time Zone Preference Universal Controller system property: Server or Inherited.
  • Server (xxx)
    Where (xxx) is the time zone ID of the server; time zone is evaluated in the time zone of the server.
  • Inherited
    Time zone is evaluated in the time zone of the Parent Workflow or Trigger / Launch specification in the case there is no Parent Workflow.

Hold on Start

 

If enabled, when the task is launched it appears in the Activity Monitor with a status of Held. The task runs when the user releases it.



Hold Reason

Information about why the task will be put on hold when it starts.

Virtual Resource Priority

Mutually Exclusive With Self

Simulate

Override Previous Instance Wait

Workflow Details

This section contains assorted detailed information about the Workflow task.

Show/Hide Skipped Tasks

Auto Layout

If Show/Hide Skipped Tasks = Hide Skipped; specification for the layout of the Workflow Monitor.
 
Options:

  • - - None - -

  • Horizontal Layout

  • Vertical Layout

Default Calendar

Default calendar used by the Workflow. If the Workflow is launched by a trigger, the trigger calendar overrides this default calendar.

Override Inherited Calendar

If enabled, uses the selected Default Calendar for this Workflow instead of the calendar used in the trigger or parent Workflow.

Previous Instance Wait

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Wait To Start

Wait Time

Wait Day Constraint

Wait Duration

Wait Duration In Seconds

Delay On Start

Delay Duration

Delay Duration In Seconds

Workflow Only

Time Options

This section contains time-related specifications for the task.

Late Start

Late Start Type

Late Start Time

Late Start Day Constraint

Late Start Nth Amount

Late Start Duration

Late Finish

Late Finish Type

Late Finish Offset Type

Late Finish Percentage Offset ( + )

Late Finish Duration Offset ( + )

Late Finish Duration Offset Unit

Late Finish Time

Late Finish Day Constraint

Late Finish Nth Amount

Late Finish Duration

Early Finish

Early Finish Type

Early Finish Offset Type

Early Finish Percentage Offset ( - )

Early Finish Duration Offset ( - )

Early Finish Duration Offset Unit

Early Finish Time

Early Finish Day Constraint

Early Finish Nth Amount

Early Finish Duration

User Estimated Duration

Critical Path Options

This section contains Critical Path-related specifications for the task.

Calculate Critical Path

The Calculate Critical Path option on the workflow will be ignored when the Simulate option is on.

If the Simulate option on the workflow is off, but on for one or more tasks within the workflow, the Calculate Critical Path option will be honored.

CP Duration

CP Duration (Resolved)

CP Duration Unit

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Execution Restriction

Restriction Period

Before Date

Before Time

After Date

After Time

Date List

Self-Service Options

This section contains Self-Service specifications for the task.

Enforce Variables 

Lock Variables 

Statistics

This section contains time-related statistics for task instances of the task.

First Execution

Last Execution

Last Instance Duration

Lowest Instance Time

Average Instance Time

Highest Instance Time

Number of Instances

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Workflow Task Details that let you perform various actions.

Save

Saves a new task record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & Edit

Saves a new record in the Controller database and opens the workflow editor. 

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new task.

Update

View Parents

Launch With Variables...

Opens a Launch With Variables... dialog.

Optionally, you can:

Launch

Edit Workflow

Displays the Workflow Editor for this task.

Copy

Creates a copy of this task, which you are prompted to rename.

Delete

Note

You cannot delete a task if it is either:

  • Specified in an enabled Trigger.

  • The only task specified in a disabled Trigger.

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task.

Tabs

This section identifies the tabs across the top of the Workflow Task Details that provide access to additional information about the task.

Workflow Task

Displays details about this Workflow task.

Task Run Criteria

Step Conditions