Configure Connection
Cisco Alma guide
Connect NIM to Alma SIS, test access to district schools, and validate the data and permissions needed for your process.
Before you beginDirect link to Before you begin
Arrange API access with your Alma SIS administrator or Alma SIS support. Ask for the API setup instructions and credentials for your school or district.
NIM requires Customer Name, Username, and Password.
Prepare SIS accessDirect link to Prepare SIS access
- Confirm the Alma SIS customer identifier for your environment with your administrator or Alma support.
- Obtain a dedicated API account and its username and password.
- Arrange read access to the schools, students, staff, and roster data needed by your process.
- If NIM will update student custom fields, confirm that the account can write the intended fields and obtain their identifiers.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Cisco Alma system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Customer Name | The customer identifier for your Alma SIS environment, used as {tenant_id} in the test endpoint. |
| Username | The username supplied for API access. |
| Password | The password for that API account. |
Test district school accessDirect link to Test district school access
-
Select Test Connection. NIM attempts to retrieve schools using:
GET /v2/{tenant_id}/district/schools -
If the test fails, verify the Customer Name, Username, Password, network access, and account permissions.
-
Collect the school, student, staff, class, and enrollment collections required by your process. Validate record matching and roster relationships before enabling downstream automation.
-
Before enabling student custom field updates, collect the field definitions and existing values, confirm field mappings, and test an intended change with a safe student record.
The connection test checks school retrieval. Validate other collection permissions and custom field writes separately.