Documentation

Bpm'online update guide from 7.10.2 to 7.10.3
PDF

The new version of bpm'online enhances user experience, enables you to use new features and improves system stability. Therefore, it is important to use the latest version of bpm'online.

This update manual is designed for users of bpm'online 7.10.3. Please note that the update process must be performed consistently and only between adjacent versions, i.e. to update bpm'online from version 7.10.1 to 7.10.3, you must first update to version 7.10.2.

Only the “Default” workspace will be updated. To save all information from the other workspaces, please move them to the “Default” workspace before updating.

How to update

We recommend updating in two stages:

1. First update on a pre-production site with a copy of the current database

2. If the first stage was completed successfully, update the production version of the application.

Attention!

Update of the production version should not be carried out during business hours, as the site will be unavailable.

The update process consists of the following steps:

1. Create a copy of the database of the production site, which will be required to deploy the pre-production site.

2. Create a new pre-production site in IIS. Application deployment is described in a separate article.

3. Install the update on a pre-production site.

4. Verify the test site. If the primary and frequently used functions run without errors, then you can begin updating the production site.

5. Stop the production version of the application.

6. Create copies of the database and application. You will need them to return to a working version in case of problems.

7. Install the update to the production version.

8. Run the website and verify that the updated version is operational.

Attention!

If the update process has failed, stop the procedure and contact the customer support.

Creating database backup

Production application database backup is required not only to return to the working site version in case of an update problem, but also to create a test site.

1. Run Microsoft SQL Server Management Studio.

2. Select the [Back Up] command under the [Tasks] section of the context menu of the application database catalog.

3. Specify the name of the database copy and the directory in which the backup will be created. Click the [OK] button to start the backup process (Fig. 2).

Fig. 2 Creating database backup

scr_setup_database_backup.png 

Note

Make sure the directory for the database backup copy already exists The SQL server has no rights to create catalogs.

When updating the bpm’online production version, we recommend creating a copy of the application using any file manager.

To open a database backup:

1.Log in to Microsoft SQL Studio.

2.Create a new database if you need to extract only certain data from the backup, or select an existing database if you need to restore all data.

3Select the [Restore database] command in the right-click menu of the database.

4.Specify path to the backup file in the opened window.

5.Click [OK] and wait for the restoration process to complete. More information is available in a separate article.

Installing updates

To install the update:

1.Delete current bpm'online files from the production site catalog;

2.Unzip the new bpm'online files to the site catalog;

Note

Use 7-Zip, WinRAR or WinZIP to unpack the files.

3.Open ConnectionStrings.config located in the bpm’online root folder using any text editor. Specify the appropriate server name and database name and connection parameters for the Redis server.

4.Open the WorkspaceConsole catalogue. In our case, it can be found here:
[Bpm’online root directory path]\Terrasoft.WebApp\DesktopBin\WorkspaceConsole\.

5.Run command prompt as an administrator, use it to open the WorkspaceConsole folder and execute one of the .bat files, depending on the type of your OS:

PrepareWorkspaceConsole.x64.bat for x64 version

PrepareWorkspaceConsole.x64.bat for x86 version

As a result, additional files will be copied to the WorkspaceConsole catalog from the ...\Terrasoft.WebApp\bin\ and ...\Terrasoft.WebApp\DesktopBin\WorkspaceConsole\x64\ (or \x86\).

6.Edit Terrasoft.Tools.WorkspaceConsole.exe.config that shares folder with WorkspaceConsole:

In the <connectionStrings> section, specify the connection parameters that are used in the ConnectionStrings.config configuration file;

In <db> section, set connectionStringName="db".

7. Download and extract the 7.10.3 update files here.

Attention!

The update needs to be performed consistently and only between adjacent versions.

8.Extract the InstallPackages folder from the archive to the WorkspaceConsole folder (...\Terrasoft.WebApp\DesktopBin\WorkspaceConsole) of the application.

Attention!

The absolute path to the InstallPackages directory must not be longer than 260 characters.

Attention!

Update your .NET to version 4.6.2 before running bpmOnlineUpdaterCLI.exe. If you do not update your .NET version, bpmOnlineUpdaterCLI.exe will close after first SQL operations and will not compile your configuration. In this case, bpm'online will display an error that configuration version (7.10.2) does not match code version (7.10.3).

9.In the extracted folder, locate and run bpmOnlineUpdaterCLI.exe that will update the connections and packages in the database. During the execution, a number of commands will be run sequentially. After the completion of each command, press [Enter] and wait for the process to complete.

Stopping the site

To avoid data loss, we recommend you to stop the production website before upgrading. This step is not relevant when working with the test site.

1.Open the Internet Information Services Manager (IIS).

2.Stop the web site using the [Stop] command in the [Actions] area (Fig. 1).

Fig. 1 Stopping a website in IIS

scr_user_upgrade_instruction_site_start.png 

Verifying website operation

After updating bpm'online, you need to verify the website:

1.Open the Internet Information Services Manager (IIS).

2.Start the web site using the [Start] command in the [Actions] area.

3.Open the test site with the help of the [Browse] command in the [Actions] area (Fig. 3).

Fig. 3 — Opening test website in a web browser

scr_user_upgrade_instruction_test_site_browse.png 

4.Test the bpm'online application and the implementation of the basic and frequently used operations.

5.If everything works properly, you can delete the backup application and database.

Enjoy the new version of bpm'online!