Update Your Application

Releasing & Managing Application Versions

This section covers how to manage and release different versions of your CommCare application.

Releasing a new version of an app in CommCare is necessary for several reasons:

• Bug Fixes: To fix any issues or bugs in the previous versions that may affect the app's performance or user experience.

• New Features: To add new functionalities or improve existing ones, enhancing the overall capability of the app.

• Content Updates: To update forms, case management workflows, multimedia, or other content to reflect changes in project requirements or data collection needs

• Security Improvements: To address any security vulnerabilities and ensure the app remains secure for users and data.

• User Feedback: To incorporate suggestions and feedback from users to make the app more user-friendly and efficient.

• Compatibility: To ensure compatibility with the latest versions of the CommCare platform and mobile operating systems.

  
  By releasing new versions, you ensure the application remains up-to-date, functional, and effective in meeting the needs of its users and the project goals.

Steps to Release a New Version of the Application

• Step 1: If there are any pending updates to be released, a pink flag labeled “Updates Available to Publish” will appear. Click on the app name at the top left to navigate to the Versions tab page.

• Step 2: The Versions tab page will display (many, if multiple versions exist) versions of the application. Click on the ‘Make New Version’ button to release the latest application build.

• Step 3: Depending on the app's size, it will take a few seconds to create a new version of the app. By default, the released version stays in “In Test” mode. To switch to Released mode, click the ‘Released’ button. (The released button will be locked if Release Mode Functionality is enabled).https://dimagi.atlassian.net/wiki/spaces/2143944704/pages/2408906787/

• Step 4: The app will be publicly released with the new version. The label in teal color ‘latest’ will appear next to it, indicating it's the most current version of the app. You can now share it with the project team to manually update the app or it will be automatically updated using the Auto-Update Application functionality.

Viewing the Current CommCare Version on CommCare Android

On CommCare Android you can view the current CommCare version by choosing About CommCare from the Settings menu before or after logging in.

You can also determine the deployed version on CommCareHQ by using the Application Status Report in the Manage Deployment Reports.

Application Update Settings

CommCare offers various settings to manage application updates efficiently. Here’s a detailed explanation:

1. Auto-Update

CommCare can be configured to check for newly released versions on a regular schedule through the Auto Update Frequency option.

Steps to Enable Auto-Update Settings in an Application:

• Click on the Settings button of the app in the top left corner, next to the app’s name.

• Click on the Advanced Settings tab.

• Scroll down to the Build Settings category and set the Auto Update Frequency.

What does Auto-Update do?

When set to auto-update, CommCare automatically checks CommCareHQ for new resources on a daily or weekly schedule. Here's how it works:

• Automatic Checks: The app checks for updates in the background immediately after the user logs in.

• Downloading Updates: If new updates are found, they are downloaded.

• Applying Updates: The updates are applied the next time the user logs in.

• Retry on Failure: If the app can't contact the server, it will try again on a future login.

• User Control: Users can cancel the updates being downloaded by navigating to "Settings -> Update App" on their mobile device.

This ensures that users always have the latest version of the app without needing to manually check for updates.

2. Manual Update

A Manual App Update in CommCare allows users to manually check for and install updates to their application. Here’s how it works:

• User-Initiated: The user initiates the update process rather than the app automatically checking for updates.

• Check for Updates: Users can navigate to the "Settings" menu and select "Update App" on their mobile device to check for any available updates.

• Download and Apply: If an update is found, the user can download and apply the update immediately.

• Control: This provides users with control over when and how they update their app, useful in scenarios where automatic updates might not be preferred.

Manual updates ensure that users can always access the latest version of the application at their convenience.

New Version Update Prompt

For projects that have shortened inactivity timeout functionality, when a new version of an app is released, users will see a pop up message allowing them to either update to the latest version now or later.

This pop up will appear with the timeout activity pop up (generated a few mins before the timeout). Clicking Update Later will close the pop up and allow the user to continue working where they were. Clicking Get Latest App will navigate the user to the WebApps home page, from where they have to select to re-enter the latest released version of the app they were working in.

Note: The new app released pop up will not appear

• For projects that do not have an inactivity timeout set.

• If use_latest_build_cloudcare feature flag is enabled.

• If the user has navigated from the Releases page to Web App.

Updating CommCare Application on Android

Updating the CommCare application on Android involves installing newer versions of the app to benefit from bug fixes, new features, and security enhancements. To learn more about it, click here : https://dimagi.atlassian.net/wiki/spaces/2143944704/pages/2408546472/