Workflow Configuration - Configure Workflow Properties during Implementation

Table of Contents

Overview

Many properties can be set on your Workflow either during its creation or when you are performing modifications to an existing one. These properties can be found in the Workflow Properties pane, located on the lower right side of your Workflow editor window as seen below:

The sections described below provide the steps to configure each Workflow property.

Setting General Properties

  1. From the Workflow window, go to the Workflow Properties pane.

  2. On the General tab, in the Value column for the Name property, type the Workflow name.
  3. In the Value column for the Description property, type the purpose of the Workflow.
  4. If the Workflow requires user input during execution, in the Value column, set the Start Interactive Session property to True.

Viewing the System Variables

  1. From the Workflow window, go to the Workflow Properties pane.

  2. Click the System tab.

    You can see all the system variables defined (by default) for the Workflow.

Defining Workflow Inputs

The Workflow inputs you define are the inputs the user will be prompted to enter during workflow execution. You can define the following types of input:

  • string
  • integer
  • boolean
  • date/Time
  • double
  • float
  • long
  • short
  • XML
  • Binary
  • <Other>, such as pre-defined CommCell entity types (for example, ClientEntity)

The sections below describe the steps to add a workflow input using a string and an <other> input type as examples.

Add a String Type Input

  1. From the Workflow window, go to the Workflow Properties pane.

  2. Click the Inputs tab and then click Add.
  3. In the Variable Name box, enter the name of the string input, for example, email_ID.
  4. From the Variable Type list, select string.
  5. If you want to define more than one value for this input, keep the Create as list check box selected to store all values in a list.
  6. Click OK.

Add an <Other> Type Input

The following steps create an input that will recognize client groups in the CommCell:

  1. From the Workflow window, go to the Workflow Properties pane.

  2. Click the Inputs tab and then click Add.
  3. In the Variable Name box, specify a name for the client group variable.
  4. From the Variable Type list, select <Other ...>.
  5. From the Select Type dialog box, select ClientGroupEntity and click OK.
  6. If you want to define more than one value for this input, keep the Create as list check box selected to store all values in a list.
  7. Click OK.

Customizing Workflow Inputs

When workflows are executed in the CommCell or used in the Web Console as forms, the input screen can be customized to make it easier for users to enter the input data. After an input is created, use the following steps to customize it:

  1. From the properties pane, click the Inputs tab.
  2. Click Customize to open the properties dialog box.
  3. From the left pane of the Inputs tab, select the input to customize.

    The right pane displays the options for the selected input.

  4. By default, the Type list shows the input type defined when the input was added. It can be changed by selecting a new value from the Type list.
  5. Enter a name in the Display Name box.

    This is the name users see when prompted to enter the input value during workflow execution. If a name is not entered, the input variable name is used.

  6. Enter a value in the Default box.

    The default value prepopulates the input field during workflow execution. If a default value is not set, the input field is blank.

    Note:

    • The default value for boolean input types must be entered as either true or false.
    • If values are added to the Possible Values box, only those values may be used for the Default box.
  7. Select a value from the Control Type list to define how the input field appears to a user during workflow execution.

    The Control Type list changes depending on the input type:

    Type Control Type
    string TEXTBOX, MULTILINE, DROPDOWN, RADIOBUTTON, CHECKBOX
    integer, double, float, long, short TEXTBOX, DROPDOWN, RADIOBUTTON, CHECKBOX
    boolean CHECKBOX
    date CALENDAR, DROPDOWN, RADIOBUTTON, CHECKBOX
    dateTime DATETIME_PICKER, DROPDOWN, RADIOBUTTON, CHECKBOX
    time TIME_PICKER, DROPDOWN, RADIOBUTTON, CHECKBOX
    XML TEXTBOX, MULTILINE
    Binary FILE_PICKER, TEXTBOX

    For information on FILE_PICKER, see Customizing Inputs Using the FILE_PICKER Control Type.

    <Other> Changes depending on what is selected as the <Other> input type.
  8. Select Optional, Required, or Read Only.

    Required fields are marked with an asterisk during workflow execution.

  9. Enter values in the Possible Values box to define the data for the following control types:
    • DROPDOWN: The possible values are listed inside the drop-down box. Users are limited to these values during workflow execution.
    • RADIOBUTTON: The possible values are used as labels for the radio buttons.
    • CHECKBOX: The possible values are used as labels for the check boxes. During workflow execution, users can select multiple possible values if Create as list was selected when the input was first added. Users can select one of the possible values if Create as list was not selected.

  10. Click OK.

Creating Workflow Variables

Variables allow you to hold a specific value type and use it anywhere in the workflow process. For example, you can insert a variable in an activity containing a message to indicate the resulting value of the variable.

The creation of variables is very similar to creation of inputs. However, in terms of usage, they differ: workflow variables are used internally in the Workflow and are never seen by the user during execution. Workflow inputs are exposed to the user during execution as they require a value provided by the user.

You can define the following types of variable:

  • string
  • integer
  • boolean
  • date/Time
  • double
  • float
  • long
  • short
  • XML
  • other, such as pre-defined CommCell entity types (e.g., ClientEntity)

Use the following steps to add a variable:

  1. From the Workflow window, go to the Workflow Properties pane.

  2. Click the Variables tab and then click Add.
  3. In the Variable Name box, specify the name of the variable.
  4. From the Variable Type list, select the type e.g., string.
  5. If you want this variable to be a list, select the Create as list check box to store all processed values in a list.
  6. Click OK.

Setting an OnStart Script

You can execute a script written in Java or JavaScript at the beginning of the workflow execution. For example, you can specify a script to help you determine if the elements involved in the Workflow are ready before execution.

  1. From the Workflow window, go to the Workflow Properties pane.

  2. Click the OnStart Script tab.
  3. Enter the code to be used.

    Tip: Click Insert Variable to add a workflow variable as needed.

Setting an OnComplete Script

You can execute a script written in Java or JavaScript at the end of the workflow execution. For example, you can specify a script to check that a certain Workflow activity completed successfully.

  1. From the Workflow window, go to the Workflow Properties pane.

  2. Click the OnComplete Script tab.
  3. Enter the code to be used.

    Tip: Click Insert Variable to add a workflow variable as needed.