Step & Step Setting Configuration
Step Configurations
S.No | Field | Type | Possible Value | Purpose/Description | Mandatory |
1 | Step Code
| String |
| Used to uniquely identify the step | No |
2 | Step Type | Dropdown |
| To configure the adapter which the step needs to go for. | Yes |
3 | Client Id | Dropdown |
| Client id for which the job has to be created | Yes |
4 | Failure Job Detail Id | Dropdown |
| Job which needs to be triggered at the time of failure | No |
5 | Type | Dropdown |
| To configure the adapter which the step needs to go for. | Yes |
6 | Parent Id | Dropdown |
| Parent step for which this step belongs to. | No |
7 | Sub Type | String |
| Based on the type field is setted ex) if step type is file then sub type can be SFTP,FTP,S3. If step type is Rest then sub type can be POST|application/xml | Yes |
8 | Path | String |
| To provide Api endpoint (in case of rest,soap), SFTP and FTP credentials(in case of File) | Yes |
9 | Object Type | String |
| Based on the response data field is setted. | No |
10 | Response Type | String |
| Setted based on the response coming from rest, file,soap etc. | Yes |
11 | Sequence | Integer | 1,2,3 | Used to give order to the steps | Yes |
12 | Result | Dropdown |
| Based on the response data field is setted. | Yes |
13 | Success Key | Freemarker Template |
| Freemarker template to dynamically get the particular field value from response | No |
14 | Success Value | String |
|
| No |
15 | Logging Enabled | Checkbox | ☑️ or ⬜ | To log the step in step history | No |
16 | Header Template | Freemarker Template |
| Freemarker template to dynamically set the header data in case of Rest adapter | No |
17 | Request Template | Freemarker Template |
| Freemarker template to dynamically set the request data in case of Rest adapter | No |
18 | Response Formatter | Nashorn Template |
| Javascript function with specific logic which will be applied over the response of the step. | No |
19 | Request Formatter | Nashorn Template |
| Javascript function with specific logic which will be applied over the request of the step. | No |
20 | Error Formatter | Nashorn Template |
| Javascript function with specific logic which will be applied over the error of the step in case of failure. | No |
Step settings configurations
S.NO | KEY | POSSIBLE VALUE | PURPOSE/DESCRIPTION | Mandatory |
1 | CLIENT_ID
| client_id | Client id for which the job has to be created | YES |
2 | CSV_DELIMITER | , . | ; etc.. | To configure the Delimiter with which the input file is delimited | YES in case of file-based |
3 | CSV_HEADER_PRESENT | YES/NO | To configure whether the Header is present in the CSV/excel file or not | YES in case of file-based |
4 | PROCESS_ONE_FILE_AT_A_TIME | YES/NO | To configure whether to process a single file or multiple files at a time | YES in case of file-based |
5 | SKU_SAP_BIZOM_TRANSLATOR_TEMPLATE | Template for any field translation | The template needs to be given if any translation is done for any field in the post data | NO |
6 | BASIC_AUTHORIZATION_USERNAME | Username for basic authentication | Username to be configured if there is basic authentication present when hitting some API/SOAP | NO |
7 | BASIC_AUTHORIZATION_PASSWORD | Password for basic authentication | The password to be configured if there is basic authentication present when hitting some API/SOAP | NO |
8 | GROUP_AND_BATCH_THE_FILE | YES/NO | To configure whether to process by batching the file and grouping it based on some field or simple file | YES in case of file-based |
9 | FILE_NAME_FOR_FILE_UPLOAD | Name of the file for uploading | Name with which the file is uploaded in FTP | YES in case of uploading to FTP/SFTP |
10 | FILE_EXTENSION_FOR_FILE_UPLOAD | .txt , .csv , .xls , xlsx etc.. | Extension with which the file is uploaded in FTP | YES in case of uploading to FTP/SFTP |
11 | MAKE_UNIQUE_FILE_NAME | YES/NO | This setting is given when we need to have a unique file name if there is more than one file with the same name | NO |
12 | DATE_FORMAT_FOR_FILE_UPLOAD | _dd_MMM_yyyy or _yyyyMMdd_HHmmss etc.. | Date format with which the file is uploaded in FTP | YES in case of uploading to FTP/SFTP |
13 | APPEND_DATA_IN_SINGLE_FILE | YES/NO | This setting is given when the data of different batch or API to be uploaded to the same file or in different file | YES in case of uploading to FTP/SFTP |
14 | WINDOWS_LINE_DELIMITER | , . | ; etc.. |
| NO |
15 | FILE_NAMES_NEEDS_TO_BE_ZIPPED | Name of the file to be zipped | This setting is needed when we need multiple files to be zipped in a folder or the folder name to be zipped | YES in case of Zipping the files |
Last updated