Managing a subflow task from the UI

You can create a subflow task using the UI. Add the mandatory and optional parameters to create a unique subflow task.

Before you begin

You must have the USE permission on the workflow that needs to be referenced in the subflow task.

Procedure

  1. Log in to the UI using valid user credentials.
  2. Select the Design tab from the home page.
  3. In the Graphical Designer page, select the Assets tab.
  4. Click the Plus icon.
  5. From the drop-down menu, select Task template.
  6. Select the Subflow plug-in from the Add new task template dialog, and then click Next.

    The Add new task template dialog opens. Enter valid details for the mandatory fields. If required, you can also specify the optional fields.

    Table 1. Mandatory fields
    Options Description
    General information
    Folder Specify a folder to save the task definition. The default value is the root folder (/). The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. The name of the folder cannot contain spaces. You must include a forward slash (/) before the folder name if you want to define an absolute path, while it is not required for relative paths.
    Name Specify a name for the subflow task. The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. The name cannot contain spaces.
    Workstation You can specify the name of the workstation and also the name of the folder in which the workstation is defined, if any. The name must start with a letter, and can contain alphanumeric characters, dashes, and underscores. The name cannot contain spaces.
    Action
    Workflow Specify a valid workflow key (workstation name with workflow name separated by a number sign (#)) or drag and drop a workflow from the palette.
    Table 2. Optional field
    Option Description
    General information
    Description If required provide any free text.
    Action
    Variables Specify key-value pairs as variables. The values can be a JSONata expression that is resolved while the task is running. Any terms in the subflow task definition that matches the key in the key-value pair is replaced with their corresponding values, effectively resolving the subflow task definition.
    v2.1.5+Fire and forget If the option is set to on, the subflow task moves to the success status immediately after submission. The status of the nested workflow within the subflow task is ignored.
    v2.1.5+Start mode
    Manage the start time of the subflow task. You can run the subflow task at its scheduled time or delay its run. The default value is Immediate. You can select any of the following values:
    Immediate
    The nested workflow runs as soon as the subflow task runs.
    Start time
    Delays the scheduled time by a defined time and offset days. If you select this option, you must specify a value for the Start time field. Optionally, you can use the Delay for days field to define a positive number of "offset days" to further delay the launch (for example, adding 2 offset days).
    After an offset
    Delays the scheduled time by hours and minutes. If you select this option, provide a value in the Offset field in hours and minutes.
  7. Click Add.

Results

You have successfully created a subflow task. You can add the task to any existing or new workflows, and then submit the workflow.