Upgrading applications

Upgrading an application allows for a new version of a released project to be deployed to an existing application. Tasks and process instances that are in progress and based on a previous application version can still be completed, however any new ones started will use the new model definitions.

Some considerations for upgrading applications to be aware of are that:

  • An application can be upgraded to a released project version that is lower than the one currently deployed, however the application version will still increment.
  • Applications can only be upgraded through the deployment service. This means that if an application was deployed via Helm it cannot be upgraded.
  • UIs will be added and removed between versions based on whether they exist in the project. If only the type is changed and the name remains the same then the type will not be updated between versions.
  • It is not possible to use a different Docker image for any service when upgrading an application except for its connectors.
  • It is not possible to edit or add any variables to services when upgrading an application, except for its connectors.

Versioning logic

The version of an application is incremental and independent of the released project version as shown in the following table:

Released project versionApplication version
11
22
43
54
35
106

Upgrade steps

Use the following steps to upgrade an application in the Administrator Application:

  1. Sign into the Administrator Application.

  2. Select the Upgrade action against an application in the Application Instances tab to upgrade it.

  3. Update the users and/or groups that will have administrator access to the application.

    Note: Users require the ACTIVITI_ADMIN role in order to be assigned as an administrator to an application.

  4. Update the users and/or groups that will have access to the application.

    Note: Users require the ACTIVITI_USER role in order to be assigned as a user to an application.

  5. Configure the details for any existing or new connectors.

    • If you created the connector yourself, this will be the name of the connector and the URL of the image you published.
    • If this is an OOTB connector then the name and image are configured automatically.
  6. Set the connector variables in JSON format. For example, if using the email connector you can set the variables EMAIL_HOST and EMAIL_PORT with the following:

    {"EMAIL_HOST":"https://mysmtp.com","EMAIL_PORT":"8050"}
    
  7. The application infrastructure can't be changed.

  8. Click Upgrade to upgrade the application.

© 2023 Alfresco Software, Inc. All Rights Reserved.