Use this page to create and manage Integrations. Integrations establish connections to external data sources, facilitating the retrieval and utilization of data for analysis and reporting.
To manage your Integrations, use the Create Integration, Edit, and Delete buttons provided.
Integration
Use this page to manage the Actions within the current Integration.
To add an Action to the current Integration, click the Create Action button.
To copy the current Integration, with all its current Actions, to another IPaaS Tenant, click the Copy To button.
To manage the Integration Variables within the current Integration, click the Integration Variables button.
Integration Variables
Use this page to manage Integration Variables within the currently selected Integration.
Integration Variables provide a mechanism for storing and reusing values across multiple Actions within the Integration. By storing a value as a variable, you can reference it in any Action within this Integration, promoting consistency and reducing redundancy.
Action
Use this page to manage the selected Action within the current Integration. An Action defines a specific API call made to the integrated data source to retrieve data, such as an Authentication request or a call to retrieve aggregate or detailed data.
Expand the sections below to view detailed information about this Action.
Click the Publish button to schedule the Action for recurring execution.
Click the Unpublish button to stop recurring execution of the Action.
Click the Edit button to configure the Action.
Click the Test button to preview the data structure returned by the third-party endpoint before data is stored in the configured data store or the cache.
Click the Run Once button to execute the Action and store the response data in the configured data store or the cache.
Click the Delete button to delete the Action.
Action > Edit > General
The General Configuration page allows you to modify the Name of the selected Action.
Please note that the Tenant Name, Integration ID, and Version are all system-generated fields and cannot be edited.
Action > Edit > Command
The Command configuration focuses on retrieving data from the specified API endpoint. Additionally, pagination settings can be configured to handle large datasets returned in multiple chunks.
Form Fields
Source - Only API endpoints are currently supported by IPaaS so this cannot be edited.
Method - The HTTP method used for the API call (GET, POST, PUT, DELETE).
URL - The complete URL of the API endpoint.
Headers - (Optional) Key-value pairs containing additional information for the request.
Params - (Optional) Key-value pairs appended to the URL for filtering or sorting data. Transformations can be applied to Params. Please refer to: emite IPaaS Transformations
Body Content - (Optional) The data to be sent in the request body (for POST, PUT methods).
Body Type - (Optional) The format of the data sent in the body (JSON, XML, etc.).
Paging
When retrieving large datasets from APIs, paging allows you to fetch data in smaller chunks to improve efficiency. Emite IPaaS offers three paging methods:
Offset Paging - Specify the starting point (offset), the number of records per page (page size), and the increment for subsequent pages.
Batch Paging (From/To): Define a specific range of data to retrieve using "from" and "to" parameters.
Batch Paging (Lower/Upper Bound): Similar to From/To, but uses lower and upper bound parameters to define the range.
Important Notes:
Consult the API documentation to understand its paging parameters.
Use the correct parameter names and choose the appropriate paging method.
Test your integration thoroughly after configuring paging.
Action > Edit > Mappings
The Mapping Configuration defines how data retrieved from the API is mapped to fields in your data store (i.e., Elasticsearch).
Form Fields
Alias - The data store (i.e., Elasticsearch) field name.
Source - The JSON path to the field in the API response OR a field mapped within another referenced Action. For more information please refer to: emite IPaaS Referenced Actions
Destination Type - The Elasticsearch field data type.
Params - Key-value pairs to pass data to other referenced Actions (for lookups).
Rules - Conditional statements to assign static values based on conditions. Please refer to: emite IPaaS Rules
Masking - Used to mask field data for sensitive contents. Two (2) methods are currently supported; ‘first-3’ and ‘last-3’. note: The number is variable and can be any value. The characters chosen to be masked will be replaced with 'X' character.
Action > Edit > Rules
Rules allow you to define API response behaviour based on specific HTTP error codes or conditions.
Form Fields
Source - The field value as defined by the JSON path of the field.
Operator - A pre-defined list of operators to apply to the field.
Value - A static value to be used by the rule to check the value based on the operator applied.
Actions - A pre-defined list of actions to be applied to the field when the rule condition is met.
For example, you can define a rule that checks if a specific field equals a given value. If the condition is met, the corresponding action (e.g., return a specific error code or message) is executed.
The Cache Configuration allows you to optimize performance by configuring how data is cached. Caching stores frequently used data, reducing API calls and improving response times. For more information please refer to: emite IPaaS Integration Cache
Form Fields
Segmentation - Categorize cached data for efficient retrieval.
ID - A unique identifier for the cache entry.
Expire In Value - The duration after which cached data expires (e.g., 1d, calc:({{expires_in}} - 10000)s).
Force Refresh - Manually refresh the cache, overriding expiration settings.
Slide Expiration - Extend the validity of cached data upon access by the 'Expire In Value'.
Action > Edit > Data Stores
The Data Store Configuration defines how data is stored in Elasticsearch or OpenSearch.
Form Fields
Type - The type of connection (Elasticsearch or OpenSearch).
Connection Name - A unique name used to look up the connection URL (defined in the iPaaS backend configuration file).
Store Name - The Elasticsearch or OpenSearch index name.
Record ID - The primary key ID for Elasticsearch or OpenSearch. If not specified, a unique ID is auto-generated.
Number of Shards - The number of primary shards for the index (defaults to 3).
Number of Replicas - The number of replicas per primary shard (defaults to 2).
Index Lifecycle Management (ILM)
ILM automates index management.
Name - The ILM policy name.
Rollover Maximum Age - Trigger rollover after a certain time.
Rollover Maximum Size - Trigger rollover when the index reaches a certain size.
Rollover Maximum Document - Trigger rollover after a certain number of documents.
Delete Minimum Age - Delete the index after a certain time after rollover.
Action > Edit > Retry Policy
The Retry Policy Configuration allows you to configure a retry mechanism for failed API calls, improving the resilience of your integrations.
Rules
Rules define the conditions for retrying failed requests. You can add multiple rules based on specific criteria.
Add More Rules - Click to define additional retry rules.
Source - The source of the condition (e.g., response status code, error message).
Operator - The comparison operator (e.g., equals, contains).
Value - The value to compare against.
Retry Parameters
Initial Delay Seconds - The initial delay before the first retry attempt.
Delay Seconds - The delay between subsequent retry attempts.
Retry Count - The maximum number of retry attempts.
Action > Edit > Schedule Config
The Schedule Configuration allows you to schedule the execution of the Action.
Scheduling is required to publish an Action. You can define a specific schedule with a start date and interval frequency (days, hours, minutes, or seconds). If you choose a past start date, the Action will execute immediately and then follow the defined schedule from the current time.
