Configure Connection
Frontline Asset Management guide
Retrieve the district API settings, configure credentials in NIM, and validate source data for ad hoc downstream automation.
Before you beginDirect link to Before you begin
You need administrator access to District View in Frontline Asset Management to retrieve the API settings. NIM requires Hostname, Username, and Password.
Use the Frontline Asset Management API documentation alongside these steps. The public NIM connector maps Frontline's Secret Key to Username and Passphrase to Password.
Retrieve district API credentialsDirect link to Retrieve district API credentials
- Sign in to District View with administrator credentials.
- In the left navigation menu, select Management > District Settings.
- Open API and SSO Information.
- Record the API URL, Secret Key, and Passphrase. Store the credentials securely for the NIM connection.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Frontline Asset Management system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | The host from the district API URL, such as customer.tipwebhss.com. The public connector adds https:// and /tipwebapi; do not duplicate them in this field. |
| Username | The Secret Key from API and SSO Information. |
| Password | The Passphrase from API and SSO Information. |
Test API accessDirect link to Test API access
-
Select Test Connection. NIM attempts to retrieve the following path relative to the connector's API base URL:
GET /api/Home -
If the test fails, verify the Hostname, Secret Key, Passphrase, network access, and district API configuration.
-
Collect the data required by your downstream process and confirm that the expected records are present.
-
Validate record matching and field mappings before using the collected data for ad hoc automation.
The connection test checks access to /api/Home. Validate the specific collections required by your process separately.