Didn't find what you're looking for? Contact Support











The Scholantis SIS Data Sync for PowerSchool functionality is currently in beta. The guide below is pre-release information and subject to change.

Scholantis SIS Data Sync allows teachers and students to easily work together in a Scholantis Portal using information already stored in your Student Information System (SIS). 

This following guide explains the steps required to sync your PowerSchool SIS with your Scholantis Portal. This approach avoids the need to manually create and import SIS data.

 

Install the REST API Plugin for PowerSchool

Before Scholantis SIS Data Sync can access data from your PowerSchool server, you have to install an application plugin on the PowerSchool server and obtain OAuth credentials by following these steps.

  1. Save the following plugin configuration file plugin.xml (right click to download) to your local computer. Or manually create an XML file called plugin.xml using the XML below (remove any blank lines).

    plugin.xml
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin xmlns="http://plugin.powerschool.pearson.com" 
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            xsi:schemaLocation="http://plugin.powerschool.pearson.com plugin.xsd"
            name="Scholantis SIS Data Sync" 
            version="1.0.0" 
            description="Plugin for PowerSchool REST API for Scholantis SDS"> 
        <oauth></oauth> 
        <publisher name="Scholantis"> 
            <contact email="support@scholantis.com" /> 
        </publisher>  
    </plugin> 
  2. Sign in to your PowerSchool admin portal using your System Administrator credentials.

  3. On the start page, choose System from the main menu, then go to System Settings > Plugin Management Configuration > Install.

  4. Enter or select the plugin installation file you just created (plugin.xml), and choose Install.

    The plugin will appear in the Installed Plugins section on the Plugin Management Dashboard page. Make sure the plugin is enabled. If not, enable it on the Plugin Management Dashboard page.

  5. Choose Data Configuration to view the OAuth credentials that were generated for the plugin:

  6. Record the values for the Client ID and Client Secret so you can enter these credentials when you create your SIS Information Sync profile.

Ensure the REST API is Accessible to Scholantis

Scholantis SIS Data Sync must be able to reach your PowerSchool portal. Ensure port 443 is open from PowerSchool server to your Scholantis Application server. Additional Web Front Ends do not require access.

To validate the PowerSchool API endpoints are available open the PowerSchool portal from the Scholantis servers. Simply open a browser and attempt to navigate to: https://myschool.powerschool.com/public/.

Synchronize your Scholantis Portal with PowerSchool

After you've installed the plugin and set up access, you will need to provide the following information to the Scholantis support team:

PowerSchool Server Information

Information provided during the PowerSchool REST API plugin setup:

Web Access URL for PowerSchool:

e.g. https://myschool.powerschool.com/public/
OAuth Client ID: 
OAuth Client Secret: 

Student AD to SIS Mapping

SIS Data Sync requires a unique ID which is shared in both your SIS and Active Directory (AD):

Shared Student ID field (available in SIS and AD):e.g. Student ID #
Stored in SIS Field: 
Stored in AD Field:e.g. employeeNumber

Note: SIS Data Sync requires at least one field to connect a student in AD to the same student in SIS. If you don't have an exact mapping, or the student ID is derived please note the details and we will investigate whether a custom mapping is possible.

Teacher AD to SIS Mapping

Shared Student ID field (available in SIS and AD):e.g. Teacher ID #
Stored in SIS Field: 
Stored in AD Field:e.g. employeeNumber
Note: SIS Data Sync requires at least one field to connect a teacher in AD to the same teacher in SIS. If you don't have an exact mapping, or the teacher ID is derived please note the details and we will investigate whether a custom mapping is possible.

What Happens When Data Syncs?

When using the Scholantis SIS Data Sync with PowerSchool, all changes will be synced automatically on a nightly basis. All you need to do is update the data in your SIS and validate that changes are synced during the next sync. 

We currently sync the following data:

  • Schools
  • Students
  • Teachers
  • Courses & Sections
  • Course & section teacher and student associations
  • Guardians

Sync Duration

SIS Data Sync validates each user's Active Directory properties when it runs nightly. If the mapped Active Directory attributes (e.g. employeeNumber) are not indexed in Active Directory the Sync job can run extremely slowly, depending on the numbers of objects and the performance of your Active Directory servers. Learn which Active Directory attributes are indexed by default: MSDN - Indexed Attributes.

We recommend the attributes used for mapping are indexed in Active Directory to significantly speed up the SIS Data Sync job and reduce load on your Active Directory servers. This can reduce the SIS Data Sync duration from hours to minutes and will be required in large environments to ensure SIS Data Sync Completes within a reasonable time frame. Further reading on TechNet - How to Index an Attribute in Active Directory and TechNet Blogs - Indexing in Active Directory.