Versions Compared

Key

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

...

  1. Installing the CommCare platform from Google Play
  2. Installing the specific CommCare application from your CommCareHQ (CCHQ) project space

You must complete both parts of the installation process to use your application.

...

To Install CommCare you will need:

  • A strong mobile data network connection (preferrably preferably WiFi)
  • An Android device with Android operating system 2.3 or higher
  • (if you have multimedia) A file manager application like the Amaze File Explorer (if you have multimedia) 
  • If you would like your users to type in a language not supported by the phone you need to download the software for it, if available. For example, for applications deployed in Hindi, you should download 'Google Hindi Input Indic Keyboard' from the Google Play Store so your users are able to type in Hindi. 

...

Step 3: Install Your CommCare Application

  1. Go to the Applications tab of CommCareHQ and select the application you want to deploy. 
    Image Removed
    CommCareHQ Menu BarImage Added

  2. When you select an application, you are brought directly to the deploy releases page. Previously, If you would like to head to the app settings firstpage, which it is now accessible via the gear icon in the app manager menu via the gear icon next to the app name.
    Image Removed
    Image Added

  3. If needed, click "make new version" to create a new version of your application.
  4. Find the version you want to deploy release and click the "Publish" button next to that version
    Image Removed
    Image Added

  5. From here you have two options: online install or offline install. Online install requires a reliable internet connection for the phone, while offline install does not require internet once the file (ccz) has been downloaded from CommCareHQ. Note that an Internet connection is required to log into the mobile app for the first time, regardless of the installation method.  Please follow the instructions below for your preferred installation method. If you have decent connectivity we recommend you start with online install

    Info
    titleUSB Mounting

    Certain versions of Android OS will not have USB Mounting capability turned on by default. Turning on USB capability in the middle of a CommCare download will interrupt the download.

    Image Removed


    Release Page - Online InstallImage Added
    Online Install

    Releases Page - Offline InstallImage Added
    Offline Install


Option A: Online Installation

- Including

(including Multimedia)

See instructions and more info about multimedia here. See this handout for guidance on installation and use of multimedia on CommCare.

Online install sends the application to your phone over a wireless data connection (WiFi or phone mobile data network data). 

  1. If your application has multimedia, leave "Include Multimedia" checked to also send down your multimedia files remotely.

    Please note:


    Image Added


    • If you use installation with the application with "include multimedia" selected, multimedia will be included in any remote updates to that application. The phones will incur increased data usage, therefore increased costs (if applicable). 

    • Applications with large amounts of multimedia (more than 20 images and/or audio files) may take a long time to install or not install successfully

    if you are
    • using this method. Even after the app is installed, updating the app would take very long (could fail if connection is poor). It is recommend that such apps (with large multimedia) use other installation methods. 

    • We recommend installing over a wifi connection rather than a

    phone
    • mobile data network for initial install or update of large amounts of multimedia files.


  2. Open Separately, open CommCare on your phone and , as you can see below, you can either click on Scan the Application Barcode or Enter Code.

    Image Modified

    Type in the App Code
    Info
    titleDifference between Scan the Application Barcode and Enter Code

    Scan Application Barcode

    When using this option, you will need to logged into CommCareHQ (CCHQ) and also have your mobile device near you. When you click on the Scan Application Barcode link on CCHQ, a modal will popup with a QR which you will need to scan with your mobile device. You can do so with your device by selecting the Scan Application Barcode option and the phone will initiate it's camera which you'll need to point to the screen with CCHQ and scan the QR code provided.

    Enter Code

    You use the code presented on CCHQ and enter it on your mobile device to install the application. With this method, you can just provide the code to your users in the field, without them being next to their computer. As long as a user has the code, they can install the application.

    Note this code is unique to version of the application.

    E.g. Application A with v1XX has a unique code which is separate from Application A with v2XX.


  3. Type in the app code from the website into the box (or scan the bar QR code if you clicked on scan bar codeapplication barcode) and click on "Begin Install." Depending upon the size of the application, it could take several minutes for installation to complete.
  4. Log in on the mobile device with the Mobile Worker username and password you created on CommCareHQ. 
  5. If you do not have a mobile user account, create a CommCare mobile worker in your project. 
    Note that : you cannot can not log into CommCare mobile using a CommCareHQ login IDcredentials.

Option B: Online Installation - Without Multimedia

If you do not want to remotely update multimedia files in the future, you must install multimedia offline.

  1. Connect your phone to the computer. Open the phone's SD card. (Sometimes phones will have two SD card folders - one in internal memory and one that is the actual physical SD card. In this case try using the internal SD card first).
  2. On your phone install a File Browser (ex. Amaze File Explorer)
  3. On CommCareHQ, click on the blue "Deploy" button for your application, then click on "Download Multimedia"
  4. Copy the downloaded .ccz file to your phone.  If you copy the phone right onto the phone's SD card (not in any folder), CommCare can often automatically find it. 
  5. Install the CommCare application.  This will validate your multimedia for the application. 
  6. You will see a set of messages indicating that multimedia could not be found.
  7. Press Menu or Settings button on your phone and choose the Install Multimedia option.
  8. Sometimes CommCare will automatically find the multimedia zip file (if you copied it directly to the phone's SD card).  If it is not already listed, press the Folder button and find your multimedia zip file.
  9. Click on the Install Multimedia button. 

See this handout for guidance on installation and use of multimedia on CommCare

If your application has multimedia and you did not choose to "Include Multimedia", the installation will likely fail at this point with a message that multimedia validation has failed. You will then have the opportunity to direct CommCare to your multimedia files. See below under "Installing Multimedia" for more detail on this process.

Expand
titleAlternative Method: Using Dropbox to Install Multimedia

 

  1. In the Dropbox account of your choice (you may one to create one specifically for the email used on the phone), add your zipped multimedia folder.
  2. On your phone, go to the Google Play store and install Dropbox.
  3. Open CommCare and install the application.
  4. You will then see a set of messages indicating multimedia couldn't be found.
  5. Press Menu or Setttings Settings button on your phone and choose the Install Multimedia option.
  6. Press the Folder button and find your multimedia zip file in Dropbox.
  7. Click on the Install Multimedia button and wait for multimedia validation to finish.

Option C: Offline Installation

  1. Connect your phone to the computer. Open the phone's SD card. (Sometimes phones will have two SD card folders - one in internal memory and one that is the actual physical SD card. In this case try using the internal SD card first).
  2. Make sure you have a file browser on your phone (This should come automatically with all devices). If you do not, you can download one from the Google Play Store (ex. Amaze File Explorer). 
  3. Choose "Offline" from the Download to Android menu and click to download the file "CommCare.ccz". 
    Image Removed
    Image Added

  4. Copy the downloaded .ccz file to your phone. 
  5. Open CommCare. From the installation screen, click the menu button and choose "Offline Install"
  6. Choose the "CommCare.czz" file. If you cannot find the ccz file, you just need to tell your device to "show internal storage" or "display advanced devices", which should be in the settings drop down when you open the initial file selection from CommCare. Now you should be able to find the file. In case this doesn't work, install Amaze File Explorer as in step 2 above.

If your app includes multimedia, please note that offline install will include all multimedia files you uploaded to CommCareHQ. All future remote updates will include changes to multimedia files. 

Updating and Changing Applications

Updating an application ("Remote Update")

When the application updates, it will update to the latest version of your application. To mark a version as latest, simply click on "Released". You can also unmark it as latest by clicking on "Released" again.

To update the application on the phone to the latest version with a star, follow these steps:

  1. Open the CommCare app
  2. Login as a mobile worker
  3. Click the phone's menu or settings button and select Update CommCare as described in the CommCare Users Guide. CommCare will search for a more recent version of the application on your HQ workspace and if found, automatically download it.

  

You can set the CommCare app to automatically try to check for updates on a regular basis through the Auto Update Frequency application setting (see Application Settings)

For more detail, please see How to Update CommCare Application Content.

Installing a different application

If you are using CommCare 2.29 or above, you may have up to 2 applications installed on one device at a time.

To install a second app:

  1. Go to the login screen of CommCare

  2. Click on the options menu (the 3 dots in the top right corner) and choose "Go to App Manager"

  3. Click “Install an App”

  4. Proceed with normal installation (from step 3 of “Installing  your first application”)

To uninstall an app:

  1. Go to the login screen of CommCare

  2. Click on the options menu (the 3 dots in the top right corner) and choose "Go to App Manager"

  3. Select the app you want to uninstall

  4. Click “Uninstall”

If you are using CommCare 2.28 or lower, you cannot have 2 CommCare applications installed on the same Android phone.  Before installing a new application, you must remove the old application:  

  1. Open CommCare and login.  Use the "Sync" button to make sure you have sent in all data from the old application. 
  2. On your phone, go to Settings -> Application -> Manage Applications
  3. Find CommCare and choose "Clear Data"
  4. Proceed with normal installation (from step 3 of "Installing your first application")