What are platform integrations?
This feature allows institutions to connect their Mainstay data to a third-party platform, such as an external SFTP server. This enables a 2-way sync of contact record data, including default fields (name, phone, email, etc.) and custom fields created by the partner. To learn more, visit Platform Integrations.
External Platform Documentation
Here is a non-exhaustive list of external platforms with SFTP import/export functionality.
- AdmissionPros: see AdmissionPros Integrations
- Amazon Lightsail: see Connecting to your Linux or Unix instance in Amazon Lightsail
- Anthology (formerly iModules): see Anthology - Data Management
- Blackbaud: see How to Configure a Secure FTP Connection
- EAB Starfish: see About the Universal Adapter
- Element451: see Securely Transferring Files
- Ellucian Banner via Evisions Argos or Broadcom AppWorx
- Ellucian Recruit via CozyRoc, KingswaySoft, or TIBCO
- Genesys: see Create and Manage List Automation Tasks
- GroupTrail: see Third-Party Integrations
- Microsoft Dynamics 365: see Export segments and other data to SFTP (preview)
- Oracle PeopleSoft: see Oracle PeopleSoft documentation for SFTP Target Connector
- Qualtrics: see Extract Data from SFTP Files Task and Load Data into SFTP Task
- Slate: see Mainstay Sync for Slate
- UKG Pro: see UKG HR Exchange protocol via SFTP file transfer
- Unifyed Student: see Unifyed Student – Admit v10.0
- Workday: see SFTP_Transport_Protocol_Data
Add an integration instance
- From the Browse Available page, click Learn More for the individual platform, in this case, SFTP.
- In the Available Integrations section, there will generally be two options: an incoming integration that will send data from the external platform into Mainstay, and an outgoing integration that will send data from Mainstay to the external platform.
- Click the green Add New button to view a configuration modal for a new integration instance.
- Alternately, in the Configured section below, click the pencil icon on an existing integration instance to adjust its configuration.
Mainstay > SFTP v2
- On Mainstay, click Download CSV Template to generate a CSV document listing all of your default fields (ex: first_name, last_name, phone, email) and custom fields (ex: CUSTOM_Application Status, CUSTOM_Class Year).
- Your external platform may require uploading this template to use for Field Mapping.
- Your external platform may also require you to specify Allowed IP Address(es). All data exports for this integration should come from 3.101.8.12 and/or 52.8.18.64.
- On Mainstay, click Add New.
-
Within the Configuration Wizard, on the Instance Details screen, create a display name and description for this instance. This is what will appear in the list; these values are only used for internal display purposes.
- On the FTP Client Authentication screen, create a new authentication.
- Authentication name is for display purposes only.
- Make sure SFTP is selected (not FTP).
- Host can be found in your external SFTP server configurations.
- Username can be found in external SFTP server configurations.
- Password can be found in external SFTP server configurations.
- Private Key can generally be left blank.
- Passphrase can generally be left blank.
- Port can generally use the default value of 22.
- Cipher can generally use the default value of Default.
- Finally, Save your authentication.
- On the next screen, enter a File name or use the default value, Mainstay_Contacts.csv. This is how the file will appear when exported to your external SFTP server.
- Then determine which contacts should be included in the file sent to your external system:
- Filter by channel:
- Filter by field value (including null and not null):
- On the Schedule screen, select one or more time slots for this recurring contact export by checking or unchecking the boxes. Note that all times are listed in Eastern Standard Time.
- Click Finish.
SFTP > Mainstay
- On Mainstay, click Configure SFTP.
- If available, enter your SSH Public Key. Otherwise, leave this blank.
- Click Configure.
- Copy the Hostname, Username, Password, and Port. You are able to view this information again in the future by clicking Configure SFTP again.
- On your external SFTP server, set up a scheduled export.
- Use the Hostname, Username, Password, and Port above as the connection for your recurring export.
- Configure the fields you would like to be exported to Mainstay.
- Configure the times and days you would like that data to be exported to Mainstay.
- On Mainstay, click Add New.
- Within the Configuration Wizard, on the Instance Details screen, create a display name and description for this instance. This is what will appear in the list; these values are only used for internal display purposes.
- On the Data Mapping screen, type the column headers as they will appear in your SFTP export file. For example, the contact id might be called "reference_id". For each column you would like to map, select the corresponding Mainstay field.
- Note that CRM ID (external platform id), First Name, Last Name, and Phone are all required fields.
- You may optionally include ID (Mainstay ID) as well - mapping to this field allows you to update existing CRM ID values. (See Creating Contacts.)
- If you use the Labels / Import Labels field, this expects a comma-separated list and will split that into an array of values.
- It is possible to map multiple columns to a single Mainstay field; priority is determined by the order in the "CSV Columns" list. For example, if your file includes a column for "mobile phone" and a column for "home phone", you might map both of these to the Mainstay "phone" field - and if the contact has a value in both columns, the integration will take whichever column you list first in the data mapping list.
- Optionally add one or more filters to determine which contacts should be ingested into Mainstay:
- Click Finish.
Enable/Disable or Delete an integration instance
- On the screen listing all instances for a specific platform, click the toggle to switch between enabled (to the right, with green showing) and disabled (to the left, with gray showing).
- Alternately, click the trashcan icon to remove this instance and configuration altogether.
View error logs
- In the side bar, click Sync Log, or visit https://app.mainstay.com/settings/sync-log.
-
This table presents a list of errors encountered while attempting to sync data between Mainstay and third-party platforms. Each log includes the following fields:
- timestamp
- id
- integration (ie, which platform)
- direction (incoming or outgoing)
- contact (a link to the Contact page of the affected individual)
- log message (ie, error code)
- If you encounter data validation errors while importing contact records, visit the Import Error Dictionary to better understand next steps.
- You can also download this data for a specific time range by clicking Download Logs in the top-right corner.
Comments
0 comments
Article is closed for comments.