Sapphire

Discover how you can create a Skyward integration access with School Passport.

In this article

Requirements

Setup Sapphire app on School Passport

Sync data with Sapphire SIS

School Passport supports Secure Data Sync with a wide range of the district's student information systems (SIS). One of them is SapphireK12 SIS. Sapphire is administrative software that should be a helpful tool. Sapphire Software is a leading software provider that offers a comprehensive enterprise-level solution, SapphireK12™, to school districts.

Requirements

• You must have administrator access to the SapphireK12 portal.

•  Service URL, Client ID, and Client Secret credentials in SapphireK12.

Setup Sapphire app on School Passport

To integrate Sapphire SIS with School Passport, add the Sapphire app from the gallery and configure it.

Add Sapphire app from the gallery

1. Sign in to your School Passport.
2. Go to Connect > Application Gallery.
3. Type "Sapphire" in the search box. 
4. Select Sapphire from results panel. 
5. Click Activate. Wait a few seconds while the app is added to your environment.
   

Configure Sapphire app

1. In the Delivery Config, enter your API credentials (Service URL, Client ID, and Client Secret).
   
2. (Optional) Click Advanced Settings:
   
   • SIS ID prefix: If multiple data sources of the same type are used, add a prefix to avoid merging entities with equal SIS IDs.
   • Bulk Upload Mode: Select to detect deleted records by comparing them with the previous upload.
   • Data will be uploaded from multiple data sources: Select if uploading data from multiple sources (e.g., SIS and Active Directory). Leave clear if it uses a single source (e.g., SIS only).
   • Compare records accordingly to the Domains of Uniqueness: Select to activate duplicate detection.
   • Preview of data upload: Select to manually approve every data sync. New data won’t be available until you accept the changes.
   • Sync hold threshold: Set a threshold for significant changes. Updated data won’t be exported until you approve these changes. 

3. (Optional) Click Test Connection to verify the connection with Sapphire SIS.

4. Accept the Terms of Use and/or Privacy Policy. Click Next.
5. In the Schools Mapping, select specific schools by dragging the slider or choose all by clicking the Auto Mapping button. See Schools Mapping. Click Next.
6. In the Attributes Mapping, set the attributes for data synchronization between Sapphire and School Passport. Click Next. Tip: You can finish the configuration of the Sapphire app in this step.
7. (Optional) In the Data Requirements, configure what actions should be taken if some data attributes are missed. Click Next.
8. (Optional) In the Filter Rules step, set up data filtering by different entity types. Click Next.
9. (Optional) In the Domains of Uniqueness, define parameters that are required to be unique to avoid duplicates in the system. See Domains of Uniqueness. Click Next.
10. (Optional) In the Master Fields, define rules to prevent data duplication when synchronizing data from your app and an SIS to School Passport. See Master Fields. Click Next.
11. (Optional) In the Schedule, set up frequency for data processing and updates. Click Next.
12. (Optional) In the Done, click Finish to complete the setup.
13. Wait a few seconds for the app configuration to apply, after which you will be redirected to the Sapphire application dashboard.

Sync data with Sapphire SIS

Once the Sapphire integration is set up, you can run sync with  SapphireK12 SIS at any time. 

We recommend running a sync if you have new or updated data in Sapphire for School Passport. Please note, that if a teacher or student is removed from the sync, their enrollments will also be deleted.

To run a sync with Sapphire SIS, go to the Sapphire app in School Passport and click Run Import.

If you have any questions about the Sapphire app configuration, please reach out to GG4L Customer Support.