Task Flow Features
Task Output Usage
Can use the output of the task that ran before it.
Multiple Execution
Can run the task once or multiple times.
Creating Task Flow
1
Go to Task Flows Page
Go to the Task Flows page within API Integration under the Development tab from the navigation bar on the left side of your screen.
2
Create New Task Flow
Create a new Task Flow by clicking the Create button in the top right corner.
3
Name and Save Task Flow
Create the task flow by naming it and clicking the Save and Next button.
Creation Form Fields
Name
Field: NameType: stringRequired: YesUnique name that identifies the task flow
Description
Field: DescriptionType: stringRequired: NoInformation text about the content of the task flow (optional)
Task Flow Configurations
Configuration Fields
Basic Information
Basic Information
Name
The name of the task flow as it appears in the list. It is required and must be unique within the project.
Description
Description related to the task flow.
Status and Monitoring
Status and Monitoring
Status
Indicates whether the task flow is active/passive.
Trace Status
Indicates whether the Trace (Debugging) feature is on/off.
Triggering and Tasks
Triggering and Tasks
Trigger Every
Indicates how often the task flow will be automatically triggered.
Tasks
Tasks defined in the content of the task flow are shown on the graph. Addition, deletion, and configuration operations are performed from here.
Endpoint
Option to trigger the task flow via its REST API endpoint.
Actions
Indicates actions to be performed if an error occurs during the execution of the defined task flow.
Trigger Frequency Configuration (Trigger Every)
You can define a scheduler to automatically run the task flow at specific times.1
Open Trigger Configuration Window
Configuration regarding how often the created task flow should be triggered is performed through the window that opens when the Change button under Trigger Every is pressed.
2
Fill Value and Unit Fields
Fill the Value and Unit fields to define the scheduler configuration.
- Minute - Minute
- Hour - Hour
- Custom - Custom Quartz Cron Expression
Task Flow Definition Settings
Task flow definition settings are performed through the window that opens via the Edit button in the top right corner.
Name
The name of the task flow as it appears in the list. It is required and must be unique within the project.
Description
Description related to the task flow.
Status
Active/passive status of the task flow.
Trace Status
Status of monitoring task flow steps. When active, data belonging to running steps is shown in logs, while when passive (suspend), detailed logging is not performed.
Task Settings
What is a Task?
In the API Integration module, each integration operation with a system or application is called a task. Since Apinizer adopts doing integrations as much as possible with API calls, it has adopted defining a task/connection type for each endpoint that can be called via API.
Task Types
Email Sending
Used for email sending
API Call
Used to send requests to external APIs
Database Connector
Used for database operations
Linux Script Execution
Used to run Linux commands
Script (JS/Groovy)
Used to run JavaScript or Groovy scripts
Notification
Used to send notifications
SNMP
Used for SNMP protocol operations
Task Definition
1
Click Task Addition Button
Sequentially running operations (transactions) are managed through the definition interface. To define a new task, press the + button on the schema under Tasks.
2
Select Task Type
Task selection screen:
3
Configure Task Details
For example purposes, explanation will be made through the API Call example in this document.
Data Transfer Between Tasks
In tasks within the task flow, the output of the previous task can be used as input for subsequent tasks. How the output of Api Call will be used as input for the Script policy added after it is shown in the screenshots below.
Output Key Usage
You can use the output of the API Call task as input for the Script policy added after it:
Viewing Task Flow Details
1
Open Details Menu
Logs can be viewed by clicking the menu button in the rightmost column of the record whose details are desired to be viewed from the task flow list and selecting Details.
2
Examine Log Records
The screen containing the log details of the Task Flow is reached.
3
View Execution Details
Press the three-dot button next to the relevant execution moment log record to examine the execution details of the task flow.
4
Task Log Details
Select Task Log Details to access the detailed execution log and outputs of each task within the task flow.
5
View Task Outputs
Execution logs of each task defined within the task flow are displayed through the opened window. Log details and task outputs can be viewed by pressing the three-dot button next to the relevant log record.
Common Fields in Tasks
Some input and output fields that are the same for each type are found when creating a task. Fields used for configuring common information in tasks are shown in the table below.Common Field Descriptions
| Field | Description |
|---|---|
| Execute This Task For | The type of how the result produced from the previous task will be executed within the current task is selected. Once: The current task is executed once. Loop: The current task runs in loop form with the definition to be specified on the result it receives from the previous task. |
| JSON Path/XPath Syntax | This option becomes active if the task execution type is selected as Loop. The result of the value given with JSON Path/XPath is executed as a loop. |
| Continue if operation fails | This option becomes active if the task execution type is selected as Loop. When actions in the loop are executed, if an error occurs, it manages whether the task should continue running or be stopped immediately. |
| Output Keys List button | The list of output keys created in previous tasks is viewed. Thus, this output key can be used in task definition inputs. |
| Output Key | The variable name to which the value that will be created when the task is executed will be assigned is entered. Subsequent tasks after this task will use the output key entered in this field if they want to process with this task’s output. |
| **Name ** | The name of the task is written. This information is assigned as the value of the {{taskflow.name}} variable. |
| **Description ** | The description of the task is written. |
Apinizer Syntax
The critical point in this field is that the value is written in accordance with Apinizer’s syntax. There are 2 elements to pay attention to in this rule.- Syntax 1: Querying Data
- Syntax 2: Using Data in Loop
Syntax rules:Example:
A result named
- Must open and close with 2 curly braces
- In the first part of the syntax, the output key name of the previous task is given. A
#sign is placed at the end - In the second part of the syntax, the value to be retrieved from within the output value is written in the query language (JSONPath, XPath) belonging to the data type
centralRates is produced in one of the previous tasks. The values of the result contain exchange rate information belonging to the Central Bank. An XPath query /Date/Currency has been written to get the elements in the array contained in this result one by one.Triggering Task Flow
Task flow can be triggered in three different ways:- Manual Triggering
- Automatic Triggering
- Triggering via Endpoint
The task flow is triggered every time the marked Execute button in the top right corner is clicked.
Deleting Task Flow
The record is deleted by clicking the menu button in the rightmost column of the record desired to be deleted in the task flow list and selecting Delete.
Endpoint Configuration
In addition to being triggered with a scheduler or manually with the execute button, task flows can also be triggered via HTTP requests through the special and unique endpoint created for the task flow at the moment the task flow is created.
1
Activate Endpoint Option
The endpoint option must be activated from the task flow editing interface.
2
Use Endpoint URL
After the endpoint option is activated, the task flow can be triggered by sending a request to the displayed URL.
3
Create Token
To trigger the task flow via its access URL, it is necessary to send a request by adding the user token to the Authorization header.To create a token: Token can be created with the logged-in user from Profile menu from top right > My Profile.
Actions Configuration
What is an Action?
Action refers to operations to be performed when an error occurs during the execution of a task flow.
1
Action Addition
You can define tasks desired to be performed in case of a possible error by pressing the + button from the Actions section.
2
Select Action Type
You can be notified of error situations or perform special operations for error situations by defining a task through the opened window when a possible error is encountered in the task flow.