Learn to use a Correlation Id to identify your customers within Urjanet’s systems.
Overview
Correlation Id’s are used to identify your customers within Urjanet’s system.
When your users connect their utility account, their request can be viewed alongside all other requests in Urjanet’s system. Without a correlation Id, there is no identifier that ties each request back to the customer in your system.
Correlation Id is an optional parameter that can be appended to your Connect URL.
Format: https://connect.urjanet.com/<organizationId>?correlationId=testing123
Step 1: Submit a test request
To add a correlation Id, follow these 4 steps:
- Copy your Connect URL from Console > Settings
- Paste into the address bar and add the correlation Id (…..?correlationId=<value>)
- Submit a request via Connect
- View the results in the Correlation Id column of the Console > Data Requests page
Step 2: Automating Correlation Id from your system
The correlation Id can be a variable sourced directly from your system. The best way to source a correlation Id value depends on how your customers will access Connect.
The example below describes the steps to add a correlation Id to an email. Similar steps are followed to add a Correlation Id within a webpage.
- Open the button where the Connect URL will be added.
- Add a dynamic variable to the end of the URL. For example: https://connect.urjanet.com/1029384756/*APPLICANT_NAME*
