Importing Customizations into SchoolEngage

Overview

To utilize custom PowerSchool fields within SchoolEngage, either for reading or writing data, it's essential to perform an export from PowerSchool first.

Steps for Exporting Extensions from PowerSchool

1. Access PowerSchool: Log in and switch to the District Office view.

2. Export Page: Go to YOUR_POWERSCHOOL_URL/admin/customization/CreatePackagePage.action, substituting YOUR_POWERSCHOOL_URL with your district's PowerSchool URL.

3. Plugin Description: Please fill in the required description fields. While these fields are essential for exporting, they are not utilized during the import process, so you can name them as you prefer. The filename is only for your reference and does not affect the import. These fields include but are not limited to Plugin version, publisher name, contact email, and file name.

4. Select Files: In "Select Individual Files":

   1. Expand the “user_schema_root” folder

   2. Choose all .xml files relevant to your newly added custom fields.

   3. Click Create Plugin Zip File to download the compressed file to your computer.

5. Preparing File for Upload to SchoolEngage:

   1. Take your newly downloaded .zip folder and extract the files onto your computer

   2. Take the user_schema_root and compress it into a .zip folder

6. Upload user_schema_root.zip file to SchoolEngage:

   1. In SchoolEngage, navigate to Settings > District

   2. Upload the new user_schema_root.zip file to the Upload Mapsource Extension section

Now your new extension field should be available as a form field mapping!

Importing Extensions with One-to-Many Tables

If you are importing a database extension that contains information on one-to-many tables, you will need to download and update your version of the SchoolEngage Data plugin. Once the extension has been installed with the instructions above, the plugin that you download from SchoolEngage will include permissions to write to those tables.

Please follow the instructions here to update your data plugin.