Connector Dialog for OData

The OData connector dialog includes the following fields and settings:

Field

Description

Collection List

Enter the URL containing the collection.

User ID

A valid User ID for the Collection List.

Password

A valid Password required to log-on to the data source. This password must match the User ID above.

Timeout

Modify this value if required. This time out governs how long the data connector should wait for data to be returned.

OData Version

Select the version from the drop-down list.

Supports Metadata

Check this box to indicate that metadata is available from the ODATA source.

Collections

This displays a list of Collections. Select a Collection from the list and then define Query Parameters as needed.

Add

Click this button to add a query parameter or filter.

Query Parameters

Allows you to define a Query Parameter. Select field values and operators using the drop-downs provided. Also enter a value for the filter condition in the text box provided.

An option to render query parameter comparisons case-insensitive is provided. 

ODATA Query URL

Type in the Query URL that will be used to fetch the data.

Notes:

  • Note that the system query option $inlinecount is not supported in OData v4 queries.
  • When a collection and query parameter(s) are selected, a query URL corresponding to these inputs is auto-generated in the ODATA Query URL box. The query URL can then be manually modified if further adjustments are necessary. However, if other changes (e.g., new selections) are made to either the collection or query parameters, the manually defined query URL is overwritten with a new auto-generated one.
  • The OData Query URL takes precedence over any other conditions or parameters in the dialog box. If you edit the query, values in the dialog box will be ignored and the query will be used to fetch data instead.
  • Although the new query parameters and operations introduced in OData v4.0 are not exposed as query parameters, you can use and execute them by manually create an appropriate OData Query URL.

Decimal Separator

Allows you to select the separator to be used for decimals.

Preview Data

Click to fetch data using the credentials and criteria you have specified. This allows you to confirm your connection, ensure you have connected to the correct table, check your query, and verify the information that will be loaded.

Notes:

  • Only 10 records are displayed to allow you to verify that you are selecting the correct data. This limit prevents system slow down.

  • The button is only enabled if the connection is active and the query is correct. Check your connection or your query if one of the buttons is disabled.

OK/CANCEL

Select OK to establish the connection and fetch data or Cancel to close the dialog. 

The state of the OK and PREVIEW buttons provides a handy status about the state of your connection:

  • The OK and PREVIEW DATA buttons are enabled as soon as the required fields have been entered and verified. This usually means a connection to the data source has been established and a table has been selected.

  • The OK button is disabled when an update is made that can lead to an invalid result (e.g. the User Name or Password is not valid, or the the SQL statement in the Query tab is invalid). In such cases, use  PREVIEW DATA to validate that data can be retrieved. If this fails verify your connection information or query until data can be retrieved.

 

Notes:

  • Refer to this page for the limitations of this release.
  • This version of OData implements expand functionality to query related data. The expanded collection name in the list of Collections uses the format [Collection]_[NavigationProperty]

 

 

 

 

© 2025 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support