Version Control

• Application Version
• Process Version

These versions play essential roles in managing updates and maintaining consistency within applications.

These are the instances where versioning is involved:

• Process design update.
• App version update.
• App export/import.

Application version

In Joget, an application's version encompasses all its components and configurations at a specific time. This holistic snapshot includes the process designs, forms, data lists, user views, and application properties. Each application version ensures that all these elements are managed and maintained consistently.

Coverage of application version

In Joget, an application's version encompasses all its components and configurations at a specific point in time.

Updating application version

Updating the application version will not affect any instances of the running process. When you create a new version of the existing app, the current version is cloned to a new version number with all its components and configurations. Note that only one version can be published at any time, and end users will only interact with the published version.

These are the instances when the process version will change. 

• Create a new version of the existing app version.
  
  The current app version selected will be cloned (process, form, datalist, userview and properties, including default plugin properties, message bundles, and environment variables ) to the following available version number.

• Import of App.
  

Process version

Process versions are specific to each app version, and changes are managed to process designs.

Inside an app version, it contains process design, but process design has its version called process version.

Determine the current process version

Click the Show Additional Info link under each process in the processes tab to reveal the Process Definition ID. The process version is between the 2 hashes.

Coverage of application version

The application version in Joget covers all essential components required for the app's functionality. Each component is versioned under the application version to ensure consistency and manageability.

Updating process version

These are the instances when the process version will change.

• Process design update via deployment from Process Builder or uploading a .xpdl definition file.
• Import of App.

When one of the above occurs, Joget Workflow will find the next available process version and assign it to it.

For example, in the table above, upon process design update via process builder, the process version will now turn to 2 from 1.

In some cases, one may perform a process design update on an older app version even though there's a newer app version in place, as illustrated in the table below.

In this case, app version 1 will now hold process version 3, not 2.

Finding the app version of the process version

In the Monitor Apps section, one can navigate to the process instance view and click the Process Name link to lead to the designer console of the app version. From the screenshot below, this particular instance is of process version 3 and belongs to app version 2.

Access of Forms

Forms associated with process instances are tied to the app version where the process started, regardless of published versions. To manage form access correctly:

• Published Version: This does not affect access to forms used by process instances. Do not remove an app version in a production server if process instances run out.
• Form Cloning: Clone forms from previous app versions to maintain access and visibility within the current app version.
• Resolution: To ensure the correct form is displayed:
  • Clone forms from earlier versions.
  • Use hidden fields to indicate the originating app/process version.
  • Create CRUD userview menus with version filters for clarity.

For example, in the table and screenshot below, 123_expenseclaim_process1 will show forms mapped according to their activity mappings under app version 1, regardless of whether app version 1 or 2 is published.

On the other hand, 124_expenseclaim_process1 will show forms from app version 2.

By accessing the form record created by a process instance of a different app version, you may not see the exact form used during the process instance flow process. As such, you can clone the form from the originating app version into the current app version you are working on to gain access to the very form used during the process flow.

For example, the screenshot below shows a form with 3 fields in a process instance assignment. Remember that the form used for this process instance originates from the app version the process instance started in.

For the same record row, when viewed in a CRUD userview menu, there's an extra field given that a field has been added to the form in the current published version.

To resolve the possible confusion and display the correct form intended for the record row, the following actions can be taken:-

1. Copy the form from the earlier app version into the published one.
2. Identify the app/process version from which each record originates by adding a hidden field in the form using the appropriate hash variable (e.g., #assignment.processVersion#).
3. Create a CRUD userview menu for each specific app/process version with a version filter in place for each app/process version.

import org.joget.apps.app.model.AppDefinition;
String appVersion = appDef.getVersion().toString();