Skip to content

Creating Integrations

Creating Integrations

After you create a partner, connection, and template, you can create an integration.

An integration is a process that you can run once or on a recurring basis. It's defined by a set of rules and criteria that determine when the process runs, what types of files FeedXChange accepts, and what types of files it produces.

A run is a single execution of an integration.

The integration is where the magic happens, where all the individual pieces come together.

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.

    The integration properties view shows the Integration Name, Partner, and Template fields set as described in the table in the next step.

  3. Fill in the fields as described:

    Property Name Property Description
    Integration Name Type Acme Pet Enrollment.
    Partner Select Acme Pet Shop.
    Template Select Acme Pet Enrollment.

  4. Click Save in the upper right corner.

  5. Click Input Properties. The Input Properties view opens.

    The input properties view shows the Input Connection, Input Path, Input Archive Path, and Input File Pattern fields set as described in the table in the next step

  6. Fill in the fields as described:

    Property Name Property Description
    Input Connection Select Acme Pet Shop S3 Connection.
    Input Path Type /home/input/. 1
    Input Archive Path Type /home/input/archive/. 1
    Input File Pattern Type enroll_.*. 2

  7. Click Response Properties. The Response Properties view opens.

    The response properties view shows the Response Connection, Response Path, Response Archive Path, and Response File Pattern fields set as described in the table in the next step

  8. Fill in the fields as described:

    Property Name Property Description
    Response Connection Select Acme Pet Shop S3 Connection.
    Response Path Type /home/output/. 1
    Response Archive Path Type /home/output/archive/. 1
    Response File Pattern Type resp_${input}.csv. 3

  9. Click Save in the upper right corner.

  10. Click Validate.
  11. Examine errors in the Errors and Warnings pane.

Note

This example integration won't work because the connection uses fictitious data. If you're using your own S3 or SFTP connection information, you can successfully test the integration. To avoid a file not found error, be sure a file exists at the specified input path. After you publish a valid integration, you can upload a file for testing purposes.

Next Steps

You can schedule an integration to run once in the future or on a recurring schedule.

You can also create an alert to email you when an integration event occurs.

If you were using a real-world configuration, you would publish the integration and run it once to debug any issues that arise. Refer to the FeedXChange How-to Guide for detailed instructions.

See also:

  1. If you have access to AWS, you can use an actual path to configure a real connection. ↩↩↩↩

  2. The file pattern uses a regular expression to identify the correct input files for the integration. For this example, the file must start with the word enroll, followed by an underscore, and any number of additional characters, such as enroll_2025-01-01T-01-00-00.csv. ↩

  3. The response file name can include a variable for the input file. In this case, the response file will be named resp_ + the input file name
    with a .csv extension. ↩