Steps
Steps define what happens during an Integration. A Step is used to perform some type of action, such as:
- sending an HTTP request
- database insert, update, or query
- scheduling an event
- data aggregation
A Step can define outputs that become available as inputs for a subsequent Step. This allows data aggregation from multiple sources.
Basic
Basic Steps can be used for initial setup of an integration, data aggregation, etc. All other types of Steps are extended from the Basic Step.
| Field label | Field name | Description |
|---|---|---|
| Name | name | Name of the Step. |
| Description | description | Can be used to write a longer description of what the Step does. |
| Integration | integration | The Integration the Step belongs to. |
| Application | sys_scope | The scope of the step. |
| Sequence | sequence | The order of the Step relative to other Steps |
| Operations | operations | If the related integration can be triggered by multiple operations, this field can be used to limit when the step should run |
| Condition table | condition_table | This field is populated with the table that is defined in the Integration. It is used to control the Conditions field. |
| Conditions | conditions | Conditions can be used to limit when the step should run |
| Outputs | outputs | |
| Error script | error_script | An error handler that is automatically invoked if any error is encountered during Step execution. |
HTTP
The HTTP Step is used to make HTTP requests.
| Field label | Field name | Description |
|---|---|---|
| Method | method | The HTTP method to use. |
| Endpoint URL | endpoint_url | The URL the request is sent to. |
| HTTP headers | http_headers | The HTTP headers to include in the request. |
| Request script | request_script | Set the values for method, URL, headers, body, and query dynamically. |
| Authentication type | authentication_type | Set which type of auth to use. None, Basic, or OAuth2. |
| OAuth profile | oauth2_profile | Set the auth profile to use when using OAuth2. |
| Basic auth profile | basic_auth_profile | Set the auth profile to use when using Basic. |
Database
The Database Step is used to make database operations.
| Field label | Field name | Description |
|---|---|---|
| Table | table | The table the database operation will be performed on. |
| Operation | operation | The database operation |
| Advanced query | advanced_query | A boolean field that specifies whether or not to use advanced query. |
| Data script | data_script | Configures the database operation. |
| Query | query | Condition builder that is used to build the query. |
| Query script | query_script | Configures the query. |