44
Metastorm BPM Version 9.0 Installation Guide December 2009 Metastorm Inc. email: [email protected] http://www.metastorm.com

Metastorm BPM Version 9 - · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Embed Size (px)

Citation preview

Page 1: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0 Installation Guide December 2009

Metastorm Inc. email: [email protected]

http://www.metastorm.com

Page 2: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Copyright Notice

© 1996–2009 Metastorm Inc. All Rights Reserved.

Trademark Information

• Metastorm®, Metastorm BPM®, Process Pod®, Enterprise Process Advantage®, ProVision®, The Best Process Wins®, Proforma®, Metastorm Knowledge Exchange®, Metastorm DNA®, Metastorm Discovery™, Business to the Power of 3™ and the See.Think.Do image are either registered trademarks or trademarks of Metastorm in the United States and/or other countries.

• Microsoft®, Outlook®, Word®, SQL Server™, Windows®, Vista®, Active Directory®, Visual Basic®, JScript®, SharePoint® and BizTalk® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

• Adobe® is a registered trademark of Adobe Systems, Inc. • AIX®, AIX 5L™, CICS®, CICSPlex®, DB2®, DB2 Universal Database™, HACMP™, Integrated Language

Environment®, i5/OS®, IBM®, ibm.com®, IMS™, IMS/ESA®, iSeries™, Language Environment®, MQSeries®, MVS™, OS/390®, OS/400®, Parallel Sysplex®, pSeries™, RACF®, S/390®, SupportPac™, WebSphere®, z/OS™, zSeries® are either registered trademarks or trademarks of the International Business Machines Corporation in the United States and/or other countries.

• JBoss, Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat, Inc. in the United States and other countries.

• SuSE® is a registered trademark of SuSE Linux AG. • Sun, Sun Microsystems and Solaris are trademarks, registered trademarks, or service marks of Sun Microsystems, Inc. in

the U.S. and other countries. • SPARC® is a registered trademark of SPARC International, Inc. SPARCstation® is licensed exclusively to Sun

Microsystems, Inc. Products bearing SPARC trademarks are based on an architecture developed by Sun Microsystems, Inc. • DataDirect®, DataDirect Connect® for JDBC™, DataDirect Connect® for ODBC are registered trademarks of Progress

Software Corporation or one of its subsidiaries or affiliates in the United States and other countries. • EJB, J2EE, Java, Java runtime environment, JavaScript, JMX, JRE, JSP, JVM and all Java-based trademarks are

trademarks of Sun Microsystems, Inc. in the United States and/or other countries. • Linux is a trademark of Linus Torvalds in the United States and/or other countries. • Intel® and Itanium® are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States

and other countries. • UNIX is a registered trademark of The Open Group in the United States and other countries. • Eclipse is a trademark of the Eclipse Foundation, in the United States and other countries. • Oracle is a registered trademark of Oracle Corporation and/or its affiliates. • "Apache Tomcat" and "Tomcat" are trademarks of the Apache Software Foundation. • HP, HP-UX and PA-RISC are registered trademarks of the Hewlett-Packard Company. • BusinessObjects™, Crystal Reports® are trademarks or registered trademarks of Business Objects S.A. in the United States

and in other countries. Business Objects is an SAP company. • Other trademarks are the property of their respective owners.

Disclaimer

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However, Metastorm accepts no responsibility, and offers no warranty whether expressed or implied, for the accuracy of this publication. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the express written permission of Metastorm Inc. The information in this document is subject to change without notice.

Metastorm BPM Version 9.0 December 2009 Page ii

Page 3: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 Installation Guide Table of Contents

1  Installation ............................................................................................................................................ 1 1.1  Overview ........................................................................................................................................................ 1 1.2  Prerequisites to running the Metastorm BPM Installation ........................................................................... 1 

1.2.1  Clean the Temp Directory ................................................................................................................. 1 1.2.2  Close Applications Running in the Background .............................................................................. 2 1.2.3  Configure the DCOM Settings on the machine ................................................................................ 2 1.2.4  Detect and End Previously Running Installation Processes ............................................................. 3 

1.3  Installing Metastorm BPM ............................................................................................................................ 4 1.3.1  The Installation Process ..................................................................................................................... 4 1.3.2  Custom Setup ..................................................................................................................................... 5 1.3.3  Install State ......................................................................................................................................... 5 1.3.4  Process Engine Setup ......................................................................................................................... 6 1.3.5  Process Engine Service ...................................................................................................................... 6 1.3.6  Configuring E-mail ............................................................................................................................ 6 1.3.7  Process Engine SMTP Mail Connector Setup .................................................................................. 7 1.3.8  Metastorm Deployment Service ........................................................................................................ 7 1.3.9  Metastorm Designer Settings............................................................................................................. 7 1.3.10 Administrative Tools User Authentication ....................................................................................... 8 1.3.11 Metastorm Repository Database Type .............................................................................................. 8 1.3.12 Metastorm Process Engine SQL Server ............................................................................................ 9 1.3.13 Metastorm Process Engine Oracle Server ......................................................................................... 9 1.3.14 Metastorm Web Extensions ............................................................................................................... 9 1.3.15 Auto Refresh Alerts List .................................................................................................................. 10 1.3.16 Configure Localization .................................................................................................................... 10 1.3.17 Metastorm Web Server Interface Language ................................................................................... 10 1.3.18 Metastorm Browser Settings ........................................................................................................... 11 1.3.19 MSDTC Configuration .................................................................................................................... 12 

1.4  Databases ...................................................................................................................................................... 13 1.4.1  Overview .......................................................................................................................................... 13 1.4.2  Configuring the Metastorm Process Engine Database ................................................................... 14 

1.5  Oracle ........................................................................................................................................................... 14 1.5.1  Setting up Overview......................................................................................................................... 14 1.5.2  Setting up Oracle for Metastorm BPM ........................................................................................... 15 1.5.3  Creating a Unicode Oracle Database .............................................................................................. 15 1.5.4  Ensuring Access to an Oracle DBMS ............................................................................................. 16 1.5.5  Creating Two Tablespaces ............................................................................................................... 17 1.5.6  Database table and column naming ................................................................................................. 18 1.5.7  Creating an Oracle User for Metastorm BPM Access ................................................................... 18 1.5.8  Running the Metastorm database scripts ........................................................................................ 19 1.5.9  Creating ODBC Data Source Settings ............................................................................................ 20 1.5.10 Troubleshooting ............................................................................................................................... 20 1.5.11 Oracle Registry Keys ....................................................................................................................... 21 

1.6  Microsoft SQL Server ................................................................................................................................. 21 1.6.1  Setting Up Overview........................................................................................................................ 21 1.6.2  Setting up Microsoft SQL Server for Metastorm BPM ................................................................. 22 1.6.3  Setting up SQL Server Express for Metastorm BPM .................................................................... 24 

Metastorm BPM Version 9.0 December 2009 Page iii

Page 4: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page iv

1.6.4  Microsoft SQL Server Registry Keys ............................................................................................. 25 

2  Post Installation ................................................................................................................................. 26 2.1  Overview ...................................................................................................................................................... 26 2.2  MetastormDefault Connection .................................................................................................................... 26 2.3  Configuring a Separate Web Server ........................................................................................................... 27 

2.3.1  Setting the account information on the web extensions computer................................................. 27 2.3.2  Adding the account information to the Engine computer .............................................................. 27 

2.4  Reconfiguring MLP Database Setting ........................................................................................................ 27 2.5  Setting Up a Second Web Client ................................................................................................................. 28 

2.5.1  Configuration Steps: ........................................................................................................................ 28 2.6  Vista Users ................................................................................................................................................... 30 

2.6.1  Important Information for Vista Users ............................................................................................ 30 2.6.2  Unexpected behavior by the Vista UAC on startup ....................................................................... 30 

2.7  Testing the Installation ................................................................................................................................. 30 2.7.1  Creating a Project ............................................................................................................................. 30 2.7.2  Deploying a Project .......................................................................................................................... 31 2.7.3  Assign Users and Roles ................................................................................................................... 31 2.7.4  Optimizing Performance .................................................................................................................. 32 

3  Installation Troubleshooting ........................................................................................................... 34 3.1  Overview ...................................................................................................................................................... 34 3.2  Common Problems ...................................................................................................................................... 35 3.3  Troubleshooting The Administrative Tools ............................................................................................... 35 3.4  Split Deployment ......................................................................................................................................... 36 3.5  Progress Bar stops at 0% and installation freezes or fails .......................................................................... 36 3.6  Engine Service Does Not Start Up Automatically on First Reboot .......................................................... 37 3.7  Engine Service Fails to Start Up with Oracle Database ............................................................................. 37 3.8  "Access denied" error when connecting to the Engine .............................................................................. 37 3.9  Unable to access the BPMEngine.Net URL ............................................................................................... 38 3.10 Problems Using Non-ASCII Characters in Scripts .................................................................................... 38 3.11 Web client login page displays “Service Unavailable” on Windows Server 2003 .................................. 38 3.12 Unable to access Web Extensions ............................................................................................................... 39 3.13 Web client does not function as expected ................................................................................................... 39 3.14 HTTP 403 (Forbidden) error returned when opening the Web Client ...................................................... 39 3.15 Web client opens but no text is displayed on the main page ..................................................................... 39 3.16 Timed Actions stop being processed .......................................................................................................... 39 3.17 Client Interface Displaying Old Options .................................................................................................... 40 

Page 5: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 1

1 INSTALLATION

1.1 Overview

This section provides detailed instructions on:

• Prerequisites to running Metastorm BPM Installation

• Installing Metastorm BPM

• The Installation Process

1.2 Prerequisites to running the Metastorm BPM Installation

Successful installation of Metastorm BPM requires certain conditions and prerequisites to be in place so that installation utilities such as Microsoft Windows Installer and InstallShield operate correctly.

Ensure that the following actions are taken prior to executing Metastorm BPM installation.

• Logon as a user with administrative rights on the machine.

• Clean the ‘Temp’ directory.

• Close applications running in the background.

• Configure the DCOM settings on the machine.

• Detect and end any installation processes running from previous installations.

1.2.1 Clean the Temp Directory The ‘Temp’ directory is a folder used to store temporary files. When a program ends, the temporary files are deleted. However, sometimes these files are not deleted, for example, when a program is aborted. Cleaning, or deleting, the contents of the ‘Temp’ directory frees up space on the hard disk.

Do not delete the Temp directory itself. Delete only the files and folders in the directory.

Page 6: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

To clean the Temp directory:

• Open Windows Explorer.

• Navigate to the location of the Temp directory; in the address bar type %TEMP% and press the Return key.

• Select Edit | Select All.

• Select File | Delete or press the delete key.

• Click Yes or Yes to All in the dialog that appears.

1.2.2 Close Applications Running in the Background

Background applications running on your computer can interfere with an installation process. Most of these applications appear in the Systems Tray for example, antivirus software, and audio players. It is important to close all applications to ensure successful installation of Metastorm BPM. Some of the most common applications running in the background that are known to interfere with installations are antivirus software, the IntelliMouse application, and audio players.

Close all applications in the System Tray, and follow up by closing applications that appear in the Task Manager.

1.2.3 Configure the DCOM Settings on the machine

Installation may fail if your computer has insufficient Component Object Model (COM) access permissions or the COM Default Impersonation Level is set incorrectly. The most common errors related to COM are "Setup failed to launch installation engine: Access is denied." and "Error installing Ikernel.exe, access is denied."

To modify the COM access permission settings on your computer:

1. Select Start | Run.

2. Type dcomcnfg. Click No if any warning screens appear.

3. Double-click Component Services.

4. Double-click Computers.

5. Right-click My Computer and select Properties.

6. Select the Default COM Security tab.

7. In the Access Permissions section, click Edit Default. 8. Ensure that your user account and the SYSTEM account are listed and the Access Permission

check box for each of them is selected. 9. To add your User Account or SYSTEM:

a. Click Add. The Select Users or Groups dialog opens. b. In the Select this object type field, make sure that at least Users is entered. If not, click

Object Types and select Users. c. In the From this location field, make sure your computer name is entered.

Metastorm BPM Version 9.0 December 2009 Page 2

Page 7: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 3

If it is not, click Locations and select your computer. d. In the Enter objects name to select field, type a new object. Click OK. e. In the Access dialog, select the new object. f. Select the Allow Access check box. g. Click OK twice.

10. Close the Component Services dialog.

The following steps set the Default Impersonation Level to Identify.

The Impersonation Level must be set within the COM services to specify whether the application can determine who is calling them and determine whether operations can be performed for that client. To set the Default Impersonation Level:

1. Perform the steps 1 to 6 described above.

2. In the COM Security dialog, select the Default Properties tab.

3. Set the Default Impersonation Level field to Identify.

4. Select Apply and click OK.

1.2.4 Detect and End Previously Running Installation Processes

Installation issues may arise if the same installation has two instances running simultaneously. This may cause conflict between the two instances of the installation engine.

To detect if another installation process is running:

1. Press Ctrl + Alt + Del and select Task Manager.

2. Select the Processes tab.

3. Check the running processes for any of the following:

• setup.exe

• isetup.exe

• ikernel.exe

• msiexec.exe

• idriver.exe

• IsUninst.exe

• IsUn16.exe

• Uninst.exe

• Uninst16.exe

To end previously running installation processes:

Page 8: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

• Select each process.

• Select End Process.

Note: Refer to InstallShield Consumer Central (http://consumer.installshield.com) for further details in troubleshooting common installation problems.

1.3 Installing Metastorm BPM The Metastorm BPM installation process implements a series of automated actions leading to the installation of the suite of Metastorm BPM components. During installation the user is prompted by a number of screens to enter their installation requirements.

This section describes the setup process. The steps in the installation process are as follows:

1. Ensure that the installation prerequisites are met.

2. Ensure that the prerequisites to running Metastorm BPM installation are met.

3. Follow the installation process.

4. Setup your database.

5. Follow post installation steps, as required.

6. Troubleshoot as necessary.

1.3.1 The Installation Process

To install Metastorm BPM:

1. To install from the Metastorm BPM DVD, simply insert the DVD into the drive. If setup does not begin automatically, you will need to run autorun.exe from the DVD’s root folder.

Note: The user installing Metastorm BPM needs to have administrative rights on the machine where Metastorm BPM is installed.

2. The Autorun screen gives the following options: o Before you install - the Metastorm BPM readme for the current release. o Redistributables - a list of all the redistributed software files in the Redist folder of the

DVD. o Install Metastorm BPM - start the installation o Install the Metastorm Migration Assistant o Browse DVD - browse the DVD.

3. Click Install Metastorm BPM to display the Setup Wizard screen. 4. The License Agreement is displayed. Read the license conditions. 5. To continue, accept the license agreement. 6. Select the Custom Setup features to install. 7. Change the Destination Folder as required. 8. Enter the Process Engine Setup details.

Metastorm BPM Version 9.0 December 2009 Page 4

Page 9: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 5

9. Enter the Process Engine Service details. 10. Metastorm Process Engine Mail Connector Configuration. 11. Select the Process Engine SMTP Mail Connector settings. 12. Metastorm Deployment Service Setup 13. Metastorm Designer Settings Configuration 14. Metastorm Administration Tools Setup 15. Specify the Metastorm Repository Database type. 16. Depending on your selection in the previous screen, either a SQL Server screen or an Oracle

screen is displayed. 17. Specify Metastorm Web Extensions. 18. Chose to Auto Refresh alerts list and Configure Localization 19. Click Install to begin the Installation.

1.3.2 Custom Setup This screen enables the user to choose which Metastorm BPM program features to install. There are prerequisites for some of these components that include the installation of third party software. The Metastorm BPM installation checks to see whether these prerequisites have been met. Components whose prerequisites have not been met appear as unselected on this screen.

• Metastorm Process Engine - manages all Metastorm processes and is the connection point for Metastorm clients.

• Metastorm Deployment Service - this is the connection point for the Designer to deploy BPM processes into the Runtime Repository.

• Metastorm Web Extensions - allows users to connect to Metastorm BPM via a web browser.

• Metastorm Designer - used for building and maintaining Metastorm BPM processes.

• Metastorm Administrative Tools - a web based application used to perform administrative tasks within Metastorm BPM.

1.3.3 Install State Custom Setup allows you to selectively install program features.

The icon next to the feature name indicates the install state of the feature. Click the icon to drop down the install state menu for each feature.

This install state means the feature:

• - will be completely installed to the local hard drive

• - will not be installed.

• - This feature, and all sub-features, will be installed on local hard drive

Page 10: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

1.3.4 Process Engine Setup Select the Engine name, Connection method and virtual folder.

1. The default name for the Process Engine is in the format <machine name>$<domain>. Once configured,

an Engine's name should not be changed. The user account used for running the Engine cannot have a blank password.

2. The connection method that will be exposed to the remote .NET Clients by the Process Engine needs to be chosen. Select either TCP - High Performance method or HTTP - Open Method, (the later requires IIS).

3. The .NET Clients Access Virtual Folder name needs to be set; this by Default is called BPMEngine.NET.

Note: If the DSN ‘Metastorm’ already exists on the machine, it must be deleted or renamed, as a DSN ‘Metastorm’ is automatically created as part of the installation. An existing ‘Metastorm’ DSN may prevent the Process Engine from starting.

1.3.5 Process Engine Service 1. Select the Start up Type:

o Manual - if you want to start the Process Engine service manually.

o Automatic - if you want the Process Engine service to start automatically on Windows

start up.

2. Enter the Process Engine Account user credentials:

o Domain

o Username

o Password

Note: The installation authenticates the details provided.

Note: The account under which the Engine runs cannot have a blank password.

1.3.6 Configuring E-mail To set up Metastorm Process Engine Mail Connectors, you must specify the default e-mail account that will be used by the Process Engine.

The Engine can also be configured to send alerts via e-mail containing a hyperlink to the service generating the alert. To use this facility you need to specify the web server name or IP address and the virtual folder for a server hosting the Metastorm web extensions. The responses you provide populate a registry key that will be read by the Process Engine. These can be amended at a later date.

1. Enter a reply to Email address for the Process Engine.

Metastorm BPM Version 9.0 December 2009 Page 6

Page 11: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 7

2. Enter a Web Server name or IP address.

3. Enter the Virtual Folder Name of the server that will be hosting the Metastorm Web Extensions.

1.3.7 Process Engine SMTP Mail Connector Setup Specify the encoding and attachment information for the Metastorm Process Engine SMTP mail Connector. The responses you provide populate a registry key that will be read by the Process Engine. These can be amended at a later date.

1. Locale ID - represents the code page identifier to be used for all email messages. 1252 represents the Western European character set. For other character sets refer to Unicode definitions, for example, 1251 for Eastern European languages and 65001 (UTF-8) is suitable for Russian and Kanji character sets.

2. SMTP e-mail body format - which can be in text or HTML format. Text messages have a maximum line length of 74 characters. Any line with more than 74 characters will be wrapped. HTML messages are not wrapped in this way.

3. SMTP e-mail encoding - which can be in text or MIME format. Any transfer of non-textual data within the text of mail messages requires MIME encoding.

4. SMTP attachment format - this can be UUencoded or MIME encoded. UUencoding and MIME encoding are methods for transmitting non-text files via Internet email.

1.3.8 Metastorm Deployment Service

These fields will be pre-populated with the details entered in the Process Engine Service screen. They can be amended as required.

1. Select the Start up Type:

o Manual - if you want to start the Deployment service manually. o Automatic - if you want the Deployment service to run automatically on Windows start

up. By selecting this option, the Metastorm Deployment service will be started at the end of the installation. The Windows ‘Net.Tcp Port Sharing Service’ needs to be started.

2. Enter the Deployment Service Account user credentials:

o Domain o Username o Password

3. User Authentication - Enter the machine name on which the Process Engine to be used for authentication users during deployment is located.

Note: The installation authenticates the details provided.

Note: The account under which the Deployment Service runs cannot have a blank password.

Note: When starting the Deployment Service in Vista or Windows Server 2008, the Local System or Network Service account may be used or a user that is a member of the IIS_IUSRS or Administrators group. The Power Users and all other groups have insufficient privileges for starting the service.

1.3.9 Metastorm Designer Settings

Page 12: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

The Designer makes use of the Deployment Service to initiate remote deployment (referred to as ‘publishing’ in previous releases).

The Designer connects to this service when the process designer deploys their projects via the Deployment service list which is held in the DeploymentServiceConfig.xml file.

1. Provide the location to the DeploymentServiceConfig.xml file, selecting either

o URL path or

o Physical/UNC path

2. Provide the location where the customLib folder should be created. This is the folder used to store 3rd party assemblies used within projects. The default path is C:\Program Files\Metastorm\BPM\Designer\CustomLib\

Note: The designer can be installed standalone by bypassing the SQL connection validation.

1.3.10 Administrative Tools User Authentication Specify the location of the Engine to be used for authentication users during administration. This allows the user credentials to be verified as holding the Metastorm role "MetastormAdministrator" when they log into the Administrative Tools web interface.

1. Enter the machine name.

1.3.11 Metastorm Repository Database Type

You must now specify information which type of database you are going to use. Metastorm BPM currently supports the following databases management systems:

• Microsoft SQL Server

• ORACLE

To specify your database type:

1. Select a radio button for an already installed database type either SQL Server/Express or ORACLE. When choosing to setup a Metastorm database on existing SQL Server or 2008 Express edition. The Metastorm install will prompt for an ODBC data source name and other database details. The collation of the Metastorm database must also be the same as the SQL Server collation. When choosing to setup a Metastorm database on an Oracle system the Metastorm installation only allows you to specify the values for a Metastorm Process Engine connection. Oracle database software should be installed and an ODBC data source configured. The Metastorm Oracle database will need to be setup and configured separately with the Oracle SQL scripts supplied, their default installation path is: C:\Program Files \Metastorm\BPM\Engine\Database\ORACLE scripts

2. On a case sensitive database, Metastorm User Ids are case sensitive by default. Select the Checkbox option if you want to force Metastorm User Ids to be case insensitive when a user logs in.

Metastorm BPM Version 9.0 December 2009 Page 8

Page 13: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 9

Note: The next set of screens displayed is determined by your choice of database.

1.3.12 Metastorm Process Engine SQL Server

1. Database server that you are installing to - select or enter the name of the SQL Server that you want to use as your Metastorm data source.

Note: If you install Metastorm BPM connecting to a local SQL Server, a dependency is set between the Process Service and the MSQLSERVER service. No dependency is set if connecting to a remote SQL Server.

2. User Credentials

• Windows authentication credentials of current user

• Server authentication using the Login ID and password 3. Name of database catalog - enter the name of the Metastorm database. 4. Setup Now - the installation will execute SQL scripts to setup a new catalog on the specified

database server. This is not a mandatory action; you have the option to setup the database after the installation.

5. If you check the checkbox you can choose to not validate the database connection.

1.3.13 Metastorm Process Engine Oracle Server 1. Database service name that you are installing to - enter the name of the Oracle Net Service Name

that you want to use as your Metastorm data source.

2. User Credentials

• Login ID

• Password

3. Name of database source name - specify the Oracle ODBC database source name (DSN) through which Metastorm will connect. The ODBC DSN must be setup manually.

1.3.14 Metastorm Web Extensions

If the Metastorm web extensions are selected and IIS is present, the Metastorm web extensions will be installed. To set up the Web Server: 1. Enter name for the Resources virtual folder that will contain resource files used by the web extensions.

The default name of the Resources is ‘Metastorm’. Note: The default virtual folder name is set to ‘Metastorm’. If a previous version of Metastorm BPM has been used with a different folder name you may want to maintain this name to preserve the user’s favorites and URL links. Note: If you are installing the web extensions on a machine with Windows SharePoint Services enabled, ensure that the virtual folder names do not match workspace names. If the virtual folder that the install tries to create already exists, an error will occur. 2. Enter name for the Resources virtual folder that will contain resource files used by the web extensions.

Page 14: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

3. Set the radio buttons to select the link to the location of the Process Engine service list as either a Physical/UNC path or a URL.

4. If the Engine is to be installed on the same machine the path defaults to the local Engine location.

5. If the Engine is installed on another machine then enter the path or browse to the location if the Engine is already installed. Expose the folder containing EngineServiceConfig.xml on that machine as a network share with the appropriate permissions to access via UNC path.

6. If the connection is over HTTP enter the URL in the format: http://<enginecomputer>/escripts/EngineServiceconfig.xml.

7. If you wish to enable automatic refresh of users’ ToDo and Watch lists, check the Auto refresh alerts lists box. The Web Client will automatically refresh ToDo and Watch lists after a folder action has been submitted or canceled.

8. If you wish to configure localization select the check box.

Note: If the Web Extensions and Engine are installed on separate computers the Windows Firewall need configuration. DCOM port 135 needs adding as an exception on the Engine machine. DTC also needs adding as an exception (this is a standard recommendation for all instances).

1.3.15 Auto Refresh Alerts List

To Do and Watch lists in the Web Client can be automatically refreshed after a user has committed a folder action. If this feature is set up, the alerts lists will be refreshed when the user: • Opens a folder from the To Do or Watch list and commits an action

• Opens a folder from the To Do or Watch list and commits a chained action

• Opens a folder from the To Do or Watch list and cancels a chained action

• Opens a folder from the To Do or Watch list and takes a Non-confirm folder action

• Opens a folder from the To Do or Watch list and takes a Confirm folder action.

1.3.16 Configure Localization If you choose the "configure localization" checkbox you will be take to two additional screens, they are:

• Metastorm Web Server Interface Language

• Metastorm Browser Settings

1.3.17 Metastorm Web Server Interface Language This Metastorm Web Server Interface Language can be configured by the administrator to enforce a particular language and culture for all users causing the web client to render in the appropriate language irrespectively of the browser local settings. This installation screen provides the ability to select one of the following Web Server Interface Language:

• English

Metastorm BPM Version 9.0 December 2009 Page 10

Page 15: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 11

• Français

• Deutsch

• Español

This configures the web client’s <globalization> settings in the web.config file as follows:

• English

<globalization culture="en-US" uiCulture="en" ... /> • Français

<globalization culture="fr-FR" uiCulture="fr" ... /> • Deutsch

<globalization culture="de-DE" uiCulture="de" ... /> • Español

<globalization culture="es-ES" uiCulture="es" ... />

Note: The default setting is <globalization culture="auto" uiCulture="auto" ... />

The “override client settings” should only be selected if you want to override the default culture settings. On selecting the “override client settings” the web client “AllowUsersToOverrideLocaleSettings” application setting will be set to “1” and you are take to the following install screen where you can configure the Browser settings.

1.3.18 Metastorm Browser Settings The selected values in the above dialogs will be used to setup the following web client application settings:

• DateFormat

o Date field order – You can choose the order in which the day, month and year appear in a date.

o Year format – You can choose whether the century is included in the year format.

o Month format – You can choose whether to show months as a number, an abbreviated word or the

whole word.

o Date field delimiter – You can specify the character used to delimit dates.

o Show leading zeros in dates – If you check this box, all dates will be displayed with leading zeros. For example, with this box checked, the date ‘4/3/2003’ will be displayed as ‘04/03/2003’.

• TimeFormat

o Clock format – You can choose to display times as 12 or 24 hour clock format.

o Time field delimiter - You can specify the character used to delimit times.

o AM indicator - You can specify the text displayed when the time is AM.

o PM indicator - You can specify the text displayed when the time is PM.

Page 16: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

• DecimalSeparator

o Decimal delimiter - You can specify the character used to separate decimal places.

• GroupSeparator

o Thousands delimiter - You can specify the character used to separate thousands in a large number.

• ListsPageSize

o The rows per page value that will appear on the web client lists, such as the ToDo List, Watch List.

1.3.19 MSDTC Configuration

To connect a Table Business Object or Query Business Object executing from the Process Engine to a database running on a separate machine, the MSDTC configuration settings should be changed.

The following configuration is required on both Engine and Database systems:

Go to Start>Control Panel> Administrative Tools.

2. Open Component Services>Computer>My Computer.

3. Right-click My Computer and click Properties.

4. Select the MSDTC tab and click the Security Configuration button.

5. Under Default Coordinator section, select Use Local Coordinator.

6. Select Network DTC Access.

7. Under Transaction Manager Communication, select Allow Inbound and Allow Outbound.

8. Click OK. When you click OK, you will be prompted for MSDTC service to restart.

9. Once the MSDTC service is restarted, restart the Metastorm Process Engine Service by going to Start->control Panel->Administrative Tools->Services.

The following article describes the steps to overcome error message that is displayed when you try to start a transaction in MSDTC: "New transaction cannot enlist in the specified transaction coordinator":

http://support.microsoft.com/kb/922430

A summary of configuration change is displayed below from the article:

1. Click Start, click Run, type regedit, and then click OK.

2. Locate the following registry subkey:

3. HKEY_LOCAL_MACHINE\Software\Microsoft\MSDTC

4. Right-click MSDTC, point to New, and then click DWORD Value.

5. Type CmMaxNumberBindRetries, and then press ENTER.

6. Right-click CmMaxNumberBindRetries and then click Modify.

7. Click Decimal.

8. In the Value data box, type 60.

This value increases the length of time that the client computer waits for the bind packet response from the server computer. This value is double the number of seconds before the client computer stops the transaction if the client computer does not receive the bind packet response. For example, a value of 60 equals 30 seconds.

Metastorm BPM Version 9.0 December 2009 Page 12

Page 17: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 13

Note: The value of 60 is only a recommended value. Additional testing on your configuration may be required.

9. Click OK.

10. Restart the computer.

The following article describes the above mentioned settings in detail, the new functionality in the Distributed Transaction Coordinator service in Windows Server 2003, and firewall settings:

http://support.microsoft.com/kb/899191/

The DTCPing tool is designed to assist with troubleshooting Microsoft DTC firewall issues.

You can download this tool from the Microsoft website.

http://www.microsoft.com/DOWNLOADS/details.aspx?FamilyID=5e325025-4dcd-4658-a549-1d549ac17644&displaylang=en

For more information on troubleshooting MSDTC issues using DTCPing tool, follow the steps mentioned here:

http://blogs.msdn.com/distributedservices/archive/2008/11/12/troubleshooting-msdtc-issues-with-the-dtcping-tool.aspx

1.4 Databases

1.4.1 Overview The Metastorm BPM database holds all configuration details for the projects and folders. It can be on the Metastorm BPM Process Engine’s server or a separate server, provided the Engine can communicate with it via ODBC and OLEDB.

For the Process Engine to read from or write to an external database, appropriate ODBC and OLEDB drivers must be installed on the Engine’s server PC.

Note: Metastorm BPM supports Microsoft SQL Server and Oracle databases.

You can install all Metastorm elements on the same computer or on separate computers, provided each element can access the database information via an ODBC connection and an OLEDB connection. The following table shows the database access requirements:

Metastorm Component Database Access Requirements

Process Engine directly to Database

Designer through Deployment Service to Database

Deployment Service directly to Database

Administrative Tools directly to Database, authenticating via the Process Engine

Web Extensions via Web Server through Engine to Database

Database Preparation

Page 18: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

The DBMS should be installed and the following accounts set up before you begin the Metastorm BPM installation:

• Account with administrative privileges so the required Metastorm database tables can be created

• Account with read and write privileges so Designer and Administrative tools can modify tables and publish information to the database, and the Process Engine can read and write from the database.

Database Configuration

For details on configuring your database refer to:

Microsoft SQL Server:

• Setting up SQL Server for Metastorm BPM

• Setting up SQL Server Express for Metastorm BPM

Oracle:

• Setting up Oracle for Metastorm BPM

1.4.2 Configuring the Metastorm Process Engine Database These are post-installation steps.

You will need to create the various database tables needed by Metastorm BPM, and install the latest Metastorm stored procedures before you can start the Engine, if you chose to install the Engine with:

• Oracle

• SQL Server (if you did not choose to set up the database during the installation)

This database does not need to reside physically on the same server as the Process Engine.

Database table and column naming

While using Oracle as the database, only standard ASCII characters are supported in table and column names. These names should only be in upper case. Extended characters, double quotes, or spaces in table or column names are also not supported. While using SQL Server as the database, similar restrictions apply although case sensitive table and column names are accepted.

Database and Password Information

The database and password information that was configured during the installation can be changed by editing Metastorm registry keys.

• Oracle Registry Keys

• Microsoft SQL Server Registry Keys

1.5 Oracle

1.5.1 Setting up Overview

Metastorm BPM Version 9.0 December 2009 Page 14

Page 19: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 15

The Metastorm Process Engine and Oracle can run on the same server, but performance may be affected. We recommend that the Process Engine and Oracle database are installed on separate servers.

If Oracle is on a different computer to the Process Engine, the Oracle Client must be on the Metastorm computer so the Engine can communicate with the database via ODBC and OLEDB. Database Configuration

• Supported Oracle databases

• Setting up Oracle for Metastorm BPM

1.5.2 Setting up Oracle for Metastorm BPM This section describes the basic steps a database administrator should follow to create the tables and indices required for Metastorm to run against an Oracle database, and covers:

• Creating a Unicode Oracle database

• Ensuring access to an Oracle database

• Creating Two Tablespaces

• Database table and column naming

• Creating an Oracle user for Metastorm access

• Running the Metastorm database scripts

Instructions are also provided for:

• Reviewing and modifying the ODBC data source settings

• Troubleshooting failure of the Engine to connect to the database.

Note: Before setting up or reconfiguring the database by running the SQL scripts ensure that all Process Engines running against the database are stopped.

1.5.3 Creating a Unicode Oracle Database This section shows the steps required to create an Oracle Unicode database. These details will differ for different versions.

1. To create a new Oracle instance for Unicode on the database server start up the Database Configuration Assistant for Oracle from the menu.

2. Click Next. 3. Select Create a Database and click Next. 4. Select a transaction processing template and click Next. 5. Enter the Global Database Name, SID and click Next. 6. Select the appropriate management options and click Next. 7. Complete the Password and Confirm Password fields, and click Next.

Page 20: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

8. Use the radio buttons to select the required storage option, click Next. 9. Select the appropriate database file locations, click Next. 10. Select the recovery configuration options and click Next. 11. Add Database Content as appropriate and click Next.

Note: Metastorm BPM does not require any scripts to be added at this stage.

12. Select the Character Sets tab and select Use Unicode (AL32UTF8). o It is essential to select the Unicode type AL32UTF8 to ensure data is interpreted

correctly.

Note: The database character set specifies the encoding to be used in the CHAR, VARCHAR and CLOB datatypes. The AL32UTF8 character set supports the latest version of the Unicode standard. It encodes characters in one, two, or three bytes. Supplementary characters require four bytes.

13. Click Next. 14. Choose the required database creation options and click Next. 15. Check that the details on the Creation Options page are correct and click Finish.

1.5.4 Ensuring Access to an Oracle DBMS To ensure access to an Oracle DBMS, you must set up a database alias, which allows connection to the DBMS via Oracle’s SQL*Net protocol.

Note: When the Process Engine runs on the same machine as the Oracle database, the IPC protocol should be used in preference to TCP/IP. This brings a significant performance improvement.

1. Start up the Oracle Net Configuration Assistant application. 2. Select the Local Net Service Name configuration option. 3. Select the Add option, and click Next. 4. Enter the Service Name (also known as the Host string) used to represent this connection. We

recommend that this is the same as the Net Service Name (which you will enter in step 10). This is usually set to “MetBPM”:

5. Click Next. 6. On the following screen, select the protocol you want to use – in this case, TCP. 7. Specify the TCP details which identify the server machine on which the DBMS runs 8. The Configuration Assistant now gives you the option to test the connection. Select the Yes radio

button and click Next. 9. When the test has successfully completed, click Next.

Note: Typically, Test uses system as the user name and manager as the password. If the test fails, the account may be locked by default. Ask your database administrator for an alternative log on. Alternatively, the Host Name or Service Name may be incorrect.

10. Enter the Net Service Name (usually the same as the Service Name which you entered in step 4, which is usually “MetBPM”) and click Next.

Metastorm BPM Version 9.0 December 2009 Page 16

Page 21: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 17

When the Configuration Assistant completes the configuration process, you can proceed to the next stage: Creating Two Tablespaces.

1.5.5 Creating Two Tablespaces

A tablespace is an Oracle construct that describes the location of a user’s database objects (for example, tables and indices) and can exist across more than one file. You now need to create two tablespace, one each for:

• Tables. The Metastorm table creation script expects the default name METASTORM_DATA.

• Indices. The Metastorm table creation script expects the default name METASTORM_INDEX.

The following steps outline a typical method for creating tablespaces; however, policies vary from site to site.

The examples in the following sections use the web-based Oracle 10G Enterprise Manager.

There are two stages required to create the tablespaces:

1. Accessing the tablespaces section. 2. Creating the tablespaces.

Accessing the Tablespaces Section

To access the relevant tablespaces section in the Oracle Enterprise Manager:

1. Browse to Oracle Enterprise Manager, using the following URL: http://<computer name>:5500/em/console/logon/logon

2. Click on the Administration link. 3. In the Storage section, click on the Tablespaces link. The Tablespaces page is displayed.

Creating Tablespaces

Note: The version of the Oracle client used to create the tablespaces must be the same as the version of the database that Metastorm BPM is to access.

You need to create two tablespaces: METASTORM _DATA and METASTORM_INDEX. To create these:

1. Click on the Create button. The Create Tablespace page is displayed. 2. Specify a tablespace Name (for example, METASTORM_DATA). 3. Set the Status to Read Write. 4. Set the Type to Permanent. 5. Under the Datafiles section, click Add. The Add Datafile page is displayed. 6. Enter the File Name (for example, METASTORM _DATA). 7. Specify an appropriate Size for the tablespace. The suggested file sizes are listed in the following

table:

Size Metastorm Data tablespace (K)

Metastorm Index tablespace (K)

Small 5800 5000 Medium 48912 40096 Large 489120 200000

The tablespace sizes depend on the Metastorm storage required.

Page 22: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Note: The tablespace size suggested for a Small amount of Metastorm storage is based on an Initial Extent Size of 64K. If your Initial Extent Size is greater (for example, 1024K) the tablespace size may need to be increased accordingly.

Note: These capacities exclude extra tables, created via Metastorm Designer tool, which will require extra space. The space they require depends on how many procedures will be published and how heavily they will be used.

8. Click Continue to return to the Create Tablespace page. 9. Click OK. 10. Repeat steps 1 to 2 to create the Metastorm index tablespace (METASTORM _INDEX).

1.5.6 Database table and column naming While using Oracle as the database, only standard ASCII characters are supported in table and column names. These names should only be in upper case. Extended characters, double quotes, or spaces in table or column names are also not supported. While using SQL Server as the database, similar restrictions apply although case sensitive tables and spaces in column names are accepted.

1.5.7 Creating an Oracle User for Metastorm BPM Access Metastorm BPM requires a user account (usually new) to access the Oracle DBMS. The exact process followed to set up this user varies from site to site.

To create an ORACLE user for Metastorm BPM access:

1. Access the Oracle Enterprise Manager as described in the previous subsection and click the Administration link.

2. Under the Security section, click the Users link. 3. Click the Create button. 4. Enter the new user Name (for example, ‘Metastorm’). 5. Specify a Password for the user. 6. Select the Default Tablespace. This must be the first one created in the previous subsection (for

example, METASTORM _DATA).

7. Select the Temporary Tablespace. This should be the pre-existing TEMP tablespace.

Note: The user created above will own the database schema you are about to create in the METASTORM _DATA tablespace.

8. Click the Role link. The Metastorm user has the CONNECT privilege by default. You also need to add the RESOURCE privilege.

9. Click OK. 10. Click the System Privileges link. 11. Add the following privileges:

o CREATE SEQUENCE o CREATE VIEW o CREATE SYNONYM

12. Click OK.

Metastorm BPM Version 9.0 December 2009 Page 18

Page 23: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 19

The user is added to the list of users.

You can now set up the Metastorm BPM database.

1.5.8 Running the Metastorm database scripts

Metastorm BPM is supplied with a set of ORACLE database scripts.

Database Schema The following scripts create the main database schema objects for Metastorm BPM:

• Oracle Create Tables.SQL

• Oracle Create Indexes etc.SQL

• Oracle - MQ Create.SQL, (only required for MQ support) Stored Procedures

The following scripts hold the definitions for the stored procedures which contain the business logic for Metastorm BPM which should be run in the order below:

• eWorkTypes.SQL

• eWorkPackage.SQL

• eWorkProcedures.SQL Administration Tools Procedures

• MBPM_ADMIN_BODY.sql

• MBPM_ADMIN_PKG.sql

• MBPM_ADMIN_SP.sql Cleanup

The following scripts can be run to remove Metastorm schema objects from a database:

• Oracle Drop.SQL (removes the Metastorm objects and stored procedures)

• Oracle - MQ Drop.SQL (drops the additional schema objects required for MQ support) Implementation

It is recommended to use a tool such as SQL*Plus to run these scripts. To run the scripts using SQL Plus:

1. Ensure there are no Engines running against the database. 2. Copy the scripts from “Metastorm\BPM\Engine\Database\Oracle Scripts“ to a location with a

shorter path such as “C:\Temp”.

Note: SQL Plus will return an error if you try to run the scripts from a location with a long path.

3. Start SQL Plus. 4. Log in as the Metastorm user you have created in the section Creating an Oracle User for

Metastorm BPM Access. For the Host String, enter the Service Name you entered in step 4 of the subsection Creating a Unicode Oracle Database.

5. Run the following scripts in this order: o Oracle Create Tables.sql.

Page 24: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

o Oracle Create Indexes etc.sql. o eWorkTypes.sql. o eWorkPackage.sql. o eWorkProcedures.sql.

o Use the @ command to run the script, for example:

o @"C:\Temp\Oracle Create Tables.SQL"

6. Press the Return key to continue. o The script prompts you for tablespace names. o When the scripts complete without warnings, you have finished setting up * to work with

Metastorm BPM.

1.5.9 Creating ODBC Data Source Settings You must create a data source that refers to the database. The data source name (DSN) must be entered into the Oracle ODBC DSN field during the Metastorm BPM installation.

Refer to the section on ‘Setting up the ODBC Data Source’ for further information.

1.5.10 Troubleshooting Information about the database to which the Engine should connect is stored in the registry. If the Engine fails to start, you should check the following registry keys:

For ODBC:

\HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database

Under this key, there should be an entry for CONNECTION with the value:

ODBC;DSN=Metastorm;UID=<>;PWD=<>;

Where the correct UID and Password are entered instead of the angle brackets <>.

For OLEDB:

\HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\Oracle DBC\

or

\HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\SQL Server DBC\

Under the relevant key, there should be an entry for connection with the value:

Provider=OraOLEDB.Oracle.1;Data Source=<>;User Id=<>;Password=<>;FetchSize=100;CacheType=Memory;PLSQLRSet=1

or

Provider=SQLOLEDB;Data Source=<>;Initial Catalog=<>;User ID=<>;Password=<>;

where the correct Data Source, Catalog, User Id and Password are entered instead of the angle brackets <>.

For ADO.NET or ODP.NET:

\HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\Oracle DBC\

or

\HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\SQL Server DBC\

Metastorm BPM Version 9.0 December 2009 Page 20

Page 25: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 21

Under the relevant key, there should be an entry for DotNetConnection with the value:

Data Source=MyDBMS;Initial Catalog=Metastorm76;User ID=metastorm;Password=secret;

or

Data Source=MyTNSName ;User Id=metastorm;Password=secret;;Connection Timeout=300;

Note: We strongly recommend that you secure access to this registry key, as it stores sensitive information about database connectivity.

1.5.11 Oracle Registry Keys

The database and password information that was configured during installation can be changed by editing the Metastorm BPM registry keys.

ODBC

HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database\Connection

To set the user ID to "metastorm" and the password to "secret" set the values:

ODBC;DSN=Metastorm;UID=metasorm;PWD=secret;

OLEDB

HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\Oracle DBC\DotNetConnection

To set the user ID to "metastorm" and the password to "secret" set the values:

Provider=OraOLEDB.Oracle.1;Data Source=<OracleDataSource>;User Id=metastorm;Password=secret;;Connection Timeout=300;

ADO.NET

HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\Oracle DBC\DotNetProvider

The value for Oracle is:

Oracle.DataAccess

1.6 Microsoft SQL Server

1.6.1 Setting Up Overview

Using SQL Server 2008 Express Edition

Microsoft SQL Server 2008 Express Edition is:

• Recommended only for stand-alone or test use of Metastorm BPM in product demonstrations, training and application development.

• Not supported for production use of Metastorm BPM.

Note: If you are using a SQL Server or SQL Server 2008 Express Edition database, it is possible to run the database scripts to set up the Metastorm database automatically during installation.

Database Configuration

Page 26: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

• Setting up SQL Server for Metastorm BPM

• Setting up SQL Server Express for Metastorm BPM

1.6.2 Setting up Microsoft SQL Server for Metastorm BPM

This section describes how to set up Microsoft SQL Server for Metastorm BPM, and covers:

1. Installing the Metastorm Database a. Executing Stored Procedures b. Running the Metastorm Database Scripts c. Microsoft Workflow Foundation Scripts

2. Setting up the ODBC Data Source.

The following assumes that when installing the Process Engine, you configured it to use Microsoft SQL Server.

For a review of the supported databases, refer to the Installation Prerequisites and Supported Environments Guides.

Note: Before setting up or reconfiguring the database by running the SQL scripts ensure that all Process Engines running against the database are stopped.

Installing the Metastorm Database To install a Metastorm database:

1. Create a new database. 2. Run the Metastorm Database scripts.

Creating a New Database

1. Create a new database using SQL Server Enterprise Manager. 2. Open the Security folder. 3. Right-click on the Logins option. 4. Select the New Login menu option. 5. Enter a Name and Password for the login. 6. Confirm the password in the Confirm dialog. 7. Select a Database for the login. 8. Select the Database Access tab in order to set roles for the login. 9. Select the database for the login. 10. Enable the created user to be able to execute stored procedures. 11. Select the following roles for the database for the login:

o db_ddladmin o db_datareader o db_datawriter.

12. Shut down SQL Enterprise Manager by selecting the Exit option from the Console menu. Executing Stored Procedures

To execute Metastorm Stored Procedures, additional database roles are required for the Metastorm Engine to run on the SQL Server.

Metastorm BPM Version 9.0 December 2009 Page 22

Page 27: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 23

By default, SQL Server does not have a default role for executing stored procedures.

SQL Server 2005

1. Run the following script in SQL Server :

/* CREATE A NEW ROLE */

CREATE ROLE db_executor

/* GRANT EXECUTE TO THE ROLE */

GRANT EXECUTE TO db_executor

2. Expand the Metastorm BPM database node. 3. Select Security | Users 4. Right click the Metastorm BPM database user and select properties.

Note: The Metastorm BPM database user is the user setup in step 5 of Creating a New Database.

5. In Database Role membership, scroll to db_executor. 6. Click the db_executor checkbox.. 7. Click OK.

Running the Metastorm BPM Database Scripts

You can click the Setup now button during the installation to run the database creation scripts located in the Engine ‘Database’ directory. Alternatively, you can also run these scripts later.

To run the scripts later, we recommend that you use SQL Query Analyzer. To do this:

1. Ensure there are no Engines are running against the database. 2. Select the database using Change Database. 3. To run the table creation scripts, open the SQL Server – Create.sql file and click on the Execute

Query button. 4. To run the procedure creation scripts, open the eWorkProcedures.sql file and click on the Execute

Query button.

Note: The location of these scripts may vary depending on where the Engine has been installed.

Administration Tools Procedures

• AdminToolsProcedures.sql

Microsoft Workflow Foundation Scripts

In addition to running the Metastorm BPM database scripts, SQL Server administrators also need to run the scripts that create the tables and procedures for Microsoft Workflow Foundation persistence support. These are:

• SqlPersistenceService_Schema.sql.

• SqlPersistenceService_Logic.sql.

These files can be found in C:\WINDOWS\Microsoft.NET\Framework\v3.0\Windows Workflow Foundation\SQL\EN\.

Page 28: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Workflow persistence is not supported for Oracle databases.

Setting up the ODBC Data Source

The installation creates a default system data source called “Metastorm” which assumes a database called “Metastorm” has been set up on the database server.

Note: It is assumed that there is one named user for the DSN connection; only this user interacts with the Metastorm BPM database for example, publishing, and role creation.

To edit or review the default “Metastorm” system data source:

1. Open the ODBC Data Sources Administrator. 2. Select the System DSN tab. 3. Select the Metastorm data source and click Configure to see the settings. 4. Edit the settings, for example, making the data source use a Trusted Connection. Use the Next and

Back buttons to access settings. 5. Click Finish. 6. Ensure that the Default Database (if requested) is set to the name of the database you have created.

For example, ‘Metastorm’. 7. When you are finished, click OK twice.

1.6.3 Setting up SQL Server Express for Metastorm BPM SQL Server 2008 Express Edition is a cut-down version of SQL Server 2008. The OSQL utility (which uses ODBC to communicate with the server) enables you to enter Transact-SQL statements, system procedures, and script files. Full documentation for this utility can be found on the web-site http://www.msdn.microsoft.com.

SQL Server 2008 Express Edition Installation

SQL Server 2008 Express Edition must already be installed prior to running the Metastorm BPM installation. The SQL Server 2008 Express Edition install package is included in the Redist folder on your Metastorm BPM Installation DVD.

The Metastorm BPM installation offers you the option to setup a database against an existing SQL Server 2008 Express Edition installation (from the Metastorm Engine Database screen, select the SQL Server / Express Edition option).

It is possible to set up the SQL Server 2008 Express Edition database during the installation, by clicking on the Setup now button on the Engine Database Setup screen. If you did not choose this option during installation, you can set up the database by following the procedure set out below.

Database Creation

If required, the database can be set up as follows:

1. Create the Metastorm database. This is done with the following command-line

osql -Usa -P -Q "Create Database Metastorm"

2. Run the table creation scripts.

osql -Usa -P -d Metastorm-i "Metastorm\BPM\Engine\Database\SQL scripts\SQL Server - Create.sql" -n

3. Run the stored procedure creation scripts.

osql -Usa -P -d Metastorm-i "Metastorm\BPM\Engine\Database\SQL scripts\eWorkProcedures.sql" -n

Metastorm BPM Version 9.0 December 2009 Page 24

Page 29: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 25

The location for the scripts in steps 1 to 4 above may vary depending on where the engine has been installed.

The example above assumes:

• a user id of sa, and an empty password. To use trusted security, omit the -U and -P switches and use -E instead.

• a database name of Metastorm.

Note: We recommend you use the OSQL tool provided with SQL Server 2008 Express Edition (or download the query tool from http://www.msde.biz) to run the scripts. Please do not attempt to use the version 7 Metastorm Query administrative tool for this purpose.

1.6.4 Microsoft SQL Server Registry Keys

The database and password information that was configured during installation can be changed using the System Administrator or by editing the Metastorm BPM registry keys.

ODBC

HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database\Connection

To set the user ID to "metastorm" and the password to "secret" set the values:

ODBC;DSN=Metastorm;UID=metasorm;PWD=secret;

OLEDB

HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\SQL Server DBC\DotNetConnection

To set the user ID to "metastorm" and the password to "secret" set the values:

Provider=SQLOLEDB;Data Source=<SQLServerDataSource>;User Id=metastorm;Password=secret;;Connection Timeout=300;

ADO.NET

HKEY_LOCAL_MACHINE\Software\Metastorm\e-Work\Engine\Database Connectors\ SQL Server DBC\DotNetProvider

The value for SQL Server is:

System.Data.SqlClient

Page 30: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

2 POST INSTALLATION

2.1 Overview After the Metastorm BPM installation, you may need to perform some of the other configuration tasks listed below depending on your installation.

• Setting up the MetastormDefault Connection

• Configuring the Metastorm Process Engine Database

• Configuring IIS

• Configuring application.config

• Configuring a Separate Web Server

• Set up a Second Web Client

• Configuring Windows Vista

• Reconfiguring the MLP Database Setting

• Testing the Installation

2.2 MetastormDefault Connection

The Metastorm BPM Designer allows the development of Connection Objects of type Database, LDAP, or Web Service. By default there will always be an initial Connection Object called the MetastormDefault Connection that connects to the Metastorm Repository. This connection needs to be configured once when the Designer is first used. After this the values are remembered. Follow the steps below to configure the MetastormDefault Connection:

1. Click on the Metastorm button and then select the Options button. 2. Select the Default Connection option. 3. On the Define Connection tab, select the Provider, SQL or Oracle. 4. Enter the name of the server. 5. Enter Authentication details. 6. Enter the name of the Metastorm Repository (following default install this will be Metastorm). 7. Select the Test Connection button. 8. If the connection fails, amend the details as needed. If the connection is successful, you can go to the

Review tab and explore the repository contents. 9. When finished, press the OK button.

Metastorm BPM Version 9.0 December 2009 Page 26

Page 31: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 27

2.3 Configuring a Separate Web Server If you have installed the web extensions and the Process Engine on separate computers, and will be connecting them via DCOM, you will need to configure the Engine's client user's roles. This involves:

• Setting the account information for the computer on which the web extensions are installed

• Adding the account information to the client user's roles on the computer on which the Engine is installed.

2.3.1 Setting the account information on the web extensions computer To set the account information, on the computer where the Metastorm web extensions are installed locate the appropriate user identity setting.

1. On Windows XP start the Internet Information Services Manager and select the Metastorm web extensions virtual folder (by default "Metastorm").

2. Right click and select the Properties menu option. On the Properties dialog select the ASP.NET tab. 3. Click the Edit Configuration button. 4. Select the Application tab in the ASP.NET Configuration Settings dialog. 5. In the Identity settings check the Local impersonation checkbox. 6. Set the user to a domain level account that is commonly known to both the Metastorm web extensions

computer and Metastorm Engine computer.

2.3.2 Adding the account information to the Engine computer The domain level user account that was added to the web extensions computer must also be added to the Client user’s roles on the Engine computer. To add this user:

1. In the Component Services administrative tool, locate the Metastorm Process Engine entry. 2. Right-click on the Metastorm Process Engine\Roles\Client\Users tree item, and select the New | User

menu option.

2.4 Reconfiguring MLP Database Setting

During the ‘Get List’ request either MLP or non-MLP objects will be used, based on the value in eDisplayMLPAlerts column of the eServer table. The database creation script run during the installation set this column value to zero (non-MLP) by default; but it can be reconfigured to MLP by setting the column value to -1. With Oracle the user is prompted while running the eWorkPackage script as to which configuration is desired, and this is applied to the eServer table directly however with SQL Server database this needs to be reconfigured following the installation. If you wish to reconfigure your SQL database, this is what you need to do:

1. Change the value in eServer.eDisplayMLPAlerts. e.g. to use MLP: Update eServer set eDisplayMLPAlerts = -1

2. Re-run the eWorkProcedures stored procedure scripts.

If you wish to reconfigure your Oracle database, this is what you need to do:

1. Re-run the eWorkPackage file and choose MLP or non-MLP mode.

Page 32: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

2. Re-run the eWorkProcedures file Note: MLP mode must be used when more than one locale is deployed. Non-MLP mode should be used when only one locale is deployed.

Note: Once multiple locales have been deployed and the engine has run in MLP mode it should not be changed back to non-MLP mode.

Note: The multi-lingual translation only extends to the content held in the database related to the lists. Content in the message column for example will not be able to be translated.

2.5 Setting Up a Second Web Client In order to allow standard login as well as Single Sign On (SSO) to a BPM Service it is necessary to create a second web site to host a copy of the Metastorm BPM Web extensions. One web site is configured to use SSO login with Integrated Windows Authentication in IIS, the other to use standard BPM login with anonymous IIS authentication. The URL used to access the websites then also determines the type of login used.

2.5.1 Configuration Steps:

1. Create a copy of the existing Web Client. a. Locate the "Web" folder that contains the Web Client files. Following a default install the

path to the folder should be: C:\Program Files\Metastorm\BPM\

b. Right-click the "Web" folder and chose Copy from the menu, to make a copy of the whole folder.

c. Open the location where you want to store the files for the second Web Client, this does not have to be a different location from the original "Web" folder.

d. Right-click in the location, and then click Paste, to paste a copy of the "Web" folder into the chosen location. Rename the folder if you wish.

2. Create a new web site. a. Open Internet Information Services (IIS). b. Right-click on the "Web Sites" folder and select "New" and then "New Web Site" from

the menu. This will open up the "Web Site Creation Wizard", click the Next button to continue.

c. On the "Web Site Description" screen" type a short description for the web site you wish to create, e.g. BPMWebClient and select the Next button

d. On the "IP Address and Port Settings" screen change the port number. The existing Metastorm BPM web client is using port 80 by default, therefore the new web client needs to be accessed through a different port. Once amended click the Next button.

e. On the "Web Site Home Directory" screen browse the chose home directory, e.g. C:\Inetpub\wwwroot. Ensure that the "Allow anonymous access to this Web site" check box is select, then select the Next button.

f. On the "Web Site Access Permissions" screen select the "Read" and "Run scripts (such as ASP)" check boxes and select the Next button to complete the wizard.

g. Select the Finish button to exit from the wizard. 3. Configure the new web site's Properties.

Metastorm BPM Version 9.0 December 2009 Page 28

Page 33: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 29

a. In IIS right click the new web site and select Properties from the menu. b. Select the Documents tab in the Properties window and add the Default.aspx file to the

list. c. Select the ASP.NET tab in the Properties window and insure that the ASP.NET version is

at least the current version of ASP.NET 2.0. d. Select the Directory Security tab in the Properties window and click the Edit button in the

"Authentication and access control" section. Make sure the "Enable anonymous access" check box is selected. Click the OK button.

e. Finally select the OK button at the bottom of the Properties window 4. Create the new Metastorm Virtual Directory.

a. In IIS right click on the new web site (created in steps 2 and 3) select "New" and then "Virtual Directory". This will Launch the Virtual Directory Creation Wizard, select the Next button..

b. On the "Virtual Directory Alias" screen give your virtual directory the Alias "Metastorm" (You can chose another name if you so wish). Select the Next button.

c. On the "Web Site Content Directory" screen enter the path to the folder you created in step 1, that contained the copy of the Web Client. Select the Next button.

d. On the "Virtual Directory Access Permissions" screen select the "Read" and "Run scripts (such as ASP)" check boxes and select the Next button to complete the wizard.

e. Select the Finish button to exit from the wizard. 5. Configure the new Web Client's web.config file.

a. Located the web.config file in the folder you created in step 1 and open up the file in an editor such as Notepad or Visual Studio.

b. Edit the web.config file so it looks like the example below. Uncomment the <authentication mode ="Forms" /> and comment out the <authentication mode="Windows"> and <identity impersonate="true" /> sections. These settings had been amended when SSO had been configured.

<!-- Uncomment the following authentication element configuration to enable SSO --> <!--<authentication mode="Windows" />--> <!--<identity impersonate="true" />--> <!-- Comment out the following authentication element configuration to enable SSO --> <authentication mode="Forms"> <forms name="MetastormBPMAuth"

loginUrl="Login.aspx" protection="All" timeout="525600" path="/"></forms>

</authentication> 6. Test the second web site.

a. Open up a browser window and try and view the new Web Client. The URL should be: http://<server name>:<port number>/Metastorm/ The browser should start to open the Default.aspx page this will redirect before visibly opening to the login page. Enter relevant user name and password details and login, e.g. user name: SysAdmin, password: metastorm.

Page 34: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

2.6 Vista Users

2.6.1 Important Information for Vista Users

The following limitations apply when running Metastorm BPM on Windows Vista.

2.6.2 Unexpected behavior by the Vista UAC on startup

On Windows Vista, the Metastorm Process Engine service can only be started in manual mode, or Automatic – delayed start mode. If neither of these settings is used, the next time the operating system is restarted UAC will hang, which prevents the system from working correctly. The user will be unable to launch services (as this will give the UAC prompt).

If this situation does occur, it may be resolved by restoring the Last Known Good Configuration. To do this:

1. Restart the operating system. 2. Press F8 before the Windows logo appears. 3. On the Advanced Boot Options screen, use the arrow keys to highlight Last Known Good

Configuration, and then press Enter.

After following these steps, the Process Engine service is removed from the system.

2.7 Testing the Installation After Metastorm BPM has been installed, the database has been configured, and the relevant post installation steps have been taken, you should test the installation by creating and deploying a sample project.

This section covers:

• Creating a Project

• Deploying a Project

• Assigning Users and Roles

• Optimizing Performance

2.7.1 Creating a Project Follow these steps to create a basic project containing two stages and one form in the Metastorm BPM Designer. Note that the creation of project is automatic when you create a process.

1. Start the Metastorm BPM Designer. 2. On the Home ribbon tab, New Component drop-down, click on the Create a New Project button. A

new project is created in the Solution Explorer, and the project name "Project1" is generated automatically.

3. Double-click or right-click on the project name and click Open to set the properties of the project. 4. The Owner field is populated automatically with the login user's name. You can edit this name if

you wish. The Owner field is the same as the Author field in the properties pane. 5. In the Description field, enter a brief description for the project. 6. In the left hand Available Languages pane, select the languages to be made available in the project

and use the add button to add them to the right hand pane. If you do not wish to add languages at this time you may do it later by selecting the Translations option from the View ribbon.

Metastorm BPM Version 9.0 December 2009 Page 30

Page 35: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 31

7. Create a new process. On the Home ribbon tab New Component group, click on the New Process button

8. The Designer creates a default process in the main panel and assigns a default name (for example MBPM1). The new process consists of a start stage and a user stage.

9. To display the process properties, click anywhere in the process, that is not occupied by a process element.

10. In the Properties pane, edit the process properties as required. 11. You can edit the process default name and caption. You can also change the default names for the

start stage, first action and first stage. 12. To create a new form, click the New Form button on the New Component drop-down on the Home

tab of the ribbon. 13. A blank form is displayed in a tabbed window in the designer area. You can drag the corners or

sides of this form to re-size it. 14. To change the appearance of the form, edit the form properties. Drag and drop the elements in the

toolbox to build the form. The form toolbar is replaced with the process toolbar when you are working on a process.

15. Go back to the process file and in the properties of the First Action attach the form you just created. 16. Select Save All. This will enable you to save your solution, which contains the project and process.

2.7.2 Deploying a Project Once you have created the basic project, you need to deploy it before it can be used. When deploying a process, you need to log in as a Metastorm user who holds either the ‘MetastormAdministrator’ or ‘ProcessDesigner’ role.

These roles and a default BPM user are automatically created by the Metastorm database creation scripts during the installation process. The default user name and password are as follows: Username: SysAdmin Password: metastorm The following steps explain the deployment of a process to the Metastorm database.

1. To deploy a project, click the Deploy button located on the Home tab of the ribbon. You will be prompted to save the Project before you can deploy it.

2. If you have saved your project, it is automatically validated. If validation is successful, you will be prompted to enter the user name and password.

3. Enter your login details and click OK. 4. You can now enter a description for this version of your project. Click OK. 5. Open your web browser and type the URL specified by your Administrator to access the BPM

server. For example, http://<<server name>>/Metastorm/ 6. Enter your user name and password. 7. On your Blank Forms list you should now see your deployed project in the list of available projects.

Note: Refer to the Designer help file for more information.

2.7.3 Assign Users and Roles

Follow these steps to register a user and assign roles.

Page 36: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Logging in to the Users Tab of the Administrative Tools Utility

1. Using Internet Explore, access the Metastorm Administrative Tools via the following URL http://<server name>/MetastormAdministration/

2. Enter the User Name and Password for the default administration account that has the MetastormAdministrator role assigned to it already Username: SysAdmin Password: metastorm Note: The default administration account should have been created by the Metastorm database creation scripts during the installation process.

Creating Yourself as a User

Once logged into the Administrative Tools you should be able to select the Users tab and create your own personal account. To register yourself as a user:

1. Click on the New User button 2. Complete the New User Form, the only required information is the Username. 3. Click the Create button.

Note: Please see the Administrative Tools section for more information.

Assigning Yourself All Static Roles

To assign yourself all roles including the MetastormAdministration role:

1. On the User Tab, search for your account that you have just created.

2. View the full user details by clicking on the arrow . 3. Below the user account entry you can view the roles held by the user and the roles available to be

assigned. 4. Select the role you wish to assign from the Available Roles list and use the arrows to move that role

to the Roles Held By User list. As soon as the role appears on the Roles Held By User list the user holds the role. Note: Multiple roles can be selected by holding down the Shift or Ctrl key while selecting roles.

2.7.4 Optimizing Performance

By default, Metastorm BPM uses the default optimal Microsoft settings for ASP .NET applications.

To change the performance settings Microsoft recommends a strategy involving performance testing or benchmarking and tuning of various parameters on a per-application basis. Metastorm BPM, settings depend on the number of CPUs (as shown below) and on customer-specific procedures, forms and usage patterns.

Note: We recommend you follow the Microsoft guide if you are concerned about the performance of your Metastorm BPM deployment.

As a starting point, Metastorm recommends the following settings are applied.

Metastorm BPM Version 9.0 December 2009 Page 32

Page 37: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 33

Metastorm specific settings

To update Metastorm specific settings and modify your deployment of Metastorm BPM, edit the web.config file. This is located in the <Metastorm Installation Directory>\<Web folder>.

executionTimeout

This is used to set the maximum number of seconds that a request is allowed to execute before being automatically shut down by ASP.NET. You may wish to increase this for a system where it is possible the Process Engine will take a long time to respond to requests. The Metastorm specific default is 300 (5 minutes).

Note: For detailed information on how to conduct the tuning of the application, refer to the Microsoft guide “Improving .NET Application Performance and Scalability” at: http://www.microsoft.com/downloads/details.aspx?FamilyID=8a2e454d-f30e-4e72-b531-75384a0f1c47&displaylang=en

Other Configuration Settings

The following configuration settings can be added to the Metastorm web.config file. By default these settings are set to optimum.

Configuration setting Default (.NET 2.0)

Recommended value

maxconnection 12 * #CPUs 12 * #CPUs

maxIoThreads 100 100

maxWorkerThreads 100 100

minFreeThreads 88 * #CPUs 88 * #CPUs

minLocalRequestFreeThreads 76 * #CPUs 76 * #CPUs

Note: Refer to the Microsoft documentation and the files machine.config.comments and web.config.comments files in the C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\CONFIG folder for more information.

Page 38: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

3 INSTALLATION TROUBLESHOOTING

3.1 Overview

This section enables you to troubleshoot problems that you may encounter:

• Common Problems

• Progress Bar stops at 0% and installation freezes or fails

• Engine Service Does Not Start Up Automatically on First Reboot

• Engine Service Fails to Start Up with Oracle Database

• Engine Becomes Unresponsive when running against Oracle

• “Access denied” error when connecting to the Engine

• Unable to access the BPMEngine.Net URL

• Problems Using Non-ASCII Characters in Scripts

• Web client login page displays “Service Unavailable” on Windows Server 2003

• Unable to access Web Extensions

• Web client does not function as expected

• HTTP 403 (Forbidden) error returned when opening the Web Client

• Web client opens but no text is displayed on the main page

• Timed Actions stop being processed

• Windows taskbar disappears after reboot following installation

• Administrative Tools

• Split Deployment Communication

Metastorm BPM Version 9.0 December 2009 Page 34

Page 39: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 35

3.2 Common Problems

Oracle Driver versions are even more important in V9 than before. The wrong drivers are likely to cause the Blank Forms, Administration Forms, and Reports lists to throw an error. If you are able to get passed the list error with an incorrect driver then you are likely to encounter transaction errors on opening any form containing Edit grids.

Distributed Transaction Coordinator (DTC) This is critical for V9 and affects the Engine machine and any database servers being connected to. If the settings are incorrect you are likely to see errors like the one below when opening forms with Edit grids or possibly even just starting the Engine:

“Failed to enlist in transaction” Please pay close attention to the information in the MSDTC Configuration topic for instructions on debugging and configuring DTC settings.

3.3 Troubleshooting The Administrative Tools

This topic contains a list of resolutions that have been found to Administrative Tool problems.

.NET Server Error "impersonation Level" If you get a .NET Server Error regarding impersonation level when you first browse to the Administrative Tools using Internet Explore you will need to re-registered asp.net to rectify the problem.

Follow the steps below:

1. Open the command prompt a. Go to Start. b. Select Run c. Type cmd and click the OK button to open up the command prompt

2. In the command prompt, navigate to this path: C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727 by typing the following command and pressing the Enter key: cd C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727

3. Once there, type the following command and press Enter to run the command and re-register asp.net aspnet_regiis -i

4. After running the above command iis needs to be restarted a. Go to Start b. Select Run c. Type iisreset and click on OK.

Note: This issue has only occurred when using XP/SP3 with Oracle 11G R1.

"Specified cast not valid" error on selecting the Users tab

Page 40: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Users familiar with version 7.x may have used other methods to insert BPM users into the Metastorm repository other than the Administrative Tools. In version 7.x the eDeliverAlertsByEMail column could contain NULL values, however in version 9.0 if this column contains NULL values rather than 0 or 1 the use will receive the "Specified cast not valid" error being displayed in the Administrative Tools when they select the User tab.

3.4 Split Deployment

V9 has several new places where settings can affect split deployment communication: C:\Program Files\Metastorm\BPM\IIS extensions\DeploymentServiceConfig.xml This file specifies the location of the Deployment Service. C:\Program Files\Metastorm\BPM\IIS extensions\EngineServiceConfig.xml This file details the various BPM services. Note: HTTP and DCOM are no longer supported. All communication now uses the ECL and therefore .NET remoting protocols. C:\Program Files\Metastorm\BPM\Web\Web.Config This file tells the Web Extension where the Engine Service List file is location. Search for ‘engineServiceListLocation’. C:\Program Files\Metastorm\BPM\Deployment\DeploymentService.exe.config This file specifies the Deployment Service’s database connection string. C:\Program Files\Metastorm\BPM\Administrative Tools\Service\web.config This file specifies the Administrative Tools web service connection to the database. C:\Program Files\Metastorm\BPM\Administrative Tools\Web\web.config This file specifies the Administrative Tools connection to the Engine machine which it uses to authenticate. Engine authentication can be bypassed by changing the RecoveryMode setting to “true” in this file. This reverts back to database authentication.

3.5 Progress Bar stops at 0% and installation freezes or fails

This error may occur if:

• The machine’s virtual memory is low.

• The TEMP and TMP directories are full.

• Other (often silent) applications are running in the background. These will be taking up machine resources.

• The user’s DCOM permissions are not set correctly.

To resolve the problem, check the following and before re-running the installation.

• Increase the amount of virtual memory on the machine.

• Clean out the TEMP and TMP directories.

• Ensure no applications are running.

• Ensure DCOM settings are correct. The user’s registry value permissions should include ‘Everyone’.

Metastorm BPM Version 9.0 December 2009 Page 36

Page 41: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 37

To update the DCOM settings, follow these steps:

1. Start Menu | Run. 2. Type dcomcnfg.exe into the dropdown and click OK, the Component Services window is displayed. 3. Right-click on the Component Services\Computers\My Computer node and select Properties. On the

Properties dialog, select the COM Security tab. 4. Click Edit Default button in the Default Access Permissions section. The next dialog lists the current

permissions. 5. If the ‘Everyone’ group is not present in the list, click the Add button. 6. If you are running Windows XP Professional, the Select Users and Groups dialog is displayed. Type

‘Everyone’ into the Enter the object names to select field. 7. Click OK. The ‘Everyone’ group is added to the list. 8. Click OK to save the new settings.

3.6 Engine Service Does Not Start Up Automatically on First Reboot

Sometimes, the Engine service, although set to startup automatically during the install, does not do so on the first reboot after the installation routine restarts the machine. However, it starts up on subsequent reboots. The workaround is to start it manually the first time through the Services control applet.

3.7 Engine Service Fails to Start Up with Oracle Database

If you are running the Engine against an Oracle database, errors occur, and the Engine fails to start, ensure that the Oracle TNS Listener service and the Oracle database service are running. These services must be started before the Engine service.

3.8 "Access denied" error when connecting to the Engine

If you receive an “Access Denied” error when attempting to login through a web server, bear in mind:

• The IIS account assigned as the IIS anonymous user needs to be listed as one of the client accounts for the Engine’s COM+ application client roles, under Component Services.

• If the Engine is on a remote machine, it will not be able to select the IIS anonymous user of the web server machine as a client account by default. This is because the anonymous user account of a default installation of IIS is a local account specific to that web server machine (usually IUSR_<Machine Name>). Therefore to allow it access to the Engine via DCOM the anonymous user account must be upgraded to a network visible account (domain account). This is not a requirement when communicating to the Engine via the HTTP listener (see point below).

• If a domain account cannot be given to the anonymous IIS user then a workaround is to set up a local account on both the web server machine and the Engine machine with exactly the same name and password. Add this user into the client accounts for the engine under COM+ and it will authenticate correctly when accessed from the web server.

• When using the HTTP listener to access the Engine, the security requirements become simpler. Assume machine A is running the web server and machine B is running the Engine with the IIS HTTP listener running on a local IIS installation. When the call is made to the web server from the browser it will be processed under the IIS anonymous user of machine A. This will open a direct TCP/IP connection to the HTTP listener on machine B and the call to the Engine will then be made from the IIS anonymous user of machine B. So all that is required to enable the

Page 42: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

necessary Engine access security is to have machine B’s IIS anonymous user on its COM+ client list.

• If the Engine is installed on a Windows 2003 R2 machine and the Client is on a different machine, you need to configure the local security policy on the Engine machine to enable the Client to access the service list, as follows:

1. Access the Local Security Policy Control Panel applet. 2. Open the Local Policies node and then select the Security Options node. 3. Double-click on the DCOM: Machine Launch Restrictions in Security Descriptor

Definition Language (SDDL) syntax item. 4. Click on the Edit Security button. 5. Click on the Add button to add the Metastorm BPM Clients group. 6. Select the Metastorm BPM Clients group. 7. Check the Allow checkbox for the Local Launch and Remote Activation permissions.

For Outlook Clients attempting to connect to a Windows 2003 or XP Engine machine, you need to ensure that, in addition to the Client being as member of the Metastorm BPM Clients group. The Metastorm BPM Clients group is allowed remote access by the COM policy for the Engine machine. To do this:

8. Access the Component Services Control Panel applet. 9. Open the Component Services node, the Computers node, then the My Computer node. 10. Select the Action menu, then the Properties dialog. 11. Select the COM Security tab. 12. In the Access Permissions section, press the Edit Limits button. 13. Select the Metastorm BPM Clients group. 14. Ensure that the Allow checkbox for the Remote Access permissions is checked.

3.9 Unable to access the BPMEngine.Net URL When a client using the Engine’s .NET interface attempts to connect to an engine on another machine, the following error may be reported:

Access denied 401 error.

To resolve this problem, open the Internet Information Services administration tool, and change the BPMEngine.Net virtual folder to turn on Integrated Windows Authentication (IWA).

3.10 Problems Using Non-ASCII Characters in Scripts This problem may occur if the procedure was written on a computer using a different code page to the computer on which the browser used to access the Web Client is running.

3.11 Web client login page displays “Service Unavailable” on Windows Server 2003

If you are running the web extensions on Windows Server 2003, the login page displays the message “Service Unavailable”, and a small red padlock appears on the Application Pool cog icon, check the Identity account on the Application Pool.

After making changes to the Application Pool it must be restarted.

Metastorm BPM Version 9.0 December 2009 Page 38

Page 43: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 39

3.12 Unable to access Web Extensions If the installation was carried out in the following order, you may be unable to access the Web Extensions:

• Process Engine installed on computer without IIS

• IIS added to the computer

• Metastorm Web Extensions added using the Modify option of the installation.

To resolve this problem, add the following users to the Client role in the Process Engine COM+ application:

• Internet Guest Account (default name: IUSR_<ComputerName>)

• Launch IIS Process Account (default name: IWAM_<ComputerName>).

3.13 Web client does not function as expected

If the Web Client does not behave as expected:

• Clear the cookies.

• Clear the browser cache.

• Restart the Web Client.

3.14 HTTP 403 (Forbidden) error returned when opening the Web Client

ASP.NET IIS Extensions may need to be reinstalled. To do this:

1. Open the Command Prompt 2. Navigate to the .NET framework version 2.0 folder. For example:

c:\Windows\Microsoft.NET\Framework\v2.0.50727 3. Run the following command:

aspnet_regiis –I

3.15 Web client opens but no text is displayed on the main page

If the Web client opens but no text is displayed on the main page and the filter on the left contains the following text:

<%@ WebHandler Language="C#" Class="esFilterTreeHandler" CodeBehind="FilterTree.cs" %>

the ASP.NET IIS Extensions may need to be reinstalled.

3.16 Timed Actions stop being processed

With a configuration of a SQL Server DBMS on a separate machine to the Process Engine it has been observed that timer processing can stop unpredictably; no errors are logged in the event log and there are no entries in the designer log.

This behavior may arise due problems in the DTC configuration.

To investigate whether DTC is the cause:

Page 44: Metastorm BPM Version 9 -   · PDF fileMetastorm BPM Version 9.0 Metastorm BPM Version 9.0 . Installation Guide . Table of Contents . 1 Installation

Metastorm BPM Version 9.0

Metastorm BPM Version 9.0 December 2009 Page 40

1. Look up Microsoft article “How to Use DTCTester tool” (article id 293799) from the Microsoft support website.

2. Download and install the tool to the Process Engine machine. 3. Run DTCTester as described in the instructions, taking care to specify the same DSN, user id and

password that the Engine is using. a. These can be found in the registry entry Connection: HKLM\SOFTWARE\Metastorm\e-

Work\Engine\Database b. Check the test output against what the article advises, to see whether the tool completed

successfully or not. 4. If tests with the DTCTester tool yield errors this indicates problems with the DTC configuration.

a. The Microsoft article lists possible reasons for this. When using Windows 2003 Server, we have found there were two areas on which to focus:

b. Ensure that network DTC access is enabled on both the Process Engine and database servers. Step one of the Microsoft article “HOWTO: Enable DTC Between Web Servers and SQL Servers Running Windows Server 2003” (article id 555017) describes how to do this.

c. It may be necessary to amend the DTC security configuration. The Microsoft article “”XACT_E_NOENLIST" error message in DTC and SQL Server” (article id 831425) describes where these settings may be amended.

Note: It may be helpful to use the DTCPing tool to assist with further diagnosis.

3.17 Client Interface Displaying Old Options Web Client interface options that were applicable to the Metastorm BPM v7.6 environment can end up being displayed in the v9.0 web client as both clients use cookies to record such things as available processes on the blank forms list, most recently used processes etc. When upgrading from v7.6 to v9.0 it may be necessary to delete cookies to prevent old options being displayed to the user in the web client interface. Delete Cookies by undertaking the following steps:

1. Tools > Internet Options 2. Go Down to the Browser History section and select the Delete Button 3. Make sure the Cookies CheckBox is selected 4. Hit the Delete Button 5. Go back to the Metastorm Web Client and hit F5 to refresh the screen, the problem should be

corrected.