PowerSchool - Automated Rostering Plugin Guide

Before Getting Started With the Plugin Installation

1. Please make sure that you have the plugin zip file downloaded to your computer. If you received this file as an email attachment, please be sure to download it to a location on your computer.
2. Please make sure you have PowerSchool version 20.11 or higher running. To check which version of PowerSchool you are running, go to your login screen.
3. Special Note - You are most likely on the latest version of PowerSchool with the 2024 updated user interface. If the screenshots below don’t look like your version of PowerSchool, skip HERE for plugin installation instructions for older versions of PowerSchool.
   
   

Steps to Install Automated Rostering Plugin for PowerSchool

1.  Login to your PowerSchool account as an administrator. In the left hand
   navigation, under the “System Management”, click the “Server” link, then
   click the “Plugin Configuration” link. 
   
   
   
2. From the “Plugin Management Dashboard”, click the “Install” button.
   
   
   
3. From the “Plugin Install” page, click on the “Choose File” button and select the
   zip plugin file you received from your computer’s file system.
   
   
   
4. One the file path to the plugin is visible in the “choose file” field, Click the
   “Install” button, and the plugin will automatically install. If the installation is
   successful, you will be taken to the “Plugin Management Dashboard” with a
   green success message displayed.
   
   
   
   
5. At this point, the plugin is installed, but must still be enabled. To enable the
   plugin, select the check box on the same line as the plugin: 
   
   
   
   
6.  After selecting the checkbox as instructed in step 6, a window will slide in from
   the right of your screen (example images below). Review the “Data Access
   Requests” at the top and click the “Enable” button at the bottom of this
   window.
   
   
   
   *There is a list of tables and fields that the plugin is requesting access to
   
   
   The plugin is now installed and you will see the check box indicating it is also
   now enabled. From the Plugin Management Dashboard, click on the name of
   the plugin to go to the “Summary Page” of the plugin. 
   
   
   
   
7. On the “Plugin Summary Page”, click the “Data Provider Configuration” link. 
   
   
   
   
8. After clicking on the “Data Provider Configuration” link from the previous step,
   you will see The “OAuth Credentials” that includes your ClientID and Client
   Secret.
   
   *Note - If you are on a later version of PowerSchool, you may see the
   “Additional Configuration” section. In this section, please make sure the
   “Access Level for v1 APIs” is set to “Read Access” and the “Maximum Page
   Size” is set to 100, then click “Submit”. 
   
   
   
   
9. Next, you will copy the “Client ID” and “Client Secret” into our configuration.

In the secure webform that loaded when you clicked on the link from our
email, under the heading “PowerSchool Connection”, you can now enter the
OAuth Client ID, OAuth Client Secret, and API Endpoint*

*The API endpoint is typically the web address where you login to
PowerSchool (Example https://yourdistrict.powerschool.com, or
https://powerschool.yourdistrict.com )

Steps to Install Automated Rostering Plugin for PowerSchool
(Older PowerSchool Versions)

1.  Login to your PowerSchool account as an administrator. In the left hand
   navigation, under the “Setup” section, click the “System” link.
   
   
   
   
2.  On the “System” page, scroll down to the “Server” section, and select the
   “System Settings” link. 
   
   
3. On the “System Settings page”, select the “Plugin Management
   Configuration” link: 
   
   
   
   
4.  From the “Plugin Management Dashboard”, click the “Install” button.
   
   
   
   
5. From the “Plugin Install” page, click on the “Choose File” button and select the
   zip plugin file you received from your computer’s file system.
   
   
   
   
6. One the file path to the plugin is visible in the “choose file” field, Click the
   “Install” button, and the plugin will automatically install. If the installation is
   successful, you will be taken to the “Plugin Management Dashboard” with a
   green success message displayed.
   
   
   
   
7. At this point, the plugin is installed, but must still be enabled. To enable the
   plugin, select the check box on the same line as the plugin:
   
   
   
   
8. After selecting the checkbox as instructed in step 6, a window will slide in from
   the right of your screen (example images below). Review the “Data Access
   Requests” at the top and click the “Enable” button at the bottom of this
   window.
   
   
   
   *There is a list of tables and fields that the plugin is requesting access to 
   
   
9. The plugin is now installed and you will see the check box indicating it is also
   now enabled. From the Plugin Management Dashboard, Click on the name of
   the plugin to go to the “Summary Page” of the plugin.
   
   
10. On the “Plugin Summary Page”, click the “Data Provider Configuration” link.
    
    
    
    
11. After clicking on the “Data Provider Configuration” link from the previous step,
    you will see the “OAuth Credentials” that includes your ClientID and Client
    Secret. 
    
    
12. In the secure webform that loaded when you clicked on the link from our
    email, under the heading “PowerSchool Connection”, you can now enter the
    OAuth Client ID, OAuth Client Secret, and API Endpoint*
    
    *The API endpoint is typically the web address where you login to
    PowerSchool (Example https://yourdistrict.powerschool.com, or
    https://powerschool.yourdistrict.com )