Skip to content

Create Integration

Create an IntegrationΒΆ

Before You Begin

Ensure you've created the partner, connection, and template.

To create an integration:

  1. Click Integrations in the left navigation pane. Existing integrations are listed.

  2. Click + Create New in the upper right corner. The Integration Properties view opens.

    Integration Properties screen showing fields for Integration Name, Partner, Template, and Description. The left navigation pane lists Integration Properties, Input Properties, Response Properties, Integration Parameters, Scheduling, Alerts, Dependencies, and Error Code Mapping. Labels for Revision and Edit Mode are visible, as is a Delete Integration button.

  3. Fill in the fields as needed. Required fields have an asterisk (*).

    Field Definitions
    Integration Name *
    The name of the integration. Because each integration is specific to a partner and a template, a good practice is to name the integration accordingly, such as Acme Pet Enrollment or PAWs Resorts Activity. Max length: 100 characters.
    Partner *
    The partner for the integration.
    Template *
    The template to use for the integration. The list of templates is populated based on the partner selected. Only published templates are available.
    Description
    Optional field to describe the integration. Max length: 255 characters.

  4. Click Input Properties. The Input Properties pane opens.

    Input Properties pane for creating an integration. The main section displays fields for Input Connection with an SFTP connection selected, Input Must Exist with Yes selected, Max Retries set to 5, Retry Interval Seconds set to 10, Input Path set to home/test-inputs, Input Archive Path set to home/test-archive, and Input File Pattern set to test.*. The left navigation menu lists Integration Properties, Input Properties, Response Properties, Integration Parameters, Scheduling, Alerts, Dependencies, and Error Code Mapping.

  5. Fill in the fields as needed.

    Input Field Definitions
    Input Connection *
    The connection to use to download the input file. Only connections for the selected partner are available.
    Input Must Exist *
    Whether an input file must be present for each run of the integration.
    Max Retries *
    If Input Must Exist is Yes, this determines how many attempts will be made before the integration run fails due to missing inputs.
    Retry Interval Seconds *
    If Input Must Exist is Yes, the number of seconds to wait between retries.
    Input Path *
    The path to the input files on the source system.
    Input Path Archive *
    The path to the directory where FeedXChange moves the input file after processing.
    Input File Pattern *
    The regular expression (regex) describing the pattern for the input file name. This enables FeedXChange to locate the correct file. For example, if the enrollment-related file names begin with enroll_ followed by a date and time, such as enroll_2025-01-01_06-00-00.txt, the input file pattern is enroll_.*.

  6. Click Response Properties. The Response Properties pane opens.

    Response Properties pane for creating an integration. The main section displays fields for Response Connection with an SFTP connection selected, Response Path set to home/outgoing, Response Archive Path set to home/outgoing/archive, and Response File Pattern set to enroll-resp_${filename}

  7. Fill in the fields as needed.

    Response Field Definitions
    Response Connection *
    The connection to use to upload the response file. Only connections for the selected partner are available.
    Response Path *
    The path where FeedXChange saves the response files on the source system.
    Response Archive Path *
    The path to the directory where older response files are kept.
    Response File Pattern *
    The literal string or prefix added to the original file name. For example, resp_${filename}.csv, where ${file name} is the input file name.

  8. To schedule the integration, refer to Schedule an Integration Run.

  9. To set one or more alerts for the integration, click Alerts. Refer to Add an Alert.
  10. To configure a dependency on other integrations, refer to Configure a Dependency.
  11. To configure error codes, refer to Configure Error Code Mappings.
  12. Click Save in the upper right corner.
  13. Click Validate to validate the integration and ensure the specified file paths are present.

Next step: Publish an Integration

See also: