...
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.(just like you configure a Form or Case Export)
Copy the OData feed/s
On Power BI / Tableau Desktop, select OData Feed/OData as your connection type.
Enter your OData feed/s, and login using your CommCare credentials
Ensure you have the necessary authentication details, as OData feeds require authentication to access.
...
If you are using 2FA or SSO, specify your API key as the password. Your API Key can be found under your My Account Settings.)
Bulk Delete Integration Feeds
...
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
...
Odata Feeds 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.
...
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.
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.
...