Taskflows > Taskflows > Setting taskflow properties
  

Setting taskflow properties

Taskflow properties define the name and location of the taskflow, the fields that the taskflow uses, and other information required to invoke and run the taskflow.
To set taskflow properties, create a taskflow, click the Start step and access the Properties section. Optionally, click the empty area of the canvas to access the Properties section.
Define the general properties, taskflow binding and access details, input fields, temporary fields, advanced properties, and notes for a taskflow.

General properties

You can specify the following general properties for a taskflow:
Property
Description
Name
Required. A descriptive name to identify the taskflow.
Taskflows saved in different folders can have the same name.
The name cannot exceed 80 characters.
Override API Name
Optional. Overrides the API name that is auto generated when you publish the taskflow with a name that you specify. When you select this option, the API Name field becomes available.
API Name
Required if you select the Override API Name option.
A unique API name to override the auto-generated API name for the taskflow. The API name that you specify in this field is used in the generated service URLs.
The API name can contain only alphanumeric characters, underscores (_), and hyphens (-), and must not exceed 80 characters.
To change the API name of a published taskflow, you must first unpublish the taskflow. Then, change the API name and republish the taskflow.
If you override the API name and import the taskflow, the imported taskflow uses the API name that you specified. However, if there is an existing taskflow with the same API name that you specified, Data Integration uses an auto-generated API name for the copied or imported taskflow to avoid duplication. Data Integration also disables the Override API Name field. Similarly, if you copy the taskflow, Data Integration uses an auto-generated API name for the copied taskflow to avoid duplication and also disables the Override API Name field.
If you override the API name and move the taskflow to a different location, Data Integration retains the API name that you specified.
Location
The project and folder in which you want to save the taskflow. Click Select to navigate to a folder.
You must create a project and folder before you create a taskflow. You cannot create a project or folder from the taskflow creation page.
If the Explore page is currently active and a project or folder is selected, the default location for the asset is the selected project or folder. Otherwise, the default location is the location of the most recently saved asset.
Description
A description of the taskflow.

Start properties

Use the Start tab to define the binding type and access details for a taskflow.

Taskflow binding

The Binding property defines how a taskflow is invoked and run. You can select one of the following values:
REST/SOAP
If you select the REST/SOAP binding type, you can run the taskflow by using a REST or SOAP endpoint. You can use the Allowed Groups and the Allowed Users fields to define the user groups and users who can run a published taskflow as an API.
The following image shows the binding set to REST/SOAP, and the Allowed Groups and Allowed Users fields:
The image shows the binding set to REST/SOAP, and the Allowed Groups and Allowed Users fields.
Event
If you select the Event binding type, the taskflow is invoked when the specified event occurs. For example, a taskflow can be invoked upon an event such as arrival of a file in a file system. The Event Source Name field is available where you can select the file listener that you created for the event.
For more information about file listeners, see Components.
The following image shows the binding set to Event and the Event Source Name field:
The image shows the binding set to Event and the Event Source Name field.
After you publish a taskflow, you cannot edit the binding details. You must unpublish the taskflow to edit the binding details.

Taskflow access

If the taskflow uses the REST/SOAP binding type, you can define the user groups and users who can run a published taskflow as an API in the Allowed Groups and the Allowed Users fields. If a user falls into either of these categories, the user will have access to the taskflow service URL at run time.
If you do not configure both the Allowed Groups and the Allowed Users fields, Data Integration does not generate the taskflow service URL. You can run and schedule the taskflow. However, you cannot run the taskflow as an API.
Note: The Allowed Groups and the Allowed Users fields define the access details for running a taskflow as an API. To configure permissions for running a taskflow from the taskflow designer or invoking a taskflow through a file listener, you must create a role in Administrator and assign the required permissions.
Configure the following properties:
Allowed Groups
Defines the groups that have access to the taskflow service URL at run time.
Use the Allowed Groups option when you want a group of users to have access to a taskflow service URL. For example, you have a group called 'Order Approvers'. If you enter Order Approvers in the Allowed Groups field, all users within the group will have access to the taskflow service URL.
The following image shows the Order Approvers group added to the Allowed Groups field:
This image shows the Allowed Groups field with the group Order Approvers. The Allowed Users field is empty.
You can specify more than one group in the Allowed Groups field.
Allowed Users
Defines the users that have access to the taskflow service URL at run time.
Use the Allowed Users field when you want a specific user to have access to the taskflow service URL. The following image shows a user jsmith in the Allowed Users field and the group Order Approvers in the Allowed Groups field:
This image shows the Allowed Groups field with 'Order Approvers' and the Allowed Users field with 'jsmith.'
Users in the Order Approvers group and the user jsmith will have access to the taskflow service URL.
You can specify more than one user in the Allowed Users field.

Input fields

Use the Input Fields section to add fields that a taskflow uses at the beginning of a step.
You can define the input fields that you want to pass when you run a taskflow. You can create input fields of a simple type or a custom type.
Enter the following properties for each input field that you create:
Property
Description
Name
The name of the input field.
Type
The type of the input field. For example, select Checkbox, Date, Date Time, Time, Number, Integer, or Text.
You can also add an input field of a simple type or custom type. To do this, select More types, and then in the Edit Type dialog box, select the Category as Simple Types or Custom Types.
Description
A description of the input field.
Required
Indicates whether the input field is required for the taskflow to run.

Input fields for taskflows invoked by file listeners

When you select the binding type for a taskflow as Event and select a file listener, Data Integration creates an input field to store details of the files that arrived, were updated, or were deleted as part of the file listener event. The input field takes the name of the file listener. You cannot edit or delete this input field. You also cannot add more input fields for taskflows that are invoked by file listeners.
After the taskflow completes, you can access the My Jobs page, click the taskflow instance, and click the Input Fields tab to view details of the files that arrived, were updated, or were deleted as part of the file listener event. The input field displays the following information for each file that arrived, was updated, or was deleted:
You can monitor the execution of the file listener and the events that occur on each run job of the file listener. File listener log entries are listed on the File Transfer Logs page in Monitor.
Note: If you had selected the binding type for a taskflow as REST/SOAP and then change it to Event, Data Integration deletes the input fields that you had previously added.

Creating an input field with a custom type

You can create an input field with a custom type using the objects available in tasks in the taskflow. To create an input field with a custom type, you must have one or more steps that contain Data Integration tasks added to the taskflow.
  1. 1. On the Explore page, navigate to the taskflow for which you want to create an input field with a custom type.
  2. 2. Add steps to the taskflow. For example, add a Data Task step and an Ingestion task step.
  3. 3. Click the Start step of the taskflow.
  4. 4. Click the Input Fields tab.
  5. 5. Click the Add icon.
  6. 6. In the Type column, select More types.
  7. The Edit Type dialog box appears.
    The following image shows the Edit Type dialog box:
    The image shows the Edit Type dialog box.
  8. 7. From the Category list, select Custom Types.
  9. A list of objects available in the taskflow appears in the Types section.
  10. 8. Select the object that you want to pass as an input and click OK.

Temporary fields

Create temporary fields for use in a taskflow step. A taskflow uses temporary fields internally. Temporary fields do not appear in the input or output of a taskflow.
For example, you might define temporary fields if the taskflow has a Decision step.
Define the following properties for each temporary field:
Property
Description
Name
The name of the temporary field.
Type
The type of the temporary field. For example, select Checkbox, Date, Date Time, Time, Number, Integer, or Text.
You can also add a temporary field of a simple type or custom type. To do this, select More types, and then in the Edit Type dialog box, select the Category as Simple Types or Custom Types.
Description
A description of the temporary field.
Some temporary fields appear without you specifically adding them. When you add a task to a taskflow, a corresponding temporary field appears. The Name of the temporary field is the name of the Data Task step. The Type of the temporary field is the name of the task you add to the Data Task step. Enter a Description and select Required, if needed.
If you included a Data Task step in a taskflow, the Data Task fields appear on the Temp Fields tab of the Start step. The Data Task fields represent the input parameters of the task.

Advanced properties

You can configure a taskflow to suspend on a fault that occurs at the taskflow level. You can also configure the taskflow to send an email notification to specified recipients when it is suspended on a fault.
You can define the following advanced properties for a taskflow:
Property
Description
Suspend on Fault
Suspends the taskflow on a fault that occurs at the taskflow level.
The Suspend on Fault property takes precedence over the following properties that you define in a Data Task step:
  • - Fail taskflow on completion - if this task fails
  • - Fail taskflow on completion - if this task does not run
Send Email on Suspension
Sends an email notification when the taskflow is suspended on a fault.
When you select the Send Email on Suspension option, the Email To, Email Cc, Email Subject, and Email Body fields become available.
Email To
Defines the primary recipients for the email notification. Enter one or more valid recipient email addresses. Separate email addresses with a comma (,) or a semicolon (;).
Required if you configure the taskflow to send an email notification on suspension.
Email Cc
Defines the recipients who need to be sent a copy of the email notification. Enter one or more valid recipient email addresses. Separate email addresses with a comma (,) or a semicolon (;).
Email Subject
Specifies a short and descriptive subject that introduces the email.
Email Body
Defines the content that you want to send in the email.
Click Edit Content to open a rich text editor and use formatting options such as bold, italics, underlines, lists, indentations, and fonts. You can also insert tables and links.

Notes

Use the Notes field to add information that you or other users might need. The notes that you enter here appear on the Data Integration page. You do not see these notes when you run the taskflow.
For example, use the Notes field to add a reminder about a task that you need to complete before you run the taskflow.