EAB Notes Export

What are platform integrations?

This feature allows institutions to connect their Mainstay data to a third-party platform, in this case, EAB. This enables an outbound sync of contact message history. To learn more, visit Platform Integrations.

Partners using EAB to store student data can export message history from Mainstay to EAB as "Notes". This integration generates a CSV file with specific columns on a schedule, and sends this to the EAB SFTP server, where it is ingested and converted into Note entries attached to student records.

Add an integration instance

1. From the Browse Available page, click Learn More for the individual platform, in this case, EAB.
2. Click the green Add New button to view a configuration modal for a new integration instance.
   • 
3. Alternately, in the Configured section below, click the pencil icon on an existing integration instance to adjust its configuration.
   • 

Setup

1. On Mainstay, click Add New.
2. 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.
   • 
3. On the FTP Client authentication screen, create a new authentication. This will prompt you to enter SFTP credentials for EAB, including the hostname, username, password, and port. This represents the SFTP server where we will send the files.
   
   • 
4. On the Data Configuration screen, filter which messages will be included:
   • Channel: Determine whether to include web chat messages, SMS text messages, or both.
   • Message Type: Determine whether to include messages in Scripts / Campaigns, exchanges with the AI and/or human agents, or both.
   • Direction: Determine whether to include incoming messages from the learner, outgoing messages from Mainstay, or both.
   • Starting Date: Determine when to start sending messages from, including a historical backfill.
   • Timestamp Offset: Optionally offset the UTC timestamps for your timezone.
   • 
5. On the CSV File screen, select the destination directory and enter the desired file name.
   • 
6. For the EAB Fields section, configure the values for various columns in the CSV that EAB is expecting.
   • GradesFirst Import Version: This number is determined by your EAB configuration.
   • Institution ID: This is the ID of your EAB institution.
   • Group ID: This may just be "group_id".
   • Is Private?: This controls whether the Note is private in EAB.
   • Is Student Viewable: This controls whether the Note is visible to learners in the EAB portal.
   • Show on Student Report: This controls whether the Note appears on EAB reports.
   • Created by: This will appear as the creator of the Note in EAB.
   • Note Reasons: This metadata will appear on the Note in EAB.
   • Note Body: This is the actual Note content in EAB. You can incorporate {date} and {url} placeholders, which will be converted into the actual date of the message and a link to the actual message in the Mainstay Conversations tool.
   • 
7. Finally, on the Schedule screen, select one or more windows in which Mainstay should export this file to EAB.
   • 

Enable/Disable or Delete an integration instance

1. 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).
2. Alternately, click the trashcan icon to remove this instance and configuration altogether.

File

The CSV file generated by this integration will include the following columns:

• note: the value will always be "note"
• add: the value will always be "add"
• Primary User ID: the CRM ID of the contact (which must be the EAB ID)
• Group ID: the "Group ID" from the configuration wizard
• Is Private?: Y|N
• Is Student Viewable: Y|N
• Show on Student Report: Y|N
• Created on: datestring
• Created by: the "Created by" from the configuration wizard
• Note Body: the computed "Note Body" from the configuration wizard
• URL: a link to this particular message in the Mainstay Conversations page
• Note Reasons: the "Note Reasons" from the configuration wizard

However, EAB is not expecting these columns to have headers, so they will be unlabeled, but always in this order.

Instead, the first row will always be just two columns:

• GradesFirst Import Version= followed by the value from the configuration wizard
• Institution ID= followed by the value from the configuration wizard

View error logs

1. In the side bar, click Sync Log, or visit https://app.mainstay.com/settings/sync-log.
2. 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)
3. If you encounter data validation errors while importing contact records, visit the Import Error Dictionary to better understand next steps.
4. You can also download this data for a specific time range by clicking Download Logs in the top-right corner.