Customizing Utility Cloud Connect
Connect handles standard data submissions requirements without any setup required. Your Connect instance can also be customized in a few ways to fit your company's requirements.
There are two primary ways to configure Connect. One way is through adjusting the settings from the Console > Settings > Connect page. The other is through URL parameters. The Connect URL structure consists of the Base URL (connect.urjanet.com) followed by an Organization Id (unique for each customer), and then URL parameters. A question mark is used to indicate the start of the parameters and an ampersand is used to separate any following parameters. The standard syntax of the URL looks like this:
https://connect.urjanet.com/?parameter1=¶meter2=
Styling connect
The primary color used in Connect can be configured globally or for each instance. Setting the color globally will update the default primary color for Connect. This can be configured in Connect through the Console > Settings > Connect page or through the API.
Setting the primary color for a Connect instance can be controlled by passing a parameter through the URL. This will override the default primary color and can be done by passing in primaryColor parameter in the URL.
Option name | Description | URL query parameter name |
---|---|---|
Primary Color | HEX code for the primary color of Connect. Applies to links, buttons, and progress spinners. | primaryColor If specifying as a query parameter in the URL, the “#” in the hex code should be URL-encoded. |
Workflow configurations
The Connect workflow can be modified to blend better into your existing workflow. You will be able to pass in parameters to constrain the workflow to a specific provider and remove the "Connect another account" button.
Option name | Description | URL query parameter name |
---|---|---|
Hide final buttons | Whether to show a button to allow a user to link another credential or try again if extraction fails. Defaults to false. | hideFinalButtons |
Provider ID | By passing in a provider ID, Connect will skip the provider selection and start the user off on the credentials page. This will also disable the back button and the breadcrumbs. | providerId |
Legal documents
Connect provides the ability to set the Terms of Service and Privacy Policy. If either is set, Connect will require that the user checks the box saying they acknowledge these. If you do not have a Terms of Service or Privacy Policy, no consent mechanism will show.
These fields can be configured in Connect through the Console > Settings > Connect page.
Updated 11 months ago