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 January 16th, 2025

Generate User Credentials

Prerequisite

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. 

Generating User Credentials

To generate user credentials: 

  1. Go to Setup Data Connection Setup.To use OData with reporting tools, you will need the following:
    • Connection URL: Available in the OData Connection Setup screen. Each company has its own unique URL that includes the version of the OData Connector used.
    • Username: Available in the OData Connection Setup screen. The username is the same as your group username.
    • Password: Crated by you. It is unique to this OData connection.
  2. To generate the OData password, click Create New Password.
  3.  Click I understand to accept the disclaimer.
  4. Provide a name for the connection. This will help you keep track of your connections. Click Verify Identity.
  5.  You will be asked to enter your password or, if you use SSO, verify your identity with an OTP. Click Submit
  6. You will then be presented with your OData password. You must copy the password before you can close this window.

    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.

     
  7. You can now use your credentials to access AIQ data from within a reporting tool such as Excel or PowerBI. For more on EXcel, see Using OData with Excel, OData with Excel Troubleshooting and OData Excel Report Building FAQs.

OData Connection Refreshing

Once you connect to your reporting tool of choice, your OData feed will refresh in the following instances:
  • When consolidation is run.
  • When a report or dashboard is run that indicates it should be refreshed beforehand.
  • When that refresh button is clicked in the GL Explorer.
  • When the refresh button is clicked in the GL listing grid.
  • Prior to period / year closing.
 
 

Datasets and Versioning

Versioning and existing reports

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. 

Versioning and new reports

Each new query should connect to the most recent version of the OData Connector. 

You will rarely need to select an older version. If you think you might, click on Need an older version for more details. For example, if you developed a report using an older version and that connection and query are 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 use the older version.

 
 

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. 

Use OData Connector with PowerBI (23.3) - AIQ Academy