Skip to content

Checking OData Quality

Check OData Quality for the selected destination. This tool is provided for administrators and developers to conduct inspections on the back-end OData service. It aids in identifying and resolving potential issues, thereby ensuring the smooth development of client applications.

For instructions on how to perform an OData Quality check, see Testing OData Quality.

What Is Being Checked

The OData Quality Check interacts with the back-end OData service in a way similar to an Offline download:

  • Retrieve metadata document and check its validity.
  • Retrieve service document.
  • Check if the metadata can be used to create Offline databases.
  • Check a small page of data for each entity set and see if the data can be consumed by the Offline feature.

    Note

    Because each entity set is checked, this process can be very time-consuming for large entity sets. The check attempts to retrieve a small subset of each entity set in the OData service, using the OData system query options $count and $skip. If the OData service does not implement $count and $skip correctly, the check could become extremely time-consuming.

  • Check if delta is supported for each entity set.

Check Results

The OData Quality Check results are displayed in a table with the following columns:

  • Code
  • Severity - the impact of the condition (High, Medium, Low).

    Note

    Issues with High severity prevent Offline synchronization from succeeding if the reported entity set is used.

  • Description - a detailed explanation of the issue.

  • Solution - if the description is not informative enough, this column provides additional information on what needs to be done by the administrator or developer to resolve the issue. This could involve adjustments to the back end, the Offline configuration, and so forth.
  • References - links to all the relevant documentation, help, notes, and so forth.

Limitations

It is not possible for OData Quality checks to identify issues that could only be detected through CUD (Create, Update, Delete) operations. This limitation may be revisited once the new feature, Dry-run of data modification requests, is implemented in OData V4.02.


Last update: January 24, 2025