To synchronize your Student Information System (SIS) with Visitor Aware using OneRoster, you must first obtain connection credentials from your Student Information System. For more information, see the OneRoster Student Information System Integration article. You will need the following:

• OneRoster Endpoint URL
• Client ID/Application ID
• Client Secret / Access Token
• Access Token URL (if applicable)
• Scope (if applicable)

Required Endpoints for OneRoster

The following endpoints are available for OneRoster.

* indicates that these endpoints are required for the Family Reunification and Rostering features

Enter your OneRoster Connection Details in Visitor Aware

Administrators with access to the administration portal can navigate to the Manage OneRoster Connection page. From the left navigation menu, click System Settings | Integration Management | OneRoster Connection.

1. Complete the following fields and settings.

• OneRoster Endpoint*: Enter your OneRoster endpoint URL to access your OneRoster API for your SIS.
  Note: The URL must end in:
   /ims/oneroster/v1p1 or /ims/oneroster/rostering/v1p2
• Client/Application ID*: Add the Client ID that connects to your SIS OneRoster API
• Client Secret / Access Token*: Add the client secret that connects to your SIS OneRoster API
• Access Token URL: If your SIS OneRoster API uses OAuth2 authentication, enter the Access Token URL endpoint
• Scope: If your SIS OneRoster API uses OAuth2 authentication, enter the required Scope
• OneRoster SIS Provider: Select your provider from the dropdown menu
• Sync Only Active Records?:
• Select Yes to filter all records by status="active" and for locations active in Visitor Aware
• Select No to include all records
• Connection Active?:
• Select Yes for the system to automatically process files from the API. When Yes is selected, your OneRoster data automatically synchronizes daily at 3 a.m. UTC
• Select No to stop the system from automatically processing files
• Only show primary enrollment data for teachers?:
• Select Yes to show students, class lists, and family reunification rosters only for enrollments where the teacher is marked as primary
• Select No to disable this feature
• Generate Employee Profiles?:
• Select Yes to retrieve and process the userIds field for all identifiers of type FacultyID. These visitor profiles receive an employee ID for employee check-in
• Select No to prevent the system from retrieving and processing these userId fields
• Student Identifier Column: Select the column in your OneRoster data that contains the student identifier
• Notification Emails: (Optional) Enter a comma-separated list of emails to receive notifications when OneRoster imports finish. If you enter email addresses, you will receive notifications when the data sync completes and corresponding Visitor Aware records update to match your SIS.
• Last Synced: This field shows the timestamp of the last data sync. By default, the system only imports records modified since the last sync
  Note: To perform a full import of all data, click the Reset Last Sync button to reset this timestamp.
• Import users that have the following roles: Select all user roles that you want to import

2. After you complete the fields, click the Test Connection button to verify your credentials. When the connection succeeds, click the Save button.

OneRoster Debugging Tool

Use this tool to search the OneRoster API for a specific endpoint and sourcedId. You can also search for users by role, given name, and family name. The response data comes directly from OneRoster endpoints and is formatted per the OneRoster specification.

Reviewing your OneRoster Data

To confirm the accuracy of your SIS data, complete the fields in the OneRoster Debugging Tool and click the Search button. The system displays the connection status and the details found using the specified endpoints.

Mapping Your Data to the Correct Locations

Ensure you include your org SourcedID, or location identifier from your SIS for each location in your Visitor Aware account. Visitor Aware will not sync over data until this step is complete. 

1. Navigate to the Locations page: https://app.visitor-aware.com/locations
2. Edit each location listed.
3. In the School ID field, enter the location identifier from your SIS. This process maps the data to the correct locations as it enters Visitor Aware.

Note: If your OneRoster Connection was configured correctly, all available locations appear in a dropdown menu in this field.

Note: Only orgs of type “school” can be associated with a Visitor Aware location. For example, if an org in your SIS is assigned to another type, such as “district” or “department,” data will not be synced with Visitor Aware.

How Visitor Aware Ingests OneRoster Data

Visitor Aware follows the OneRoster specification. However, Visitor Aware’s ingestion of OneRoster data might differ from your expectations.

Visitor Aware evaluates the enabledUser property of a user's record.

• If the enabledUser property is "true," the system updates the user if their data has changed
• If the enabledUser property is "false," the system deactivates the user in Visitor Aware, and they will not be able to log in. The user is not deleted.