CampusESP Integration
  • 31 Jan 2025
  • 4 minute read
  • Dark
    Light
  • PDF

CampusESP Integration

  • Dark
    Light
  • PDF

Article summary

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:

  1. From the main navigation, select Database.

  2. Under Configurations, select Slate Template Library (legacy tool).

  3. At the top of the page, select refresh the Slate Template Library.

  4. Under the Users heading, next to the CampusESP Service Account, select Add.

To configure the CampusESP service account:

  1. From the main navigation, select Database.

  2. Under Users & Access, select User Permissions.

  3. Select Service Account, CampusESP.

  4. Select Edit User.

  5. Select the Roles tab.

  6. Copy the username.

  7. 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:

  1. Copy the following Suitcase ID:

    a449fb11-f53a-43e6-8db5-9100fe7d7fa0:slate-examples
  2. From the main navigation, select Database.

  3. Under Import and Data Processing, select Suitcase Import.

  4. Paste the Suitcase ID.

  5. Select Retrieve. The Import Suitcase popup appears.

  6. Click Import.

To configure the CampusESP data export query:

  1. From the main navigation, select Queries / Reports.

  2. Select the CampusESP - Data Export query.

  3. Select Edit Query.

  4. Select Copy.

  5. Enter a name for the copied query.

  6. Select Save. Having a copy lets you view original configurations or start over.

  7. 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, email, stage, and cohort have appropriate values for your instance.

    • Review and update the subquery exports for fields, such as fafsa completion or visit indicator.

  8. Select Schedule Export.

  9. Select all Requested Weekdays.

  10. 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.

  1. From the main navigation, select Database.

  2. Under Import and Data Processing, select Source Format Library.

  3. Next to CampusESP - Data Import, select Add. A popup appears.

  4. Select Add.

  5. Confirm the browser dialog. You are redirected to the CampusESP - Data Import source format page.

  6. Select Edit.

  7. Make any necessary changes to the source format settings.

  8. Select Save.

  9. 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

parent crm id (Required)

Relation GUID

  • User/parent’s unique ID in CRM

  • Can be used to import data back into CRM

relationship to student

Relation Relationship

Associated student’s relationship

first name

Relation First

User/parent’s first name

last name

Relation Last

User/parent’s last name

email (Required)

Relation Email

  • User/parent’s email address

  • Users are matched by email address and data are merged based on their email.

phone

Relation Phone

User/parent’s phone number

address1

Relation Address

User’s address (line 1)

address2

Relation Address 2

User’s address (line 2)

city

Relation Address City

User/parent’s city

state

Relation Address State

User/parent’s state/providence

zip

Relation Address Postal

User/parent’s postal code or zip code

country code

Relation Address Country

User’s country code (ISO ALPHA-2)

student crm id (Required)

Person GUID

Associated student’s ID

student first name

Person First

Associated student’s first name

student last name

Person Last

Associated student’s last name

student email

Person Email

Associated student’s email address

cohort (Required)

Custom Field

  • Current cohort or admit term for this student (used for comparison reports)

  • For example, Fall 2024, FA24, or 2024FA

stage (Required)

Rank 1 Decision, Application Status, Person Status.

  • Current stage for this student

  • For example, Inquiry, Application Complete, or Deposited

  • Denied, Canceled, or Withdrawn indicators can be sent via this field or via a separate field(s).

    Families will be added to their respective community and be unsubscribed

counselor

Custom Field (Staff Assigned by Default)

Counselor name or region assigned to student

first gen

Custom Field

Boolean (true or false) field indicating if a student is first generation

fafsa completion

Custom Field

Boolean (true or false) field indicating if FAFSA has been completed

visit_indicator

Custom Field or Form Subquery

Boolean (true or false) field indicating if the student has visited campus

orientation registration status

Custom Field or Form Subquery

Boolean (true or false) field indicating whether a student has or has not registered for orientation

admitted student day registration status

Custom Field or Form Subquery

Boolean (true or false) field indicating whether a student has registered for admitted student day

housing contract status

Custom Field or Form Subquery

Boolean (true or false) field indicating if a housing contract has been submitted

college

Literal

College to which the student has applied or is enrolled

major

Custom Field

Student’s chosen major

missing items

Checklist Subquery

Any missing items required for the application


Was this article helpful?