Skip to main content

Configure Connection

Skyward Qmlativ guide

Create the Skyward integration access record, securely collect its OAuth details, and add them to NIM.

Data access is controlled by Skyward

Skyward approval determines which tables and fields are available. Review the Integration Access XML for the access requested by the connector.

Before you begin​

  • Confirm that your Skyward Qmlativ tenant has approved the required API access.
  • Have access to the Administrative Access portal and its API module.
  • Plan a secure place to store the generated client secret. Skyward displays it only as part of the generation workflow.

Create integration access in Skyward​

  1. In Qmlativ, open the main menu.

  2. Select Administrative Access, then open the API module.

  3. Select Integration.

  4. Search the integration list for Tools4ever Identity Management, then select its arrow to open the integration.

  5. Select Add Integration Access.

  6. Complete the integration access record:

    FieldValue
    NameTools4ever NIM
    KeyTools4everNIM
    Authentication TypeOAuth 2.0
    Is ActiveSelected
    Effective DateToday’s date
    Custom API EntitiesSelect the entities NIM will manage—normally all relevant entities.

  7. Select Save, then select Generate Secret.

  8. Copy the Key, Secret, and API URL. Select I have Copied This Data, then select Run Process to finish.

Protect the client secret

Treat the generated secret like a password. Store it in your approved secret-management process and do not include it in tickets, email, or documentation.

Configure the system in NIM​

Add a Skyward Qmlativ system in NIM and enter the values below.

NIM fieldValue
Customer/Tenant IDYour tenant API address, for example <CUSTOMER>.skyward.com/<CUSTOMER>API.
Client IDThe Client Key from the Skyward Integration Access screen.
Client SecretThe Client Secret from the Skyward Integration Access screen.
Integration KeyRequest this customer-specific key from Tools4ever Support.
Entity IDUsually 1, which identifies the district for the request. If a tenant has multiple districts, configure one NIM system per district.
School Year IDOptional. Leave blank to use the latest active school year, or enter a specific school-year ID.
Fiscal Year IDOptional. Leave blank to use the latest active fiscal year, or enter a specific fiscal-year ID.

Validate the connection​

  1. Save the system configuration in NIM.
  2. Run a read or test connection against a permitted entity.
  3. If a table or field is unavailable, confirm that it was selected under Custom API Entities and that Skyward has approved the required access.