Specify flow attributes

Procedure

  1. From the Action menu, select Add Flow Attribute or right-click in a blank section of the flow definition and select Flow Attribute.

    The Flow Attribute dialog box appears.

  2. On the General tab, enter the description text in the field provided. When you have finished typing the description, click OK.
  3. To specify user variables and environment variables, click Modify, which is located to the right of the Input Variables field.

    The Flow Input Variables dialog displays a list of input variables that are currently defined in the flow, and the order in which they are defined.

    You can specify variables on a per-flow basis, which allows multiple jobs or sub-flows within a flow to use the same variable; you can specify variables from the job definition dialog, which overrides these flow-level input variables; and you can specify built-in variables.

    Input variables can only contain alphanumeric characters, underscores, and user variable definitions. No semicolons can be part of the value.

    Important:

    The order in which you define the variables is important. You must define one variable before you can use it in the next. For example, if you have an input variable named MyVar_#{Var1}, you must have defined the Var1 variable first. Var1 can either be defined in the current flow level (if it was defined before MyVar_#{Var1}) or at a parent or other upper level flow.

    • To add an input variable, click New.

      Specify a name for the variable. Unless you are explicitly specifying a built-in variable, do not use a variable name beginning with JS_.

      To define a default value, select the Specify a Default Value field, then specifying a default value for the variable. You can include user variables when specifying a default value.

      Important:

      Do not specify a default value for a built-in variable.

    • To modify an input variable, select the variable you want to edit and click Edit.

    • To remove an input variable, select the variable you want to remove and click Remove.

    The environment variables defined in the list can only be used in the current flow or sub-flow, though any environment variables listed at the parent flow level are propagated to its subflows. Variables defined in sub-flows will overwrite variables defined in the main flow or parent flows if they have the same name.

    Changing environment variables in a job cannot affect other jobs. Therefore, if one job changes the value of an environment variable, the same environment variable is unaffected in the next job, even if it runs after the first job.

    The names and values of local and environment variables that a job uses appear in the Runtime Attributes of that job.

  4. Optional. To specify a working directory at the flow level, use the Working directory field.
    Tip:

    You can use user variables when specifying the working directory.

    All valid inner work items (subflows, jobs, and job arrays) in the flow will use this directory as the working directory unless you further specify a working directory for the inner work item. In this case, the working directory setting for the inner work item will override the setting for this flow.

  5. In the Notify when flow field, select the appropriate notification option. To receive a notification only if a flow exits, leave the default at Notify when flow exits. Otherwise, leave Notify when flow checked, and select the desired option.
  6. In the Email address field, specify the email address to be notified. The default email address is your user name.
    Tip:

    You can use user variables when specifying the email address.

  7. To prevent concurrent versions of the same flow, in the Options box, check Allow only one flow to run at a time.
  8. Click OK.

Turn off email notification for a flow

Procedure

  1. On the General tab, uncheck Notify when flow. This does not affect email notifications regarding job completion.
  2. Click OK.