Versioning Apps

SKIP AHEAD TO
Why does Checkbox have a versioning system?
When should you create a new version of an App?
How to create a new version
Making changes to your published Apps
What are some example scenarios that you should consider when publishing a new version?

 

Why does Checkbox have a versioning system?

Checkbox has a versioning system to manage multiple iterations of an App. When creating a new version of an App, you can choose to inherit any previous versions to continue making iterations without overwriting these previous versions.

 

When should you create a new version of an App?

There are two main use cases when new versions of an App should be created.

  1. It is best practice to keep track of the changes made since the App can be altered by a number of different users and the changes may not be immediately apparent. This can be done by creating another version once you have made significant progress and need to back up this work.

  2. Published versions of Apps cannot be edited. Therefore, to make changes to a published version of an App, you must create a new editable version of the App that inherits the published version.

 

How to create a new version

  1. Click on Apps in the top navigation bar, and locate your app. From this landing page, click Versions & Publishing.

    Versions___Publishing.png


  2. Here you can create a +New Version and inherit the version you want to copy. This creates an identical but editable version of the app you're inheriting.

    Note: Use descriptive Version Names and Version Descriptions so it is easily understandable in the future.
    + For example, Version 1.0 might have the description Section 1-3 Completed. 

    Create_new_version.png


  3. Once you have created the new version, you will be taken into the Studio of this version of the app to make the required changes.

 

Making changes to your published Apps

When versions are published, they can no longer be edited. To make changes to published apps, you need to re-publish another version, making it the latest published version. This will immediately be the version that is accessed when creating new assessments.

To publish another version:

  1. Inside the "Versions & Publishing" tab, click the 3 dotted icon in the "Actions" column for the version you wish to publish

    Actions.png


  2. Click "Publish"

    Publishing a version will now make it the latest published version of the App.

    Note: When a new version of an app containing workflow is published, all workflow groups are reset. Ensure that you reassign the relevant team members to the appropriate workflow groups - click here to learn how to do this.

    Publish.png

 

What are some example scenarios that you should consider when publishing a new version?

To make this clearer, here are a few scenarios:

Scenario 1: Manager publishes Version 1.0 and an end user starts an Assessment shortly after. Before the user finishes the Assessments, the manager publishes Version 2.0. When the end user returns to the Assessment, they will be continuing Version 1.0 of the App.

Scenario 2: Manager publishes Version 1.0 and then Version 2.0 before any end user begins running Assessments. When the end user begins an Assessment, they will be using Version 2.0 of the App.

Scenario 3: Manager publishes Version 1.0, then Version 2.0 and then re-publishes Version 1.0. When the end user begins and Assessment, they will be using Version 1.0.