Installing the Aequitas SIS Integration

Guide Overview

The Aequitas Integration allows administrators to seamlessly integrate Aequitas SIS with Incident IQ by automating most aspects of your data upload. This provides administrators the ability to easily manage the sync and mapping options for users, groups, and locations between the two programs in one convenient location. The following guide provides step-by-step instructions on how to integrate the Aequitas with Incident IQ.

 

Guide Index

You can use the following links below to quickly navigate to a specific section in this document. To quickly return to this index, simply use the Return to Index link located at the end of any section.

  1. Creating OneRoster Format CSV Files
  2. Installing the Incident IQ Integration
  3. Setting up the Nightly FTP Uploads

 

Creating OneRoster Format CSV Files

Incident IQ uses an SFTP setup to sync information from Aequitas from CSV files that utilize the OneRoster protocol. You will need to set up CSV files using the following naming conventions:

  1. orgs.csv
  2. users.csv
  3. courses.csv
  4. classes.csv
  5. enrollments.csv
  6. academicSessions.csv

You can use the following IMS OneRoster links for guides on how to format the data for each file:

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

          IMS OneRoster: CSV Tables (April 17th, 2017)

If you have any questions, concerns, or have any issues with your CSV files you will need to contact Incident IQ customer support for additional details.

[Return to Index]

 

Installing the Incident IQ Integration

Please note that all information entered during installation can be edited at any time after setup. To begin, start by selecting Incident IQ Apps > Browse on the left navigation bar.

Aequitas_CSV_Install_000.png

Click on the Aequitas App and then select Install near the top of the page to begin.

Aequitas_CSV_Install_001.png

Step one of the installation process simply provides an overview of what the Aequitas Integration will install into Incident IQ. Select Continue once you are ready to proceed to step two.

Aequitas_CSV_Install_002.png

For the first phase of step two, you will need to enter your FTP server information. This includes the following:

  • URL
  • Port
  • Username
  • Password
  • Path

Aequitas_CSV_Install_003.png

If you do not have access to an SFTP server, you can click on Use IIQ Hosted FTP Site to generate credentials for an IIQ hosted SFTP server instead. This will also automatically fill in the server credentials for you in the process.

Aequitas_CSV_Install_004.png

Once you have completed this section, select Validate & Save to proceed.

Aequitas_CSV_Install_005.png

The next phase of step two will ask you to select a default location. This will be used as the location a user account will be assigned if they do not match any of your custom mappings that are set up after the integration has been installed. Once you have completed this section, select Continue to proceed.

Aequitas_CSV_Install_006.png

Before proceeding, you may make changes to any section by clicking on any of the settings options. Please note that you can edit any of these options once the app has been installed as well. When you are ready to proceed, select Continue.

Aequitas_CSV_Install_007.png

At this time, you will be asked to review all of the changes that are about to be made to your Incident IQ site. Before moving on, please keep in mind that after the installation process begins it cannot be stopped. Once you have completed your review, select Install App to begin the integration process.

Aequitas_CSV_Install_008.png

Please note that it may take a few moments for the integration to complete the installation. Once this process has been completed, you can import Aequitas user data into Incident IQ.

Aequitas_CSV_Install_009.png

[Return to Index]

 

Setting up Nightly Data Syncs with the FTP Server

To schedule the upload to occur automatically each night, you will need to create a task in Windows Task Manager to send data through your selected file share program. You can do so by searching for Administrative Tools and selecting Task Scheduler. This will open the Task Scheduler window.

Task_Scheduler_1.png

In the Task Scheduler window, start by clicking on Action > Create Basic Task...

Task_Scheduler_2.png

This will open the Create Basic Task Wizard. At the very least, you will need to provide a name for the new task. You can also add a task if desired. Once complete, click Next.

Task_Scheduler_3.png

In the next step, you will be asked to select when this task should Trigger. We recommend running it daily (overnight) for the most accurate user data. Please ensure you set the task to run regardless of whether a user is logged in or not on the server. Once complete, click Next.

Task_Scheduler_4.png

For the next step, you will need to specify what action the task will take when running. Select Start a Program and then click on Next.

Task_Scheduler_5.png

When specifying the action to perform, locate the .exe file of your FTP program. the Program/script file browser. You will need to provide the correct command-line parameters based on the FTP server software that you are using. If you are unsure of what scripting commands should be entered you will need to refer to your software's help documentation for further instructions. Once complete, click Next.

Task_Scheduler_6.png

In the final step, you may review all of the settings of your task. Once you have completed your review, check Open the Properties dialog for this task when I click Finish option and then click the Finish.

Task_Scheduler_7.png

In the sync properties window, you will need to check Run whether user is logged on or not as well as Run with highest privileges. Click OK to complete the sync setup.

Task_Scheduler_8.png

[Return to Index]

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.