Configure Connection
LACOE Data Exchange guide
Obtain an API key from LACOE Support, configure the hostname and credentials, and validate employee data for downstream lifecycle provisioning.
Before you beginDirect link to Before you begin
NIM requires Hostname and API Key. Confirm the intended environment and data access with LACOE Support before configuring the connection.
Obtain accessDirect link to Obtain access
- Contact LACOE Support to request generation of an API key for your organization.
- Confirm access to the employee data required by your process and obtain the hostname for the intended environment.
- Store the supplied API key securely. Refer to the public LACOE Data Exchange API documentation for API details.
The public documentation link uses the UAT host. Confirm the appropriate hostname with LACOE Support before collecting production data.
Configure the connection in NIMDirect link to Configure the connection in NIM
- Go to Configuration > Settings > Connectors, select Add, and add the LACOE Data Exchange connector. See Add a connector for details.
- Add a LACOE Data Exchange REST system in NIM.
- Open the system's Connection screen, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | The LACOE Data Exchange host confirmed by LACOE Support, using the format expected by the Connection screen. |
| API Key | The key generated by LACOE Support for your organization. |
The Username field is not used by this connector.
Validate accessDirect link to Validate access
-
Select Test Connection. NIM attempts to retrieve employees using:
GET /api/v2/EmployeeDemographics -
If the test fails, verify the Hostname, API Key, network access, and employee data permissions with LACOE Support.
-
Collect EmployeeDemographics, EmployeeActivePositions, and EmployeePrimeJobAttributes as needed, and confirm that the returned records match the access granted to your API key.
-
Validate employee matching and field mappings before using the data for downstream lifecycle provisioning.
The connection test checks EmployeeDemographics access. Validate the other collections needed by your process separately. The connector defines read operations for these tables.