| Parameters | Definition | Type |
|---|---|---|
| Parameters | Definition | Type |
| Systems | Platform to send and receive responses | DropDown |
| API | API endpoints of the selected system. Depending on the Platform chosen, the list of API’s in the dropdown changes. | DropDown |
| Response Variable | Stores API response Example: | Variable |
| Payload | Request Body. Information sent along with the API call | Variable (defined), JSON, Array |
| Files | Upload one or many files contents. Example:
| Variable (defined), JSON, Array |
| Headers | Request Headers Example:
| Variable (defined), JSON |
| URL Arguments | Arguments used in a dynamic URL. API URL: URL Argument: Formatted URL: In this case, | Variable (defined), JSON |
| Parameters | Request parameters API URL: Query Params: Formatted URL: Here, | Variable (defined), JSON |
| Override time | To override the timeout at Flow level. Read more below. |
{
"envelope_namespace": "xmlns:urn='urn:enterprise.soap.sforce.com'",
"body": {
"urn:login": {
"urn:username": "user1@ddckap.com",
"urn:password": "user1@123"
}
}
}
Variable to be incremented.
Example: line\_number, total\_records
Data to be formatted.
Example: orders\_summary, \["test", "array", "data"], {'data': orders\_summary}
Available Options
Types of Exception
Example: Exception, ValueError
Choose from drop-down:
Choose from drop-down:
Choose from drop-down:
a) if there is dynamic data, pass it as a dictionary here
b) else leave it blank
| Dictionary | | Message || {{key}} | {% endfor %}
| {{value}} | {% endfor %}
Value or data assigned to a variable
Examples:
Hello WorldNon String:
0\[1, 2, 3, 4, 5]{ "customer\_id": 123}Type of data to be modified
Action to modify existing data
Pop:
Remove
Deep Copy
To learn more, find the use cases below
| String | #### Use Case 1 - Dictionary(Action: Assign) ``` Modify variable customer_info['customer_id'] with value custom_attribute['value'] ``` * Assume the variable customer\_info is a dictionary/JSON and contains the value `{“entity_id”:12, “name”: “Alice Blue”}` * To add more keys with values to the dictionary, the modifier handler is used * The below step adds `customer_id` to the dictionary * After processing, the `customer_info` variable contains the value `{“entity_id”:12, “name”: “Alice Blue”, “customer_id”: custom_attribute[‘value’]}` #### Use Case 2 - **Array(Action: Append)** ``` Modify variable customer_info['customer_id'] with value custom_attribute['value'] ``` * Assume the variable customer\_info is an array/list and contains the value `[{“entity_id: 1}, {“entity_id: 2}, {“entity_id: 3}]` * To add an item to the array, the Modify Variable handler is used * The below step adds `customer_id` to the Array * After processing, the `customer_info` variable contains the value `[{“entity_id: 1}, {“entity_id: 2}, {“entity_id: 3}, {"custom_attribute['value']}]` ### Mapping Provides the ability to get mappings from the user and format data between two different system APIs. {% hint style="info" %} This adds a new mapping card in the pipes section to get mappings in the pipe. The Modifiers will also be provided in the same section. {% endhint %} Based on the Mapping configuration, the destination payload will be prepared from the source data.  #### Available Options | *Parameters* | *Definition* | *Type* | | ------------ | -------------------------------------------------------------------------------------------------------------- | ------------ | | Display name | Mapping name displayed in the pipe | Alphanumeric | | Source | API used to request data from the Source system | DropDown | | Destination | API used to send data to the Destination system | DropDown | | Variable | Stores mapped data | Variable | | Source Data | Source data that will be formatted and sent to destination API as per the mapping configuration | JSON, Array | | Ignore Keys | Keys that should be ignored by the system, while processing data in the mapping structure defined by the user. | Alphanumeric | #### **Example** ``` Prepare mapping with name Customers Information from source Get Customers- Magento 2 to destination Create Customers - Epicor P21 Custom Server ``` Creates a mapping node in the pipe to provide the mapping of data between the specified source and destination APIs. #### **Use Case - Ignore Keys** ``` { "customer": [ { "name":"alice", "address": { "street": "Jarvis St.", "door_number": "5A" } }, { "name":"bob", "address": { "street": "Marvel St.", "door_number": "7D" } } ] } ``` Assume the field `street` is mapped from source to destination system and the path generated for this field will be `customer/address/street`. During Mapping, when the user sends this customer data(Parameter: Data) inside a loop, one entry at a time, to get the `street address`, the resulting path generated will be `address/street`. In this case, the user should mention the parent keys to be ignored. In this case `customer`. If multiple keys need to be ignored, then the user should mention them as comma-separated values. {% hint style="info" %} When an API or system is changed in the Flow, then the previously configured mapping becomes unstable. So users will be alerted if the mapping should be retained or if it should be deleted during the save and merge process. If the mapping is retained, the errors will be highlighted. {% endhint %} ### If, Else If & Else To define and check for decision-making conditions inside the Flow. Condition parameters are defined for the `If` and `Else If` handlers. If this condition is satisfied, the children of `If` will be executed. Otherwise, the children of `Else` will be executed.  #### Available Options | *Parameters* | *Definition* | *Type* | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | | Condition |Condition that needs to be satisfied for the children-statements to be executed
Example: admin\_details\['status']
If the value is true, the children will be executed
Data to be iterated/looped
Example: Sales\_rep\_data\['data']
The loop will keep running until there is an item in the data
| Array | | Key |Variable assigned to the loop counter
Example: key, item
Displayed in the progress bar of pipes
Examples:
ID of the entry. Useful in identifying if the entities succeeded or failed.
Example: item\[‘itemCode’], mapped\_orders\['hdr']\['webReferenceNumber']
Content that needs to be displayed
Example:
Dynamic ⇒ Variable: order\_info, line\_no
Static ⇒ HelloWorld, 12345
To change the format of the output time
Example: Month-Day-Year HH:MM:SS
| DropDown | ### Credential Keys Retrieves any credential details from the respective project. (Example: Name, System, Hostname)  #### Available Options | *Parameters* | *Definition* | *Type* | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | Value |Data that were assigned while setting up the credentials of the system
Value: Name, System, Hostname
String/Non-string
Actual date-time in UTC format or variable name containing the date-time in UTC format
| DropDown | | Action |Advance/Recede
To add or subtract hours and minutes
| DropDown | | Hours and Minutes | Value of hours and minutes to be added or subtracted to the given time | Numeric | ### Time Converter Converts Time from one format to the other (12Hr clock to 24Hr clock and vice versa). | *Parameters* | *Definition* | *Type* | | ------------- | ---------------------------- | ---------------------- | | Convert | The conversion time format | DropDown | | Variable | Variable to store the output | Alphanumeric | | Enter Hours | Hours value | Numeric (1-12 or 1-24) | | Enter Minutes | Minutes value | Numeric (1-60) | | Enter Seconds | Seconds value | Numeric (1-60) | | Meridiem | Choose AM or PM | DropDown | \ **Time Zone converter** This handler serves two purposes: 1. Converts datetime (object/string) from a time zone to another timezone. 2. Generates a timestamp for a given datetime (object/string). [Click here to Learn more about configuring the Timezone Converter and examples.](https://docs.dckapintegrator.com/developers/flows/timezone-converter-handler) ### **Data Type converter** Converts data from one data type to another (string to integer or integer to string). | *Parameters* | *Definition* | *Type* | | ------------ | ----------------------------------------------------------------------------- | ------------ | | Variable | Stores the output | Alphanumeric | | Value | Value or variable whose data type has to be converted | Alphanumeric | | Data type |Data type that the value has to be converted to
String/ Integer
| DropDown | ### **Current DateTime** Converts current time to the timezone of selected system. **Available options** | *Parameters* | *Definition* | *Type* | | ------------ | ------------------------------------------ | ------------ | | Variable | Stores the output | Alphanumeric | | System | Current time is converted to this timezone | Alphanumeric | ### Pagination To send required paginated data for API calls. **Available options** | *Parameters* | *Definition* | *Type* | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------ | | Variable |Output from the handler
(Part of the data (from input data) as per the number of records mentioned)b
| Alphanumeric | | Response Data |The input to the handler i.e., the data which needs to divided into smaller arrays.
Example: response data will be the output from an API call
| Alphanumeric | | Number of records | Number of records the user needs in the output every time | Numeric | ### While Loop Loop till specified condition is true. **Available options** | *Parameters* | *Definition* | *Type* | | ------------ | ------------------------------------- | ------ | | Condition | Loop till specified condition is true | JSON | ### Break To break a loop. ### SFTP Writer To create files in a remote location using SFTP connection. Prerequisite: Add SFTP Credentials| Parameters | Definition | Type |
|---|---|---|
| File | Existing remote folder location followed by file name Example: /tmp/test/file1.csv | String |
| Data | Name of variable containing the data to be written | Alphanumeric |
| Character Set | Encoding character set for the file content | Drop Down |
| Parameters | Definition | Type |
|---|---|---|
| File | Existing remote folder location followed by file name Example: /tmp/test/file1.csv | String |
| Variable | Name of variable to store the data read from the remote location | Alphanumeric |
| Handle CSV Data | If yes, provides a list for easy looping and if no, provides raw bytes. | DropDown |
| Character Set | Decoding character set for the file content | Drop Down |
| Parameters | Definition | Type |
|---|---|---|
| File Path | File path where the new file to be read exists. Example: /testing/ | String |
| File name | Name of the file to be created with extension Example: file1.txt | String |
| Variable | Name of variable to store the data read from the remote location | Alphanumeric |
| Handle CSV Data | If yes, provides a list for easy looping and if no, provides raw bytes. | DropDown |
| Character Set | Decoding character set for the file content | Drop Down |
| Parameters | Definition | Type |
|---|---|---|
| File Path | Existing file path where the new file is to be created Example: /testing/ | String |
| File name | Name of the file to be created with extension Example: file1.txt | String |
| Data | Name of variable containing the data to be written | Alphanumeric |
| Character Set | Encoding character set for the file content | Drop Down |
Location from which the list of files and folders are to be listed
Example: /testing/
| String | | Variable | Name of variable to store the list of files and folders from the remote location | Alphanumeric | #### Delete File | Parameters | Definition | Type | | ----------------------- | ---------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Delete File | DropDown | | Path |Location from which file is to be deleted
Example: /testing/
| String | | Variable | Name of variable to know the status of the action - whether file is deleted or not | Alphanumeric | | File Name |Name of the file to be deleted
Example: file1.txt
| String | #### Rename File | Parameters | Definition | Type | | ----------------------- | ---------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Rename File | DropDown | | Path | Location in which the file to be renamed exists Example: /testing/ | String | | Variable | Name of variable to know the status of the action - whether file is renamed or not | Alphanumeric | | File Name |Name of the file to be renamed
Example: old.txt
| String | | New File Name | New name of the file Example: new\.txt | String | #### Move File | Parameters | Definition | Type | | ----------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Move File | DropDown | | Path |Location in which the file to be moved exists
Example: /testing/
| String | | Destination Path |Location to which the file has to be moved
Example: /testing/folder/
| String | | Variable | Name of variable to know the status of the action - whether file is moved from the source path to destination or not | Alphanumeric | | File Name |Name of the file to be moved
Example: file.txt
| String | #### Change Permission | Parameters | Definition | Type | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Change Permission | DropDown | | Path |Location in which the file whose permission is to be changed exists
Example: /testing/
| String | | Variable | Name of variable to know the status of the action - whether file’s permission is changed or not | Alphanumeric | | File Name | Name of the file whose permission is to be changed Example: file1.txt | String | | Desired Permission | The desired permission is given as a three digit number - by default, it is 644 meaning read and write for the owner, read for groups and read for the public. | String | #### Create Directory | Parameters | Definition | Type | | ----------------------- | --------------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Create Directory | DropDown | | Path |Location in which directory has to be created
Example: /testing/
| String | | Variable | Name of variable to know the status of the action - whether directory is created or not | Alphanumeric | | Directory Name | Name of the directory to be created | String | ### SFTP Advanced Lists files, deletes, renames, moves & changes permission for file and creates directory in the remote location using the established SFTP connection {% hint style="success" %} **Note:** For root folder, use `/` in the path field {% endhint %} #### List files | Parameters | Definition | Type | | ----------------------- | --------------------------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Choose the action to be performed as list files. By default, the handler lists files. | DropDown | | Path |Location from which the list of files and folders are to be listed
Example: /testing/
| String | | Variable | Name of variable to store the list of files and folders from the remote location | Alphanumeric | #### Delete File | Parameters | Definition | Type | | ----------------------- | ---------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Delete File | DropDown | | Path |Location from which file is to be deleted
Example: /testing/
| String | | Variable | Name of variable to know the status of the action - whether file is deleted or not | Alphanumeric | | File Name |Name of the file to be deleted
Example: file1.txt
| String | #### Rename File | Parameters | Definition | Type | | ----------------------- | ---------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Rename File | DropDown | | Path | Location in which the file to be renamed exists Example: /testing/ | String | | Variable | Name of variable to know the status of the action - whether file is renamed or not | Alphanumeric | | File Name |Name of the file to be renamed
Example: old.txt
| String | | New File Name | New name of the file Example: new\.txt | String | #### Move File | Parameters | Definition | Type | | ----------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Move File | DropDown | | Path |Location in which the file to be moved exists
Example: /testing/
| String | | Destination Path |Location to which the file has to be moved
Example: /testing/folder/
| String | | Variable | Name of variable to know the status of the action - whether file is moved from the source path to destination or not | Alphanumeric | | File Name |Name of the file to be moved
Example: file.txt
| String | #### Change Permission | Parameters | Definition | Type | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Change Permission | DropDown | | Path |Location in which the file whose permission is to be changed exists
Example: /testing/
| String | | Variable | Name of variable to know the status of the action - whether file’s permission is changed or not | Alphanumeric | | File Name | Name of the file whose permission is to be changed Example: file1.txt | String | | Desired Permission | The desired permission is given as a three digit number - by default, it is 644 meaning read and write for the owner, read for groups and read for the public. | String | #### Create Directory | Parameters | Definition | Type | | ----------------------- | --------------------------------------------------------------------------------------- | ------------ | | What do you want to do? | Create Directory | DropDown | | Path |Location in which directory has to be created
Example: /testing/
| String | | Variable | Name of variable to know the status of the action - whether directory is created or not | Alphanumeric | | Directory Name | Name of the directory to be created | String | ### Internal Dynamic Call To trigger a dynamic pipe from another pipe.  a) Dynamic Pipe: Choose the dynamic pipe to trigger from the dropdown list b) Payload: The payload field is used to send data to the Dynamic Pipe that is being called. This data will be used in the Dynamic pipe to process the associated Flow. c) Response Variable: Once the dynamic pipe is triggered from this handler, a variable will be sent back from the dynamic pipe. The 'Response variable' field will be used to store that response.