ZeeMee Integration
  • 17 Mar 2025
  • 3 minute read
  • Dark
    Light
  • PDF

ZeeMee Integration

  • Dark
    Light
  • PDF

Article summary

ZeeMee provides a community for students to engage with other students and participate in live virtual events. Utilizing student behavior on their social platform, ZeeMee provides colleges with actionable insights to help colleges predict and impact outcomes from recruitment through graduation.

Slate can integrate bidirectionally with ZeeMee. Once configured, your institution can send specific data to ZeeMee through the use of a query, and ZeeMee can send data to Slate through a source format.

📖 Further Reading: Refer to the ZeeMee website for more information.

Step 1: Contact ZeeMee

ZeeMee will help your institution configure the integration so that it meets their requirements. Contact Garvel Kindrick ([email protected]) to get started.

ZeeMee will request the endpoints to the Slate query and source format resources, which are described in the sections below.

Step 2: Create a ZeeMee service account in Slate

This user account lets ZeeMee send files to your Slate database. To create the account:

  1. From the main navigation, select Database.

  2. Under Configurations, select Slate Template Library.

  3. In the Search Library bar, enter "ZeeMee Service Account."

  4. Scroll down to the Users section. To the right of the item ZeeMee Service Account, click Add. A popup appears.

  5. Click Add. Do not make changes to this user account.
    Add_ZeeMee_User_Account.png

📝 Note

If you do not see the ZeeMee Service Account, click the refresh the Slate Template Library link at the top of the page.
Refresh_Slate_Template_Library.png

Step 3: Import ZeeMee Data Export query with Suitcase

To import the query and add it into your database:

  1. Copy the following Suitcase ID:

    fb38af9e-f711-452a-8a72-1e06a1ab5510:slate-examples
  2. Select Database from the main navigation.

  3. Select Suitcase under Import and Data Processing.

  4. Select Import.

  5. Paste the Suitcase ID.

  6. Select Retrieve. The Import Suitcase popup appears:

  7. Select Import.

Next, you’ll configure the ZeeMee query and schedule the export.

Step 4: Customize the ZeeMee data export query

This query allows you to send data to ZeeMee. Since many items are custom, it will require some additional configurations.

To configure the ZeeMee data export query:

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

  2. Use the Search Queries bar to find and select the ZeeMee Data Export query.

    ZeeMee_Data_Export_Query.png

  3. Click Edit Query.

  4. Before making any changes, click Copy. A popup appears. Saving a copy lets you view the original configurations, or start over if necessary.

  5. In the Copy Query popup, enter a name, then click Save. You are redirected to the copy's query overview page.

    Copy_Query.png

  6. Return to the original query.

  7. Click Edit Query.

  8. Click Edit Permissions. A popup appears.

  9. Select Add Grantee. In the next window, enter the following configurations:

    • Active: Active

    • Type: Username

    • Name: Enter an internally recognizable name for this token; for example, "ZeeMee"

    • Username and Password: Enter a username and password for the grantee.
      You will need to provide these credentials to ZeeMee.

    • Token: A token is generated automatically

    • Permissions: Select Web Service

      Edit Grantee

  10. Click Save.

  11. Using the specifications provided to you by ZeeMee, update the copied query to meet your needs. Many of the standard exports are pre-configured, and placeholder literal exports have been added to help guide you.

  12. Add any necessary filters to limit the data sent to ZeeMee (for example, you may wish to limit the query results to just records with particular prospective entry term values.)

  13. Once the query is configured, select Edit Web Service. A popup appears.

  14. In the Edit Web Service popup, enter the following configurations:

    • Service Type: JSON

    • Include NULLs: Include NULL Values

      Edit Web Service

  15. Click Save. A Web Service item appears in the query details summary.

  16. Click the JSON link next to the Web Service item.

    Click_JSON_Link_in_Edit_Query_Details_Summary.png

  1. Select the Service Account created in step 9.

    Username

  2. The URL is generated. Copy it and provide it to ZeeMee along with the username and password.

    URL Generated

Step 5: Create the ZeeMee source format in Slate

This source format is used to import the ZeeMee data.

  1. Select Database on the top navigation bar and select Source Format Library.

  2. Add the ZeeMee (CSV) source format.

  3. On the ZeeMee source format landing page, select the View link under Web Services to capture the endpoint to provide to ZeeMee. The endpoint is located on the Certificate-Based Authentication tab.

    A screenshot of the source format, highlighting the 'Web Services' View link and its pop-up's 'Certificate-Based Authentication' tab.

  4. Configure the Remap settings once a file has been uploaded. Standard items that can be used for matching purposes are pre-mapped. As always, feel free to customize how the data will be imported.

  5. Set the Remap Active flag to Active on the source format once you are finished mapping the Source Format. This will run the import using the Remap settings configured in the step above for all files uploaded on or after the Remap As Of Date value.

📝 Note: The Student.Id.PartnerCSV source field is mapped to the Slate GUID Matching Only destination. It is recommended that you send the Slate Person Record GUID to ZeeMee when configuring the query (this value is pre-configured in the ZeeMee Data Export query described above). If you are sending a different field to ZeeMee, then update this mapping to reflect the field that ZeeMee has in their system.


Was this article helpful?