PegaRULES Process Commander Release V6.1 SP2
Installing on WebSphere 6.1 Application Servers
September 25, 2010
Copyright 2010 Pegasystems Inc., Cambridge, MA All rights reserved. This document and the software describe products and services of Pegasystems Inc. It may contain trade secrets and proprietary information. This information should not be disclosed to third parties unless otherwise provided for by a contract or business agreement with Pegasystems. This document and the software are protected by federal copyright law, international laws, and/or applicable treaties. This document is current as of the date of publication only. Changes in the document may be made from time to time at the discretion of Pegasystems. This document remains the property of Pegasystems and must be returned to it upon request. This document does not imply any commitment to offer or deliver the products or services provided. This document may include references to Pegasystems product features that have not been licensed by your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems service consultant. Other brand or product names are trademarks of their respective holders.
This document is the property of: Pegasystems Inc. 101 Main Street Cambridge, MA 02142-1590 Phone: (617) 374-9600 Fax: (617) 374-9620 www.pega.com PegaRULES Process Commander Document: Installation Guide Software Version: 6.1 SP2 Updated: September 25, 2010
Contents Introduction..................................................................................................................................... 1 Process Commander Deployment Architecture ............................................................ 1 Overview of the Installation Procedure ................................................................................. 3 Process Commander Core Component Versions ................................................................ 5 Step 1: Environment Considerations........................................................................................... 6 Prerequisites ............................................................................................................................ 6 Supported Process Commander Platforms ................................................................... 7 Check the Pega Developer Network for the Latest Information ................................... 7 A Note for PRPC 4.2 Users .............................................................................................. 8 Step 2: Database Preparation ....................................................................................................... 9 Database Prerequisites ........................................................................................................... 9 Creating a PRPC Database ................................................................................................... 10 Creating Access to the Database ......................................................................................... 10 User Permissions for the Microsoft SQL Database..................................................... 11 User Privileges for the Oracle Database ...................................................................... 12 User Privileges for the UDB Database.......................................................................... 12 Create the Schema in Process Commander Database ...................................................... 12 Using a SQL Script to Create the Schema ................................................................... 13 Next Steps .............................................................................................................................. 13 Step 3: Application Server Preparation ..................................................................................... 14 Verify the Java Environment ................................................................................................ 14 Configure Support for the Process Commander Database ............................................... 15 Microsoft SQL Server..................................................................................................... 15 Oracle .............................................................................................................................. 15 UDB ................................................................................................................................. 17 Create a WebSphere Profile ................................................................................................. 18 Start and Configure the Server ............................................................................................ 19 Set JVM Requirements .................................................................................................. 20 Create URL Providers .................................................................................................... 25 Create JDBC Resources ................................................................................................ 30 Configure WebSphere WorkManager ........................................................................... 42 Other WebSphere Configuration................................................................................... 44 Next Steps ....................................................................................................................... 47 Deploy the PegaRULES core application ............................................................................ 47 Deploying prpc_j2ee14_ws.ear in WebSphere ............................................................ 47
iv
Pegarules Process Commander Installation Guide V6.1 SP2
Installing the System Management and Online Help Applications ................................... 54 Assigning the PegaDiagnosticUser Role to your System Management Application Users ................................................................................................................................................ 57 Next Steps ....................................................................................................................... 58 Steps 4 - 9: Rulebase Setup........................................................................................................ 59 Install the Process Commander Schema and Rules in the Database............................... 59 Step 10: Final Settings in Process Commander ....................................................................... 73 Configure your environment ................................................................................................ 74 Enable Developer Help and the System Management Application ............................ 75 Create an Organization .................................................................................................. 76 Install Solution Frameworks................................................................................................. 78 Appendix A: Command-line Interfaces for Installation, Upgrade, and Utilities ..................... 79 Prerequisites................................................................................................................... 80 Installation and Upgrade Setup..................................................................................... 80 Running the Install and Upgrade Scripts ..................................................................... 83 Advanced Properties ..................................................................................................... 83 Other Environment Properties ...................................................................................... 84
Introduction This document describes how to install a new instance of PegaRULES Process Commander 6.1 SP2. Upgrading an existing Process Commander installation is described in other documents: ■
To upgrade a Process Commander 4.2 system to 6.1 SP2, your current system must first be at 4.2 SP6. If your current system is earlier than 4.2 SP6, see the Upgrade Guide for 4.2 SP6 for instructions on moving to SP6.
■
To upgrade from 4.2 SP6 to 6.1 SP2, see the manual Upgrade Guide, V4.2 SP6 to V5.
■
For information about upgrading any existing Process Commander 5 installation to 6.1 SP2 see the PegaRULES Process Commander Upgrade Guide 6.1 SP2, released with Process Commander 6.1 SP2.
These documents and any updates to existing Process Commander documentation are available on the Pega Developer Network (pdn.pega.com). Please check this site for the latest installation and configuration information.
Process Commander Deployment Architecture Process Commander is a Java EE enterprise application. As shown in the diagram below, it runs on top of two main platform sub-systems: 1. A database system to store the rules and work objects used and generated by Process Commander. 2. An application server that supports the Java EE specification. The application server provides a run-time environment and other services, such as database connections, Java Messaging Services (JMS) support, and connector and services interfaces to other external systems.
2
PegaRULES Process Commander Installation Guide v6.1 SP2
Both developers working on Process Commander applications and users working with those applications access Process Commander through Web browser interfaces.
3
Overview of the Installation Procedure The following outline details the steps in the 6.1 SP2 installation process: Preparation Phase
Step 1 – Environment Considerations Step 2 – Database Preparation Step 3 – Application Server Preparation
Rulebase Setup Phase
Step 4 - License Agreement Step 5 - Type of Setup Step 6 - Database Configuration Step 7 - Database Connection Step 8 - Temporary Directory Step 9 - Rulebase Loading
PRPC Configuration Phase
Step 10 – Final Settings in PRPC
Installing Process Commander includes 10 steps organized into three phases:
1. Preparation Phase You complete the Preparation Phase following the procedures in this guide. ■
Step 1: Environment Considerations, page 6.
Make sure that your environment meets the requirements for PRPC 6.1 SP2 in terms of: Hardware, OS, JVM, JDBC Driver, Application Server, Database Server, PRPC, and their respective settings. 1. Review the current Platform Support Guide, which is available on the Pega Developer Network (PDN) or from your Pega account executive. This document lists the recommended software components needed to support Process Commander, and any special requirements or known issues with particular vendors or versions. 2. Review your site’s deployment requirements with your IT representatives. 3. Consult with your Pegasystems representative about your installation plans. Pegasystems’ prior experience with various platforms and deployment architectures can help your installation go smoothly. ■
Step 2: Database Preparation, page 9.
4
PegaRULES Process Commander Installation Guide v6.1 SP2
Create and configure a blank database for Process Commander to use. You can use SQL scripts provided by Pegasystems to create the schema required by Process Commander in the database, or you can choose to have the Installation and Upgrade Assistant create the schema when you run that tool. You provide connection information for this database to the Installation and Upgrade Assistant used in the Rulebase Setup Phase and to specify the datasource in your application server. The connection information you will need includes the location of the JDBC driver file, the driver class name, the database connection URL, and the database user's username and password.
Note: When the Database Preparation is complete, Step 3, the Application Server Preparation, and Steps 4-9 in the Rulebase Setup Phase can be performed in either order or simultaneously. You can, for example, launch the Rulebase Setup process in Step 9 of the Assistant and then configure your Application Server while the Rulebase load process is running. However, you must configure the application server and deploy the Process Commander applications before you can complete Step 10, PRPC Final Settings.
Important: You must be careful not to start the deployed Process Commander applications while the Rulebase loading process is still running on the database. Note that your application server may start the application automatically when it is deployed. If the Process Commander application attempts to connect to the database while the Rulebase is loading, the database loading will not complete correctly. ■
Step 3: Application Server Preparation, page 14.
Configure your application server to support the Process Commander application, including: 1. Configure the right Database Driver for your Database 2. Configure the PRPC Data Source 3. Configure other Application Server settings 4. Deploy the Process Commander application (WAR or EAR) 5. Deploy the online help application (prhelp.war) and System Management Application (prsysmgmt.war).
2. Rulebase Setup Phase You complete the Rulebase Setup Phase by running steps 4 to 9 in the Installation and Upgrade Assistant (PRPC_Setup.jar). This tool is covered in this guide in the section Steps 4-9, Rulebase Setup Phase on page 59.
5
The Installation Assistant optionally creates the Process Commander schema in the database instance you provide, and installs the initial set of rules and classes Process Commander needs to run into the database.
3. PRPC Configuration Phase You complete the PRPC Configuration Phase after finishing the Installation by logging into Process Commander. The setup steps you should complete in Process Commander are described in section Step 10: Final PRPC Configuration Steps, page 74.
Process Commander Core Component Versions The Process Commander core application is packaged in four different versions to support deployment into different Java EE environments. The following table summarizes which packages provided and their use: Type of deployment
PRPC package to use
All Tomcat deployments
prweb.war
New deployments on WebSphere 6.1.x, 7.0.x.
prweb.war or prpc_j2ee14_ws.ear
New deployments on WebLogic 9.x, 10.3.1, 11g (10.3.2); JBoss CE 4.2.x, 4.3.x, 5.0.x
prweb.war or prpc_j2ee14.ear
New deployments on JBoss EAP 4.3.x, 5.0.x (Red Hat)
prpc_j2ee14_jbossJBM.ear
Tomcat users should install the WAR in all cases. If you have any questions regarding the correct package to deploy, contact Pega Support.
6
PegaRULES Process Commander Installation Guide v6.1 SP2
Step 1: Environment Considerations Prerequisites The prerequisites for installing Process Commander are: ■
An application server host computer with adequate memory and disk space for the installation. Process Commander requires a minimum of one GB of free memory. This is in addition to any memory allocated for the operating system or other applications on the server. The memory required for your system may need to be higher, depending on the number of users and your specific configuration.
■
A working installation of the application server. Process Commander Installation Guides for each supported application server are available with your Pegasystems software distribution and on the Deployment page of the Pega Developer Network (http://pdn.pega.com).
■
A configured relational database available for Process Commander use, and support in your organization for the installation and configuration of relational databases.
The database and application server platforms may be either UNIX or Windows systems. However, a Windows system is required for the Pegasystems developer and end-user clients and for some of the Pegasystems monitoring tools, specifically, PegaRULES® Process Analyzer™, Process Simulator™. The
7
environment for your initial Process Commander system should include at least one Windows platform.
Note: If you have difficulty installing any of the third-party software required by Process Commander, contact the other software vendor to resolve the issues before installing Process Commander.
Supported Process Commander Platforms Because Process Commander is developed to industry standards — Java and J2EE technologies, J2EE compliant application servers, SQL databases, web browsers, XML, and HTML— a Process Commander system can be successfully deployed on a wide range of hardware and software platform combinations. However, careful selection of your platform components can make your installation and deployment of Process Commander easier. To determine the right platform components for your Process Commander deployment: 1. Review the current Platform Support Guide, which is available on the Pega Developer Network (PDN) or from your Pega account executive. This document lists the recommended software components needed to support Process Commander, and any special requirements or known issues with particular vendors or versions. 2. Review your site’s deployment requirements with your IT representatives. 3. Consult with your Pegasystems representative about your installation plans. Pegasystems’ prior experience with various platforms and deployment architectures can help your installation go smoothly. For additional information see the Platform Support Guide, which is available as a PDF file on the Pega Developer Network (PDN), located at http://pdn.pega.com.
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure, check the Pega Developer Network (PDN), located at http://pdn.pega.com, for the latest information. The installation guides are updated whenever new information becomes available. Be sure to check for the latest version.
Pegasystems Documentation The latest Process Commander documentation, including Installation, Upgrade, and Platform Support guides is available on the Documentation page of the Pega Developer Network.
8
PegaRULES Process Commander Installation Guide v6.1 SP2
Visit http://pdn.pega.com and select Guides -> Process Commander V6 Deployment
Deployment information and updates Check the Deployment page on the Pega Developer Network for information, updates, and platform bulletins on deploying Process Commander including links to the latest Knowledge Base articles. Visit http://pdn.pega.com and select Browse -> Deployment -> About This Topic
A Note for PRPC 4.2 Users This installation procedure differs from earlier installation procedures in significant ways. Please review the instructions carefully. In particular, please be aware of two changes: ■
Pegasystems now recommends using data sources defined in your application server to establish connections to your database instead of the Process Commander connection pooling sometimes used in earlier installations.
■
Be sure to create and configure a temporary directory that Process Commander can use to store static data. See the section “Setting the Explicit Temporary Directory” in the chapter that describes deployment with your application server.
9
Step 2: Database Preparation To prepare your database server to use with Process Commander, you must complete the following tasks: ■
Create a blank database.
■
Create an appropriate user that Process Commander can use to access the database.
■
Create a database schema that defines the data objects (tables, indexes, views, triggers and procedures) required by Process Commander. You can either have your DBA, or someone with similar permissions, use your database tools to run a SQL script provided by Pegasystems to create the schema objects, or, in Step 6 of the Assistant, you can select a Create Schema option to have the Assistant create the schema automatically before loading the Rulebase. Running the SQL script allows you to review and, if necessary, customize the schema for your environment.
Database Prerequisites Process Commander requires a working installation of one of the supported databases, as described below. For additional information, see the Platform Support Guide, which is available as a PDF file on the Pega Developer Network (PDN). Go to http://pdn.pega.com and select Guides -> Process Commander V6 Deployment..
10
PegaRULES Process Commander Installation Guide v6.1 SP2
Install and configure the relational database according to vendor directions. This database may reside on the same server as the Process Commander software, or it may be on a different server.
Creating a PRPC Database Create a database with a minimum of 4GB for the user tablespace and allow the database to grow. For a typical development environment, expect the database to grow to at least 10GB over time. The space required for your system may need to be higher, depending on your use of Process Commander and the number of users. Be sure to record: ■
Database server name
■
Database port number
The Process Commander system requires this information to access this database.
Additional UDB Requirement When using UDB, for each schema that contains Process Commander tables, Process Commander requires a 32K bufferpool, a 32K user regular tablespace, and a 32K user temporary tablespace. By default, the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size.
Creating Access to the Database Create a user for this database with full read and write permissions. At a minimum this “base” Process Commander user must have appropriate read and write permissions to be able to run SQL scripts on the database. In addition, a small number of Process Commander functions require permission to run CREATE_TABLE and ALTER_TABLE operations. You can assign permissions that include these operations to the base user, or you can create a second Admin DB user with these extended permissions which Process Commander uses only for these special functions. For details, see “Creating Base and Admin Database Users,” below. When you configure data access in your application server, you must provide the user name and password for the user or users you have created to access the Process Commander database. Be sure to record this information and have it available when configuring the application server.
Creating Base and Admin Database Users If possible, it is best to create a single Process Commander user with full permissions. If you want to restrict users’ access to the Process Commander database, you can create two users:
11
■
A “base” user with only read and write permissions.
■
An Admin user with full access including permission for CREATE_TABLE and ALTER_TABLE operations.
To implement two users, you configure access to the database in your application server by creating two data sources: ■
One datasource referencing the JNDI location jdbc/PegaRULES that specifies the username and password for the base DB user. This user must have at least read and write permissions for the database.
■
A second datasource referencing the JNDI location jdbc/AdminPegaRULES specifying the username and password for the DB Admin user. This user must have full access including permission for CREATE_TABLE and ALTER_TABLE operations.
How Process Commander Uses the two Database Accounts If you configure a second datasource for the Admin user, Process Commander uses that user when performing a small number of functions that require altering the database, specifically: ■
Using the Database Schema Management tool (Tools > Database > Modify Database Schema).
■
Creating any new Circumstance Definition rule or defining a single circumstance on a rule. The extended permissions are needed to support reporting on circumstanced properties. (On the Pega Developer Network, see PRKB-25173: How to create a rule with multiple circumstance properties.)
■
Exposing embedded properties for selection and reporting. (On the Pega Developer Network, see PRKB-25278: How to create Declarative indexes for embedded properties.)
For all other functions, Process Commander uses the base DB user which only requires read and write permissions. If you do not provide ALTER TABLE and CREATE TABLE permissions to any user, Process Commander generates a warning when you use these features. The warning includes SQL script that you can provide to your DBA to manually make the necessary database changes. Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the Process Commander database user with public and db_owner roles with all corresponding System Permissions granted.
12
PegaRULES Process Commander Installation Guide v6.1 SP2
User Privileges for the Oracle Database Set the user account for the Process Commander database user with the default RESOURCE and CONNECT roles with all corresponding system privileges granted. In particular, be sure that the user has the Create View system privilege.
Note: On the Oracle 10g HTML-based Enterprise Manager console there are separate tabs for setting the user’s roles and system privileges. When editing the properties for the Pega user, be sure to go to the Roles tab to set the RESOURCE and CONNECT roles, and then to the System Privileges tab to set the Create View system privilege.
Important: Do not grant DBA access to the user, as this may cause problems with the installation.
User Privileges for the UDB Database Create a user account for the Process Commander database user with at least SYSADM privileges.
Create the Schema in Process Commander Database Before you load the initial Process Commander rules into the database in Steps 4-9 below, you must create the database schema that defines the data objects (tables, indexes, views, triggers and procedures) required by Process Commander. You can create the schema in two ways: 1. In the Install and Upgrade Assistant user interface, you can select the Create Schema option. The Assistant then creates a default schema in the database automatically before loading the Rulebase. If you want the Assistant to create the schema, skip the following section “Using a SQL Script to Create the Schema”, and continue with the Assistant as described in Steps 4-9 below. 2. Your database administrator (DBA), or someone with appropriate permissions, can run a SQL script, provided by Pegasystems, to create the schema in your Process Commander database. Process Commander V6.1 SP2 includes SQL scripts for each supported database: mssql, oracle (oracledate), and udb, for example, oracledate_install_6.1SP2.sql. Running the SQL script allows you to review and, if necessary, customize the schema for your environment. To create the schema in the database using the SQL script, follow the procedure described in the next section.
13
Using a SQL Script to Create the Schema If you choose not to select the Create Schema option in the Installation and Upgrade Assistant your database administrator (DBA), or someone with appropriate permissions, must run a SQL script to create the schema in your Process Commander database. 1. In the software distribution directory for Process Commander find the install SQL script for your database type. C:\PRPC_distro\schema\oracledate\install\oracledate_install_6.1SP2.sql
2. You or your DBA should review this script to make sure it is appropriate for your environment. You can customize the script if necessary. For example, the default scripts create an ASCII database. Modify the scripts if you require Unicode. In most cases, the SQL script can be used without modification. If you are unsure about whether the script can be run in your environment, contact Pegasystems Customer Support. 3. Use your database tools to run the appropriate SQL script against your Process Commander database.
Note: For MS-SQL installations only, the following message may appear: Warning: The table 'pr4_rule' has been created but its maximum row size (8506) exceeds the maximum number of bytes per row (8060). INSERT or UPDATE of a row in this table will fail if the resulting row length exceeds 8060 bytes. You may ignore this message. This warning message relates to a known limitation of Microsoft SQL Server. Process Commander does not exceed the maximum row size in this table.
Next Steps You can continue either with Step3, Application Server Configuration, or Steps 49, Rulebase Setup. These two procedures are independent and can be completed in either order or simultaneously. Note, however, that you cannot run Process Commander successfully until the database setup is complete. If you deploy and start the Process Commander application before the database is complete, the application generates errors.
14
PegaRULES Process Commander Installation Guide v6.1 SP2
Step 3: Application Server Preparation This section first describes the tasks you must complete on your application server before beginning to deploy the PRPC application: ■
Verify the Java Environment
■
Configure Support for the Process Commander Database
To complete deploy the Process Commander system, you deploy three applications: ■
the Process Commander core application, prweb.war or prpc_j2ee14.ear
■
the System Management Application, prsysmgmt.war or prsysmgmt.ear
■
the Developer Help application, prhelp.war
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 1.5.0_07 or higher. Refer to the Platform Support Guide, available as a PDF file on the Pega Developer Network (PDN) located at http://pdn.pega.com, for specific recommendations for your platform.
15
Important: During installation, Process Commander requires access to the directory specified by the java.io.tmpdir setting in the JVM. Confirm that there is write access to this directory before installing Process Commander. Be sure your application server is configured to use an appropriate JDK. The default Java environment for your application server may not be one of the recommended JDKs for Process Commander.
Configure Support for the Process Commander Database In order to support JDBC connections between your application server and the Process Commander, you must install the appropriate database client software and JDBC drivers on your application server as recommended by your database vendor. The following sections provide guidelines for the supported database systems.
Microsoft SQL Server Use the drivers provided by your application server or download the latest drivers from the Microsoft website. For both SQL Server 2005 and 2008, use the appropriate driver for your JVM –
For Java 5: sqljdbc.jar
–
For Java 6: sqljdbc4.jar
Configure the application server so that these drivers are loaded in the classpath.
Note: Be sure only the appropriate JAR file is loaded. Do not put both sqljdbc.jar and sqljdbc4.jar in the classpath.
Oracle Follow all Oracle instructions for installing the client software and the JDBC drivers. 1. Confirm that the appropriate JDBC driver is in the /jdbc/lib directory of your Oracle installation directory or download it from the Oracle site. The appropriate file depends on the Java version of your JVM: –
For Java 5: ojdbc5.jar
–
For Java 6: ojdbc6.jar
If you are using the OCI (thick) driver, this directory must also contain the Oracle Client software.
16
PegaRULES Process Commander Installation Guide v6.1 SP2
Note: Pegasystems recommends use of the Thin Client driver. 2. If you are using the OCI (thick) driver, confirm or set the appropriate environment variables: Edit as follows for Solaris: –
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables.
–
Add $ORACLE_HOME/lib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOME/lib directory (as Process Commander uses 32-bit libraries).
Edit as follows for AIX: –
Set ORACLE_HOME and LIBPATH environment variables.
–
Add $ORACLE_HOME/lib32 to the LIBPATH before the reference to the standard $ORACLE_HOME/lib directory (as Process Commander uses 32-bit libraries).
For the Windows environment, the necessary environment variables (such as ORACLE_HOME and Path) are set automatically by the Oracle installation program. Be sure the application server classpath is configured to load this JDBC driver.
Validating the Oracle Connection Login into SQL*Plus to validate the Oracle connection. For example, enter the following command on the server: userid/password@SID
Example: $sqlplus oratest/
[email protected]
In this example, oratest is the userid, oratest is the password, and oratest.rpega.com is the SID. This should return Oracle system information and the Connected to: message. SQL*Plus: Release 10.1.0.2.0 - Production on Mon Nov 27 11:08:28 2006 Copyright (c) 1982, 2004 Oracle Corporation. All rights reserved. Connected to: Oracle Database 10g Enterprise Edition Release 10.1.0.2.0 – Production With the Partitioning, OLAP, and Data Mining options SQL>
17
If problems logging in occur (that is, the above messages do not appear), resolve these issues first before loading Process Commander.
UDB Follow the IBM instructions for installing the client software and the JDBC drivers to make the db2jcc.jar available. This JDBC driver is the Type 4 universal driver. For WebLogic, configure the application server so that this driver is loaded in the classpath.
18
PegaRULES Process Commander Installation Guide v6.1 SP2
Deploying Process Commander WebSphere 6.1 This section describes a sample deployment procedure for Process Commander 6.1 SP2 on WebSphere 6.1. If you are installing 6.1 SP2 on an earlier WebSphere release, the Administration Console screens and fields will vary from those described below, and you may need to make some modifications to the configuration settings specified. Be sure to contact Pegasystems Customer Support before installing Process Commander on a hardware and software platform that does not conform to one of the supported platforms for this release. For more information, see Supported Process Commander Platforms on page 7.
Create a WebSphere Profile Run the WebSphere Profile Management Tool to create a WebSphere profile in which to run the PRPC application. You must create a new profile dedicated to PRPC, so that PRPC can run in its own JVM environment. You may use either the Typical profile creation or the Advanced profile creation option. The Typical profile assigns default values for such things as the Profile name, Node name, Host name, and access ports. Advanced Profile creation lets you change the defaults. Both methods allow you to choose whether to apply Administrative Security requiring a login with user name and password when starting the Administrative Console. If you choose the Advanced option, be sure to choose to deploy the Administrative Console.
19
Note: On Windows platforms, the Typical option creates the application server as a Windows service by default. This means that you must manage the profile as a Windows service, for example when starting and stopping the server. If you do not want to run the application as a Windows service, choose the Advanced profile creation option and, on the Windows Service Definition page, do not check “Run the application server process as a Windows Service.” Make sure you record the following information about the profile you create: ■
Profile name
■
User name and password for the Administrative Console (if you choose to apply Administrative Security.)
■
Port numbers for the profile, including at least: –
Administrative Console Port (9060 by default)
–
HTTP transport port (9080 by default)
Depending on your environment, you may also need to record the port numbers for the Administrative console secure port, the HTTPS transport port, and the SOAP connector port. If you are unsure about these requirements, check with your application server administrator For information on WebSphere Profiles, go to the WebSphere online documentation at http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jspl, and search for “Creating and deleting profiles.”
Start and Configure the Server 1. Start the server for the new profile, launch the Administrative Console, and login. On Windows platforms, you can start the profile server and launch the Administrative Console from the Start menu, for example, in a default installation: –
To start the server, click Start > All Programs > IBM WebSphere > Application Server v6.1 > Profiles > AppSvr01 > Start the server.
–
To launch the Administrative Console, click Start > All Programs > IBM WebSphere > Application Server v6.1 > Profiles > AppSvr01 > Administrative Console.
20
PegaRULES Process Commander Installation Guide v6.1 SP2
If you enabled Administrative Security when you created the profile for this server, you will need to login using the user name and password you specified at that time. When the Administrative Console is launched, it displays the Welcome screen for WebSphere’s Integrated Solution Console:
2. Click the link WebSphere Application Server to display the Welcome page for the Application Server:
Set JVM Requirements Setting Memory Parameters
21
Set these memory parameters as described below: ■
Initial Heap Size: 768
■
Maximum Heap Size: 1024
If your application server is using the Sun JVM, add the PermSize and MaxPermSize settings as well: ■
PermSize: 64MB
■
MaxPermSize 256MB
1. In the Administrative window, on the left side of the screen, click the “+” next to Servers to expand the servers. Click Application Servers.
2. Find the name of the server on which Process Commander will run, and click that server name. (In the example above, the server is server1.) The Configuration tab for that server appears.
3. In the Server Infrastructure section, click the “+” next to Java and Process Management to expand the section.
22
PegaRULES Process Commander Installation Guide v6.1 SP2
4. Click Process Definition. This displays the Configuration tab for Process Definition.
5. In the Additional Properties section, click Java Virtual Machine. This displays the Configuration tab for the Java Virtual Machine.
23
6. On this window set: –
Initial Heap Size of 768
–
Maximum Heap Size of at least 1024
Note: These values are initial minimum estimates for typical development systems. They may need to be higher based on your server hardware and the number of other applications on the server. Consult with your System Administrator about the requirements for your site. You can set the Initial and Maximum heap sizes to the same value to avoid the performance costs of heap contraction and expansion. All of the memory
24
PegaRULES Process Commander Installation Guide v6.1 SP2
is allocated at startup. However, if you set an initial heap size lower than the maximum, you may find that the heap does not grow to the maximum size. Consult with your System Administrator to tune these settings to the best values for your environment. 7. If your WebSphere instance is using the Sun JVM, also set the PermSize and MaxPermSize settings: –
PermSize of 64MB
–
MaxPermSize of 256MB
Note: These memory settings for the JVM are minimum settings only. They may need to be higher based on your server hardware and the number of other applications on the server. If needed, set PermSize and MaxPermSize parameters in the Generic JVM Arguments field by entering: -XX:PermSize=64m,-XX:MaxPermSize=256m
Separate the JVM Arguments with a space between each. Do not use commas. 8. Click Apply to apply these settings. A message appears at the top of the screen explaining that the changes were made.
9. Click Save within the message to save these changes to the master configuration. The confirmation screen appears. Click the Save button to confirm that you want your changes saved to the master repository.
Enabling AWT to support PRPC Graphs--UNIX Only
25
If you are deploying PRPC on any of the UNIX platforms (Solaris, AIX, HPUX, Suse or RedHat Linux,) complete the following steps: 1. Still on the Java Virtual Machine page, in the Generic JVM Arguments field, enter: -Djava.awt.headless=true
For example,
Note: Separate this argument from any others in the field with a space. Do not use commas. 2. Click Apply. 3. In the Messages section at the top of the page, click Save. This setting enables server to render graphics that are required to produce the PRPC graphical reports.
Create URL Providers Follow the procedure below to set the required URL Pega reference and an explicit Temporary directory for Process Commander. The temporary directory is used by Process Commander to store static data during a session. It is important that the directory be properly specified and accessible to the Process Commander user. In WebSphere you specify this directory as a JNDI reference to a URL object.
26
PegaRULES Process Commander Installation Guide v6.1 SP2
1. In the WebSphere Administration console select Resources > URL > URL Providers in the left frame.
2. Select the Scope level appropriate to your deployment, and click on the Default URL Provider link.
27
3. Under the Additional Properties section, click on the URLs link.
28
PegaRULES Process Commander Installation Guide v6.1 SP2
4. Click New.
5. Define a URL for the NULL file that Process Commander can use to discard erroneous error messages Complete this form as follows: –
In the Name field, enter PRPCnone
–
In the JNDI field, enter url/pega/none
–
In the specification field, enter file:///null for Windows or file:///dev/null for UNIX/Linux.
6. Click OK. 7. From the URLs page, click New again to create another URL specification:
29
8. Create a URL specification for a temporary directory that Process Commander can use to store static data during a session. Notes: If the directory you specify does not exist, Process Commander will attempt to allocate it. It is good practice to allocate the directory on the system before specifying it here. The user that owns the Java process must have the appropriate permissions to use this directory, including write access. In particular, if you have J2 security enabled, ensure that this directory is accessible under your security policy. In a clustered deployment, each Process Commander instance must have its own temporary directory. You cannot share a temporary directory with more than one Process Commander instance. Complete this form as follows: –
In the Name field, enter PegaTempDir
–
In the JNDI field, enter url/initialization/explicittempdir
–
In the specification field, enter file:// followed by the full path to the temporary directory. Enter the path using forward slashes for both
30
PegaRULES Process Commander Installation Guide v6.1 SP2
Windows and UNIX platforms. For example, on Windows the value might be: file://D:/Temp/PegaTempDir. Important: The directory names you enter here are case sensitive. Be sure to enter the names of the directories exactly as they have been created on your system. 9. Click Ok to save your changes.
Create JDBC Resources Create a JDBC provider 1. In the Administrative console, click Resources > JDBC > JDBC Providers to display the JDBC Providers page:
2. In the Scopes dropdown, choose the scope level appropriate to your deployment, and click New. Note: The screen shots in the following section show the Oracle settings. If you are not using Oracle, follow the instructions for each step to configure the JDBC provider for your database, replacing the Oracle settings shown in the screen shots with the appropriate information for your database.
31
3. Complete the fields in Step 1 as follows: –
In the Database type dropdown, select the database type of your Process Commander database: DB2, Oracle, or SQL Server,
–
The Provider type dropdown lists only contains provider types that are appropriate for the database type you selected.
–
•
For DB2, choose DB2 Universal JDBC Driver Provider.
•
For Oracle, choose Oracle JDBC Driver
•
For SQL Server, choose Microsoft SQL Server JDBC Driver.
In the Implementation type dropdown, select Connection pool data source.
–
In the Name and Description fields enter a descriptive name and explanatory description for the driver you selected.
Click Next.
32
PegaRULES Process Commander Installation Guide v6.1 SP2
4. In the Directory location field, confirm the entry, if one is displayed, or enter the path to the driver class files. The appropriate file depends on the Java version of your JVM: Oracle: –
For Java 5: ojdbc5.jar
–
For Java 6: ojdbc6.jar
MS SQL 2005 and 2008: –
For Java 5: sqljdbc.jar
–
For Java 6: sqljdbc4.jar
Note: Be sure only the appropriate JAR file is loaded. Do not put both sqljdbc.jar and sqljdbc4.jar in the classpath. 5. Click Next.
33
6. Confirm that the settings are correct, and click Finish. You are returned to the JDBC Providers page.
7. Click on the name of the provider you just created to display the General Properties page.
34
PegaRULES Process Commander Installation Guide v6.1 SP2
Create Data Source 1. Still on the JDBC providers page, under the Additional Properties heading, click Data Sources to define the data source.
35
2. Click New.
3. Define the data source name and JNDI name as described below. –
In the name field, enter PegaRULES
–
In the JNDI Name field, enter jdbc/PegaRULES.
–
Click Next.
36
PegaRULES Process Commander Installation Guide v6.1 SP2
4. Supply information about your Process Commander database. The information required varies according the database type. In the Oracle example shown above, you supply the database URL and the data store helper class name. For MS SQL Server, you supply the database name, server name and, if applicable, port number on the database server.
Note for Oracle users: For Oracle 10g and 11g, specify a URL for the Type 4 (thin client) JDBC driver, for example, jdbc:oracle:thin:@myServer:1521:myDatabase, where myServer is the DB server name, 1521 is the port number it is using for communication, and myDatabase is the database name. Then, in the Data store helper class name, specify the Oracle 10g data store helper. If you are unsure about the information to supply for your database server, consult with your site DBA. Click Next. 5. On the Summary page, confirm that the settings are correct and click Finish. You are returned to the JDBC Providers page.
37
6. Click the PegaRULES link in the Name column to open the properties page for this data source. Then, under Additional Properties, click on the Custom Properties link to display the Custom Properties page:
7. Click New to define any additional properties you may need for your database connection here.
38
PegaRULES Process Commander Installation Guide v6.1 SP2
To create a new property, click New on the Custom Properties form. After creating each property, click OK to save the property, and New again to create the next property. Be sure to set the Type field appropriately for the Value of the connection property. PRPC requires the following properties for each database type: –
If Oracle with the ojdbc5 driver, add the following property: Name: connectionProperties Value: oracle.jdbc.V8Compatible=true This property is not needed with Java 6 and the ojdbc6.jar driver.
–
If MS SQL Server, add the following properties: For non-Unicode databases only: Name: SendStringParametersAsUnicode Value: false For all databases:
39
Name: SelectMethod Value: cursor Name: webSphereDefaultIsolationLevel Value: 2 –
If UDB, add the following properties: Name: currentSchema
Value:
Note: Be sure to enter the schema name in all capital letters. –
Name: currentFunctionPath
Value: SYSIBM, SYSFUN, Name: fullyMaterializeLobData
Value: true
Name: fullyMaterializeInputStreams Name: progressiveStreaming Name: progressiveLocators
Value: true
Value: 2 Value: 2
Name: webSphereDefaultIsolationLevel Value: 2
Note: SYSIBM and SYSFUN are system schemas provided by DB2. They are required because Process Commander 6.1 SP2 makes use of some functions made available in these schemas. 8. After you have set the necessary properties, click the Save link in the message at the top of the page.
Define Database Authentication Credentials 1. In the link path at the top of the page, click PegaRULES to return to the PegaRules properties page. Then, under the Related Items section, click the link JAAS – J2C authentication data. You will define your database authentication credentials here.
40
PegaRULES Process Commander Installation Guide v6.1 SP2
2. Click New to specify the General Properties.
3. Enter an Alias for this J2C connector, the User ID and Password for your PRPC database user, and a Description. The Alias can be any name that uniquely identifies this J2C entry. 4. Click OK to return to the authentication data entries page, and click Save in the Messages section at the top of the page.
41
5. In the link path at the top of the page, again click PegaRULES to return to the PegaRules properties page.
6. Click in the Component-managed authentication alias dropdown to select the J2C alias you just created: 7. Click Ok, save your changes. 8. On the JDBC providers page, click Test Connection.
42
PegaRULES Process Commander Installation Guide v6.1 SP2
Configure WebSphere WorkManager If you are deploying Process Commander’s EAR archive, prpc_j2ee14_ws.ear, complete the following procedures to define a WorkManager. Process Commander uses the WorkManager to run asynchronous tasks to support internal components such as agents, services, daemons, and child-requestors. If you are deploying Process Commander’s WAR archive, prweb.war, you do not need to configure the WorkManger. Continue with the configuration procedure, “Other WebSphere Configuration” on page 44. Complete the following procedures to define the WorkManager: 9. In the navigation menus on the left of the Administration Console, Expand Resources, expand Asynchronous Beans, and select Work Managers
10. On the Work Managers listing page, set the Scope to the level appropriate for your deployment, and click New.
43
11. Complete the Configuration page for the Work Manager as follows: –
In the Name field, enter a name to identify this Work Manager, for example, PRPCWorkManager.
44
PegaRULES Process Commander Installation Guide v6.1 SP2
–
In the JNDI name field, enter exactly the JNDI location wm/PegaWorkManager
–
In the Service names section, select the Security checkbox.
–
In Thread pool properties, set Maximum number of threads to 5.
–
Uncheck the Growable checkbox.
12. Click OK You are returned to the Work Managers listing page. 13. In the Messages box at the top of the page, click Save.
Other WebSphere Configuration This section contains an additional configuration step you must complete in WebSphere.
Set HTTP transport channel custom property CookiesConfigureNoCache to false In order to support the ability to open files attached to work objects in Process Commander, you must set a custom property, CookiesConfigureNoCache, on the transport chain in the Web Container settings for the Process Commander server.
Note: In earlier versions of WebSphere, this property was set to false so that cookies could be cached by default. Process Commander requires this caching to allow users to open attached files directly from a work object. In WebSphere 6.1, this property is set to True by default so that caching is not allowed. You must create and set this property on the HTTP transport channel for the Process Commander server. For more information see “HTTP transport channel custom properties” in the WebSphere 6.1 Information Center (http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp). Complete the following steps to set this property: 1. In the administrative console, select Servers > Application Servers and click on the name of server you created for Process Commander. The console displays the configuration page for the server:
45
2. Under Container Settings, expand Web Container Settings, and then click Web Container transport chains. This console displays the listing page for transport chains:
3. Click the name of the appropriate transport chain: –
If your site is using the default transport configuration for this server, select WCInboundDefault or, if you have enabled SSL for the Process Commander port, WCInboundDefaultSecure.
–
If your site has defined a custom transport chain for this server, select that chain name
46
PegaRULES Process Commander Installation Guide v6.1 SP2
The console displays the Configuration page for the selected transport chain. 4. Under Transport Channels on this page, click HTTP inbound channel. The console displays the Configuration page for the selected transport channel. 5. Under Additional Properties on this page, click Custom Properties. The console displays the listing page for this channel’s custom properties:
6. Click New. The console displays the form for a new custom property:
7. As pictured above, complete the form by entering CookiesConfigureNoCache in the Name field, and False in the Value field. 8. Click OK, and then Save in the Messages box on the Custom Properties listing page.
47
Next Steps This completes the configuration of your application server. Continue with the next section to deploy the Process Commander components.
Deploy the PegaRULES core application Complete the instructions below to deploy the PRPC core application component prpc_j2ee14_ws.ear.
Important: The PRPC core application component is available both as a WAR file, prweb.war, or an EAR file, prpc_j2ee14_ws.ear. Pegasystems recommends deploying the EAR file component, prpc_j2ee14_ws.ear for all new deployments on WebSphere 6.1 systems. The WAR file core component, prweb.war, can be successfully deployed on the WebSphere application servers, but deploying and configuring the EAR file ensures that you can add advanced J2EE features as your application grows or when you migrate to a production environment. Do not install both prweb.war and prpc_j2ee14_ws.ear.
Note: WebSphere may automatically start the application, prweb.war or prpc_j2ee14_ws.ear, when it is deployed. Be sure to stop the application after deploying. -
Do not start the application while the Install and Upgrade Assistant is loading the Rulebase to the Process Commander database. The application connection to the database can interfere with the Rulebase loading phase.
-
When the application starts up, you may see error messages for missing resources and references. You may ignore these messages. You will supply these resources as you complete the installation process.
Deploying prpc_j2ee14_ws.ear in WebSphere 1. Ensure that the WebSphere Application Server is running, and log into the administration console. 2. On the left side of the screen, click the “+” next to Applications, and then click Install New Application.
48
PegaRULES Process Commander Installation Guide v6.1 SP2
The first page of Preparing for the application installation appears:
3. Complete this form as follows: –
Click the Browse button and navigate to select prpc_j2ee14_ws.ear from your Process Commander software distribution.
–
Click the radio button: Show me all installation options and parameters. This option will allow you to review all the installation options for the application, including the default bindings and resource mappings.
–
Click Next.
WebSphere prepares the EAR file for deployment; this may take a few minutes. The page Preparing for the application installation appears.
49
4. Complete this page as follows: –
Check Generate Default Bindings
–
In the Virtual Host section, select Use default virtual host name for Web and SIP modules.
–
Accept the other defaults and click Next:
If you receive a Security Warning, click Continue. This security file allows Process Commander to run when J2EE Security Checking is enabled.
Note: To enable J2EE Security, it is necessary to make some site-specific parameter changes in this file. See the J2EE Security documentation for more information. The next section of the installation process is a series of ten steps under the general heading of Install New Application. Only one screen requires changes. For each of the other screens, you may accept the defaults, or customize them according to the requirements of your organization.
50
PegaRULES Process Commander Installation Guide v6.1 SP2
5. For Step One, accept the defaults and click Next: 6. Continue through steps 2 to 8, either accepting the defaults, or customizing for your organization, as needed. 7. In Step 9, you map resource references to resources:
51
8. For the three Resource references to url/initialization/explicittempdir, enter the JNDI name url/initialization/explicittempdir in the field Target Resource JNDI Name. There are url/initialization/explicittempdir references for the EJB EngineCMT, EngineBMT and prweb.war.This maps the location you specified in the URL provider you created above to the corresponding Resource Reference in the application, so that the application will use the location for the PegaTempDir. 9.
Click Next. Depending on your configuration, you may see a set of warnings related to missing resource references, for example:
52
PegaRULES Process Commander Installation Guide v6.1 SP2
These are resource references that are defined in web.xml, the deployment configuration files for the application, but not mapped to resource definitions in your application. In the page, Map resources to references, they are mapped to the Target Resource JNDI Name url/pega/none, indicating that they are not used. Pegasystems provides these references for J2EE compliance, but their use is optional. You can continue with the deployment. 10. At the bottom of the Warnings page, click Continue. 11. Continue through steps 10 to 14, either accepting the defaults, or customizing for your organization, as needed. 12. On the final Summary screen, review the settings, and click Finish:
53
The system begins installing the EAR file, which may take a few minutes. The following message is displayed.
When the installation completes successfully, WebSphere displays a message similar to the following:
54
PegaRULES Process Commander Installation Guide v6.1 SP2
13. Click the Save link to save the changes to the master configuration.
Installing the System Management and Online Help Applications In addition to the Process Commander application, you must also deploy the online help application (prhelp.war) and System Management application (prsysmgmt.war or prsysmgmt.ear). Complete the following steps to deploy prsysmgmt.war or prsysmgmt.ear. 1. Under the left frame, select Applications > Install New Application.
2. Complete this form as follows:
–
Click the Browse button and navigate to select prsysmgmt.war or prsysmgmt.ear from the archives directory of your Process Commander software distribution.
–
In the Context Root field, enter prsysmgmt.
55
–
Select Prompt me only when additional information is required.
–
Click Next.
WebSphere displays Step 1: Select installation options.
3. Select Next to accept the defaults. WebSphere displays Step 2: Map modules to servers.
4. Review the Clusters and Servers field to confirm that the server you are deploying Process Commander to is selected and then click Next.
56
PegaRULES Process Commander Installation Guide v6.1 SP2
WebSphere displays Step 3: Summary.
5. Review the settings to make sure they are appropriate for your site and click Finish to begin installing the application. WebSphere displays a message, Installing . . ., and updates it with information during the install. When complete the following message is displayed in the page:
6. Click the Save link to save the changes to the master configuration. You are returned to the first page of the installation series:
57
7. Deploy prhelp.war using the same procedure as prsysmgmt.war Use the name of the file, prhelp, as the context root and deploy to the same server. For more details on the System Management Application, refer to the System Management Application Reference Guide.
Assigning the PegaDiagnosticUser Role to your System Management Application Users Users accessing the System Management Application in Process Commander must be assigned the role PegaDiagnosticUser. If the user does not have this role they will be challenged for authentication when they attempt to access the System Management Application from Process Commander. By default, the deployment configuration for Process Commander assigns the PegaDiagnosticUser role to Everyone. If you want to restrict access to the System Management Application, use your application server tools to assign the PegaDiagnosticUser role to any users that must be able to access the System Management Application. The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element on the Diagnostic Data servlet in the prweb application’s web.xml file: - - Diagnostic Data Serves diagnostic files generated by the JMX client /DiagnosticData GET POST
58
PegaRULES Process Commander Installation Guide v6.1 SP2
- PegaDiagnosticUser If you do not want to restrict access to the System Management Application, you can edit the web.xml file in the WEB-INF directory of the prweb.war deployment in your application server and delete this security constraint element. Note that changing this setting in the web.xml file may require redeployment of the PegaRULES Web Application.
Next Steps If you have not completed the Rulebase Loading phase, continue with the next section: Steps 4-9 Rulebase Setup Phase. Be sure that the Process Commander applications are not started. If you have completed the Rulebase Loading phase, start the Process Commander applications and continue with Step 10, Final Settings in PRPC.
59
Steps 4 – 9: Rulebase Setup Install the Process Commander Schema and Rules in the Database Run the Process Commander Installation and Upgrade Assistant to create the Process Commander schema in the database, and load the Process Commander application rules.
Note: The following procedure describes the use of the user-interface to the installer to create the schema in the database and load the base Process Commander rules. The 6.1 SP2 distribution also includes scripts to support these tasks through a command-line interface. Support is provided through install.bat and install.ksh files configured through a properties file, setupDatabase.properties. To use the scripted option, see “Appendix A: Command-line Interfaces for Installation, Upgrade, and Utilities.” The Assistant requires a local installation of at least Java 1.5. 1. Download the Process Commander image, PRPC_DistributionImage.zip, or copy it from your CD, to the computer on which you will run the installation assistant. The computer on which you run the assistant must have access to allow a database connection to the Process Commander database. This computer should also have 1GB of RAM and at least 3 GB of disk space available to the system temporary directory.
60
PegaRULES Process Commander Installation Guide v6.1 SP2
Note: On a 64-bit system, running PRPC_Setup.jar requires up to 1.6 GB memory. To avoid memory errors, use one of the following methods: 1. Use a 32-bit JVM to run PRPC_Setup.jar, or 2. Increase the memory allocated to the JVM: –
In the scripts directory of your Process Commander software distribution, open the file setupDatabase.xml in a text editor.
–
In the file find the following element:
–
Increase the value of –Xmx to 2048.
–
Save and close the file
2. Extract PRPC_DistributionImage.zip to a directory, to create the following directory structure:
3. Double click on the PRPC_Setup.jar file or right-click the file and click Open With > Java, to launch the Installer. If JAR files are not associated with Java commands on your system, launch the installer at the commandline. In a command-line console, change to the directory containing PRPC_Setup.jar, and type in the following command: Java –jar PRPC_Setup.jar
Note: On Windows systems you may see the following error when you try to launch PRPC_Setup by double-clicking the JAR file.
61
Could not extract JAR file to directory: C:\Windows\System32\pegaGUIInstallerTemp In this case, use the command-line jar command as described above.
4. Click Next to display the Environment Considerations.
See “Step 1, Environment Considerations in this guide for more information on completing this step.
62
PegaRULES Process Commander Installation Guide v6.1 SP2
5. Click Next to display the Database Preparation page.
6. Review this page to confirm that you have prepared the database as required. See “Step 2, Database Preparation” in this guide for more information on completing this step. These tasks are completed outside of the Assistant. You must complete this preparation before running the Rulebase Load phase. You can exit from this tool to complete them, and then restart to continue beyond this point. 7. When your Database Preparation is complete, click Next to display Application Server Preparation.
63
8. Review this page to learn about the tasks you complete to prepare your application server before deploying the Process Commander applications. These tasks are completed outside this Assistant. You can exit from this tool to complete them, and then restart to continue beyond this point, or you can continue with the Rulebase Setup phase immediately and complete the Application Server Preparation later.
Note: When the Database Preparation is complete, Step 3, the Application Server Preparation, and Steps 4-9 in the Rulebase Setup Phase can be performed in either order or simultaneously. You can, for example, launch the Rulebase Setup process in the Assistant and then configure your Application Server while the Rulebase load process is running. However, you must configure the application server and deploy the Process Commander applications before you can complete Step 10, PRPC Final Settings.
Important: You must be careful not to start the deployed Process Commander applications while the Rulebase loading process is still running on the database. Note that your application server may start the application automatically when it is deployed. If the Process Commander application attempts to connect to the database while the Rulebase is loading, the database loading will not complete correctly.
64
PegaRULES Process Commander Installation Guide v6.1 SP2
9. If you have completed your Application Server Preparation or you want to continue with the Rulebase Setup in the database before completing the Application Server Preparation, click Next to display the License Agreement.
10. Review the License agreement and click Accept to continue.
65
11. Select Installation and click Next to display the Database Configuration page.
12. Complete this page as follows: Database Type –
Select the type of your Process Commander database.
Note: Instructions to install using a database on DB2 on z/OS are not covered in this guide. See the Installation Guide for DB2 on z/OS and WebSphere for information on this platform. Create Database Schema –
Leave Create Database Schema checked to allow the Assistant to create the appropriate schema in the database as part of the Rulebase Load process. You database should be empty.
–
Uncheck Create Database Schema if you used your database tools to create the schema using the SQL scripts provided in the schema directory of your software distribution. See “Using a SQL Script to Create the Schema” in this guide for more information.
Note: If you run the Assistant with Create Database Schema selected on a database that already has the schema installed, the Rulebase Load process fails with an error message. Click Next to display the Database Connection page.
66
PegaRULES Process Commander Installation Guide v6.1 SP2
If your database type is Oracle or MS SQL, you specify the JDBC driver class name, the location of the driver JAR file, the database connection URL, and the database user name and password.
If your database type is IBM UDB, you also specify the user schema name:
13. Complete the fields to specify the database connection to your Process Commander database:
67
–
JDBC Driver Class Name – Enter the name of the appropriate database driver class: •
Oracle 10g/11g:
oracle.jdbc.OracleDriver
•
IBM DB/2 Type 4:
com.ibm.db2.jcc.DB2Driver
•
SQL Server 2005 and 2008: com.microsoft.sqlserver.jdbc.SQLServerDriver
–
Driver JAR file – Enter the full path to the appropriate driver file for your database type and version: Use additional fields if your database requires more than one JAR file. See “Configure Support for ” on page 15 for information on your database.
–
Database JDBC URL – Enter the JDBC connection URL for your Process Commander database. The formats for each database type are as follows: •
Oracle 10g/11g (Native OCI Client): jdbc:oracle:oci:@your_tns_name
•
Oracle 10g/11g (Thin Client): jdbc:oracle:thin:@yourServer:1521:yourDatabase
•
DB/2 (Universal Driver): jdbc:db2://serverName:port/dbName
•
SQL Server 2005 and 2008:
•
jdbc:sqlserver://:1433;SendS tringParametersAsUnicode=false;SelectMethod=cursor
Note: The port number for MS SQL 2008 may be different than the typical default for 2005. In the URL for MS SQL, be sure to include the SendStringParametersAsUnicode and Select Method parameters as in the example. In the URL for UDB, be sure to include the following parameters: - fullyMaterializeLobData=true; - fullyMaterializeInputStreams=true; - progressiveStreaming=2; - progresssiveLocators=2; –
Username and Password – Enter the user name and password you created for the Process Commander user on your database
68
PegaRULES Process Commander Installation Guide v6.1 SP2
–
UDB Schema Name—For UDB databases, enter the schema name assigned to the Process Commander database when it was created.
14. When you have completed entering the database connection information, click Test Connection. The Installation Assistant tests whether it is able to make a connection to the database you have specified and displays the result:
Click OK to close the window. If the connection is not successful, review your connection information, correct any errors, and retest. If the connection is successful, click Next to continue.
15. Enter or Browse to select a temporary directory for the Installation Assistant to use while loading the Process Commander rules. By default, the Assistant uses a directory, pegaGuiInstallerTemp, created in the directory from which the tool is run. If you leave the field blank, the Installation Assistant uses the user system temporary directory.
Important: The Assistant requires at least 3 GB of space during the installation process. Be sure there is enough disk space to allow the
69
directory to grow to this size. The Assistant deletes all temporary files at the end of the process. –
Click Next to display the Rulebase Loading page.
16. Press START to begin loading the database with the rules. The Assistant shows the progress through the stages of the installation:
70
PegaRULES Process Commander Installation Guide v6.1 SP2
Click Show Logs to see the log detail as the process is running.
The Assistant displays the following window when complete:
Note: A typical installation can take 20 to 60 minutes depending on the speed of your system. If you choose to pre-load the assembled rules cache, the process takes an additional 90 minutes.
71
When processing the larger files, the log can appear inactive for some minutes. Please allow the Assistant to finish. If the process does not complete: –
Review information on the logs in the Output and Error tabs, and correct the problems.
–
Exit from the Assistant.
–
Clear the Process Commander database: Using your database tools, run the drop SQL script in the schema\\util directory for your database type in the Process Commander software distribution, for example:
C:\PRPC_distribution\schema\oracledate\util\oracledate_drop_6.1.sql
–
Restart this Installation and Upgrade Assistant and complete the steps again as directed above.
17. When the process completes, the instructions for Step 10—Final Settings in PRPC opens in a browser window:
72
PegaRULES Process Commander Installation Guide v6.1 SP2
18. Click Exit in the Assistant and continue with the procedures in the next section “Step 10—Final Settings in PRPC.
73
Step 10: Final Settings in Process Commander Access the Process Commander servlet, PRServlet, through a browser. Type in the URL for Process Commander application: http://://PRServlet. For example: http://prpc-server:8080/prweb/PRServlet The PegaRULES login screen (PRServlet) will be displayed:
74
PegaRULES Process Commander Installation Guide v6.1 SP2
Login to Process Commander: –
User Name:
[email protected]
–
Password: install
The Process Commander Developer portal displays with a welcome message in the What’s Happening section of thepage:
Process Commander automatically launches a process to index the Process Commander rules in the system to support full-text search in the Developer environment. While this process is running, you may notice some delay in the responsiveness of the Process Commander user interface. Depending on your system, the indexing will complete in 10 to 15 minutes.
Note: This indexing process starts as soon as you start the Process Commander application. Before you login, you may notice this activity in your application server administrative console. If you want to monitor the progress of the process, click here in the What’s Happening message.
Configure your environment Use the Process Commander Landing pages, accessed from the Pega button, to configure your initial environment:
75
Enable Developer Help and the System Management Application To enable Help and the System Management Application, you must set the URLs that are used to access them. 1. On the Landing pages, select System -> Settings -> URLs
76
PegaRULES Process Commander Installation Guide v6.1 SP2
2. Complete this page to specify the URLs to access the Help (prhelp.war) and System Management (prsysmgmt.war) applications –
In the field Online Help URL, enter the URL for the prhelp.war file: Provide the name of your Process Commander server and the port number, for example, http://prpc_server:8080/prhelp
–
In the field for SMA URL, enter the URL for the System Management Application, prsysmgmt.war, for example, http://prpc_server:8080/prsysmgmt.
–
Click Submit
Note: If you specify only localhost as the server name, only users logged into the same server on which the applications are deployed are able to access the applications. Replace localhost with the actual server name if you want to allow access to the applications from other Process Commander nodes. These applications are accessed from the Process Commander interface. Either application can be deployed to a different application server than the core Process Commander application.
Create an Organization 1. Open the Org and Security > Organization Setup landing page:
77
2. In the Organization Name field, enter the name of your organization, leave the Action control set to Preview and click Run to review the objects and users that will be created: –
Right-click in the window and select Print to print a record of this page.
Important: Be sure to preview and record the information on this page. The organization name you provide will be used to create the initial users and access groups for your Process Commander system. You will need to know the user names to log on and begin using your Process Commander installation. 3. Set the Action to Create and click Run to create the organizational structure. 4. Stop and restart the application server. Continue with the next section to enable the System Management Application for your installation.
78
PegaRULES Process Commander Installation Guide v6.1 SP2
Install Solution Frameworks If you are installing one of Pegasystems Solution Frameworks as part of your Process Commander development environment, install the framework now. Follow the instructions in the Installation Guide for the framework.
79
Ap p e n d ix A: Command-line Interfaces for Installation and Upgrade Process Commander 6.1 SP2 provides a command-line interface for installing or upgrading Process Commander databases. You can call t mander Schema and Database This section describes the command-line interface to the Process Commander Installation and Upgrade Assistant. To install the Process Commander database, you 1. Create a database using your DB vendor's tools 2. Specify the database connection information in the setupDatabase.properties file 3. Run the script install.bat or install.ksh to create the Process Commander schema in the database and load the initial Process Commander rules and classes. To complete the Process Commander installation, you must also configure your application server and deploy the Process Commander applications. These scripts do not perform any application server operations. For complete information on installing Process Commander, see the Process Commander Installation Guide v6.1 SP2 for your database and application server. This guide is available in the Doc directory in your software distribution and on the Pega Developer Network, pdn.pega.com.
80
PegaRULES Process Commander Installation Guide v6.1 SP2
To upgrade a Process Commander database, you 1. Use your database tools to run SQL scripts that Pegasystems provides to update the database schema 2. Specify the database connection information in the setupDatabase.properties file. 3. Run upgrade.bat or upgrade.ksh to update the Process Commander rules and classes
Note: Executing upgrade.bat or upgrade.ksh does not update the database to the 6.1 schema. You must apply the SQL scripts provided by Pegasystems to your Process Commander database before running the upgrade script. For complete information on upgrading Process Commander, see the PegaRULES Process Commander Release V6.1 SP2 Upgrade Guide 5.x to 6.1 SP2. This guide is available in the Doc directory of your software distribution and on the Pega Developer Network, pdn.pega.com.
Prerequisites Before running these scripts, you must complete the following prerequisites: 1. You must have a JDK installed (Java 5 or later), and the path to that JDK must be defined in a JAVA_HOME environment variable. 2. You must have the JDBC driver JAR file for your target database available. 3. For an installation, you must create a database with a minimum of 2GB for the user tablespace and allow the database to grow. Create a user for this database with full read and write permissions to create tables, procedures, and views. You provide connection information for this database to the script, including the location of the driver file, the driver class name, the database connection URL and the user's username and password.
Installation and Upgrade Setup Complete these steps before either installing or upgrading Process Commander. 1. Extract the contents of the coreBuildDistributionImage.zip into a directory. 2. Open the command-line console for your platform and change directory into the “scripts” subdirectory. 3. Edit the file setupDatabase.properties to provide the following property values:
81
–
pega.jdbc.driver.jar= The full path to the JDBC driver file for your database The driver required for each database type is: Oracle 10g/11g: •
For Java 5: ojdbc5.jar
•
For Java 6: ojdbc6.jar
DB/2 UDB: db2jcc.jar SQL Server 2005,2008:
–
•
For Java 5: sqljdbc.jar
•
For Java 6: sqljdbc4.jar.
pega.jdbc.driver.class= The class name of the JDBC driver for your database. The class required for each database type is: Oracle 10g/11g:
oracle.jdbc.OracleDriver
IBM DB/2 Type 4:
com.ibm.db2.jcc.DB2Driver
SQL Server 2005, 2008: com.microsoft.sqlserver.jdbc.SQLServerDriver
–
pega.database.type= The type of database:
–
Oracle 10g/11g:
oracledate
DB/2 UDB:
udb
SQL Server 2005, 2008:
mssql
pega.jdbc.url= The connection URL for your database, for example: Oracle 10g/11g (Native OCI Client): jdbc:oracle:oci:@your_tns_name Oracle 10g/11g (Thin Client): jdbc:oracle:thin:@myServer:1521:myDatabase DB/2 UDB: jdbc:db2://serverName:port/dbName SQL Server 2005, 2008:
82
PegaRULES Process Commander Installation Guide v6.1 SP2
jdbc:sqlserver:// :1433; databaseName=;SelectMethod=cursor; SendStringParametersAsUnicode=false;
Note: Be sure to include the SelectMethod and SendStringParametersAsUnicode parameters for SQL Server.
–
pega.jdbc.username= pega.jdbc.password= The user name and password to use when connecting to your database.
–
user.temp.dir= The full path to a temporary directory for the script process to use while loading the Process Commander rules. If not specified, the installer uses the user system temporary directory.
Important: At least 3 GB of space is required during the installation process. –
run.assembler=true/false If true, the installer pre-assembles the Process Commander Classes and makes them available in a cache. If false, classes are assembled as they are requested during Process Commander use, slowing response time for users. Pre-loading the cache makes the system perform better for the initial Process Commander users but adds up to 90 minutes to the installation process.
–
#bypass.pega.schema=
(Install only)
To skip schema creation in the Installation Assistant, remove the hash mark, #, at the beginning of this line in the setupDatabase.properties file. Use this option if you have previously created the schema in the database using the SQL scripts provided by Pegasystems. Setting this property corresponds to clearing the Create Schema checkbox in the Install Assistant user interface. Important: The bypass.pega.schema property is ignored by the upgrade script. Before upgrading the database, you must apply SQL scripts, provided by Pegasystems, to your the Process Commander database to update the data schema. See your Upgrade Guide for more information.
83
Running the Install and Upgrade Scripts After entering the settings in setupDatabase.properties, run the appropriate install or upgrade script for your platform: ■
install.bat for Windows, install.ksh for Unix systems
■
upgrade.bat for Windows, upgrade.ksh for Unix systems
You can pass up to six arguments to either script to override the properties set in the setupDatabase.properties file. These arguments are required for any of the properties not defined in the properties file: –
driverClass
–
driverJAR
–
dbType
–
dbURL
–
dbUser
–
dbPassword
Enter each argument on the command-line followed by the value as described above. Separate each argument with a space. For example: ./install.ksh --driverClass oracle.jdbc.OracleDriver
--driverJAR D:\ojdbc6.jar
--dbType oracledate --dbURL jdbc:oracle:thin:@dbServer:1521:prpc_database -dbUser username --dbPassword password
The scripts run an Ant project which installs or upgrades the Process Commander target database as specified. A log of the transactions is written to the command-line console and to a file in the scripts\logs directory.
Advanced Properties You should not need to set the following properties under normal use. However, they may be useful in certain circumstances. –
pegarules.config Path to prconfig.xml file
–
prbootstrap.config Path to a prbootstrap.properties file The Install and upgrade scripts create their own configuration files based on the settings you specify. Set these two properties if you want the scripts to instead use configuration files you have created. For details on these files see your installation or upgrade guide.
84
PegaRULES Process Commander Installation Guide v6.1 SP2
Notes: If you wish to use configuration files, you must create both files and set the corresponding properties. If either of the properties is not set, the script will generate both configuration files. You must always set the "pega.jdbc.driver.jar” property in setupDatabase.properties. Neither prconfig.xml or prbootstrap.properties contains the location of the DB driver file.
–
bypass.load.engine.classes If set to any value, the Rules Engine classes are not loaded into the database. Use this property if you want to load rules without changing the engine classes.
–
bypass.load.rules If set, the rules are not loaded into the database. Use this property if you want to load the engine classes without changing the rules.
Other Environment Properties Ant Property
Default value
Notes
jvm.arg.mem.max
-Xmx1024m
Maximum memory allocated to Java tools which are run by this script.
pega.install.root
${basedir}
Path to the scripts directory of the distribution image
pega.archives
${pega.install.root}/../archives/
Path to the PRPC application archives in the distribution image, like prweb.war.
pega.rules
${pega.install.root}/../rules/
Path to the PARs (Pega archives) which will be loaded
pega.schemas
${pega.install.root}/../schema/
Path to a directory named “DDL”, containing vendor specific content to be loaded. Each vendor directory must contain a “statements” subdirectory.
