OData (Open Data Protocol) feeds is a standard protocol for consuming data services over the web, allowing for easy integration with a variety of analytics and reporting tools. OData is an open protocol that allows the creation and consumption of queryable and interoperable RESTful APIs in a simple and standard way. It enables real-time access to data within different systems and applications, facilitating the analysis, sharing, and manipulation of this data across various platforms.
Current Supported Integrations
Benefits of Using OData Feeds with CommCare
Real-Time Data Access: OData feeds provide real-time access to CommCare data, enabling up-to-date analysis and reporting.
Easy Integration: Easily connect CommCare with popular data analysis tools without the need for custom API programming.
Flexible Data Queries: OData allows for flexible querying of data, enabling users to specify exactly which data they need from their CommCare projects.
Standardized Protocol: As a widely adopted standard, OData is supported by a range of tools and platforms, ensuring compatibility and ease of use.
Setting Up OData Feeds in CommCare
Enable OData Feed
Log in to your CommCareHQ account.
Navigate to the project space where you want to enable the OData feed.
Go to Data > Export Data.
Choose the type of data you want to create an OData feed for (e.g., Forms or Cases).
Click on the + Create OData Feed button next to the relevant data export.
Configure OData Feed Settings
Specify a name for your OData feed.
Choose the data items you want to include in your feed.
Configure any additional settings, such as filters for the data.
Save your OData feed configuration.
Accessing Your OData Feed
After saving, you will be provided with an OData URL. This URL is used to access your OData feed.
Ensure you have the necessary authentication details, as OData feeds require authentication to access.
When querying Repeat Group OData URLs, the limit and offset parameters operate at the form level, meaning limit=1 will return all responses within a repeat group for one form.
Bulk Delete Integration Feeds
The bulk delete OData integration feed gives you the option to bulk delete multiple exports at once.
These are the steps to bulk delete form export
In the Export Dashboard you will find a check box to select all or specific exports
On checking the box, you will notice a "Delete Selected Export" button becomes available on the left side of the page
Click on the "Delete Selected Export" button and you will be promoted to confirm the bulk delete action
Once Delete Export is clicked it will bulk delete the exports selected at once
Tips & Tricks
Best Practices
Secure Your Data: Ensure that access to your OData feed is secured and only available to authorized users.
Monitor Data Usage: Keep an eye on how your OData feed is being used to ensure optimal performance.
Stay Updated: Regularly check for updates on CommCare's OData feed functionality to leverage any new features or improvements.
Set-up a web user read-only role limited to read OData feeds
Navigate to Users / Roles & Permissions
Click +Add Role at the bottom of the page
Provide a name to this role: e.g. Read-Only OData
Unselect all permissions except the ones below:
Export Form Data (if necessary)
Export Case Data (if necessary)
PowerBI/Tableau Integration
Allow role to access data from all locations
Save and assign this role to a user
Repeat Groups
If setting up an OData Feed for a form that contains Repeat Groups , you will also need to reference the additional feeds created for that repeat group data if it is of interest. Each repeat group will have its own OData URL.
