Skyward

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

In this article

Requirements

Before you begin

Skyward activation in School Passport

Skyward Qmlativ setup

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.

Requirements

  • You must have administrator access to the Skyward portal.

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

Before you begin

Configuring and connecting your Skyward environment to School Passport may vary depending on the Skyward version you use:

If you are unsure which Skyward version you use, please contact the Skyward Support Team for assistance.

Skyward activation in School Passport

  1. Log in to your School Passport, and navigate to the Connect.
  2. Navigate to the Application Gallery and select the Skyward application. Note: There are two Skyward applications available: "Skyward" (for Native API) and "Skyward (OneRoster)" (for Qmlativ and OneRoster API).
  3. Click Activate.
  4. On 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. 

  5. In the Delivery Config, enter the Service URL, OAuth Client ID, and OAuth Client Secret. Please note, that API integration setup with your Skyward SIS and obtaining API credentials for Skyward SIS varies based on hosting:
    • Secure Cloud (ISCorp) Hosted Districts: Create an IT Services call to have ISCorp set up the Read-Only API by visiting the Support Center or ISCorp.
    • Managed Services / TN State Hosted Districts: Create an IT Services call to have Skyward set up the Read-Only API install by visiting the 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.
  6. (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: The system will detect deleted records based on a comparison with the last upload.
    • Data will be uploaded from multiple data sources:  (for example, from the SIS and the Active Directory). Do not check the box if you plan to upload data from a single data source (e.g. only from the SIS).
    • Compare records accordingly to the Domains of Uniqueness.
    • Preview of data upload: (you will have to approve every data sync). Your new data will not be available until you accept the changes.
    • Sync hold threshold: If the system detects significant changes, the updated data will not be accessible until you approve the changes. This ensures that you have control over the data being synced and exported.
    • Sync emergency contacts: 
    • Import all active staff: The system will import all active staff members who are enrolled in your data source, including teachers, administrators, principals, consultants, and other staff members who provide educational services.
    • Import teaching staff only: All active teachers enrolled in your data source will be imported into the School Passport.
  7. Accept the Terms of Use.
  8. (Optional) Click Test Connection to test the connection with Skyward SIS.

  9. Click Next.
  10. In the Schools Mapping, select specific schools by dragging the slider or choose all by clicking the Auto Mapping button. See Schools Mapping.
  11. In the Attributes Mapping, you can configure under what attributes, data of a separate entity from Skyward will be synchronized to School Passport.
  12. Finish the setup process by clicking the Finish Configuration on the top right or click Next to continue setup.
  13. (Optional) Continue the setup as needed:
    • In the Data Requirements, configure what actions should be taken if some data attributes are missed. Click Next.
    • In the Filter Rules step, set up data filtering by different entity types. Click Next.
    • In the Domains of Uniqueness, define parameters that are required to be unique to avoid duplicates in the system. Click Next.
    • In the Master Fields, define rules to prevent data duplication when synchronizing data from your app and an SIS to School Passport.
    • In the Schedule, set up frequency for data processing and updates.
    • In the Done, click Finish to complete the setup.
  14. On the Skyward dashboard, click Run Sync.
    skyward-run-sync

Skyward Qmlativ setup

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.