Configure Connection
PowerSchool SIS guide
Install and configure the Tools4ever plugin, enter the connection credentials in NIM, and validate student data and intended email updates.
Before you beginDirect link to Before you begin
You need access to manage plugins in the PowerSchool Admin Console. The PowerSchool developer API documentation is protected by login.
NIM requires Hostname, Client ID, and Client Secret.
API connectivity is the recommended method. If a required field, such as PSGUID, is unavailable through your API or data exports, consult PowerSchool about supported access methods. Where authorized direct database access is available, the Oracle Database integration can be an alternative for retrieving that data.
Install the Tools4ever pluginDirect link to Install the Tools4ever plugin
- Download the Tools4ever PowerSchool plugin.
- Open the PowerSchool Admin Console and go to System Management > Server > Plugin Configuration.
- If an existing instance of the Tools4ever plugin is installed, remove it before installing the replacement.
- Select Install, choose the downloaded plugin, and select Install to complete installation. The plugin appears in Installed Plugins on the Plugin Management Dashboard.
- Enable the plugin.
Retrieve client credentialsDirect link to Retrieve client credentials
- Open the installed Tools4ever plugin and go to Data Provider Configuration.
- If Access Level for v1 APIs is shown, set it to Full Access, as required by the existing setup procedure.
- Set Maximum Page Size to
1000. - Retrieve the Client Key and Secret for NIM and store them securely. The Client Key is entered as Client ID in NIM.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a PowerSchool SIS system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | The PowerSchool SIS host for the intended environment, using the format expected by the Connection screen. |
| Client ID | The Client Key from the plugin's Data Provider Configuration. |
| Client Secret | The Secret associated with that Client Key. |
Test student-count accessDirect link to Test student-count access
-
Select Test Connection. NIM calls the following path to retrieve the student count:
GET /ws/v1/district/student/count -
If the test fails, check the Hostname, client credentials, plugin enablement, API access settings, and network access.
-
Collect the student and roster data required by your process, and validate identity matching, field mappings, and relationships before enabling downstream provisioning.
-
Test an intended email contact update with a safe student record and verify the resulting information in PowerSchool before enabling automated writes.
The connection test checks student-count access. Validate other collections and student email update permissions separately.