.svg)
Discover how you can create a Synergy integration access with School Passport.
In this article
School Passport supports Secure Data Sync with a wide range of the district's student information systems (SIS). One of them is Synergy SIS. Synergy is the foundation of the enterprise-level Synergy Education Platform (Synergy EP®), providing all the data and process management functionality you expect from a world-class SIS while extending beyond traditional SIS boundaries to deliver greater value. Synergy SIS empowers your district to do more, saving time and money while helping to improve efficiency and educational outcomes.
To configure data sync with Synergy, perform the following steps:
Get Synergy API credentials
To get your Synergy API credentials, refer to the Synergy Setup Guide up Third-Party Integration and where to find the API credentials you need.
Setup Synergy app on School Passport
To integrate Synergy SIS with School Passport, add the Synergy app from the gallery and configure it.
Add Synergy app from the gallery
- Sign in to your School Passport.
- Go to Connect > Application Gallery.
- Type "Synergy" in the search box.
- Select Synergy from results panel.
- Click Activate. Wait a few seconds while the app is added to your environment.
Configure Synergy app
- In the Delivery Config, enter your API credentials.
- (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.
-
(Optional) Click Test Connection to verify the connection with Synergy SIS.
- Accept the Terms of Use and/or Privacy Policy. Click Next.
- In the Schools Mapping, choose schools you wish to sync with School Passport. Select specific schools by dragging the slider or choose all by clicking the Auto Mapping button. See Schools Mapping. Click Next.
- In the Attributes Mapping, specify which Synergy attributes will sync with School Passport. Click Next. Tip: You can finish the configuration of the Synergy app in this step.
- (Optional) In the Data Requirements, configure what actions should be taken if some data attributes are missed. Click Next.
- (Optional) In the Filter Rules step, set up data filtering by different entity types. Click Next.
- (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.
- (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.
- (Optional) In the Schedule, set up how often you want to automatically sync data with Synergy SIS. Click Next.
- (Optional) In the Done, click Finish to complete the setup.
- Wait a few seconds for the app configuration to apply, after which you will be redirected to the Synergy application dashboard.
Sync data with Synergy SIS
Once the Synergy integration is set up, you can run sync with Synergy SIS at any time.
We recommend running a sync if you have new or updated data in Synergy 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 Synergy SIS, go to the Synergy app in School Passport and click Run Import.
If you have any questions about the Synergy app configuration, please reach out to GG4L Customer Support.