Scholaro - Slate Integration Setup
This documentation describes the steps
required to allow Scholaro to send documents directly into your Slate instance.
The process involves:
Creating a
service account in Slate for Scholaro
Also refer to:
Creating a
Source Format in Slate
Also refer to:
Configuring
Webhooks for Scholaro
Remapping
the Source Format
Also refer to:
Create Service Account in Slate
In Slate, go
to Database > User Permissions
Click New
User
Enter the
following details to create the service account
First Name
= Scholaro
Last Name =
Service Account
Email = Add a monitored email address that you
have access to. Remember this email address because you will use it
later.
User Type =
Service Account
User ID = scholaro
Password = Add a strong password. Record this password in a secure
location because you will need it later.
Create Source Format
In Slate, go
to Database > Source Formats
Click New
Source Format
Enter the
following details on the General tab but do not click save yet.
Status = Active
Name = Scholar DIP
Format = DIP
Type = One-Time / Differential
Remap As Of
Date = Today’s date in yyyy-MM-dd
format
Remap
Active = Inactive
Scope = Person/Dataset Record
Dataset = Person/Application Records
Unsafe = Unsafe
Hide = Create Source Interactions
Disable
Update Queue = Allow records to
enter update queue upon import (allow rules to fire)
Update Only
= Allow record creation
Dedupe
Records = Enable record creation
for all rows
Notification
= Failures only
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.
Read
Permission = Optional: add a
permission to restrict which users may view this source format, or leave
blank.
Upload/Build
Permission = Optional: add a
permission to restrict which users may use and edit this source format,
or leave blank.
Source
Metadata = Optional: add a form
here if you want to record metadata about source uploads.
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)

Enter the
following details on the Format Definition tab, then click Save.
XML =
<layout
b="	" h="1" type="dip"
index="index*.txt" />
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
Enter the
following details
URL = the
Standard POST URL for your Source Format.
Events to
send = evaluation_report.created
Authentication
= Use basic authentication
Username =
scholaro
Password =
the strong password you created for your service account
Enabled =
Checked
Scholaro can
now send ZIP files to your Slate instance.
Remap the Source Format
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.
When the
Source Format is ready for mapping, you will see an Imported rows count
for the new source. Click Remap.
On the Field
Mappings screen, add the following mappings:
first = Record > First Name
last = Record > Last Name
email = Record > Email
type = Material > Material Code
Filename =
Material > Material Filename
Now go to
the Prompt Value Mappings screen. Map the type field to the correct
Material Types in your Slate instance.
Click on
the type source field
Map the
incoming document types to Material Types in your instance. Click Save.
When the
field and prompt mappings are complete, return to the Scholaro DIP Source
Format.
Click Edit
in the top right corner of the screen.
Set the
Remap Active to Active. Click
Save.