API Integration: Install Munetrix PowerSchool Plugin

Provides step-by-step guidance to install the Munetrix PowerSchool plugin to share student, teacher and roster data with Munetrix.

Overview

The Munetrix Plugin for PowerSchool, once installed, will allow Munetrix to access PowerSchool data on demand.  This allows Munetrix to provide data to our customers that is updated daily without the hassle of setting up SFTP drops or manual exports.  The Plugin also pulls all data required for all Munetrix products.

The plug-in consists of a zip file storing one primary XML file and a supporting folder of additional XML files.  The primary XML file defines all of our data access requests as well as defining the plug-in name and version amongst other similar details.  Additional XML files are stored in a folder named queries_root.  Each XML file in this folder defines the SQL PowerQuery that will be executed when we access PowerSchool data.   

The zip file containing the plug-in will be provided prior to installation.  The file does not need to be unzipped or otherwise altered in any way prior to installation. 

 

Installing the Zip File

Once the zip file has been received follow the below steps to install it on the PowerSchool server: 

Note:  There may be some slight differences between your version of PowerSchool and the images shown in the provided examples. 

  • From the PowerSchool homepage select System Management > Server > Plugin Configuration 

 

  • From the Plugin Configuration page select Install. 

A screenshot of a computer

Description automatically generated

  • Click on Choose File and then navigate to and select the provided installation zip file.  Once this is done click on Install. 

A screenshot of a computer

Description automatically generated

  • You should be returned to the Plugin Configuration page and a message should display indicating successful installation. 

A screenshot of a computer

Description automatically generated

  • A notification from PowerSchool will appear.  It will outline our Data Access Requests and the PowerQueries we will use to access this data.  There is also a notification to the district regarding their responsibilities.  Click on Enable to finish configuring the plug-in.  This process may take a few minutes to complete. 

A screenshot of a computer

Description automatically generated

  • A message should be displayed indicating the plug-in was enabled successfully. 

A screenshot of a computer

Description automatically generated

 

Retrieving Credentials

Munetrix requires three pieces of information from the district to access data via the newly installed plugin.   

  • The PowerSchool URL for the customer 
  • Client ID
  • Secret 

 

The PowerSchool URL for the customer can be seen in the web address bar of your browser when logged into PowerSchool.  It usually takes a form like - https://<district name>.powerschool.com 

  • From the list of Installed Plugins in the Plugin Configuration page select the newly installed plugin.  This will open the Plugin Setup page. 
  • From the Plugin Setup page select Data Provider Configuration

A screenshot of a computer

Description automatically generated

  • The Client ID and Secret will be displayed on the Data Provider Configuration page.  Munetrix requires these to access customer data via the plugin.