Creating an OData Connection

This article will provide a step-by-step guide to setting up an OData connection.

Written By Grainne Reidy (Super Administrator)

Updated at March 12th, 2024

Generate User Credentials

Before being able to create OData connections, your Administrator will first need to enable the connection. Each User will need to create their own set of user credentials to access the data. 
 


To generate user credentials: 

  1. Log in to the Entity.
  2. Go to Analysis Data Connection Setup.


     
  3. A reporting tool will need three pieces of information before it can connect to your company: 
    • The URL of the connection (available in the OData Connection Setup screen). Each company has its own unique URL that includes the version of the OData Connector used.
    • A username (available in the OData Connection Setup screen). The username is the same as your group username.
    • A password you will create that is unique to this OData connection.
  4. To generate the OData password, click Create New Password.


     
  5. Provide a name for the connection. The name of the connection will help you keep track of your connections.



     
  6. Enter your current login password as a security check.


     
  7. You will then be presented with your password. You will not be able to use this password to log in to the system. You must copy the password before you can close this window.



Delete

Warning 

Important: Once you close this window, you will no longer have access to this password so keep it in a safe place, such as a password manager.


You can now use your credentials to access AIQ data from within a reporting tool. An example of this is documented in Using an OData Connection, here

Delete

Datasets and Versioning

To support the future development of our OData datasets, the OData Connector supports versioning. This enables us to deliver changes to the OData connector and datasets without breaking any existing reports created in your reporting tool. Once a report is built using a particular version of the OData Connector, it will continue to work even if the OData Connector is upgraded. 


Each new query should connect to the most recent version of the OData Connector. You will rarely need to actively select an older version of the OData Connector for a report. The only time would be if you developed a report using an older version and that connection and query were not available within the report anymore. To save having to re-develop the report using the most recent version of the OData Connector, you could simply use the older version. 



Delete

Power BI Sample Report Pack

We provide a link to a sample Power BI report pack on the Data Connection Setup screen. This is provided as an example of how the OData Connector can be used within a Power BI report. 


It is provided without warranty and is not a supported component of our product. 

Delete