Add New Flow
This section lists the steps that are required to create a new Flow.
To add a new Flow, click on the Add New button.
The Add Flow page contains three sections:
Enter the following details to get started with a Flow:
- A suitable Flow Name
- A brief description of the Flow
- Status toggle On/Off button: To enable or disable the Flow
- Systems: Displays systems that are configured in the Flow API
Source API fields to display in the Mapping node.
For dynamic calls, the user makes a POST call to the DCKAP Integrator API and provides data. When DCKAP Integrator processes this request, the Flow is unaware of the input format since there is no API to get the information. The source data will be provided to the keyword
PAYLOADby default and which can be used in Flows further.
To show the fields in the mapping, the user has to provide both source and destination API. However, the user doesn't have a source API, since it is directly provided in
PAYLOAD. So the user has to provide the source response, which contains the sample template of data that the user is sending (similar to API Manager - Request) and the user has to choose the
SOURCE RESPONSEoption in the source API of mapping node.
Mapping Handler Configuration
Choose a JSON file to import the flow. Only exported JSON Flow files can be imported here. This is used to transfer flows from one project to another.
Export Flows allows users to save the entire Flow as a JSON file.
Difference between Save and Save & Merge
After making changes to the Flow
- Save - if you click on Save, changes will be saved but do not reflect in the pipe
- Save & Merge - Clicking on Save & Merge, will reflect changes made in the pipe
Users can drag and drop the Handlers to the Flow Builder. After the Handlers are placed in the Flow Builder, they are configured by adding parameters and assigning variables.
As mentioned earlier, Handlers are code-representation statements that carry out specific functionalities. Examples include API Call, If, Loop, Increment Variable, Initialize Variable, etc.
This tab will display the Pipes that the Flow is linked to.
Snippets are a small section of the Flow, consisting of a block of statements, that are inserted into the Flow as needed. These typically include commonly used functions and loops, which can be easily included in a large Flow.
For example, the statements inside an IF loop can be composed as one snippet, which can then be used within a larger Flow.
This makes the Flow more readable and avoids repetitive lines of statements.
Snippets can be imported and exported between Flows.
The Number of Snippets used in a flow is displayed as shown in the image below: