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

      Skyward

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

      In this article

      Requirements

      Obtain Skyward API credentials

      Setup Skyward Qmlativ access

      Setup Skyward app on School Passport

      Sync data with Skyward

      See also

      School Passport supports Secure Data Sync with a wide range of the district's student information systems (SIS). One of them is Skyward SIS. Skyward is administrative software that should be a helpful tool. Skyward products include a K-12 student information system and a finance/human resources suite for schools and municipalities.

      To configure data sync with Skyward Qmativ, perform the following steps:

      1. Setup Skyward Qmlativ access
      2. Contact our Support Team to set up the Skyward app for you.
      3. Sync data with Skyward

      To configure data sync with other Skyward versions, perform the following steps:

      1. Obtain Skyward API credentials

      2. Setup Skyward app on School Passport

      3. Sync data with Skyward

      If you’re not sure which version you have, contact the Skyward Support Team for help.

      Requirements

      • You must have administrator access to the Skyward portal.

      • (Not for Skyward Qmativ) API (Service) URL, Key, and Secret credentials in Skyward.

      Obtain Skyward API credentials

      To get API credentials, first activate the GG4L connection in Skyward. How you do this depends on your hosting:

      • Secure Cloud (ISCorp) Hosted Districts: Create a support request to ISCorp to set up the Read-Only API through the Skyward Support Center or ISCorp.
      • Managed Services / TN State Hosted Districts: Create a support request to Skyward to set up the Read-Only API through the Skyward Support Center.
      • Self-Hosted Districts: Use the API Server Launch Kit to set up the Read-Only API. Optionally, districts can create an IT Services call to have Skyward set up the Read-Only API as a billable service by visiting the Support Center.

      After that, contact the GG4L Support Team to request your API credentials. We’ll generate them for you and send them to you.

      Setup Skyward Qmlativ access record

      For Skyward Qmlativ users only.

      Qmlativ API enables secure communication and interaction with Skyward through the Integration Access system.

      To use Qmlativ's APIs, you should set up an integration access record in Qmlativ. This record is then synchronized with Skyward's secure Partner Portal, which gives School Passport the necessary credentials (such as a username and password) to access the APIs and connect their software with Qmlativ.

      Every integration will have a record available within Qmlativ, which you can view by navigating to the Integration List. To create an integration access record:

      1. Go to Skyward Qmlativ.
      2. Click Menu > Administrative Access > API > Integration. The full list of available integrations opens.
      3. From the Integrations, find the integration to which you want to grant access, and select it. Alternatively, click the arrow icon before the Vendor Name column. Integration details will open.
      4. On the Integration Details, go to the Integration Accesses (1) tab, to display a list of all integration access records available for this integration. (note that no records will display when you first view this screen). Then, click the Add Integration Access (2) on the top right.

      5. On the Integration Access page:

        • Name: Enter the friendly name that helps you identify the integration access record, often named with the Integration's name and purpose without affecting access credentials. Tip: It is often useful to name this with the Integration’s name plus the year, such as "{Integration} 2023".
        • Description (optional): Provide additional details for the integration access if needed.

        • Integration: When you click on this box, options will appear. Select School Passport as the Vendor Name with OneRoster as the Product Name. The Integration will be automatically set to the selected Integration when starting from the Integration Details screen. 

        • Key: This can be whatever you want and is similar to a username. Please make sure that this key is different from your current sync’s API key so that we can verify that data is being pulled exclusively from the Integration Access system.

        • Authentication Type: Select Any.
        • Is Active: Select this checkbox.
        • Effective Date: Choose a date when you want this to be active.
        • Expiration Date: Choose a date when you no longer want this to be active.

      6. (Optional) If you want to restrict access (e.g., not share with all schools), go to the Configuration section, click OneRoster Configurations, and select an existing OneRoster configuration or create your own.

        skyward_add integration access

      7. Click Save on the top left to save your integration access record. After saving, the integration access record will created.
      8. Click Close to finish the configuration.
      9. Email our Support Team from your district email. Our technical team will verify that the integration access record has been created for your district and generate the required secret for this integration access record. 
      10. You will receive a confirmation reply email once Skyward Qmativ setup is complete.
      After setup, please contact GG4L Support Team to inform us so we can set up the Skyward app for you.

      Setup Skyward app on School Passport

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

      Add Skyward app from the gallery

      1. Sign in to your School Passport.
      2. Go to Connect > Application Gallery.
      3. Type "Skyward" in the search box. Note: There are two Skyward applications available: "Skyward" (for Native API) and "Skyward (OneRoster)" (for Qmlativ and OneRoster API).
      4. Select Skyward from results panel. 
      5. Click Activate. Wait a few seconds while the app is added to your environment.

      Configure Skyward app

      1. In the Sync Mode:

        • Select Import to bring data from Skyward to School Passport. With this mode, Skyward is used as a data source for School Passport.

        • (Recommended) Select 2-way Sync to provide changes in both directions. That applies to create, edit, and delete operations. 

      2. In the Delivery Config, enter your API credentials.
      3. (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 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. 
        • Sync emergency contacts: Select to begin syncing emergency contacts.
        • Import all active staff: Select to import all staff members enrolled in your data source, including teachers and administrators.
        • Import active teachers only: Select to import only active teachers from your Skyward SIS.

      4. (Optional) Click Test Connection to verify the connection with Skyward SIS.

      5. Accept the Terms of Use and/or Privacy Policy. Click Next.
      6. In the Schools Mapping, choose the 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.
      7. In the Attributes Mapping, specify which Skyward attributes will sync with School Passport. Click Next. Tip: You can finish the configuration of the Skyward app in this step.
      8. (Optional) In the Data Requirements, configure what actions should be taken if some data attributes are missed. Click Next.
      9. (Optional) In the Filter Rules step, set up data filtering by different entity types. Click Next.
      10. (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.
      11. (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.
      12. (Optional) In the Schedule, set up how often you want to automatically sync data with Skyward SIS. Click Next.
      13. (Optional) In the Done, click Finish to complete the setup.
      14. Wait a few seconds for the app configuration to apply, after which you will be redirected to the Skyward application dashboard.

        Sync data with Skyward

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

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

        skyward-run-sync

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

        See also

        Grade Sync with Skyward