ProcessMaker Distribution

ProcessMaker releases/fixes are distribute in three different ways, each one is generated from a specific branch for the release.

Official Release

An Official Release is a major release that includes substantial changes made to ProcessMaker. It is distributed as a full, standalone product build and includes improvements of all previous official releases and hotfixes.

  • New features.
  • Improvements.
  • Bug fixes.
  • Security fixes.
  • Major changes.
  • Changes in database schema.

Distribution:

Official Releases are publicly released and can be found at ProcessMaker's SourceForge page.

Installation:

Official Releases can be installed by:

  • Making a brand new installation.
  • Overwriting a previous official release with or without hotfixes applied. For this, please read the Upgrading ProcessMaker page.

Versioning:

The new generated Release follows the version number scheme defined in Semantic Versioning.

Considerations:

Take into consideration the following:

  • Official Releases may include backward incompatible changes that are described on the releases notes of each version.
  • An Official Release may affect the Minor or Patch number of the release (MAJOR.MINOR.PATCH, see Semantic Versioning page for more information).

Hotfix

A Hotfix is a cumulative package generated over a previous "Official Release" and created based on customer requests. Hotfixes are incremental and include the improvements of previous Hotfixes and Patches. These improvements may include:

  • New features.
  • Bug fixes.
  • Security fixes.
  • Changes in database schema.

However, major changes (non backward compatible changes) are not included.

Distribution:

Hotfixes are distributed / communicated only to current customers.

Installation:

Hotfixes must be installed over a base Official Release. For this, read the How to install a Hotfix section.

Versioning:

Hotfixes may affect the Minor or Patch number of the release (MAJOR.MINOR.PATCH, see Semantic Versioning page for more information).

Patch

A Patch is designed to update the "Official Release" with improvements. These are created based on a customer request and are released between Hotfixes.

Patches are generated over previous released Official Releases and Hotfixes, are incremental and include improvements of previous patches. These improvements include:

  • New features.
  • Bug fixes.
  • Security fixes.

However, Patches do not include:

  • Database schema changes.
  • Major changes (Non backward compatible changes).

Distribution:

Patches are distributed only to clients that requested an specific bug fix or urgent feature.

Installation:

Patches must be installed over a base Official Release + Hotfixes. For this, read the How to Install a Hotfix or a Patch section and follow the instructions.

Versioning:

Patches are named with the "Patch" word and the correlative number of patch in the metadata part of the version. For example: ProcessMaker v3.1+patch1, v3.1+patch2, etc (Visit the Semantic Versioning page for more details).

How to Install a Hotfix / Patch

Hotfixes and Patches are applied with the hotfix-install line command accompanied by the database-upgrade command because of possible changes into the database schema.

Before installing, make sure that the hotfix or patch .tar file is placed at: INSTALL-DIRECTORY > opt > processmaker > shared > hotfixes.
Otherwise, when installing the following error message will display:

Installation on Linux

Once placed the .tar file, open a terminal as a root user and navigate to where ProcessMaker is installed. For example:

cd INSTALL-DIRECTORY/opt/processmaker

Then, enter the following command to install the Hotfix / Patch:

./processmaker hotfix-install Filename.tar

The installation of the Hotfix / Patch will begin:

Once the installation is done, use the upgrade command to update the database and file locations for the new version.

./processmaker upgrade

The system will begin to check the integrity of the ProcessMaker files.

If the integrity check fails, the process will ask the user if he/she wants to continue with the upgrade process. Answer "Y" to continue.

Finally, use the processmaker database-upgrade command:

./processmaker database-upgrade

This command will check if changes have been done to the database schema.

Once finished, to review if the ProcessMaker version has been upgraded, login into ProcessMaker and open the "Admin" tab, then go to "System Information" under "Settings".

Installation on Windows

Once placed the .tar file, open the Command Prompt (found at Start > All Programs > Accessories > Command Prompt) and navigate to where ProcessMaker is installed. For example:

cd INSTALL-DIRECTORY\opt\processmaker"

Install the Hotfix/Patch with the following command:

php.exe -f processmaker hotfix-install filename.tar

In the following example, the Hotfix file is named "Hotfix-2.8.0.4.tar".

Once the installation is done, use the upgrade command to update the database and file locations for the new version.

php.exe -f processmaker upgrade

The command will check the integrity of the ProcessMaker files:

If the integrity check fails, the process will ask the user if he/she wants to continue the upgrade process. Answer "Y" to continue.

Finally, upgrade the database schema with the command database-upgrade.

php.exe -f processmaker database-upgrade

To review if the ProcessMaker version has been upgraded, login into ProcessMaker and open the "Admin" tab, then go to "System Information" under "Settings". The ProcessMaker version should have been changed with the number of the Hotfix / Patch installed.