Configure Connection
TeamDynamix guide
Prepare API account access, configure ticket settings, and validate account retrieval and ticket creation in NIM.
Before you beginDirect link to Before you begin
Review the vendor's Creating a TeamDynamix Web API Auth Account documentation. It links to the API Service Accounts instructions, which require a TeamDynamix portal login.
The Web API Auth Account article describes authentication accounts used within TeamDynamix Workflow Web Services. For the NIM connection, obtain the underlying service account credentials and permissions needed for external API access.
NIM requires Tenant URL, Application ID, Ticket Status ID, Ticket Type ID, Username, and Password.
Prepare the service account and ticket settingsDirect link to Prepare the service account and ticket settings
- Have your TeamDynamix administrator create or configure a service account for NIM using the vendor's API service account instructions.
- Grant access to the accounts, tickets, and ticketing application required by your process, including ticket creation when needed.
- Obtain the Tenant URL and the target ticketing Application ID.
- Identify the Ticket Status ID and Ticket Type ID to use when creating tickets. Confirm these values are valid for the selected application.
- Ensure the NIM server can reach the TeamDynamix API.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a TeamDynamix system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The TeamDynamix tenant address, using the format expected by the Connection screen. |
| Application ID | The ID of the target TeamDynamix ticketing application. |
| Ticket Status ID | The configured status ID for ticket creation. |
| Ticket Type ID | The configured type ID for ticket creation. |
| Username | The service account username used by NIM. |
| Password | The password for that service account. |
Test account retrievalDirect link to Test account retrieval
-
Select Test Connection. NIM attempts to retrieve accounts using:
GET /accounts -
If the test fails, verify the Tenant URL, Username, Password, service account permissions, and network access.
-
Collect account and ticket data and review the results in NIM.
-
Create a test ticket and confirm its application, status, type, and field values in TeamDynamix before enabling automated ticket creation.
The connection test checks account retrieval. Validate ticket access, ticket settings, and creation permissions separately.
Use report data for downstream provisioningDirect link to Use report data for downstream provisioning
Use the TeamDynamix Report connector when your process needs report data as a source for downstream provisioning. Both the REST and Report connector repositories are linked on the TeamDynamix integration page.
Configure report access using the settings exposed by that connector, collect the required report, and validate its identifiers and field mappings before using the data to provision another system. The REST account retrieval test does not validate Report connector access.