Integrating with the Infinite Campus Student Information System

Table of Contents

Overview

Integrating with Infinite Campus

• Infinite Campus OneRoster File Specification Requirements

• Setting Up The Integration

  • Setting Up the Files

  • Creating a Zip Tool Extract

• Helpful Resources

Overview

This article contains guidance on setting up a SIS integration using Infinite Campus's Data Extract Utility and Zip Tool Extract.

Integrating with Infinite Campus

Infinite Campus OneRoster File Specification Requirements

• All of the CSV header names and filenames are case-sensitive.
• The CSV files have pre-defined filenames and each must have the .csv extension.
• The ZIP file can have any filename, but it must have the .zip extension.
• The CSV files must be in the root directory of the zip (no sub-folders).
• The CSV files must include a header row.
• The CSV files must include double quotes around values which contain a comma.
• The CSV files must have a UTF-8 character encoding.

Setting Up The Integration

Note: The Data Extract Utility must be installed and the user must have the proper tool rights to proceed with the following steps. The Data Extract Utility page also contains more information and definitions concerning the fields used to set up the OneRoster CSV Extract Configuration. For any additional information on using the Data Extract Utility, please contact Infinite Campus Support directly.

Setting Up the Files

PATH: System Administration > Data Utilities > Data Extract Utility > Data Extract Utility Set Up

• In the Data Extract Utility, the first step is to create an Extract Instance for each file that will be used in the OneRoster Exports. If you have already set up these instances using the BULK file type, for all of the files listed in the Data Extract Utility OneRoster Filenames and Procedures table, feel free to skip ahead to Creating a Zip Tool Extract.
• The following procedure details steps on how to create bulk export OneRoster files for each of the 8 CSV files needed by the DESSA System to successfully integrate using a OneRoster export. Please refer to the Data Extract Utility Field Definition and Explanations table below for details on what each field is and what should be entered.
  • Enter the Extract Instance Name
  • Enter the File Name. See the Data Extract Utility OneRoster Filenames and Procedures table below for the supported file names. Note that file names are case sensitive.
  • Select SFTP in the Delivery Mode field. This allows the user to enter the file name and file extension.
  • Enter "csv" in the File Extension field.
  • Select "CSV" in the Column Delimiter dropdown.
  • Select "UTF-8" in the Character Set dropdown.
  • Mark the Include Header Row? checkbox.
  • Mark the Include Double Quotes? checkbox.
  • Select SQL.
  • From the Data Extract Utility OneRoster Filenames and Procedures table below, select the appropriate text from the SQL/Prism Bulk column for the corresponding file name, and paste it into the SQL/Prism field. 

Data Extract Utility Field Definition and Explanations
Field Name	Explanation/Required Input
Extract Instance Name	This is the name of your Extract Instance and will be used in later steps to select the files you will need to pull and send to DESSA. It is recommended you name it after the file name and file type for ease of use in later steps. Example: "OR_bulk_academicSessions" for the academic sessions file name instance
File Name	This is the name of your actual file. If you were setting up the extract for the Academic Sessions file for example, you would name this academicSessions
File Extention	Enter csv
Delivery Mode	Select SFTP
Append Date to Filename?	Leave this blank
Column Delimiter	Select CSV
Character Set	Select UTF-8
Include Header Row?	Check this Box
Include Double Quotes?	Check this Box
SQL/Prism/AdHoc/Use Data Warehouse Connection	Select SQL

Data Extract Utility OneRoster Filenames and Procedures
Filename	SQL/Prism Bulk
manifest.csv	EXEC extract_V1P1OneRosterManifest @type = 'bulk'
academicSessions.csv	EXEC extract_V1P1OneRosterAcademicSessions @type = 'bulk'
classes.csv	EXEC extract_V1P1OneRosterClasses @type = 'bulk'
courses.csv	EXEC extract_V1P1OneRosterCourses @type = 'bulk'
demographics.csv	EXEC extract_V1P1OneRosterDemographics @type = 'bulk'
enrollments.csv	EXEC extract_V1P1OneRosterEnrollments @type = 'bulk'
orgs.csv	EXEC extract_V1P1OneRosterOrgs @type = 'bulk'
users.csv	EXEC extract_V1P1OneRosterUsers @type = 'bulk'

• Repeat the above process until you have an extract instance set up for each of the filenames in the above table.

Image 1

 

Creating a Zip Tool Extract

PATH: System Administration > Data Utilities > Data Extract Utilities > Zip Tool

After successfully setting up the OneRoster CSV Extracts in the Data Extract Utility, the Zip Tool can be used to export the files to a third-party system such as the DESSA System. Unlike the Utility Set Up tool, the Zip Tool allows users to upload more than one file to export to a third-party system. It is for this reason that we recommend using the Zip Tool to send your files for the SIS Integration.

• The following procedure details steps on how to use the Zip Tool to export bulk files to the DESSA System. Please refer to the Zip Tool Field Definition and Explanations table below for details on what each field is and what should be entered.
  • Select New.
  • In the Detail Information editor enter the Extract Instance Name.
  • Fill the remaining fields using the information found in the Zip Tool Field Definition and Explanations table below. Also, see image 2 below for an example of a bulk-processing configuration.
  • In the Select instances to include section, mark the names of the 8 Extract Instances previously created using the Data Extract Utility. Be sure to include the following files:
    • manifest.csv
    • academicSessions.csv
    • classes.csv
    • courses.csv
    • demographics.csv
    • enrollments.csv
    • orgs.csv
    • users.csv
  • Click Save.
  • Click the Test Connection button to check the connection to the entered server by attempting to write a 1-byte file to the location setup.
    • If it is successful, a pop-up displays indicating the connection is good.
    • If it is not successful, the reason the connection failed is displayed. 
  • If the connection is successful, click the Run Extract button to send files immediately to the DESSA Server to be configured for the SIS Integration.
  • Lastly, use the Data Extract Schedule section to automate the sending of rosters to keep all information in the DESSA System up to date.
    • The DESSA Data Operations Team recommends sending files daily for the best results. 
    • The Imports to the DESSA System start each day at 2 AM EST. We recommend setting the schedule to send files no later than 1:30 AM EST each day. 

Zip Tool Field Definition and Explanations
Field Name	Explanation/Required Input
Extract Instance Name	This is the name of your Extract Instance and will be the name displayed after saving Use a name to help you know this extract is for the DESSA System Example: DESSA_OneRoster_Export
File Name	This is the name of your actual OneRoster file The name can be anything but has to stay the same every day. TheDESSA Data Operations Team recommends using the name "OneRoster" for consistency
File Extention	Enter zip
Delivery Mode	Select SFTP
Append Date to Filename?	Leave this blank
Username	Username to connect to the DESSA server This will be sent to you by the DESSA Data Operations Team via a 1Password Secure Link
Password	Password to connect to the DESSA server This will be sent to you by the DESSA Data Operations Team via a 1Password Secure Link
Domain	Leave this blank
Server	DESSA Server name or IP address This will be sent to you by the DESSA Data Operations Team via a 1Password Secure Link
Port	Port number  DESSA uses Port 22
Path	Leave this blank, you will upload it directly to the root folder

Image 2

 

Helpful Resources

For in-depth information on how to configure the Data Extract Utility and the Zip Tool Extract in Infinite Campus, please take a look at this article from the Infinite Campus support site.

For any additional information on using the Data Extract Utility, please contact Infinite Campus Support directly.

For questions about what dat the DESSA System uses to upload your rosters, please refer to the following article: What data do I need to send?

For additional information regarding the steps to set up a SIS Integration, please refer to the following article: How do I setup a SIS Integration?