Task Flow is used to run many tasks as a flow by integrating them to implement a task. In the flow, the sequentially running tasks are integrated via their own APIs.

Each task in the flow can use the output of the task running before it and can run the task once or more than once.

List of Task Flows

When the Development → API Integrator → Task Flows link is clicked from the main menu, the Task Flow List is displayed.


At the top of the list are the filter fields. When the filter fields are updated, the list content is also updated according to the filter.

A new Task Flow can be created by clicking the Create button at the top right of the list interface.

Creating a Task Flow

Defining the running processes, managing the log details of the process histories, suspending the flow, triggering the flow (creating endpoint, defining scheduler, running on-demand) are managed through the interface below.

The picture below shows the Task Flow settings:


Adding and Deleting Task

By clicking the plus symbol buttons in the task flow, a new task can be defined in the desired region in the flow.

To delete the task, click on the crossed out button that appears when the task icon is hovered.

To edit the task, the task icon must be clicked.


The fields used for the Task Flow configuration are shown below.

Field

Description

Name

An optional description of the task flow that may be useful for usage and management activities.

Description

It is the explanation of the task flow. It is optional to enter.

Enable or Suspend

The task flow must be enabled for it to be executable, it can be suspended to prevent it from running instead of deleting it.

Trace

When turn on tracking of task flow steps (All) is selected, the data of the running steps are displayed in the logs, while when Off is active, detailed logging is not made.

Tasks

The tasks that will create the flow are managed through the section here. The working order of the tasks progresses sequentially between the Start and End boxes. Click to get detailed information about task types and adding them.
Endpoint

One of the trigger options for the task flow is to send a request to the endpoint of the REST API of the task flow.

  • To enable this option, the switch button is brought to the active form. When this option is active, Endpoint Url and API Key information is generated.

When sending a request to the address in the Endpoint Url field, apiKey should be entered for the header information and API Key for its value.

  • If the task will not be run through the endpoint, it is brought to the disabled form.

Schedule

One of the trigger options for the task flow is to create a scheduler. This tells the task how often to execute. Click to get detailed information about timer operations.

Actions

Actions run when the task flow fails. Click to get detailed information about the action procedures.

Viewing the Details of The Task Flow

Logs can be viewed by clicking the menu button on the rightmost column of the record for which the details are to be accessed from the task flow list and selecting Details.


The picture below shows the log details of the Task Flow:


Deleting a Task Flow

The record can be deleted by clicking the menu button in the rightmost column of the record to be deleted in the task flow list and selecting Delete.

Task Flow is used to run many tasks as a flow by integrating them to implement a task. In the flow, the sequentially running tasks are integrated via their own APIs.

Each task in the flow can use the output of the task running before it and can run the task once or more than once.