- 28 Nov 2023
- 5 minute read
- Print
- DarkLight
- PDF
MaiaLearning Integration
- Updated 28 Nov 2023
- 5 minute read
- Print
- DarkLight
- PDF
MaiaLearning is a platform that engages middle and high school students in planning for college and careers. It also allows high school counselors to submit application documents on behalf of their students. This documentation provides the configuration steps within Slate and MaiaLearning to enable MaiaLearning Prospects and MaiaLearning Documents integrations.
Slate Configurations
MaiaLearning Prospects and MaiaLearning Documents can function independently of one another. However, they do involve many shared configuration steps, such as adding the standard user account in Slate and signing up for a MaiaLearning account. Items applicable just to one or the other are in separate, respectively named sections.
User Account
The user account provides MaiaLearning access to post data files or documents to the source formats that handle importing data..
Select Database on the top navigation bar and select Slate Template Library.
Add the MaiaLearning Service Account user. No changes should be made to the user account.
Note: If you do not see the user account, use the Refresh the Slate Template Library link at the top of the page to refresh the available resources.
Custom Field
Use a custom field configured as unique for merging to store the MaiaLearning ID. This ID can be used for matching purposes for any data and documents sent for the same student in the future.
Select Database from the top navigation bar and select Fields.
Create a person-scoped custom field to store the MaiaLearning ID. The field should be configured with the Unique For Merging setting Value contains a unique ID which identifies a single record for merging.
Note: In later steps, this field will be mapped in the MaiaLearning Prospects and MaiaLearning Documents source formats.
MaiaLearning Documents Source Format
This source format imports application documents uploaded by high school counselors on behalf of their students.
Select Database on the top navigation bar and select Source Format Library.
Add the MaiaLearning Documents (DIP) source format.
Once a file has been received, configure the Remap settings. Many items have been pre-mapped. As always, feel free to customize how the data will be imported.
Note: Be sure to map the MLID source field to the MaiaLearning ID custom field that you created in the previous step. Use the Unsafe Override setting to ensure that records with active applications will have this field set by this source format.
The documents are imported using the Custom: Material Code and Custom: Material Filename destinations, which have been pre-mapped. In order to import the PDF documents, these mappings cannot be changed.
On the Value Mappings page, be sure to map the Slate material type destinations for each document type that MaiaLearning will send.
Note: Any document types that are not mapped to a Slate material type will be sent to Batch Acquire for manual processing.Set the Remap Active flag to Active on the source format once you are finished customizing the mappings. This will run the import using the Remap settings configured above for all files uploaded on or after the Remap As Of Date value. No other changes should be made to the source format settings.
MaiaLearning Prospects Source Format
This source format will import data about high school students who opted to share their information with your institution.
Select Database on the top navigation bar and select Source Format Library.
Add the MaiaLearning Prospects (CSV) source format.
Once a file has been received, configure the Remap settings. Many items have been pre-mapped. As always, feel free to customize how the data will be imported.
Note: Be sure to map the MLID source field to the MaiaLearning ID custom field that you created in the previous step. Use the Unsafe Override setting to ensure that records with active applications will have this field set by this source format.
Set the Remap Active flag to Active on the source format once you are finished customizing the mappings. This will run the import using the Remap settings configured above for all files uploaded on or after the Remap As Of Date value. No other changes should be made to the source format settings.
MaiaLearning Configurations
Part of the MaiaLearning configurations includes providing your Slate subdomain (for example, "apply.slateuniversity.edu") and the ID of the source formats configured in the steps above. To find this information, refer to the information below.
Slate Resources
Slate Subdomain
The subdomain is the portion of the web address used to connect to Slate before the /manage. For example, if accessing Slate through the URL "https://apply.slateuniversity.edu/manage," then the institution's subdomain is apply.slateuniversity.edu.
Source Format GUID
The globally unique identifier (GUID) is a 36-character value that uniquely identifies a source format. The following steps describe how to retrieve the GUID. Note: If you are enabling both the MaiaLearning Prospects and MaiaLearning Documents source formats, repeat the steps for each one. Be sure to note the source format corresponding to each copied GUID.
MaiaLearning Account
Create an account on maialearning.com using the Sign Up link on the login page.
Complete the sign up form. Once complete, a confirmation email will be sent to allow completing the registration, including setting a password.
Note: You must use your university-supplied email address, or administrative rights will not be granted to the account.
Email [email protected], using the email account you just registered, with the subject line "Slate Integration Request," and include your university name, the Slate subdomain, the MaiaLearning Documents GUID, and the MaiaLearning Prospects GUID retrieved in the Slate Resources section above. MaiaLearning will then contact you to verify the details and enable the Slate integration for your institution. Once the integration has been enabled, proceed to the next step.
Log in to your MaiaLearning account to manage the Slate integration. The integration will initially be set to Inactive by MaiaLearning.
Verify that your Slate subdomain, MaiaLearning Prospects GUID, and MaiaLearning Documents GUID are correct. If necessary, change them by selecting the Action menu and selecting Edit.
Optional: Use the Test Prospects and Test Documents buttons on the integration page or Edit Slate Integration modal to send sample files to Slate to allow you to customize and test your mappings in the Slate source formats before turning on the integration.
Open the Edit Slate Integration modal and change the Status to Active once you are ready for the integration to go live.