Scholaro - Slate Integration Setup

Scholaro - Slate Integration Setup

This documentation describes the steps required to allow Scholaro to send documents directly into your Slate instance. The process involves:

  1. Creating a service account in Slate for Scholaro

    1. Also refer to: User Accounts, Importing Data with Web Services

  2. Creating a Source Format in Slate

    1. Also refer to: Creating a Custom Source Format

  3. Configuring Webhooks for Scholaro

  4. Remapping the Source Format

    1. Also refer to: Upload Dataset Stages

Create Service Account in Slate

  1. In Slate, go to Database > User Permissions

  2. Click New User

  3. Enter the following details to create the service account

    1. First Name = Scholaro

    2. Last Name = Service Account

    3. Email = Add a monitored email address that you have access to. Remember this email address because you will use it later.

    4. User Type = Service Account

    5. User ID = scholaro

    6. Password = Add a strong password. Record this password in a secure location because you will need it later.

Create Source Format

  1. In Slate, go to Database > Source Formats

  2. Click New Source Format

  3. Enter the following details on the General tab but do not click save yet.

    1. Status = Active

    2. Name = Scholaro DIP

    3. Format = DIP

    4. Type = One-Time / Differential

    5. Remap As Of Date = Today’s date in yyyy-MM-dd format

    6. Remap Active = Inactive

    7. Scope = Person/Dataset Record

    8. Dataset = Person/Application Records

    9. Unsafe = Unsafe

    10. Hide = Create Source Interactions

    11. Disable Update Queue = Allow records to enter update queue upon import (allow rules to fire)

    12. Update Only = Allow record creation

    13. Dedupe Records = Enable record creation for all rows

    14. Notification = Failures only

    15. Notification Email = Add the same monitored email address you used for the service account. You may also set Notification to “Successes and Failures” if you want to be alerted every time this import runs.

    16. Read Permission = Optional: add a permission to restrict which users may view this source format, or leave blank.

    17. Upload/Build Permission = Optional: add a permission to restrict which users may use and edit this source format, or leave blank.

    18. Source Metadata = Optional: add a form here if you want to record metadata about source uploads.

    19. Do not click save - proceed to the Format Definition tab. (If you did click save, that’s ok. On the next screen, click Edit in the top right corner to return to this menu screen)

  1. Enter the following details on the Format Definition tab, then click Save.

    1. XML =

      <layout b="&#x9;" h="1" type="dip" index="index*.txt" />

  1. Now that you’ve created the Source Format, open the Web Services menu and note the “Standard” POST URL. You will provide that to Scholaro in the next steps.

Provide Webhooks Configuration to Scholaro

  1. Login to

  2. Enter the following details

    1. URL = the Standard POST URL for your Source Format.

    2. Events to send = evaluation_report.created

    3. Authentication = Use basic authentication

      1. Username = scholaro

      2. Password = the strong password you created for your service account

    4. Enabled = Checked

  1. Scholaro can now send ZIP files to your Slate instance.

Remap the Source Format

  1. The first time Scholaro sends you a ZIP file, you will see a successful Web Service Post from Scholaro on the Scholaro DIP Source Format screen.

  2. When the Source Format is ready for mapping, you will see an Imported rows count for the new source. Click Remap.

  3. On the Field Mappings screen, add the following mappings:

    1. first = Record > First Name

    2. last = Record > Last Name

    3. email = Record > Email

    4. type = Material > Material Code

    5. Filename = Material > Material Filename

  1. Now go to the Prompt Value Mappings screen. Map the type field to the correct Material Types in your Slate instance.

    1. Click on the type source field

    2. Map the incoming document types to Material Types in your instance. Click Save.

  1. When the field and prompt mappings are complete, return to the Scholaro DIP Source Format.

  2. Click Edit in the top right corner of the screen.

  3. Set the Remap Active to Active. Click Save.