Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt

CommCare Sync is a self-hosted, standalone, web-based app that can be used to manage a CommCare “data warehouse.” It’s a suite of configurations, with an improved UX from the command-line Data Export Tool. This turn-key tool allows you to export your data from CommCare and save it to a local or cloud-based database (MySQL, PostgresSQL, Amazon RDS, GCP Cloud SQL, Azure SQL Database).

...

Table of Contents
minLevel1
maxLevel2
outlinefalse
stylenone
typelist
printabletrue

...

New community supported open source tool

...

Multiexcerpt include macro
macro_uuidc6ae9228-d8de-4816-9784-c6a29483e3b6
nameCommunity of Practice
templateDataeJyLjgUAARUAuQ==
pageCommCare Help Site Design Guidance
addpanelfalse

Installation

If you wish to try out, or self-host CommCare Sync, you can do so by setting it up from the source code which is available in the commcare-sync Github repository.

...

Download your DET config file from CommCare

...

  1. If you haven’t already, add the CommCare project space in the “CommCare Setup” tab.

  2. If you haven’t already, add a CommCare account that has access to the project space.

  3. Important note to Dimagi users: Do NOT use your superuser @dimagi.com account, follow the steps below to create a user below. Create a web user for a specific project, and set up API key for that user (under Account Settings). You can use a "+" in your email address that tells you what your web user is for. e.g. "firstnamelastname+demo-cc-sync@dimagi.com"

  4. Add the export from the “Exports” tab.

  5. On the export details page, click “run”.

  6. When the run completes, view the logs to confirm it ran successfully.

...