Integration Details¶
Integrations List View¶
The Integrations list view includes the following fields.
- Name
- The name of the integration.
- Description
- The description of the integration.
- RCX Process
-
The RCX process selected for the template used in the integration.
RCX Processes
FeedXChange supports the following types of processing within RCX:
Process Name Description Activity Enables processing of bulk accruals (such as partner accrual feeds) and redemptions (such as point transfers or other expenditures coming from external sources). Enrollments Enables processing bulk enrollments of new members with optional duplicate matching by combinations of fields. Member Segments Enables bulk assignment of segments to members based on external segmentation sources. Member Preferences Enables bulk setting of member preferences and member-level loyalty feature flags. You can add preferences, but updating existing preferences isn't supported. LoyaltyID Enables adding a loyalty ID to members. Profile Update Enables updating member profile data. Note
Any process based on RCX member activity can autoenroll the member with only their loyalty id and receive profile updates as they become available.
- Partner
- The partner for the integration.
- Template Name
- The template used in the integration.
- Actions
- Icons in the Actions column are enabled depending on the integration's
- status and the privileges of your role:
-
- Copy (): Enables you to copy the integration.
-
- **Edit** (:fontawesome-solid-pen-to-square:): Opens the integration in edit mode. -
- **Delete** (:material-trash-can:): Deletes the integration. -
- **Publish** (:material-check-circle-outline:): Publishes the integration. -
- **Run Once** (:material-play-circle-outline:): Runs the integration immediately. -
- **Pause** (:material-pause-circle-outline:): Pauses the integration. Any -
scheduled integration runs are paused until the integration is resumed. -
- **Resume** (:material-clock-time-ten-outline:): Resumes a paused integration. -
Scheduled runs continue normally. -
- **Unpublish** (:material-cancel:): Unpublishes an integration so you can edit it. -
- **Upload File** (:material-tray-arrow-up:): Enables you to upload an input -
file to the storage location. You can then click **Run Once** to run the -
integration on that file.
Integration Details View¶
The Integration Details view includes the following fields. Required fields have an asterisk (*).
Integration Properties¶
- 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.
Input Properties¶
- 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 isenroll_.*.
Response Properties¶
- 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.
Scheduling Properties¶
- Effective Date/Time *
- The date and time the integration runs.
- Repeating *
- Whether the integration runs on a recurring basis. If
Yesis selected, two additional fields, Frequency and Repeat Interval, are displayed. - Frequency *
-
For schedules that repeat, the general time unit for how often the process is to run. Choices are:
- minutes
- hours
- days
- weeks
- months
- years
The Frequency and Repeat Interval are used together to schedule the recurring integrations, instructing FeedXChange to run this task every [Repeat Interval] [Frequency].
- Repeat Interval *
- For schedules that repeat, determines how often the process repeats. For example,
2withweeksmeans the integration runs biweekly. The Repeat Interval must be a positive integer. - Control Rate/Min *
- Determines the number of transactions FeedXChange processes per minute. The rate limit ensures that the system efficiently handles each request without exceeding capacity constraints, maintaining optimal performance and stability.
Alerts¶
Each integration can have one or more alerts.
Alerts List View¶
- Alert Name
- The name of the alert.
- Alert Type
- The type of alert to send: Integration failed, Records failed, Start, Success.
- Notification Email Address
- The email address or addresses to which to send the alert notification.
Alert Details View¶
Required fields have an asterisk (*).
- Alert Name *
- The name of the alert. Max length: 50 characters.
- Alert Type *
-
The type of alert to send. Options are
- Integration failed: the integration didn't finish
- Records failed: the integration finished, but one or more records weren't processed
- Start: the integration started
- Success: the integration finished successfully
- Notification Email Address *
- The email address or addresses to which to send the alert notification. To notify multiple people, separate each address with a comma.
Dependencies¶
A dependent integration is one that waits for the successful completion of one or more prerequisite integrations.
- Dependency Name
- The name for the dependency. Each integration can have only one dependency, but it can specify multiple prerequisite integrations. If the name is left blank, the integration has no dependency.
- Dependency Type *
-
The criterion for determining whether to run the dependent integration. This field is required if Dependency Name is filled. Options are:
- All must succeed
- One of must succeed
- Integration Dependencies *
- The prerequisite integrations whose status is to be evaluated to determine whether FeedXChange runs the dependent integration. This field is required if Dependency Name is filled.
Error Code Mapping¶
Note
The error code mapping feature is currently in development.
- RCX Error Code
- The error code generated in ReactorCX.
- Error Code Description
- The description for the error code as displayed by ReactorCX.
- Partner Error Code
- The corresponding error code in the partner's system.
See also: