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 beginDirect link to Before you begin

Tools4ever is a Skyward partner. Use the Tools4ever Identity Management integration in your Qmlativ integration catalog to provision access using the existing procedure below.

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 process.

Create integration access in SkywardDirect link to Create integration access in Skyward

In Qmlativ, open the main menu.
Select Administrative Access, then open the API module.
Select Integration.
Search the integration list for Tools4ever Identity Management, then select its arrow to open the integration.
Select Add Integration Access.

Complete the integration access record:

Field	Value
Name	`Tools4ever NIM`
Key	`Tools4everNIM`
Authentication Type	`OAuth 2.0`
Is Active	Selected
Effective Date	Today’s date
Custom API Entities	Select the entities NIM will manage—normally all relevant entities.

Select Save, then select Generate Secret.
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 NIMDirect link to Configure the system in NIM

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

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

Validate the connectionDirect link to Validate the connection

Save the system configuration in NIM.
Select Test Connection. NIM attempts to retrieve system metadata using:
```
GET /Custom/GetSystemMetadata
```
If the test fails, verify the tenant API address, client credentials, Integration Key, district settings, integration activation, and network access.
Collect the data required by your process. If a table or field is unavailable, confirm that it was selected under Custom API Entities and that Skyward has approved the required access.
Validate identity matching and field mappings before enabling downstream provisioning. Test intended security user, group membership, staff, and contact changes with safe records before enabling automated writes.

The connection test checks metadata retrieval. Validate access to the required tables, fields, and write operations separately.

Step 1 of 3