- 31 Jan 2025
- 4 minute read
- Print
- DarkLight
- PDF
CampusESP Integration
- Updated 31 Jan 2025
- 4 minute read
- Print
- DarkLight
- PDF
CampusESP provides a modern, all-in-one family engagement platform that helps your institution share personalized, timely content with families across web, mobile, email, and SMS.
This article describes how to integrate the CampusESP parent engagement platform with Slate.
Step 1: Adding the CampusESP service account
To add the CampusESP service account to your database:
From the main navigation, select Database.
Under Configurations, select Slate Template Library (legacy tool).
At the top of the page, select refresh the Slate Template Library.
Under the Users heading, next to the CampusESP Service Account, select Add.
To configure the CampusESP service account:
From the main navigation, select Database.
Under Users & Access, select User Permissions.
Select Service Account, CampusESP.
Select Edit User.
Select the Roles tab.
Copy the username.
Share this username with CampusESP to grant SFTP access.
The CampusESP service account uses an RSA Keypair for authentication, so no password is needed.
Step 2: Configure the CampusESP data export query
The CampusESP - Data Export query exports relation data from Slate to the CampusESP platform.
đź’ Contact your customer service representative at CampusESP for support customizing the export.
To import the CampusESP data export query:
Copy the following Suitcase ID:
a449fb11-f53a-43e6-8db5-9100fe7d7fa0:slate-examples
From the main navigation, select Database.
Under Import and Data Processing, select Suitcase Import.
Paste the Suitcase ID.
Select Retrieve. The Import Suitcase popup appears.
Click Import.
To configure the CampusESP data export query:
From the main navigation, select Queries / Reports.
Select the CampusESP - Data Export query.
Select Edit Query.
Select Copy.
Enter a name for the copied query.
Select Save. Having a copy lets you view original configurations or start over.
The query has standard data exports, a filter, and scheduled export settings. Configure the following:
Adjust the exports and filters to send the desired records to CampusESP in the export.
Update any fields from the suitcase that no longer exist.
Ensure that the required fields,
stage
, andcohort
have appropriate values for your instance.Review and update the subquery exports for fields, such as
fafsa completion
orvisit indicator
.Select Schedule Export.
Select all Requested Weekdays.
Select Save.
See the CampusESP Export Dictionary for field definitions and descriptions.
Step 3 (Optional): Adding the source format
This CampusESP source format imports updates from the CampusESP parent portal.
By default, the import does not create new relation records, but it does allow updates to relation records when data in CampusESP differs from data in Slate.
From the main navigation, select Database.
Under Import and Data Processing, select Source Format Library.
Next to CampusESP - Data Import, select Add. A popup appears.
Select Add.
Confirm the browser dialog. You are redirected to the CampusESP - Data Import source format page.
Select Edit.
Make any necessary changes to the source format settings.
Select Save.
Several fields have been pre-mapped for convenience, but you can adjust these mappings as needed. Select Edit Mappings and review and update the destination field and value mappings as desired.
đź“ť Note: In order for Slate to match records in the Source Format, the Person and Relation GUIDs must remain mapped.
The /incoming/campus_esp/
directory is created the first time the SFTP sweep runs after the Source Format has been added to the database, which generally occurs approximately every 15 minutes. The directory can also be manually created if desired. This directory must exist before CampusESP connects via SFTP.
CampusESP Data Dictionary
This data dictionary, provided by CampusESP, describes the function of the columns included in the standard export query and source format. Required fields are marked (Required).
Column Name | Slate Equivalent | Description |
---|---|---|
| Relation GUID |
|
| Relation Relationship | Associated student’s relationship |
| Relation First | User/parent’s first name |
| Relation Last | User/parent’s last name |
| Relation Email |
|
| Relation Phone | User/parent’s phone number |
| Relation Address | User’s address (line 1) |
| Relation Address 2 | User’s address (line 2) |
| Relation Address City | User/parent’s city |
| Relation Address State | User/parent’s state/providence |
| Relation Address Postal | User/parent’s postal code or zip code |
| Relation Address Country | User’s country code (ISO ALPHA-2) |
| Person GUID | Associated student’s ID |
| Person First | Associated student’s first name |
| Person Last | Associated student’s last name |
| Person Email | Associated student’s email address |
| Custom Field |
|
| Rank 1 Decision, Application Status, Person Status. |
|
| Custom Field (Staff Assigned by Default) | Counselor name or region assigned to student |
| Custom Field | Boolean (true or false) field indicating if a student is first generation |
| Custom Field | Boolean (true or false) field indicating if FAFSA has been completed |
| Custom Field or Form Subquery | Boolean (true or false) field indicating if the student has visited campus |
| Custom Field or Form Subquery | Boolean (true or false) field indicating whether a student has or has not registered for orientation |
| Custom Field or Form Subquery | Boolean (true or false) field indicating whether a student has registered for admitted student day |
| Custom Field or Form Subquery | Boolean (true or false) field indicating if a housing contract has been submitted |
| Literal | College to which the student has applied or is enrolled |
| Custom Field | Student’s chosen major |
| Checklist Subquery | Any missing items required for the application |