Skip to content

About Integrations

About Integrations

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.

Before you can create and run an integration, you must create a partner, connection, and template.

Each integration links to a partner, includes one or two connections (one for the input file and optionally another for response files), and uses a template. Because each template corresponds to a specific RCX process, the integration does too. It's best to name integrations accordingly.

The integration is where you specify

  • the file name pattern and location for the input file that FeedXChange downloads from the S3 bucket or SFTP host before running the integration.
  • the file name and location for the response file that FeedXChange uploads after the integration runs.

Input Properties

The Input Properties tab on the Integration details view is where you specify the connection to use and the path to the file FeedXChange downloads to run the integration. Although you can specify an exact file name, the host server might include a timestamp or another way to differentiate one file from another to avoid overwriting the previous file.

The Input File Pattern uses a regular expression to identify the file to download.

Example

For an enrollment integration, the storage bucket might receive a file named enroll_2025-01-01_00-00-01.123.csv. To instruct FeedXChange to find that file, you could use the regular expression enroll_.*. This means the file starts with the word enroll, followed by an underscore, and any number of additional characters.

Response Properties

The Response Properties tab on the Integration details view is where you specify the connection to use. You also define the path to the response file FeedXChange generates and uploads after it runs the integration.

The Response File Pattern is a prefix to be added to the original file name. It uses the text you supply to generate the file name to upload. You can customize the filename by using the variable ${file name} in the pattern. When specifying a file name extension for the response file, it must be appended to the file name.

Example

For an enrollment integration, if you want enroll_ prepended to the file name, use enroll_${filename} for the pattern. To apply a .csv extension, use enroll_${filename}.csv.

Integration Parameters

Not yet implemented.

Scheduling Options

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

When you configure an integration to run on a recurring schedule, the options are granular in:

  • minutes
  • hours
  • days
  • weeks
  • months
  • years

You also choose an interval, which can be any positive whole number.

Example

The "PAWs Resorts Enrollment" integration runs every 12 hours, and the "PAWs Resorts Activity" integration runs every 30 minutes.

Alerts

You can configure an integration to send email alerts to one or more team members when FeedXChange triggers one of these alert types:

  • the integration failed
  • a record within the integration failed
  • the integration started
  • the integration finished successfully

The Alerts dialog box with a search bar, Create New button, and four configured alerts, one for each available alert type. One example shows two email addresses, separated by a comma.
Figure 1. Integration Alerts

Dependencies

You might have an integration that requires one or more other integrations to finish before it runs. Dependencies enable you to specify:

  • all selected integrations must succeed
  • at least one of the selected integrations must succeed

Note

An integration can succeed even if some records aren't processed.

The dependent integration is the one that waits for the successful outcome of one or more prerequisite integrations. You configure the dependency for the dependent integration.

See also: