Documentation

bpm'online sales enterprise
PDF

Installing bpm’online application

To install bpm'online the following components are required:

1.MS SQL Server 2012 SP3 or Oracle Database 11g Release 2 or higher

2.Microsoft .Net Framework 4.6.2 or higher – for bpm'online version 7.11.0, Microsoft .Net Framework 4.7 or higher – for bpm'online version 7.11.1 or higher;

3.IIS 7 or higher

4.Redis Server 3.0 or 3.2.

To deploy bpm'online on-site application, do the following:

Install and/or enable required Windows components.

Install the Redis server.

Deploy the database.

Modify the ConnectionStrings.config file.

Create and sett up application website using IIS.

Note that deploying of the bpm’online on-site is different for MS SQL Server 2012 SP3 and Oracle Database 11g Release 2.

Note

MS SQL Server (or Oracle Database 11g) and SVN server deployment procedure is covered in the documentation of these products.

Attention

It is not recommended to unpack files using the built-in Windows archiver. Use 7-Zip, WinRAR or WinZIP instead.

Contents

Deploying the bpm’online database

Redis Server installment

Setting up the ConnectionStrings.config file

web.config configuration(Oracle only)

Checking Windows mandatory components

Creating and setting up application website using IIS

See also

Bpm’online setup FAQ

Deploying the bpm’online database

Deploy the bpm'online database on an SQL server by restoring it from a backup copy file that is located in the application folder. The process is different for MS SQL Server and Oracle Database. You can also use a backup copy of an existing bpm’online database if you are deploying a website for development or testing environment. The process of creating a MS SQL Server DB backup is described in a separate article.

Deploying the MS SQL Server DB

To restore a database:

1.Log in to Microsoft SQL Server Management Studio.

2.Click the [Databases] catalog and select the [Restore Database] option from the context menu (Fig. 550).

Fig. 550 Selecting database backup command

scr_setup_restore_database.png 

3. In the [Restore Database] window:

a.Specify the name of the database in the [Database] field;

b.Specify the [Device] checkbox and specify the path to the database backup copy file. By default, the backup file is supplied together with bpm’online executable files and is located in the “~\DB” folder (Fig. 551).

Fig. 551 Selecting database backup

scr_setup_restore_database_data.png 

4.Go to the [Files] tab. In the [Restore the database files as] area, specify the paths and the names of the database files (Fig. 552). Specify the paths to the TS_Data.mdf and TS_Log.ldf database files.

Attention

It is required to create a folder that will be used for database files restoring beforehand, as the SQL Server may not create directories.

Fig. 552 Specifying the names and paths to TS_Data.mdf and TS_Log.ldf files.

scr_setup_restore_database_options.png 

5.Click the [OK] button and wait for the database restore process to be finished.

Deploying the bpm’online database

Download and unzip the archive with the SQL scripts that are used to deploy the database from the Oracle dump file.

To deploy the  database:

1.Open the CreateUser.sql and RecompileSchema.sql scripts in the editor and modify the following macros:

YOUR_SCHEMA_NAME – schema name

YOUR_SCHEMA_PASSWORD – schema password

\\your_server.com\Share – path to the backup (.dmp file).

Note

By default the Oracle DB backup file is located in the ~\db folder with the bpm’online executable files. If the backup file is located not on the Oracle server, it should be located in the network folder with general access.

2.Open the backup file in the text editor, find and save the name of the used schema located before the “.SYS_EXPORT_SCHEMA” record (Fig. 553).

Fig. 553 The schema name in the backup file

chapter_setup_oracle_find_schema_name.png 

3.Remove the modified scripts on the Oracle server. To create a new schema, execute the following command from the folder with the scripts:

sqlplus.exe "SYS/SYS_PASSWORD@your_server.com:1521/YOUR_SERVICE_NAME AS SYSDBA" @CreateUser.sql

SYS_PASSWORD – a password for authorization on the Oracle server

your_server.com – network address of the Oracle server

YOUR_SERVICE_NAME – Oracle service name.

1.Perform DB backup import  in the created schema:

impdp "YOUR_SCHEMA_NAME/YOUR_SCHEMA_NAME@//your_server.com:1521/BPMBUILD"
REMAP_SCHEMA=ORIGINAL_SCHEMA_NAME:YOUR_SCHEMA_NAME
DIRECTORY=BACKUPDIR DUMPFILE=filename.dmp NOLOGFILE=YES

YOUR_SCHEMA_NAME – the name of the schema specified in the CreateUser.sql

your_server.com – network address of the Oracle server

ORIGINAL_SCHEMA_NAME – the name of the schema from the backup file (step 2).

Note

The sqlplus and impdp utilities are installed with the Oracle server.

1.Consistently run:

sqlplus.exe "YOUR_SCHEMA_NAME/YOUR_SCHEMA_PASSWORD@your_server.com:1521/YOUR_SERVICE_NAME"
@tspkg_UtilitiesGlobalTypes.sql

sqlplus.exe "YOUR_SCHEMA_NAME/YOUR_SCHEMA_PASSWORD@your_server.com:1521/ YOUR_SERVICE_NAME"
@RecompileSchema.sql

Redis Server installment

Redis Server is installed from a setup file.

Run the redis-server.exe file to start Redis Server setup. During the installation, a number of commands will be run sequentially. After the completion of each command, click [Next] and wait for the process to complete.

Start the Redis Server after the installation. To do this, go to the menu [Control Panel]-[Administrative Tools]-[Services] or enter "Services.msc" in the command line (Fig. 554).

Fig. 554 Redis Server service start window

scr_setup_start_redis_server.png 

Setting up the ConnectionStrings.config file

Setting the ConnectionStrings.config configuration file are different for the MS SQL Server and Oracle Database.

Setting the ConnectionStrings.config for the MS SQL Server

1.Edit the ConnectionStrings.config file that is located in the root folder of bpm'online. Specify the connection parameters (connectionString) for the restored database (name=”db”) and Redis Server (name=”redis”).

<?xml version="1.0" encoding="utf-8"?>
<connectionStrings>
<add name="db" connectionString="Data Source=TSW\MSSQL2014;
Initial Catalog=7.10.2.1416_SalesEnterprise_Demo;
Persist Security Info=True; MultipleActiveResultSets=True;
Integrated Security=SSPI; Pooling = true; Max Pool Size = 100; Async = true" />
  <add name="redis" connectionString="host=[Computer name];db=[Redis DB number];port=6379;
maxReadPoolSize=25;maxWritePoolSize=25" />
 <add name="reports" connectionString="XpoProvider=MSSqlServer;
Data Source=TSW\MSSQL2014;Initial Catalog=7.10.2.1416_SalesEnterprise_Demo;
Integrated Security=SSPI" />
 <add name="defRepositoryUri" connectionString="" />
<add name="defWorkingCopyPath" connectionString="%TEMP%\%WORKSPACE%" />
 <add name="defPackagesWorkingCopyPath"
connectionString="%TEMP%\%APPLICATION%\%WORKSPACE%\TerrasoftPackages" />
 <add name="clientUnitContentPath"
connectionString="%TEMP%\%APPLICATION%\%WORKSPACE%\ClientUnitSrc" />
 <add name="sourceControlAuthPath"
connectionString="%TEMP%\%APPLICATION%\%WORKSPACE%\Svn" />
<add name="elasticsearchCredentials" connectionString="User=gs-es; Password=DEQpJMfKqUVTWg9wYVgi;" />
</connectionStrings>

Attention

The number of Redis db must be unique for each application site.

1.You can see the database server name (Data Source) in the authorization window while connecting to the server using Microsoft SQL Server Management Studio (Fig. 555).

Fig. 555 SQL server authorization window

scr_setup_server_name.png 

2.The (Initial Catalog) database name should match the [Database] field value that you specified when restoring database (Fig. 551).

Setting the ConnectionStrings.config for the Oracle Database

1.Edit the ConnectionStrings.config file that is located in the root folder of bpm'online. Specify the connection parameters (connectionString) for the restored database (name=”db”), the reports (name=”reports”) and Redis Server (name=”redis”).

<?xml version="1.0" encoding="utf-8"?>
<connectionStrings>
 <add name="db" connectionString="Data Source=(DESCRIPTION =
(ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = [Server network
 address])(PORT = 1521))) (CONNECT_DATA = (SERVICE_NAME = [Oracle service
name]) (SERVER = DEDICATED)));User Id=[Schema name];Password=[Schema
password];Statement Cache Size = 300" />
 <add name="redis" connectionString="host=[Computer name];db=[Redis DB
number];port=6379;
maxReadPoolSize=25;maxWritePoolSize=25" />
 <add name="reports" connectionString="XpoProvider=Oracle;Data
Source=(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL =
TCP)(HOST = [Server network address])(PORT = 1521))) (CONNECT_DATA =
(SERVICE_NAME = [Oracle service name]) (SERVER = DEDICATED)));User
 Id=[Schema name];Password=[Schema password];Statement Cache Size = 300" />
 <add name="defRepositoryUri" connectionString="" />
<add name="defWorkingCopyPath" connectionString="%TEMP%\%WORKSPACE%" />
 <add name="defPackagesWorkingCopyPath"
connectionString="%TEMP%\%APPLICATION%\%WORKSPACE%\TerrasoftPackages" />
 <add name="clientUnitContentPath"
connectionString="%TEMP%\%APPLICATION%\%WORKSPACE%\ClientUnitSrc" />
 <add name="sourceControlAuthPath"
connectionString="%TEMP%\%APPLICATION%\%WORKSPACE%\Svn" />
</connectionStrings>

Attention

The number of Redis db must be unique for each application site.

Specify the server network address, Oracle service name, name of the restored database and password.

web.config configuration(Oracle only)

You will need to configure the Web.config file located in the bpm’online root folder:

1.In the general parameter of the <db> block, change the value of the currentSchemaName attribute to the schema name that is specified in ConnectionStrings.config:

<db>
    <general securityEngineType="Terrasoft.DB.Oracle.OracleSecurityEngine, Terrasoft.DB.Oracle"
executorType="Terrasoft.DB.Oracle.OracleExecutor, Terrasoft.DB.Oracle"
isCaseInsensitive="true" maxAnsiJoinCount="0"
engineType="Terrasoft.DB.Oracle.OracleEngine, Terrasoft.DB.Oracle"
metaEngineType="Terrasoft.DB.Oracle.OracleMetaEngine,
Terrasoft.DB.Oracle"
metaScriptType="Terrasoft.DB.Oracle.OracleMetaScript,
 Terrasoft.DB.Oracle" typeConverterType="Terrasoft.DB.Oracle.OracleTypeConverter,
Terrasoft.DB.Oracle" connectionStringName="db"
binaryPackageSize="1048576" useOrderNullsPosition="true"
 currentSchemaName="[Oracle DB schema name]" maxEntitySchemaNameLength="30" />
</db>

1.Remove the comment from the<system.data> block, check that the version of the library is 4.112.1.2.

<system.data>
       <DbProviderFactories>
           <remove invariant="Oracle.DataAccess.Client" />
           <add name="Oracle Data Provider for .NET"
invariant="Oracle.DataAccess.Client" description="Oracle Data
 Provider for .NET" type="Oracle.DataAccess.Client.OracleClientFactory, Oracle.DataAccess,
Version=4.112.1.2, Culture=neutral, PublicKeyToken=89b483f429c47342"/>
       </DbProviderFactories>
   </system.data>

1.Specify the quartz.dataSource.SchedulerDb.provider key value in the <quartz> block:

<add key="quartz.dataSource.SchedulerDb.provider" value="OracleODP-20" />

1.Save the changes.

Checking Windows mandatory components

Make sure that Web Server IIS and Windows components are installed on the web server before creating and setting up a website.

Component

Component items

Common HTTP Features

Static Content

Default Document

HTTP Errors

HTTP Redirection

Application Development

ASP.Net

.Net extensibility

ISAPI extensions

ISAPI Filters

WebSocket Protocol

Microsoft .Net framework 3.5.1

Windows Communication Foundation HTTP Activation

Windows Communication Foundation Non-HTTP Activation

Microsoft .Net Framework 4.6.2 Advanced Services or higher – for bpm'online version 7.11.0, Microsoft .Net Framework 4.7 Advanced Services or higher – for bpm'online version 7.11.1 or higher (Windows 8, Windows 10, Windows Server 2012, Windows Server 2016).

 

ASP.NET 4.6.2 or 4.7;

WCF services

HTTP Activation

Message Queuing (MSMQ) Activation

Named Pipe Activation

TCP Activation

TCP Port Sharing

Health and Diagnostics:

HTTP Logging

Logging Tools

Request Monitor

Custom Logging

Security

Basic Authentication

Request Filtering

IP and Domain Restriction

To check the availability of the needed components:

1.Enter the “control panel” in the [Start] menu and select the [Control Panel] (Fig. 556).

Fig. 556 The [Control Panel] section in the [Start] menu

scr_setup_main_menu.png 

2.Select the [Programs] option in the opened window (Fig. 557).

Fig. 557 The [Programs] menu

scr_setup_programs.png 

3.From the [Programs and Features] menu, select the [Turn Windows features on or off] option (Fig. 558).

Fig. 558 Selecting the [Turn Windows features on or off] option

scr_setup_turn_windows.png 

4.Select all required components in the [Windows Features] window (Fig. 559).

Fig. 559 Selecting Web Server IIS and Windows components

scr_setup_turn_windows_on.png 

Creating and setting up application website using IIS

To create and set up a website:

1.In the IIS control window, click the [Sites] folder and select the [Add Website] option from the context menu (Fig. 560).

Fig. 560 Creating a website for bpm'online application

scr_setup_add_website.png 

2.Specify the name of the website, the path to the root folder with the bpm’online files, IP address and website port (Fig. 561).

Attention

The following path C:\Inetpub\wwwroot is used by default. If needed, specify your own IP address.

Fig. 561 New website parameters window

scr_setup_add_web_site_parametres.png 

3.In the [Connections] field, click the created website and select the [Add Application] option in the menu (Fig. 562).

Fig. 562 Selecting IIS application adding command

scr_setup_add_application.png 

4.Specify the name of the application "0" in the [Alias] field. Specify the “Terrasoft.WEBApp” directory (Fig. 563).

Fig. 563 The application parameters selection window

scr_setup_add_applications_settings.png 

5.Go to the [Application Pools] section.

6.Select the [BPMonline] pool.

7.Select the [Integrated] mode in the [Managed pipeline mode] field.

8.Specify the Asp.Net - 4.0.30319 version in the [.Net Framework version] field (Fig. 564).

Fig. 564 Applications Pools parameters input window

scr_setup_applications_tool.png 

9.Check if the specified ASP.Net version is allowed. To do this:

a.Go to the ISAPI and CGI Restrictions on the web-server level (Fig. 565).

Fig. 565 Opening ISAPI and CGI Restrictions

scr_setup_isapi.png 

b.Make sure that the [Allowed] status is checked in the [Restriction] field for the used ASP.Net version (Fig. 566).

Fig. 566 Status check for the ASP.Net version used

scr_setup_isapi_allowed.png 

10.Make sure that all the required permissions are active. To do this:

a.Open the Handler Mappings on the server level (Fig. 567).

Fig. 567 Opening the Handler Mappings

scr_setup_handler.png 

b.Select the [Edit Feature Permissions] action in the [Actions] area.

c.Make sure that all the required checkboxes are selected in the [Edit Feature Permissions] window (Fig. 568).

Fig. 568 Checking required parameters in the [Edit Feature Permissions] window

scr_setup_handler_settings.png 

11.Restart the website with the [Restart] command on the [Manage Website] area (Fig. 569).

Fig. 569 [Restart] command at the [Manage Websites] area

scr_setup_restart_website.png 

12.Open the site with the address or use the [Browse] command (Fig. 570). make sure that the authorization page is displayed.

Fig. 570 Selecting the [Browse] command in the website [Actions] area

scr_setup_browse.png 

Note

To log in to a newly deployed application, use the default Supervisor user account. It is highly recommended to change the Supervisor password immediately. Login: Supervisor; Password: Supervisor.

13. To enable Russian language:

Go to the [Languages] section in the system designer.

Select Russian language and click [Open].

Select the [Active] and [Use by default] checkboxes on the opened page. Save the changes.

Note

To enable the language, the user who has run the IIS application pool needs to have access permissions to read, edit and delete application files and content subordinate catalogs (catalog .\Terrasoft.WebApp\conf).

Next

Websockets setup

Switching from HTTP to HTTPS

Setting up additional parameters and integrations

Bpm’online setup FAQ

Did you find this information useful?

How can we improve it?