General Properties for Workflows


On this page

You can configure general properties, such as the name of the workflow and whether to run the workflow as a job or as an API.

  • Name: Enter a name for the workflow.

  • Description: Enter a description about the workflow.

  • Tags: Define the property value to group workflows under a particular heading in the Web Console Forms application. You can enter multiple tags, separated with a semi-colon (;).

    Workflow forms appear under the tag name in the Web Console. If you leave the Tags property empty for a form, the form appears under the Untagged category. If none of the workflow forms have tags, the forms appear without grouping. For information about workflow forms, see

  • Start Interactive Session: To allow user input during workflow execution, move the toggle key to the right.

  • Mode: From the list, select one of the following:

    • Job: Assigns a job ID to the workflow when the workflow runs. You can monitor workflow execution from Active jobs and Job history pages. If services are restarted, the workflow automatically restarts.

    • API: Runs the workflow completely in memory (no job ID is assigned). Because API workflows run completely in memory, they run faster than workflows run as jobs.

      The following REST APIs run workflows as APIs: API (POST) and API (GET).

  • Show in web console: To make the workflow available in the Web Console Forms application, move the toggle key to the right.

  • Execute in web console: To open the workflow input dialog box in the Web Console when the workflow runs, move the toggle key to the right.

    When the input dialog box opens in the Web Console, JavaScript and cascading style sheets (CSS) are supported.

  • Manual Percent Complete: To specify the percentage of completion for activities in the workflow, move the toggle key to the right.

  • Message Name: This property applies only to business logic workflows. The message name is the top-level element for the XML message that you want to connect to the workflow.

    For example, to connect the workflow to the XML message used to create a user, type App_CreateUserRequest. For information about business logic workflows, see Creating a Business Logic Workflow.

  • Execute When: This applies to business logic workflows. Select one of the following:

    • Request: Runs the workflow when the XML message is sent to the server.

    • Response: Runs the workflow when the XML message is returned by the server.