See a simple guide on how to activate and configure a 2-Way Sync application.
In this article
Important:
This article provides an overview of the process. For detailed instructions on setting up a specific app, please refer to the Applications & Integrations for step-by-step guidance.
A 2-way Sync application allows data to be both pushed from School Passport into the application you choose to integrate with, and the data is also being pulled from the application back into School Passport. This ensures that your data is consistent across both platforms and stays up-to-date.
Select the schools and their data (attributes) that you want to export, define time to determine until what date export occurs, and enable the Privacy Shield to protect personal data.
Requirements
- Primary District Admin permissions are required.
- You might require the following credentials for data source/SIS connection:
- Client ID
- Client Secret
- Service URL
- Authentification URL
Step 1: Activate a 2-Way Sync application
- Sign in to School Passport.
- Go to the Connect > Application Gallery.
- Find and select an application you want to use for your organization.
- Click Activate.
- In the Sync Mode, click 2-way Sync.
- In the Delivery Config, enter the required connection parameters to your data source/SIS. For Google Workspace and Google IDM you should log in to your Google account instead. Note: Connection parameters may vary in different applications.
- In the Schools Mapping, map the schools that were imported from the provided server.
- Click Finish Configuration on the top right to skip the remaining configuration steps and complete the setup process, or continue with the configuration process manually.
- Click Run Import. Alternatively, click Run Preview to review the data before importing it into School Passport, and then click Run Import.
Step 2: Check data usage by the application
After the data processing is finished, you can easily check how the data was consumed with the application.
- Under the Home page, choose a 2-Way Sync application.
- On the application page, go to the History tab.
- Click Show Details to view a sync summary.