Please rate how useful you found this document: 
Average: 5 (1 vote)

Overview

This document provides guidance to upgrade to ProcessMaker 3.2.2 from an older ProcessMaker version. Read this document carefully before beginning to upgrade to ProcessMaker 3.2.2.

ProcessMaker is here to help. If you need technical assistance or would like to request a Professional Services engagement, please submit a support ticket: http://bugs.processmaker.com/login_page.php. If you are upgrading from ProcessMaker 1.x, Professional Services must perform the upgrade for you.

Prerequisites for the Upgrade

Ensure the following prerequisites are met as you prepare to upgrade:

  • Determine how to prepare a ProcessMaker test environment based on whether your current ProcessMaker production server meets ProcessMaker 3.2.2 supported stack requirements. Review version 3.2.2 stack requirements.

    • Current production environment meets ProcessMaker 3.2.2 supported stack requirements.

      Action: Create a test environment that is a clone of your current production server that includes all core files and data.

    • Current production environment does not meet ProcessMaker 3.2.2 supported stack requirements.

      Action: Create a test environment that meets ProcessMaker 3.2.2 supported stack requirements. Then, copy your current production server, including all core files and data, to the test environment.

  • ProcessMaker Support requires remote access to the both the current production server and the new test environment either through a VPN or any Remote Assistance Tool, to perform the upgrade in the new test environment.

Upgrade Road Map

The Upgrade Road Map, shown below, depicts steps to upgrade to ProcessMaker 3.2.2:

  • Upgrading from 1.6.x or older: ProcessMaker Professional Services must perform the upgrade to version 3.2.2 for you. This upgrade path is not supported.
  • Upgrading from version 2.0 or 2.0.4.x: Your upgrade path involves these ProcessMaker versions:
    • Version 2.5.0.x
    • Version 2.5.2.x
    • Version 3.2.2
  • Upgrading from version 2.8 or 2.9: Your upgrade path is direct to version 3.2.2.
  • Upgrading from 3.0.x or 3.1.x: Your upgrade path is direct to version 3.2.2.

Plan Your Upgrade with ProcessMaker Support

Use the schedule template below to plan your upgrade path to ProcessMaker 3.2.2. Outline each step that must occur on the upgrade path through each ProcessMaker version until ProcessMaker 3.2.2 is installed in the test environment. After each upgrade is completed, this template becomes an audit that documents each upgrade.

Download a PDF of this template here.

Schedule Template to Upgrade the Test Environment
Task Task Responsibility Completion Time (Hours) Task Description Date Completed
1 Deploy the new test environment with a supported OS Customer Verify that the new test environment uses a supported operating system.
2 Install the Supported Stack (Apache, PHP and MySQL) ProcessMaker Support If the new test environment does not have a supported stack, install the appropriate ProcessMaker 3.2.2 stack.
3 Backup Creation Customer and ProcessMaker Support Back up the core files.
4 Database backup creation Customer and ProcessMaker Support Backup the database files.
5 Additional Setup ProcessMaker Support Restore the connection hash and service settings.
6 Standard upgrade procedure ProcessMaker Support Run the standard upgrade procedure. Any issue found during this procedure needs to be documented in a new row below this one with all the details how to fix it.
7 Test all basic functionalities ProcessMaker Support Test all basic functions in the new test environment.
8 Customer functional tests Customer The CUSTOMER needs to test all the processes and custom plugins to ensure correct functionality.

Note: Each issue found that ProcessMaker Support is to fix must be documented in a new row of this table before continuing to upgrade to the next ProcessMaker version.

Template to Document Steps to Upgrade the Production Server

Use the template below for the following purposes:

  • Document a consolidated list of all steps and hours involved to perform your entire upgrade path in the test environment. Update this list after each upgrade to complete until ProcessMaker 3.2.2 is installed in the test environment.
  • Meticulously document any issues discovered on the test server during the upgrade path. Include extra settings required to fix each issue before starting the upgrade path on the production server.

Download a PDF of this template here.

Steps to Upgrade the Production Server
Step Task Description Task Responsibility Completion Time (Hours) Comments (Including ProcessMaker Version)

ProcessMaker Support Recommendations

ProcessMaker Support strongly recommends to follow these recommendations:

  1. All the steps in this document must be followed to successfully upgrade to ProcessMaker 3.2.2.
  2. ProcessMaker Support begins each upgrade only after the Customer completes exhaustive functional testing, and then provides approval to continue.
  3. The production environment upgrade must be done only after the test environment upgrade is completed.

Upgrade Standard Procedure

The following sections outline the standard procedure to upgrade from ProcessMaker versions 2.x and 3.x to ProcessMaker 3.2.2 based on these supported operating systems:

Linux

To upgrade to ProcessMaker 3.2.2 on the supported Linux operating system, refer to the section below based on from which ProcessMaker version you are upgrading:

Upgrade from ProcessMaker 2.0.x to ProcessMaker 2.5.0.x

Follow these steps to upgrade from ProcessMaker 2.0.x to ProcessMaker 2.5.0.x:

  1. Copy the processmaker-2.5.0.tar.gz file to the /opt directory.
  2. Overwrite any existing files in the /opt directory: > tar -xzvf processmaker-2.5.0.tar.gz
  3. Configure the permissions for the processmaker directory: > chmod -R 770 processmaker/
  4. Configure the owner of the files within the processmaker directory: > chown -R apache:apache processmaker/
  5. Change to the processmaker directory: > cd processmaker
  6. Run the processmaker script to upgrade the database as well as repair the database structure: > ./processmaker database-upgrade
  7. Upgrade ProcessMaker files, the ProcessMaker database, and the translation files as described at ProcessMaker Command: > ./processmaker upgrade

    Note: If you are upgrading from ProcessMaker Community edition 2.x or later to ProcessMaker Enterprise edition 3.2.2, perform the following command to migrate your cases from the Community edition to the upgraded Enterprise edition: > ./processmaker migrate-new-cases-lists

  8. Flush the cache: > ./processmaker flush-cache

Upgrade from ProcessMaker 2.5.2.x or later to ProcessMaker 3.2.2

This section describes how to upgrade from the following ProcessMaker versions:

  • 2.5.2.x
  • 2.8
  • 2.9
  • 3.0.x
  • 3.1.x
  • 3.2

Refer to the following sections to upgrade from ProcessMaker 2.5.2.x or later to ProcessMaker 3.2.2:

Before Upgrading to ProcessMaker 3.2.2

Before upgrading to ProcessMaker 3.2.2, run the following query in the database to which ProcessMaker will be upgraded:

UPDATE CONTENT SET CON_VALUE = 'none' WHERE CON_CATEGORY = 'WEE_DESCRIPTION' AND CON_LANG = 'en' AND CON_VALUE = '';
UPDATE CONTENT
SET CON_VALUE = 'untitled'
WHERE CON_CATEGORY IN ('WEE_DESCRIPTION', 'WEE_TITLE', 'DYN_TITLE', 'OUT_DOC_TITLE', 'REP_TAB_TITLE', 'TRI_TITLE') AND CON_VALUE = '' AND CON_LANG = 'en';
Steps to Upgrade to ProcessMaker 3.2.2

Refer to the following sections to upgrade to ProcessMaker 3.2.2 using these supported databases:

Upgrade to ProcessMaker 3.2.2 with Apache

Follow these steps to upgrade to ProcessMaker 3.2.2 with Apache:

  1. Copy the processmaker-3.2.2.tar.gz file to the /opt directory.
  2. Overwrite any existing files in the /opt directory: tar -xzvf processmaker-3.2.2.tar.gz
  3. Configure the permissions for the processmaker directory: chmod -R 770 processmaker/
  4. Enter the directory: cd /opt/processmaker
  5. Give permission access to the following files: chmod -R 775 bootstrap bootstrap/cache config framework cd thirdparty/html2ps_pdf/ chmod -R 775 cache/ out/ temp/
  6. Configure the owner of the files within the processmaker directory: chown -R apache:apache processmaker/
  7. Change to the processmaker directory: cd processmaker
  8. Upgrade ProcessMaker files, the ProcessMaker database, and the translation files as described at ProcessMaker Command: su -s /bin/sh apache -c "./processmaker upgrade WORKSPACE"
  9. Flush the cache: su -s /bin/sh apache -c "./processmaker flush-cache WORKSPACE"
  10. Note: If you are upgrading from ProcessMaker Community edition 2.x or later to ProcessMaker Enterprise edition 3.2.2, perform the following command to migrate your cases from the Community edition to the upgraded Enterprise edition: su -s /bin/sh apache -c "./processmaker migrate-new-cases-lists"

Upgrade to ProcessMaker 3.2.2 with NGINX

Follow these steps to upgrade to ProcessMaker 3.2.2 with NGINX:

  1. Copy the processmaker-3.2.2.tar.gz file to the /opt directory.
  2. Overwrite any existing files in the /opt directory: tar -xzvf processmaker-3.2.2.tar.gz
  3. Configure the permissions for the processmaker directory: chmod -R 770 processmaker/
  4. Change to the processmaker directory: cd /opt/processmaker
  5. Give permission access to the files: chmod -R 775 bootstrap bootstrap/cache config framework cd thirdparty/html2ps_pdf/ chmod -R 775 cache/ out/ temp/
  6. Configure the owner of the files within the processmaker directory: > chown -R nginx:nginx processmaker/
  7. Change to the processmaker directory: cd processmaker
  8. Upgrade ProcessMaker files, the ProcessMaker database, and the translation files as described at ProcessMaker Command: su -s /bin/sh nginx -c "./processmaker upgrade WORKSPACE"
  9. Flush the cache: su -s /bin/sh nginx -c "./processmaker flush-cache WORKSPACE"
  10. Note: If you are upgrading from ProcessMaker Community edition 2.x or later to ProcessMaker Enterprise edition 3.2.2, perform the following command to migrate your cases from the Community edition to the upgraded Enterprise edition: su -s /bin/sh nginx -c "./processmaker migrate-new-cases-lists"

Windows

To upgrade to ProcessMaker 3.2.2 on the supported Windows operating system, refer to the section below based on from which ProcessMaker version you are upgrading:

Upgrade from ProcessMaker 2.x to ProcessMaker 2.5.0.x

Follow these steps to upgrade from ProcessMaker 2.x to ProcessMaker 2.5.0.x:

  1. Copy the processmaker-2.5.0.tar.gz file to c:/opt directory.
  2. Extract processmaker-2.5.0.tar.gz to the /opt directory.
  3. Go to the c:/opt/processmaker directory: cd c:\opt\processmaker
  4. Run the processmaker script to upgrade the database as well as repair the database structure: php -f processmaker database-upgrade
  5. Upgrade ProcessMaker files, the ProcessMaker database, and the translation files as described at ProcessMaker Command: php -f processmaker upgrade

    Note: If you are upgrading from ProcessMaker Community edition 2.x or later to ProcessMaker Enterprise edition 3.2.2, perform the following task to migrate your cases in the Community edition to the upgraded Enterprise edition: > ./processmaker migrate-new-cases-lists

  6. Flush the cache: php -f processmaker flush-cache

Upgrade from 2.5.2.x or later to ProcessMaker 3.2.2

This section describes how to upgrade from the following ProcessMaker versions:

  • 2.5.2.x
  • 2.8
  • 2.9
  • 3.0.x
  • 3.1.x
  • 3.2

Refer to the following sections to upgrade from ProcessMaker 2.5.2.x or later to ProcessMaker 3.2.x:

Before Upgrading to ProcessMaker 3.2.2

Before upgrading to ProcessMaker 3.2.2, run the following query in the ProcessMaker database that will be upgraded:

UPDATE CONTENT SET CON_VALUE = 'none' WHERE CON_CATEGORY = 'WEE_DESCRIPTION' AND CON_LANG = 'en' AND CON_VALUE = '';
UPDATE CONTENT
SET CON_VALUE = 'untitled'
WHERE CON_CATEGORY IN ('WEE_DESCRIPTION', 'WEE_TITLE', 'DYN_TITLE', 'OUT_DOC_TITLE', 'REP_TAB_TITLE', 'TRI_TITLE') AND CON_VALUE = '' AND CON_LANG = 'en';
Steps to Upgrade to ProcessMaker 3.2.2

Follow these steps to upgrade to ProcessMaker 3.2.2:

  1. Copy the processmaker-3.2.2.tar.gz file to c:/opt directory.
  2. Extract processmaker-3.2.2.tar.gz to the /opt directory.
  3. Go to the c:/opt/processmaker directory: cd c:\opt\processmaker
  4. Run the processmaker script to upgrade the database as well as repair the database structure: php -f processmaker database-upgrade
  5. Upgrade ProcessMaker files, the ProcessMaker database, and the translation files as described at ProcessMaker Command: php -f processmaker upgrade

    Note: If you are upgrading from ProcessMaker Community edition 2.x or later to ProcessMaker Enterprise edition 3.2.2, perform the following task to migrate your cases in the Community edition to the upgraded Enterprise edition: > ./processmaker migrate-new-cases-lists

  6. Flush the cache: php -f processmaker flush-cache

Contact Us

If you would like to request support, provide feedback, and/or report an issue, please go to http://bugs.processmaker.com.