Bpm'online update guide from 7.14.0 to 7.14.1
PDF

This manual covers the process of updating bpm'online to version 7.14.1. Our team at bpm’online is constantly working to deliver advanced capabilities to automate your sales, service, and marketing processes. Here are the new release notes.

Please note that the update process must be performed consistently and only between adjacent versions, i.e. to update bpm'online from version 7.13.4 to 7.14.1, you must first update to version 7.14.0.

Before you get down to the update, go to the [Configuration] section and consistently perform the [Generate source code for all items] and [Compile all items] actions. If you receive errors during performing these actions, correct them and afterwards start the update.

Note

The process is different for MS SQL Server and Oracle Database.

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. Back up the database and application. You may need 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.

Note

To enable domain-based authentication in bpm’online, transfer Windows authentication settings to the updated application. More information about Windows authentication settings in bpm’online is available in a separate article.

Attention

If the update process has failed, stop the procedure and contact the customer support. Provide the folder with update log: \Terrasoft.WebApp\DesktopBin\WorkspaceConsole\Log.

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.

Creating database backup for MS SQL Server

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 [OK] 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.

3. Select 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.

Creating Oracle Database backup

1. Connect to the Oracle server using the SqlPlus utility.

sqlplus "SYS/SYS_PASSWORD@ORACLE_HOST:ORACLE_PORT/SERVICE_NAME AS SYSDBA"

SYS_PASSWORD – a password for authorization on the Oracle server

ORACLE_HOST – Oracle server address

ORACLE_PORT – Oracle server port

SERVICE_NAME – Oracle service name

2. Execute the following SqlPlus commands:

CREATE OR REPLACE DIRECTORY DIRECTORY_ALIAS AS 'PATH_TO_BACKUP_DIRECTORY';

GRANT READ, WRITE ON DIRECTORY DIRECTORY_ALIAS to BACKUP_SCHEMA_NAME;

DIRECTORY_ALIAS – an alias for the directory where the backup copy will be placed

PATH_TO_BACKUP_DIRECTORY – full path to the directory where the backup copy will be placed

BACKUP_SCHEMA_NAME – name of the schema for which the backup is made.

3. Back up your schema using the expdp utility:

expdp "BACKUP_SCHEMA_NAME/BACKUP_SCHEMA_PASSWORD@//ORACLE_HOST:ORACLE_PORT/SERVICE_NAME" SCHEMAS=BACKUP_SCHEMA_NAME DIRECTORY=DIRECTORY_ALIAS dumpfile=BACKUP_FILE_NAME NOLOGFILE=YES

ORACLE_HOST – Oracle server address

ORACLE_PORT – Oracle server port

SERVICE_NAME – Oracle service name

DIRECTORY_ALIAS – an alias for the directory where the backup copy will be placed

BACKUP_SCHEMA_NAME – name of the schema for which the backup is made.

BACKUP_SCHEMA_PASSWORD – password for the schema for which the backup is made.

BACKUP_FILE_NAME – name of the file where the schema will be exported.

As a result, the expdp utility will create a backup copy of the BACKUP_SCHEMANAME schema with the BACKUP_FILE_NAME in the PATH_TO_BACKUP_DIRECTORY directory.

Deployment of the backup copy is covered in a separate article.

Installing updates

Update requires application setup files for the new bpm'online version.

Attention

Please contact bpm'online support for the proper version of bpm'online application setup files.

To install the update:

1. Delete current bpm'online files from the website catalog. Delete the temporary ASP.NET files:

  • The storage address of the temporary files, which need to be deleted, is specified in the tempDirectory setting (see the “compilation” block of the loader web.config and web.app). This setting is not specified by default.
  • If the tempDirectory setting is not specified, clear the files stored at the following addresses (where %ApplicationName%  is the name of website in IIS):
    • 64 bit
      • %windir%\Microsoft.NET\Framework64\v4.0.30319\Temporary ASP.NET Files%ApplicationName%
      • %windir%\Microsoft.NET\Framework64\v4.0.30319\Temporary ASP.NET Files%ApplicationName%_0
    • 32 bit
      • %windir%\Microsoft.NET\Framework\v4.0.30319\Temporary ASP.NET Files%ApplicationName%
      • %windir%\Microsoft.NET\Framework\v4.0.30319\Temporary ASP.NET Files%ApplicationName%_0

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

Attention

It is not recommended to unpack files using the built-in Windows archiver. The following applications are recommended for unpacking: WinRAR, WinZIP, 7-Zip.

3. Distribute the “Full control” rights to the IIS user for the [Path to root bpm’online catalog]\Terrasoft.WebApp\con and [Path to root bpm’online catalog]\ Terrasoft.WebApp\Terrasoft.Configuration\Pkg catalogs.

4. 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.

5. Open the WorkspaceConsole folder:
[Path to bpm’online root folder]\Terrasoft.WebApp\DesktopBin\WorkspaceConsole\.

6. In the WorkspaceConsole folder, run the .bat file that corresponds to the OS bitness.

PrepareWorkspaceConsole.x64.bat for 64-bit version;

PrepareWorkspaceConsole.x86.bat for 32-bit 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\).

7. 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;

8. Download and extract the 7.14.1 update files:

MS SQL update files

Oracle Database update files

Attention

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

9. 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.

10. In the extracted folder, locate and run bpmonlineUpdater.exe that will update the connections and packages in the database. During the execution, a number of commands will be run sequentially. Please wait for the entire process to complete.

Note

Any errors encountered during the update will be recorded in the log file:
[Path to bpm’online root folder]\Terrasoft.WebApp\DesktopBin\WorkspaceConsole\Log.
In case of errors, please stop all update activities and contact bpm’online support immediately.

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 

Website starting, compilation and verification

After the update process has completed, start the bpm’online website in IIS, compile the application and test the website by opening it in a web browser.

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 

Note

If during login you receive the "Unable to load one or more of the requested types" error, make sure that you install the Microsoft Visual C++ 2010 SP1 Redistributable Package to the web-server (application server PC). You can download it on Microsoft site using the following link.

4. Generate client static content by running the [Compile all items] action in the [Configuration] section.

5. Open the application in a web browser, verify that your routine bpm’online operations are performed correctly.

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

Enjoy the new version of bpm'online!