Set up a wrapper connection

Tom Santiago

Updated November 07, 2024 17:23

A wrapper is a developer toolkit to build connectors that provide communication between integrator.io and external APIs that can't use an application connector or any other universal connector . Wrappers require you to create a stack and are more complex to set up and maintain, but when simpler connector solutions fail, a wrapper connector can connect with any platform. Wrapper connectors can't be made available for use across other integrator.io accounts.

When to use a wrapper connection

Use a wrapper connector only if the external API doesn't have a branded connector created by Celigo and has requirements that can't be resolved using a universal connector.

If Celigo already has an application connector that works for your integration purposes, you should use the application connector because it has been specifically customized for communication with the app.
If an application connector does not exist, use a universal connector to create your integration flows. Universal connectors are the least complex solution for communicating with apps that don't yet have an application connector.

For example, if the API doesn't allow REST or HTTP-based connections, use a wrapper.

Wrappers are also useful if the external app requires the base URI or relative path to be passed without encryption, but also requires sensitive information (like token, password) to use encryption in JSON format. You can't view encrypted information after you save the connection, so make sure you can easily reference the schema of the JSON object.

Create a stack

Wrappers require you to create your own stack to store all the logic for connecting to and communicating with the external system. Verify that you have Developer Mode enabled so that you're able to see Stacks in the Resources menu.

Create a server stack

Use the following steps to create a server stack:

Navigate to Resources > Stacks. You'll need to have Developer Mode enabled to access Stacks.
Click + Create stack.
In the Name field, enter an appropriate name for the stack that you are about to create.
Use the drop-down list in the Type field to select Server.
Enter the server URL in the Host field.
Click Save & close.
Once you've saved the stack, click Show token in the System token column, and copy the token. You'll need this access token to enable the wrapper extension to communicate with integrator.io.
Review the express-integrator-extension readme files to specify the wrapper functions required to set up the connection. The ping function is especially important since it allows integrator.io to detect if the connection to your stack is active.

Create an AWS Lambda stack

Use the following steps to create a AWS Lambda stack:

Navigate to Resources > Stacks. You'll need to have Developer Mode enabled to access Stacks.
Click + Create stack.
In the Name field, enter an appropriate name for the stack that you are about to create.
Select AWS Lambda from the Type drop-down list.
Enter the Access Key Id and the Secret Access Key.
Select the region from the AWS Region drop-down list.
Enter the Function name.
Select C#, Java, Node.js, or Other from the Language drop-down list.
Click Save & close.
Review the lambda-integrator-extension readme files to specify the wrapper functions required to set up the connection. The ping function is especially important since it allows integrator.io to detect if the connection to your stack is active.

Create a wrapper connection

Use the following steps to create a wrapper connection:

After completing the above steps, click Resources > Connections > New connection, then choose the Wrapper application connector.

Name (required): Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection, and a unique identifier will prove helpful later when selecting among a list of connections that you’ve created.

Application (required, non-editable): A reminder of the app you’re editing.

Ping function: If you're using a ping function in your wrapper code, specify that function name here. This enables integrator.io to test your connection. If your connection goes offline due to an intermittent issue, integrator.io runs a batch process every hour (with an exponential decay) to regularly ping your connection and bring the connection back online if possible. If the connection drops and is re-established, pending or in progress jobs will resume processing.

Stack: Choose the stack that is hosting your wrapper code.

Unencrypted: Provide any non-sensitive data here.

Encrypted: Provide any sensitive data here.

sidebar. Optional concurrency and rate limit settings

Borrow concurrency from (optional): Select another connection from the list. By default, all data flowing through a connection record is submitted to the respective endpoint application at the concurrency level configured for that connection record. There are cases, however, where multiple integrator.io connections need to share the same concurrency level, and this field allows you to specify which connection you would like to borrow from. With borrowed concurrency, the data flowing through both connections will be submitted to the endpoint application together, via a shared concurrency model.
Auto-recover rate limit errors: This setting is enabled by default with a predefined value for Target concurrency level. You can disable the setting if required. To set or make changes in any of these settings, you must have admin or manage permissions.
- Target concurrency level: This field is shown only if Auto-recover rate limit errors is enabled. Change the predefined value as required to limit the number of concurrent API requests allowed by the connection resource. See also, Setting currency level on a connection.
- Concurrency level: When Auto-recover rate limit errors is checked, you can't modify the concurrency level because it matches the value set by the connected platform's runtime. When Auto-recover rate limit errors is not checked, you can enter a value to limit the number of concurrent API requests allowed by the connection resource. See also, Setting currency level on a connection.