Create an Integration

Creating an integration includes defining the trigger and invoke application connections, and defining how data is mapped between the two applications. The following procedure provides general instructions for creating an integration, with links to more detailed information for certain steps. When you perform each step, the progress indicator changes to let you know how close you are to completing the integration.

If you want to use a lookup table in your data mapping, create the lookup first. See Manage Lookups for instructions.

To create an integration:

  1. In the navigation pane, click Design, then Integrations.

  2. On the Integrations page, click Create.

    The Create integration panel opens.

  3. Select the type of integration pattern applicable to your business needs. See Understand Integration Patterns.

  4. Enter the following information:

    Field Description

    Name

    Provide a meaningful name so that others can understand the integration. You can include English alphabetic characters, numbers, underscores, and dashes in the identifier.

    Identifier

    Accept the default identifier value. The identifier is the same as the integration name you provided, but in upper case.

    Version

    Accept the default version number of 01.00.0000. Or, if you want to change the version number, enter the version using numbers only in this format: xx.xx.xxxx.

    Integrations are uniquely identified by an identifier and version. Note the version format of xx.yy.zzzz, where xx is the major version and yy.zzzz is the minor version.

    Integrations having the same identifier, but a different major version, can be active at the same time. For example, INT-A/1.00.0000 and INT-A/2.00.0000 can be active at the same time.

    When activating an integration while another integration of the same identifier and same major version is already active, the currently activated integration is deactivated prior to activating the selected integration.

    For example, if two integrations have the following integration states:
    • INT-A/2.00.0000 - Not active

    • INT-A/2.10.0000 - Not active

    Integration INT-A/2.00.0000 is then activated.
    • INT-A/2.00.0000 is now active.

    • INT-A/2.10.0000 is not active.

    Integration 2.10.0000 is then activated.
    • INT-A/2.00.0000 is now not active.

    • INT-A/2.10.0000 is now active.

    Documentation URL Optionally enter a URL to a design document that provides the details of the integration. The valid URL format is:
    http(s)://hostname:port/documentation_path
    Keywords Enter keywords (tags) to identify the integration. You can search for integrations on the Integrations page using keywords.

    Package

    Note: This field only appears if you are creating a globally available integration (that is, outside a project).

    Enter a new or existing package name in which to place your integration. When you enter the initial letters of an existing package, it is displayed for selection. See Manage Packages and About Packages.

    Description

    Provide a meaningful description so that others can understand the integration.

    Available to other projects

    Note: This field only appears if you are creating an integration in a project.

    Selecting this check box enables this project integration to be called by a parent integration in a different project. If you don't select this check box, this integration can only be called by a parent integration in the same project. See Invoke a Child Integration from a Parent Integration.

  5. Click Create.

  6. See the following sections based on your selection.