PART 1: Configuring SFTP connectivity in SCOIR and Slate
SCOIR supports the sending of document batches via SFTP, the approach recommended by Slate for integrations that include a need for document imports. While the following can be leveraged as general guidance, Slate user documentation should be consulted for more detailed information regarding what is being accomplished in each step.
Step 1 – Create a Slate user for SCOIR:
This user can be established using the information you feel is most appropriate.
Step 2 – Enable the SFTP Access role for this user:
This is easily accomplished by checking the “SFTP Access” on the list of available roles.
Step 3 – Collect information for SCOIR configuration:
Once you’ve enabled SFTP Access, you’ll need to make note of the Host, Port, and Username information shown under the “SFTP Access” portion of the screen displayed above.
Step 4 – Enter additional SFTP Access details:
4a. Define a “Path Restriction” to limit SCOIR’s access to a specific location on your SFTP server. Note: If you wish to restrict access to something more specific then the pre-configured “/incoming/” directory, see the “Connection Instructions” link on the SFTP Access bar for details regarding how this task can be accomplished.
4b. In order to ensure SCOIR is able to connect, you must provide Slate with the three IP addresses from which SCOIR will initiate document deliveries:
- - 220.127.116.11
Step 5 – Allow sufficient time for settings to take effect:
Be certain you’ve saved the “Allowed Networks” info in Slate before attempting to continue. Also, note that it may take up to an hour before these saved networks are processed by Slate. The next step will fail if your updates have not fully processed.
Step 6 – Configure SCOIR SFTP Integration:
Now you can log into your SCOIR account (app.scoir.com), navigate to the SFTP Integration page, and complete the configuration steps. Details follow the screen capture below.
6a. Complete Step 1 by entering the Hostname, Port, and File Path (“Path Restrictions” from Slate) that you noted in step 3 & 4a above.
6b. Complete Step 2 by entering the Username collected in steps 3 above. Slate users should opt for generating a key, as this is the preferred method for setting up SFTP.
6c. Copy the newly generated key and return to Slate. Here you must enter and save this key in the SSH2 Public Key portion of the “SFTP Access” section of the new user’s role page.
6d. Return to SCOIR and complete Step 3 by testing your connection.
If everything has been configured correctly you will receive a message indicating a successful test and the screen will permit you to proceed.
6e. Complete step 4 by activating your SFTP Delivery configuration and you’re ready to begin receiving documents.
Optional: If you wish to have these documents automatically imported into Slate, continue with Step 7 to Part 2 of this document.
Step 7 – Enable Student Manifest Delivery:
PART 2: Preparing for SCOIR document deliveries
SCOIR documents can be easily imported into Slate, but completing some basic configuration steps will ensure the best possible results. While the following can be leveraged as general guidance, Slate user documentation should be consulted for more detailed information regarding what is being accomplished in each step.
Step 1 – Add the SCOIR ID as new field:
Each SCOIR document delivery includes a customizable .CSV index file with basic information about the applicants associated with each document. This information is provided to assist with matching on the college/university side.
Step 2 – Create the Source Format:
Once you’ve created the SCOIR ID field, you can continue by creating the new Source Format to enable the import.
Step 3 - Import a SCOIR manifest & batch for mapping
Download and import a manifest .CSV and .ZIP document batch to continue with the format definitions. If you haven't received test files yet, you can request these from email@example.com.
Step 4 – Complete the Format Definitions:
4a. The file fields are mapped to their corresponding Slate destination. This mapping must be completed for both files. (Note: Any additional source fields can also be mapped to their corresponding Slate destinations based on your school's needs.)
4b. The SCOIR DocumentType (see appendix for possible values) are mapped to their corresponding Slate destination via the value mappings.
Step 5 – Documents imported successfully
The documents are saved to the materials tab of existing students. In the event the applicant does not exist in your system, a new applicant record is created and the materials are saved.
- Counselor recommendations
- Teacher recommendations
- Recommendations from additional parties
- A generic recommendation, appropriate to any college/university
- A recommendation written for a specific university
- Counselor recommendations that apply to any college/university (Document Type: CounselorRecommendation)
- Counselor recommendations that apply to a specific college/university (Document Type: CounselorSpecificRecommendatio
- Teacher recommendations that apply to any college/university (Document Type: GenericRecommendation)
- Teacher recommendations that apply to a specific college/university (Document Type: SpecificRecommendation)
- Additional recommendations that apply to any college/university (DocumentType: OtherRecommendation)
- Additional recommendations that apply to a specific college/university (Document Type: OtherSpecificRecommendation)
Supporting Document Types