Import Apps
      Back to home
      1. Help Center
      2. Applications & Integrations
      3. Import Apps

      Veracross

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

      In this article

      Scenario description

      Add the GG4L as the Integration Partner in Veracross Portal

      (For Veracross API V3) Add scopes

      Setup Veracross app on School Passport

      Sync data with Veracross

      School Passport supports Secure Data Sync with a wide range of the district's student information systems (SIS). One of them is Veracross SIS. Veracross uses one single database and an integrated school management system to serve the district's entire campus and integrates seamlessly with a number of third-party solutions.

      Scenario description

      To configure data sync with Veracross, perform the following steps:

      1. Add the GG4L as the Integration Partner in Veracross Portal.
      2. (For Veracross API V3) Add scopes.
      3. Email support@gg4l.com to request the setup of the Veracross app. If you have Veracross API credentials (Client ID, Client Secret, School Route), you can set up Veracross app yourself.
      4. Once the app is set up, sync data with Veracross.

      Add the GG4L as the Integration Partner in Veracross Portal

      To integrate Veracross with School Passport, first, add Global Grid 4 Learning (GG4L) as an Integration Partner in your Veracross portal. Learn how to set up an Integration Partner.

      Note:

      The School Route, Client ID, and Client Secret will be shared automatically with School Passport once you submit your details to support@gg4l.com.

      (For Veracross API v3) Add scopes

      When making API requests, you can access different types of data, each controlled by specific scopes. To connect with Veracross API v3, add the following scopes:

      • students:list
      • courses:list
      • people.relationships:list
      • classes:list
      • academics.enrollments:list
      • staff_faculty:list
      • contact_info:list
      • households:read
      • summer.enrollments:list
      • academics.config.grading_periods:list
      • academics.classes.meeting_times:list

      Learn how to add scopes into Veracross

      Setup Veracross app on School Passport

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

      To add Veracross app from the gallery:

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

      To configure Veracross app:

      1. In the Delivery Config, enter your API credentials:

        • Username: Enter the Client ID copied from the Veracross Portal.
        • Password: Enter the Client Secret copied from the Veracross Portal.
        • School Abbreviation: Enter the School Route copied from the Veracross Portal.
        • API Version: Select Veracross API version. Note: For Veracross API v3, make sure to add the necessary scopes.
      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 the changes. 
      3. (Optional) Click Test Connection to verify the connection with Veracross SIS.
      4. Accept the Terms of Use and/or Privacy Policy. Click Next.
      5. In the Schools Mapping, choose the Veracross 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.
      6. In the Attributes Mapping, specify which Veracross attributes will sync with School Passport. Click Next. Tip: You can finish the configuration of the Veracross app in this step.
        attributes-mapping_finish-configuration
      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 Done, click Finish to complete the setup.
      12. Wait a few seconds for the app configuration to apply, after which you will be redirected to the Veracross application dashboard.

      Sync data with Veracross

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

      We recommend running a sync if you have new or updated data in Veracross 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 Veracross SIS, go to the Veracross app in School Passport and click Run Sync.

      If you have any questions about the Veracross app configuration, please email GG4L Customer Support.