BPMonline On-Site Setup Guide for MSSQL DBMS

Similar documents
BPMonline On-Site Setup Guide

Installation and Deployment Guide for HEAT Service Management

Report Exec Enterprise System Specifications

MYOB Advanced Business

Workspace Administrator Help File

Web Applications Installation. version

Installation Guide for Pulse on Windows Server 2012

Bomgar Vault Server Installation Guide

DefendX Software Control-Audit for Hitachi Installation Guide

Prophet 21 Middleware Installation Guide. version 12.16

DeskAlerts 9 Installation Guide

December P Xerox FreeFlow Core Installation Guide

Web Applications Installation. version 12.17

Getting Started with. Management Portal. Version

INSTALLATION AND SET UP GUIDE

NTP Software File Auditor for Hitachi

PlateSpin Protect 11.2 SP1 Installation and Upgrade Guide. November 2017

System, Environment, & Configuration Requirements for FASTER Web 6.4

Web Suite Time Billing and Business Management Software

Installation on Windows Server 2008

ActiveFlow. Installation Guide. Revision Date: Feb 15, 2011

Teamlab Office Server Community Edition

INSTALLATION AND SET UP GUIDE

GoldMine Connect Installation Guide

User Manual. Admin Report Kit for IIS 7 (ARKIIS)

Ekran System v.5.2 Deployment Guide

Version Installation Guide. 1 Bocada Installation Guide

QualiWare 6.5 System Requirements

This guide details the deployment and initial configuration necessary to maximize the value of JetAdvantage Insights.

Microsoft Windows Servers 2012 & 2016 Families

PageScope Enterprise Suite Ver. 3.1 Installation Guide

Upgrade to Webtrends Analytics 8.5: Best Practices

Workstation Configuration Guide

PREREQUISITES version 3.6

EMS DESKTOP CLIENT Installation Guide

How to transfer data between BPMonline 7.x environments

Workstation Configuration

Sage 200 Extra System Requirements and

NTP Software Defendex (formerly known as NTP Software File Auditor) for NetApp

FORMVERSE TECHNICAL REQUIREMENTS GUIDE & CUSTOMER PRE-INSTALLATION CHECKLIST

HR-Lite Database & Web Service Setup Guide

LABEL ARCHIVE Administrator s Guide

Deltek Costpoint Enterprise Reporting 6.1. Installation Guide for New Users

Installation Guide Savision iq

Installation and Upgrade Guide. Front Office v9.0

Platinum~Pro (v21.0): Deployment Guide (v1.2)

ProKitchenNet User s Guide ProKitchen Server Edition. Real View, LLC

Introduction Chapter 1. General Information Chapter 2. Servers Used... 9

NeuralStar Installation Guide

RMS Monitoring Software System Installation

SOA Software Intermediary for Microsoft : Install Guide

Accops HyWorks v3.0. Installation Guide

Workstation Configuration

Installing or Upgrading ANM Virtual Appliance

Kaseya 2. Installation guide. Version R8. English

Pulse 4.11 SCADA/HMI. Installation Guide

Web Applications Installation. version

Installation and Upgrade Guide. Front Office v8.7


XLmanage Version 2.4. Installation Guide. ClearCube Technology, Inc.

inforouter V8.0 Server & Client Requirements

Sides Colour Coding. Applies to both Xp and Windows 7. Applies to Xp only. Applies to Vista and Windows 7 only

V4.1. CtxUniverse INSTALLATION GUIDE BY ADRIAN TURCAS. INFRALOGIC INC. #412c-1255 Phillips Square, H3B 3G1 MONTREAL, CANADA

INSTALLING LYNC SERVER 2013 EE POOL ON WINDOWS SERVER 2012

F-Secure PSB Getting Started Guide

GoldMine Connect Installation Guide

SplendidCRM Deployment Guide

Print Audit 6. Print Audit 6 Documentation Apr :07. Version: Date:

NTP Software File Auditor for Windows Edition

ElasterStack 3.2 User Administration Guide - Advanced Zone

Scribe Insight Installation Guide. Version August 10, 2011

integreat4tfs Installation Guide

WhatsUpGold. Getting Started Guide

These are the system requirements for DocuWare version 6.7: Upgrade to DocuWare 6.7: DocuWare 5.1c or higher

Deltek Time & Expense with Employee Self Service Version New Installation for Microsoft SQL Sever

Automation Anywhere Enterprise 10 LTS

Connectware Manager Getting Started Guide

CloudShell 7.1 GA. Installation Guide. Release Date: September Document Version: 2.0

Getting Started Guide. This document provides step-by-step instructions for installing Max Secure Anti-Virus and its prerequisite software.

Nuance. PowerMic Mobile. Installation and Administration Guide

Sage 300. Sage CRM 2018 Integration Guide. October 2017

Perceptive TransForm E-Forms Manager 8.x. Installation and Configuration Guide March 1, 2012

Proficy Plant Applications 7.0 Quick Install Guide (And Best Practices)

Bluespring BPM 5. Installation Guide

Ekran System v.6.1 Deployment Guide

Installation Guide. for 6.5 and all add-on modules

Sage 200c Professional. System Requirements and Prerequisites

Sage 200c Professional. System Requirements and Prerequisites

LiNC-NXG for Windows 8 Professional, Windows 7 Professional, Vista Business Edition and XP Professional

Using the SQL CI TeamCity plugin in SQL Automation Pack

LifeSize Control Installation Guide

1. Prerequisites. Page 1 of 29

Ensure that the server where you install the Primary Server software meets the following requirements: Item Requirements Additional Details

Installation Guide Worksoft Analyze

Report Exec Dispatch System Specifications

GARDiS Installation. Install Guide SM007_8. Unit 10 Concept Park Innovation Close Poole Dorset BH12 4QT

Ekran System v.5.5 Deployment Guide

This document lists hardware and software requirements for Connected Backup

Workstation Configuration

SC-T35/SC-T45/SC-T46/SC-T47 ViewSonic Device Manager User Guide

Transcription:

BPMonline On-Site Setup Guide for MSSQL DBMS

1 Contents About This Guide... 2 Server Requirements for BPMonline On-Site Deployment... 3 Client PC Requirements... 7 Recommended Procedure for Session Storage Server Deployment... 8 Deploying BPMonline On-Site Application... 9 Preparing the Database Server, Application Server and Session Storage Server... 9 Preparing the DBMS... 9 ConnectionStrings.config Setup... 11 Creating Application Site on IIS... 12 Licensing BPMonline On-Site... 21 Updating BPMonline On-Site... 24 The Parameters of WorkspaceConsole... 24 Examples of WorkspaceConsole Commands... 27 The Procedure for Package Installation... 29 BPMonline

2 About This Guide This guide describes the BPMonline On-Site version 7.1 deployment procedure. Note The "On-Site" deployment involves hosting the system on the servers of your company. There is an alternative way of deploying the system, which is called "On-Demand". The "On-Demand" deployment provides the operation of the application in the SaaS mode. In the "On-Demand" mode the application is deployed on the BPMonline servers. Basic server requirements, including DBMS and web-server, as well as workstation requirements can be found in Server Requirements for On-Site BPMonline Deployment and Client PC Requirements chapters. The procedure for deploying the Redis server is described in the Recommended Procedure for Session Storage Server Deployment. The step by step BPMonline installation procedure is described in the Installing BPMonline On-Site chapter. Additionally, this guide covers the initial licensing of the BPMonline software, which must be performed after installing the application, as well as tools and procedures for updating already installed BPMonline applications. Note The system requirements and setup procedures for additional third-party software, such as DBMS, are not covered in this guide. Please refer to the documentation of the corresponding products. Note More information about configuring BPMonline can be found in the Customization Guide or BPMonline Help. BPMonline

3 Setup Guide Server Requirements for BPMonline On-Site Deployment The server performance significantly affects the efficiency and overall performance of the application. The better hardware configuration of the server is, the better is the performance of BPMonline. Attention! To work with BPMonline, you will need to deploy four servers: database server, user session server, SVN repository server, and application server. It is recommended that you deploy the servers on different computers. DBMS Server System Requirements Number of Users CPU Frequency, GHz Number of Cores in CPU Number of CPUs, pcs RAM DDR3, GB HDD, number of drives for array organization, pcs HDD, internal interface, type HDD, rotational speed, rpm 10 2 2,53 2 1 4 2 SATA2 7200 20 2.33 2,53 2 4 1 4 8 2 4 SATA2 7200 50 2,33 2,66 2 4 2 8 12 4 6 SATA2\SAS 10000 15000 100 2,66 3,16 4 2 12 16 6 8 SCSI\SAS 15000 200 2,83 3,16 4 4 24 32 12-16 SAS; FC, iscsi Entry-level 300 2,33 2,66 8 4 48 64 16-24 SAS; FC, iscsi Entry-level 500 2,66 2,83 6 8 6 8 96 24-28 SAS; FC, iscsi Entry-level Attention! The hardware configuration, that meets the minimum requirements, guarantees basic operation of BPMonline, but does not ensure good performance. The use of MS SQL Failover Cluster is recommended to ensure resiliency. In this case, please take into account the requirements for storage system and data access, provided by DBMS vendor. The requirements for CPU and HDD resources, provided in the table above, are recommended for the primary servers in the cluster.

Server Requirements for BPMonline On-Site Deployment 4 Application Server System Requirements Number of Users CPU Frequency, GHz Number of Cores in CPU Number of CPUs, pcs RAM DDR3, GB HDD, number of drives for array organization, pcs HDD, internal interface, type HDD, rotational speed, rpm 10 2 2,53 2 1 2 4 20 2,33 2,66 2 4 2 4 6 50 2,66 3,16 4 2 10 12 1 SATA2 7200 10000 100 2,83 3,16 4 2 4 24 200 3,06 3,33 6 4 48 300 2,66 3,33 6 8 6 72 1 2 SATA2 7200 10000 500 2,66 3,33 6 8 8 120 2 4 SATA2\SAS 10000 15000 Note We recommend using 64-bit versions of OS and DBMS. Server Connection System Requirements Number of Simultaneously Working Users Network Bandwidth (MB/s) DBMS Server Application Server Central Switch (Router) 10 50 10 100 10 100 10 100 50 200 100 100 100 200 500 100 1000 100 1000 100 1000 500 and more 1000 1000 1000 Database Server Software Requirements Deploying BPMonline database on DBMS MS SQL requires MS SQL Server 2008 Service Pack 3 or higher. Note Regular backup of BPMonline database on an external storage device is highly recommended. Application Server Software Requirements Operating System: Windows 7; Windows 8; BPMonline

5 Setup Guide Windows Server 2008 / Windows Server 2008 R2 (starting from Web edition); Windows Server 2012. Web-server: Internet Information Services 7; Internet Information Services 7.5; Internet Information Services 8. Additionally:.Net Framework 4.5. Note.NET Framework 4.5 is included in Windows 8 and Windows Server 2012. The.NET Framework 4.5 installer is available at: http://www.microsoft.com/en-us/ download/details.aspx?id=30653. List of Required Web Server IIS and Windows Components Common HTTP Features: Static Content; Default Document; HTTP Errors; HTTP Redirection. Application Development: ASP.NET;.NET Extensibility; ISAPI Extensions; ISAPI Filters. Health and Diagnostics: HTTP Logging; Logging Tools; Request Monitor; Custom Logging. Security: Basic Authentication; Request Filtering; IP and Domain Restrictions; Microsoft.NET Framework 3.5.1: Windows Communication Foundation HTTP Activation; Windows Communication Foundation Non-HTTP Activation. Microsoft.NET Framework 4.5 Advanced Services (Windows 8, Windows Server 2012): ASP.NET 4.5; WCF Services a. HTTP Activation; b. Message Queuing (MSMQ) Activation; c. Named Pipe Activation; d. TCP Activation; e. TCP Port Sharing. User Session Server Software Requirements To ensure seamless operation of the system, the user sessions are stored in a separate database that is deployed on a separate user session server. The Redis database (http://redis.io) is used for storing user sessions.

Server Requirements for BPMonline On-Site Deployment 6 SVN Repository Server Software Requirements To enable committing workspace state to the repository, deploy the SVN server (version 1.6 or higher) and create the data repository that will be specified when installing the application. The SVN server is a free software that can be downloaded on the web. For example, you can use the installer available at: http://downloads-guests.open.collab.net/servlets/ ProjectDocumentView?documentID=6134&showInfo=true BPMonline

7 Setup Guide Client PC Requirements BPMonline does not require local installation on a user PC. Parameters Minimum Requirements Recommended Requirements CPU frequency Pentium IV compatible processor with clock rate of 1,8 GHz, and higher Intel 2 Core compatible processor with clock rate of 2 GHz, and higher RAM 1 GB and higher 2 GB and higher Available hard disc space (HDD) Monitor resolution 100 MB 150 MB and higher 1024х768 or higher Connection Channel The recommended requirement for data channel for client-server connection is 512 Kbps per one user. Operating System Microsoft Windows: Windows XP Service Pack 3; Windows Vista; Windows 7; Windows 8. Mac OS: Mac OS X 10.6 Snow Leopard; OS X 10.7 Lion; OS X 10.8 Mountain Lion. Additional Software One of the following Internet browsers must be installed on the client computer: Internet Explorer, starting with version 8 (version 10 or higher is recommended); Firefox, the latest official version; Chrome, the latest official version; Safari, the latest official version. For correct operation of some functional modules of BPMonline, you have to install Silverlight 4.0 (or higher) browser plugin on each user computer. The browser used to access BPMonline has to support Silverlight.

Recommended Procedure for Session Storage Server Deployment 8 Recommended Procedure for Session Storage Server Deployment It is recommended to deploy the Redis server in such a way that it is launched as a Windows service on the user session storage server. For example, this can be achieved using utilities from the Windows Server 2003 Resource Kit Tools, which you can download using the following link: http://www.microsoft.com/en-us/download/details.aspx?id=17657 Latest version of Redis can be downloaded using the following link: https://github.com/msopentech/redis/archive/2.6.zip The Procedure for Redis Deployment: 1. Download and install Windows Server 2003 Resource Kit Tools (by default, it is installed in C:\Program Files\Windows Resource Kits\Tools\ ). 2. Download latest Redis server redistributable and save its files in the following folder on the session storage server: a. C:\Program Files\Redis\redis-2.6.zip\redis-2.6\bin\release\redisbin.zip - if Redis server OS is 32-bit; b. C:\Program Files\Redis\redis-2.6.zip\redis-2.6\bin\release\redisbin64.zip - if Redis server OS is 64-bit. 3. Install Redis as service in the OS. a. Using the Windows Command Prompt, execute the following command: C:\Program Files\Windows Resource Kits\Tools\srvany.exe Redis C:\Program Files\Windows Resource Kits\Tools\Srvany.exe b. Enter Redis service parameters in the system registry on the session storage server by running the Redis.reg file (located in the BPMonline install folder). 4. Start the Redis service in the list of services in the [Computer Management] window (Fig. 1). Fig. 1 Starting the Redis Service in the Computer Management Window BPMonline

9 Setup Guide Deploying BPMonline On-Site Application The BPMonline deployment process can be divided into the following general steps: 1. Preparing the application server, database server and session storage server. 2. Preparing the DBMS: restoring the database on the MS SQL Server. 3. Deploying the BPMonline application on the application server. Connection strings setup in the ConnectionStrings.config file. 4. Creating an application on IIS. Later in This Chapter Preparing the Database Server, Application Server and Session Storage Server, page 9 Preparing the DBMS, page 9 ConnectionStrings.config Setup, page 11 Creating Application Site on IIS, page 12 Preparing the Database Server, Application Server and Session Storage Server Before deploying BPMonline application, deploy the DBMS and all other required software: 1. Install the MS SQL Server 2008 Service Pack 3 (or higher) on the database server. 2. Install Redis on the user session storage server. Note The procedure for Redis server deployment is described in the Recommended Procedure for Session Storage Server Deployment chapter. 3. Make sure that all required IIS components are installed on the application server. Note The list of required IIS components is provided in the Server Requirements for BPMonline On-Site Deployment chapter. 4. Make sure that.net Framework 4.5 is installed on the application server. 5. Optionally, install SVN server and create a repository for storing configuration changes. See Also Server Requirements for BPMonline On-Site Deployment, page 3 Recommended Procedure for Session Storage Server Deployment, page 8 Preparing the DBMS Restore the BPMonline database from the BAK backup file located in the BPMonline setup folder: 1. Open Microsoft SQL Management Studio, right-click the [Databases] folder and select the [Restore Database] command (Fig. 2).

Deploying BPMonline On-Site Application 10 Fig. 2 Restoring the Database 2. In the opened database restoration parameters window (Fig. 3): Fig. 3 Setting Up the Database Restoration Parameters a. In the [To database] field, enter the database name. b. Select the [From device] option. c. Specify the path to the BAK file containing the database backup. By default, the file is located in the \DB\ sub folder of the BPMonline setup folder. 3. In the left part of the database restoration window, click [Options]. 4. Specify the locations and names of the restored database files (Fig. 4): BPMonline

11 Setup Guide Fig. 4 Restoration Settings for Database Files a. MDF file for the TS_Data file. b. LDF file for the TS_Log file. Note Restore the database files to an existing folder, since MS SQL does not have permission to create directories. 5. Click the [OK] button to run the database restoration process. ConnectionStrings.config Setup Copy the BPMonline setup folder to the \inetpub\ folder on the application server. In the ConnectionStrings.config file specify the database server and session storage server connection strings for the application, another database server connection string for the report designer, and (optionally) SVN server repository location. Editing ConnectionStrings.config 1. Open the ConnectionStrings.config file for editing. The file is located in the setup folder.

Deploying BPMonline On-Site Application 12 2. Specify the database connection parameters for the BPMonline application by replacing the existing <db> tag: <add name="db" connectionstring="data Source=[database server name]; Initial Catalog=[database name]; Persist Security Info=True; MultipleActiveResultSets=True; User ID=[MS SQL Server user name]; Password=[MS SQL Server user password]; Pooling = true; Max Pool Size = 100; Async = true" /> Note Database server name is displayed in the [Server name] field in the SQL Server Management Studio login window. Database name is the name that was specified in the [To database] field during the database restoration. 3. Specify the connection parameters for the user session storage server (the computer where Redis server is deployed). <add name="redis" connectionstring="host=[session storage server name or ip];db=0;port=6379" /> Note One Redis server can be used for multiple separate applications. Each application site must have unique database number (the db parameter). 4. Specify the connection string parameters for the report designer. These parameters are similar to the db parameters: <add name="reports" connectionstring="xpoprovider=mssqlserver;data Source=[database server name];initial Catalog=[database name]; User ID=[MS SQL Server user name]; Password=[MS SQL Server user password];" /> Note When using Windows authentication on the MS SQL Server, replace User ID=; Password= with Integrated Security = SSPI in the database connection strings for both the BPMonline application and the report designer. Also, in this case the Application Pools parameters must be modified in the IIS (described further). 5. Specify the connection string parameters for workspace repository (this step is optional): <add name="defrepositoryuri" connectionstring="[svn repository address in the format: http://#svnserver#:80/#svnrepo#]" /> Creating Application Site on IIS The application website can be deployed on IIS, version 7, 7.5 or 8. 1. Run Internet Information Services manager. 2. Add BPMonline website by clicking the [Add Web Site] in the context menu (Fig. 5). BPMonline

13 Setup Guide Fig. 5 Creating a New Site for BPMonline 3. In the opened window, fill out the parameters of the new website (Fig. 6): Fig. 6 Filling Out the BPMonline Website Parameters a. In the [Site name] field, enter BPMonline. b. In the [Physical path] field, specify the location of BPMonline setup folder. c. In the [IP address] and [Port] fields select the IP addresses used and a port to access the website. 4. Add an application 0 to the website using the [Add Application...] command of the website context menu (Fig. 7).

Deploying BPMonline On-Site Application 14 Fig. 7 Creating an Application for the BPMonline Website 5. In the opened window, fill out the application parameters (Fig. 8): Fig. 8 Filling Out the Application Parameters for BPMonline Website a. In the [Alias] field, specify 0. b. In the [Physical path] field, specify the location of the Terrasoft.WebApp folder. BPMonline

15 Setup Guide 6. In the server tree, select Application Pools. 7. In the list of applications, double-click the BPMonline application (Fig. 9). Fig. 9 Editing Application Pool for BPMonline Application 8. In the opened window, specify the importing parameters (Fig. 10): Fig. 10 Configuring the Application Pool Parameters a. In the [Managed pipeline mode] field, select Integrated. b. In the [.NET Framework version] field, select.net Framework v4.0.30319. 9. Click [Advanced Settings...]. (Fig. 11).

Deploying BPMonline On-Site Application 16 Fig. 11 Editing the Application Pool Parameters 10. In the opened window, change the value in the [Idle Time-out (minutes)] field to 0 (Fig. 12). Fig. 12 Setting Up Idle Timeout 11. Enter the login and password of the user account that the application should use to access MS SQL Server: Attention! This step must be performed if Windows authentication is used for MS SQL Server connection (if instead of MS SQL Server user login and password, Integrated Security = SSPI is specified in the ConnectionStrings.config file). a. Click the [...] button in the [Identity] field to edit this property. b. In the opened window, select the [Custom account] and click the [Set] button. BPMonline

17 Setup Guide c. Enter the login and password of the domain user account that is used by the application to access the MS SQL Server. For example, this can be domain user who has access to MS SQL Server administration (Fig. 13). Fig. 13 Identity Setup for Application Pool 12. Check if the selected ASP.NET version is allowed. To do so, in the [Connections] tree select the server on which BPMonline application is deployed. Open the [ISAPI and CGI Restrictions] item (Fig. 14).

Deploying BPMonline On-Site Application 18 Fig. 14 The [ISAPI and CGI Restrictions] Item 13. In the list of versions for ASP.NET v4.0.30319, in the [Restriction] column, Allowed value must be set (Fig. 15). Fig. 15 Checking if the Selected ASP.NET Version is Allowed 14. If the [Restriction] column contains the Not Allowed value for the ASP.NET v4.0.30319, set permission manually (Fig. 16): BPMonline

19 Setup Guide Fig. 16 Allowing the Use of the Selected ASP.NET Version a. Double-click the ASP.NET v4.0.30319 item. b. In the opened window, select the [Allow extension path to execute]. 15. Check if all needed permissions are set: a. In the [Connections] tree select the BPMonline website. b. Double-click the [Handler Mappings] item (Fig. 17). Fig. 17 The [Handler Mappings] Item c. In the [Actions] area, select [Edit Feature Permissions]. d. In the opened card (Fig. 18) select all checkboxes.

Deploying BPMonline On-Site Application 20 Fig. 18 Checking Feature Function Permissions 16. Restart the website (Fig. 19). Fig. 19 Restarting the Website As a result, when the website is opened in browser, BPMonline login page will be displayed. BPMonline

21 Setup Guide Licensing BPMonline On-Site After installing BPMonline, license the software. To license the product you need to generate the license request file and send it to BPMonline technical support team: support@bpmonline.com. 1. Generating a License Request File: 1. Log in to BPMonline using the default Supervisor user account. You will be prompted to license the software. Note To log in as the default supervisor user, enter Supervisor (without quotes) in both the [User] and [Password] fields. You can change the password of this account later on. Attention! For security reasons we strongly recommend to change the password of the "Supervisor" account after logging in. 2. Click the [License Manager] button (Fig. 20) to open the License Manager. Fig. 20 Opening the License Manager 3. In the [Your Customer ID] field, enter unique customer ID provided to you during the purchase of BPMonline. 4. Click the [Request Licenses] button (Fig. 21). Fig. 21 Generating a License Request File As a result, a license request file will be generated and downloaded.

Licensing BPMonline On-Site 22 5. Send the license request file to BPMonline technical support: support@bpmonline.com. You will receive a similar file (a license key), containing your updated license data. 2. Loading a License Key in the System: 1. Save the license key file sent to you by the technical support. 2. Click the [License Manager] button (Fig. 20) to open the license manager window. 3. In the opened license manager window click the [Upload Licenses] button and specify the path to the license file you received earlier from the technical support team (Fig. 22). Fig. 22 Loading a License Key File to the System As a result, the license data will be updated in the BPMonline system. 4. Go to the [Distributed Licenses] tab. 5. Select the checkbox in the [BPMonline CRM] column for the Supervisor user (Fig. 23). Fig. 23 Granting a License to a BPMonline User 6. Close the license manager window. After completing the licensing you can log in to BPMonline using the Supervisor user account. BPMonline

23 Setup Guide Note For more information about licensing users, please refer to the BPMonline help file. Click the button on the license manager to open the help file.

Updating BPMonline On-Site 24 Updating BPMonline On-Site Updating an already deployed BPMonline application assumes installing packages that can contain both base functionality updates and new functionality (such as integration with third-party applications and services). Package assembly and installation is done with the help of the WorkspaceConsole application. This application is automatically installed on the application server along with BPMonline. The executable file is located in the installation folder of the application:...\terrasoft.webapp\desktopbin\workspaceconsole\terrasoft.tools.w orkspaceconsole.exe Perform the following steps before you start working with WorkspaceConsole: 1. Copy all content from the...\terrasoft.webapp\bin\ folder to the...\terrasoft.webapp\desktopbin\workspaceconsole\ folder or run the PrepareWorkspaceConsole.bat file that will execute this operation automatically. 2. Specify the database connection string ( mssqlsolution ) in the Terrasoft.Tools.WorkspaceConcole.exe.config file (section general, attribute connectionstringname ). The WorkspaceConsole parameter names are not case sensitive. WorkspaceConsole is a command line application. You can use Windows command prompt to enter commands manually or use the BAT files. Later in This Chapter The Parameters of WorkspaceConsole, page 24 Examples of WorkspaceConsole Commands, page 27 The Procedure for Package Installation, page 29 The Parameters of WorkspaceConsole The Windows command line is used for managing WorkspaceConsole. The WorkspaceConsole application can be run with a number of parameters. The WorkspaceConsole commands are entered as follows: Terrasoft.Tools.WorkspaceConsole.exe -param1=value1... - paramn=valuen For example: c:\inetpub\wwroot\bpmonline CRM\Terrasoft.WebApp\WorkspaceConsole>Terrasoft.Tools.WorkspaceCon sole.exe workspacename=default -operation=saveworkspacecontent - contenttypes=repository Also, you can run WorkspaceConsole commands using BAT files. Example of Command for Package Installation: The package Demo needs to be installed on the Default workspace. The package archive is located in the D:\Temp\Packages_7.0.0.103 folder. Temporary files created during the package installation will be saved in the D:\Temp\Packages_7.0.0.103\.temp folder. Terrasoft.Tools.WorkspaceConsole.exe -workspacename=default - operation=installfromrepository - BPMonline

25 Setup Guide sourcepath=d:\temp\packages_7.0.0.103 - destinationpath=d:\temp\packages_7.0.0.103\.temp -packagename=demo The following parameters can be passed to WorkspaceConsole: operation The operation to perform. Required parameter. The following base operations are used: SaveWorkspaceContent saves packages to GZ files that then can be installed on other workspaces (if these workspaces meet the requirements of the installed package) InstallFromRepository installs packages from GZ files on the specified workspace contenttypes username userpassword sourcecontrollogin sourcecontrolpassword repositoryuri workspacename packagename InstallFromSvn installs packages from the repository on the specified workspace Type of data that is saved by the SaveWorkspaceContent operation. Used in the SaveWorkspaceContent operation. Required parameter. To assemble packages, the parameter value must be Repository User name for authentication. Required parameter. Used in the SaveWorkspaceContent operation User password for authentication. Required parameter. Used in the SaveWorkspaceContent operation User name for accessing the SVN repository. Required parameter. Used in the InstallFromSvn operation User password for accessing the SVN repository. Required parameter. Used in the InstallFromSvn operation SVN repository address that is used for storing the package structure and metadata. Optional parameter. The parameter value is used instead of the similar property of the workspace that is specified in the workspacename parameter. Used in the InstallFromSvn, SaveWorkspaceContent operations Workspace name. Required parameter. Used in the InstallFromRepository operation Name of the package (of the workspace specified in the workspacename parameter) for which the InstallFromRepository, InstallFromSvn and SaveWorkspaceContent operations can be executed. The operations shall be executed both for the specified package and the packages they depend on. Optional parameter. If the parameter is not specified, the operation will be executed for all workspace packages

Updating BPMonline On-Site 26 sourcepath destinationpath workingcopypath clearworkspace regenerateschemasources updatedbstructure installpackagesqlscript installpackagedata continueiferror The path to the local folder that contains ZIP files of the packages. Required parameter. Used for the InstallFromRepository operation Path to the local folder that, depending on the type of operation, contains either the resulting files, or temporary files that are created during the package installation. Required parameter. Used for the InstallFromRepository operation Local folder for storing the package metadata. Optional parameter. If it is not empty, its value is used instead of the similar property of the workspace specified in the workspacename parameter. Used in the InstallFromSvn, SaveWorkspaceContent operations Determines whether the workspace is cleared before the update. Possible values: true, false. Optional parameter. Default value: false. Used in the InstallFromRepository and InstallFromSvn operations Determines whether the source codes are regenerated after saving packages in the database. Possible values: true, false. Optional parameter. Default value: true. Used in the InstallFromRepository and InstallFromSvn operations Determines whether the database structure is updated after saving packages. Possible values: true, false. Optional parameter. Default value: true. Used in the InstallFromRepository and InstallFromSvn operations Determines if SQL scripts are executed before and after saving packages. Possible values: true, false. Optional parameter. Default value: true. Used in the InstallFromRepository and InstallFromSvn operations Determines whether the data bound to the package is installed. Possible values: true, false. Optional parameter. Default value: true. Used in the InstallFromRepository and InstallFromSvn operations Determines whether the operation is continued after encountering the first error. If the value is true, then the operation will be completed, and the user will obtain the list of all errors occurred. Possible values: true, false. Optional parameter. Default value: false. Used in the InstallFromRepository and InstallFromSvn operations BPMonline

27 Setup Guide logpath Path to the folder in which the log of the specified operation shall be saved. The name of the log file consists of the date and time when the operation has started. Optional parameter. If the parameter is not specified, the log will not be saved. Used in the InstallFromRepository and InstallFromSvn operations Note To display the list of WorkspaceConsole application parameters, run the application with the help parameter: Terrasoft.Tools.WorkspaceConsole.exe - help Examples of WorkspaceConsole Commands Package Assembly Use the SaveWorkspaceContent operation with the Repository content type (ContentTypes) to assemble packages. Required Parameters: -operation=saveworkspacecontent -contenttypes=repository -username=bpmonline_user_name -userpassword=bpmonline_user_password -workspacename=workspace_on_which_the_package_was_added -destinationpath=folder_in_which_the_package_should_be_saved -sourcecontrollogin=svn_user_name -sourcecontrolpassword=svn_user_password Optional Parameters: -workingcopypath=working_copy_folder -repositoryuri=svn_repository_address -packagename=saved_package_name Example of command for assembling the Demo package. The obtained package archive will be saved in the D:\Temp\Repository\ folder. Terrasoft.Tools.WorkspaceConsole.exe -username=supervisor - userpassword=supervisor -workspacename=default - operation=saveworkspacecontent -contenttypes=repository - destinationpath=d:\temp\repository\ - workingcopypath=d:\temp\source\ -repositoryuri=http:// svnserver:8050/svn/bpmonline -sourcecontrollogin=svnuser - sourcecontrolpassword=svnpassword Package Install Use the InstallFromRepository operation to install the package from the archive file. In this case, the following actions are performed:

Updating BPMonline On-Site 28 downloading ZIP archives with the last version of the package structure and metadata and saving them locally to the disk; comparing the structure of the specified workspace with the downloaded from ZIP archives; before saving packages to the database, the SQL scripts that should be applied before the package installation are executed; after the comparison, the structure and metadata of the modified package items (schemas, assemblies, SQL scripts, data), as well as packages themselves, are saved to the database; by default, after the packages have been installed, the following actions are performed: the regeneration of the source codes, updating the database structure, executing the SQL scripts that should be executed after the package installation, as well as installation of the package data. Required Parameters: -operation=installfromrepository - workspacename=name_of_the_workspace_on_which_the_package_will_be_i nstalled -sourcepath=folder_that_contains_the_installed_package -destinationpath=folder_for_temporary_files Optional Parameters: -packagename=package_name -logpath=path_to_the_error_log_file The following parameters have the values by default. If the values are not specified, the following values are implied: -clearworkspace=false (workspace is not cleared) -continueiferror=false (the first error stops the execution) -installpackagesqlscript=true (package SQL scripts are installed) -installpackagedata=true (package data is installed) -regenerateschemasources=true (regeneration is performed) -updatedbstructure=true (database structure is updated) Specify these parameters only if their values must differ from the default values. For example, if a package should be installed without installing the data, add the installpackagedata parameter with the false value to the command. Examples of Commands for Package Installation: Installing packages from ZIP archive with making changes in the DB structure, executing SQL scripts and installing the package data: Terrasoft.Tools.WorkspaceConsole.exe -workspacename=default - operation=installfromrepository -sourcepath=d:\temp\repository\ - destinationpath=d:\temp\destination\ -clearworkspace=true - continueiferror=true -logpath=d:\workspaceconsolelog BPMonline

29 Setup Guide Installing packages from ZIP archive without making modifications in the DB structure, executing SQL scripts and installing data. Terrasoft.Tools.WorkspaceConsole.exe -workspacename=default - operation=installfromrepository_new - sourcepath=d:\temp\repository\ - destinationpath=d:\temp\destination\ -clearworkspace=true - continueiferror=true -logpath=d:\workspaceconsolelog - installpackagedata=false -installpackagesqlscript=false - updatedbstructure=false The Procedure for Package Installation When new BPMonline versions are released, you will need to update already deployed application. Updating is done by installing newer packages with the base functionality (in other words, updating pre-installed packages) using the WorkspaceConsole application. First the updated base packages are installed on a workspace, and then these modifications are committed to the SVN repository. Follow these steps to update the application: 1. Save all modifications of all user packages to SVN. Before you start updating the application, make sure that the workspace doesn't contain modified schemas. 2. Apply base packages in a workspace with modifications in database. The example of the command that applies the updated base packages on the Default workspace: Terrasoft.Tools.WorkspaceConsole.exe -workspacename=default - packagename=nui -operation=installfromrepository - sourcepath=c:\temp\packages\ - destinationpath=c:\temp\packages\temp 1. Apply the base packages on other workspaces without modifying the database structure. The example of the command that applies packages on the Developer workspace without modifying the database: Terrasoft.Tools.WorkspaceConsole.exe -workspacename=developer - packagename=nui -operation=installfromrepository - sourcepath=c:\temp\packages\ - destinationpath=c:\temp\packages\temp -updatedbstructure=false - installpackagesqlscript=false -installpackagedata=false Perform the following actions for all workspaces: 1. Update the workspace from the repository. To do this, perform the [Update from Repository] action (Fig. 24) in the [Configuration] section.

Updating BPMonline On-Site 30 Fig. 24 Updating the Workspace from the Repository 2. Generate the source code for schemas where necessary. To do this, perform the [Generate Where It Is Needed] action in the [Source Code] action folder (Fig. 25) of the [Configuration] section. Fig. 25 Generating Source Code for Schemas where Necessary 3. Compile the workspace by performing the [Compile Modified Items] action (Fig. 26) in the [Configuration] section. BPMonline

31 Setup Guide Fig. 26 Compiling the Workspace Note If the compilation did not occur, generate the source code of one of the user package schemas (the [Generate for Selected Items] action) and then retry compilation.