On-Premise Hosting: How to request your data in a migratable format from CommCare HQ

On-Premise Hosting: How to request your data in a migratable format from CommCare HQ

This page is for project teams who are setting up new, on-premise instances of CommCare who want to receive data that is currently stored in Dimagi’s CommCare HQ cloud service (www.commcarehq.org or india.commcarehq.org).

This page is not for teams

  • looking to download their project data for regular use such as analysis or data cleaning; for that see Data Analysis & Visualization  

  • requesting user activity logs; for this see HIPAA Compliance

  • looking to migrate to Dimagi’s CommCare HQ cloud service

  • looking to migrate from any instance besides Dimagi’s CommCare HQ cloud service

  • looking to migrate to any instance that already has live data on it

Data Format

Our team will run a process which will extract all data associated with the project space on our cloud offering. The data will be in a serialized (JSON) format and stored temporarily on our secure servers until it is ready to share with you, after which it will be destroyed.

The file will include the following information:

  • All rows from tables that are scoped to the domain (e.g., Web Users, Mobile Workers, Locations, Fixtures, Domain Settings).

  • All documents associated with the domain (e.g., Applications, Forms, Cases, Multimedia Metadata).

  • All binary files (images, audio) attached to forms or apps.

Instructions

Submit your request to our support team at support@dimagi.com. You will need to select a window during which your project will experience downtime; please make sure to submit the request at least 3 weeks in advance of this date. Please include the following information in your message:

  • A link to this page

  • A link to your project space on CommCare HQ

  • Details about your timeline:

    • when you expect to begin testing the migration

    • when you aim to finish the migration

  • Your preferred transfer option:

    • Option 1. Your provide a secure location for Dimagi to transfer the data files to (e.g. a secure DropBox, Google Drive, Sharepoint folder).

    • Option 2. You give Dimagi permission to temporarily store the data file in our secure Google Drive in order for us to be able to transfer it to you, and give Dimagi permission to grant access to a specific email address. (You must provide the email address.)

  • A proposed date on which we can shut off access to your project space on CommCare HQ, which includes rejecting mobile submissions. This is required in order for us to be able to provide you with a consistent snapshot of your data. We cannot give a precise time estimate for the amount of downtime that will be required for your project. It can be from hours to days, and is typically less than a week.

  • When we are done, would you like us to re-enable access and submissions (test run) or keep access and submissions permanently disabled (final run)?