Create a Universal Connector module

This explains how to create a customized module using the Universal Connector wizard.

1. In CONNECT flows, select Universal Connectors on the workspace menu.

2. In the upper-right corner, select the plus + icon. The Create Universal Connector wizard opens.

3. On the Module Configuration page, enter information about the new module:

   1. Enter a short name for the module in the Module Information text box. Only alphanumeric characters and spaces are allowed. This name serves as the module label.

   2. Select the Display Type down arrow, then select Input or Output as the module type. Input modules let you connect to data sources and perform data retrieval. Output modules are used to publish messages to a particular destination.

   3. Select Select File, then browse to and select a graphic for the module. The graphic must have a resolution of at least 256 × 256 pixels. The preferred size is 512 × 512 pixels.

4. Select the Go to next step icon to move to Version page.

5. In the Version text box, enter a version number for the module in x.y.z format.

6. Select the Go to next step icon. The Authentication page opens.

7. (Optional) On the Authentication page, specify one of the following authentication methods for the module:

   1. From the Select Credential dropdown list, select one of the following credential types: API-key (bearer authentication), OAuth Client Credential Grant (OAuth authentication), or Username and Password (basic authentication).

   2. Select Use credential in custom authorization to populate the Select Credential list with more credential types, then select the desired credential type from the list.

   3. (Optional) If using another authentication method, enter header and query parameter values in the Authentication headers and Authentication query parameters sections.

   4. (Optional) Select Allow untrusted certificates if plannig to connect to a service that uses self-signed certificate and disables certificate validation.

8. Select the Go to next step icon. The HTTP Configuration page opens.

9. On the HTTP Configuration page, complete the following fields:

   1. URL: Enter the full endpoint URL, including the path. Example: https://api.example.com/endpoint. Use parameters to make the URL configurable. Example: https://api.example.com/{resource}. At runtime, the system replaces {resource} with the configured value.

   2. Action: Select the HTTP method to use (for example, GET, POST, or PUT). If the selected method supports a request body, the Body field appears.

   3. Body: Enter body text; this text may be combined with configurable parameters. This field only appears if the action requires a payload body, such as a POST or PUT request.

   4. Content-Type: Select the type of content for the request from the Content-Type dropdown menu. This field only appears if the action requires a payload body.

   5. Header and query parameters: Enter required headers and query parameters. Select Add Header or Add Parameter to add additional entries. You can include configurable parameters in these fields.

   6. In the Response Configuration section, select the additional options set for the module:

      • JSON convert response body

      • Request body compression

      • Include response settings

10. Select the Go to next step icon. The Module Settings page opens.

11. (Optional) On the Module Settings page, configure each parameter by completing the following fields:

    1. Source: Specifies where to get data from for the parameter. Available options include User setting, Message parameter, and User setting if set.

    2. Display name: [User settings only] The text displayed above the parameter input field in the module UI.

    3. Type: [User settings only] The expected data type: String, Number or Bool

    4. Requirements: An optional setting for string and number user settings only. Specify the minimum and maximum lengths for strings or minimum and maximum values for numbers.

    5. Default value: [User setting only] Specifies the default value for the parameter. This field may be left blank on this page but a value must be entered when using the module.

    6. Help text: An optional user setting for the text that appears under the input field in the module. The help text is used to prompt users to enter certain data.

    7. Purpose: Text that describes the parameter. This text appears in the module settings.

12. Select the Go to next step icon. The Documentation page opens.

13. (Optional) On the Documentation page, complete the following fields to add supporting documentation to the module:

    1. Connector description: This text appears as a tooltip for the module in Flow Studio.

    2. Module documentation: A description of what the module does, the input messages expected by the module, how output messages appear, and a code example. This text appears on the Documentation tab of the Module Settings dialog.

    3. Settings: This field is auto-populated with previously entered information.

14. Select the Go to next step icon. The Release Notes page opens.

15. On the Release Notes page, enter information in the Edit box about the module release, including what’s new, what’s improved, and what’s been fixed.

    Select the Go to next step icon to move to the Preview page. A preview of the Universal Connector module is shown.

16. After previewing the module, select Save and Publish to publish the module or return to previous pages and make changes.