Upon request, Rego will setup an ODATA connection into your Clarity instance. This may be used to connect tools such as Microsoft PowerBI to the Clarity data warehouse schema. PowerBI is the only certified and tested tool for this configuration of ODATA, no other tools are specifically supported. The process of querying data into PowerBI requires detailed knowledge of the Clarity data warehouse dataset and is not meant to replace the supported reporting tools within Clarity. Access to the Clarity transactional data is not possible.
First, create a username in Clarity that will be the “Service Account” for all ODATA connections. For this new username, make sure that Force Password Change for the user is unchecked and External Authentication for the user is unchecked. You will also need to provide “OData – Access” and “Data Warehouse OData Service - Navigate” rights to the user.
Second, run the ‘Load Data Warehouse’ and then the ‘Refresh Data Warehouse OData Model’ before the first connection from Power BI. Run the ‘Refresh Data Warehouse OData Model’ job every time there is a structural change to the DWH (example – tables/columns added/removed).
Lastly, to connect PowerBI to ODATA, set the endpoint URLs, these can be found within Clarity in Admin > Settings:
https://odata-<environment_tier>.us-services.moventus.com/api/odata/<OData_authenticator>_dev
https://odata-<environment_tier>.us-services.moventus.com/api/odata/<OData_authenticator>_ds
And set the username in this specific pattern:
User: <clarity_username>|<OData_authenticator>
Password: <clarity_user_password>
An example below:
Once connected the tables will be available to retrieve data:
ODATA Service Account Password Reset Procedure:
In the future, if you wish to reset the password for the service account that authenticates the ODATA connection, follow this guidance:
ODATA authentication happens through REST. Whenever the ODATA service account password is expired in Clarity it must be reset from the Clarity Administration side (Clarity Administration-> Organization → Resources) and not from the “Forgot Password” link on the login screen of NON-SSO URLs.
When the password is changed in Clarity (not SSO, but on Clarity Administration-> Organization → Resources), the new password will come into effect immediately. Password change has no dependency on the Refresh ODATA model Job or any other sync process as authentication directly happens against the Clarity URL through REST API.
If Power BI is unable to connect to ODATA with the new password, it is because of caching that is done at the Power BI client side. Once the Clarity password is changed, please make sure to clear the caches in Power BI. Additionally, SSO password change does not automatically change the password on the Clarity admin side i.e., the user will be able to login to Clarity using a new password, but Rest/XOG will work only with the old password but fails with the new password. The user needs to manually change the Clarity administration password for the respective ODATA users after each password rotation.