Skip to main content

Installing OneRoster CSV SIS Integration

Installing OneRoster CSV SIS Integration

Installing OneRoster CSV SIS integrations enables administrators to seamlessly connect with Incident IQ by automating the majority of the data upload process. This feature allows administrators to easily manage sync and mapping options for users, groups, and locations across the two programs in a single, convenient location.

Prerequisites

Creating OneRoster Format CSV Files

Incident IQ utilizes SFTP to synchronize data using the OneRoster protocol. To prepare your data, create six CSV files following these naming conventions:

  1. orgs.csv

  2. users.csv

  3. courses.csv

  4. classes.csv

  5. enrollments.csv

  6. academicSessions.csv

Please refer to the IMS OneRoster links below for guides on how to format the data in each file:

IMS OneRoster: CSV Tables (June 3rd, 2015)

IMS OneRoster: CSV Tables (December 31st, 2020)

Once created, compress the files into a single archive titled OneRoster.zip.

Note: Contact Incident IQ support for assistance with CSV file issues.


Installing the App

All settings configured here remain editable post-installation.

  1. Navigate to Incident IQ Apps > Browse in the left-hand navigation.

  2. Choose the OneRoster CSV SIS integration that your district uses, and then click Install. If your SIS is not listed, please contact Incident IQ for more information.

  3. Review the overview of the integration's components, then click Continue.

SFTP Integration

  1. Enter your SFTP server details:

    • URL

    • Port

    • Username

    • Password

    • Path

    • Alternative: If you don’t have access to an SFTP server, click Use iiQ Hosted FTP Site to auto-generate credentials.

  2. Validation: Click Validate & Save.

Default Location Mapping

  • Select a Default Location for imported users.
    This location applies to any account that does not match your custom mappings set up after installation.

Once installed in Incident IQ, click Manage App Settings to configure settings and run your first data sync.


Scheduling Nightly SFTP Server Data Syncs

To automate uploads, create a task in the Windows Task Scheduler. You can find this tool by searching for ‘Administrative Tools’ and selecting ‘Task Scheduler’.

  1. Create Task: Click Action > Create Basic Task…

  2. Name Task: Follow the Create Basic Task Wizard to name your task. Click Next.

  3. Set Trigger: Select Daily (overnight) to ensure data accuracy. Configure the task to run regardless of whether the user is logged in. Click Next.

  4. Define Action: Select Start a Program. Click Next.

  5. Configure Program:

    1. Locate the .exe file of your FTP program.

    2. Enter the required command-line parameters specific to your software documentation. Click Next.

  6. Finalize & Properties:

    1. Check the ‘Open the Properties dialog for this task when I click Finish’ box.

    2. Click Finish.

  7. Adjust Security: In the Properties window, ensure the following are checked:

    1. Run whether user is logged on or not

    2. Run with the highest privileges

    3. Click OK.

Related Articles
Did this answer your question?