PeopleSoft 9.2 Application Installation for DB2 for z/OS ...
PRPC V5.3 Installation Guide WebLogic 9.2 (Full ... - Pega Community
-
Upload
khangminh22 -
Category
Documents
-
view
1 -
download
0
Transcript of PRPC V5.3 Installation Guide WebLogic 9.2 (Full ... - Pega Community
PegaRULES Process Commander Release V53
Installing on WebLogic 92 Application Servers
June 8 2007
copy Copyright 2007 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 andor 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 wwwpegacom PegaRULES Process Commander Document Installation Guide Software Version 53 Updated June 8 2007
Contents
Chapter 1 Introduction 1 Process Commander Core Component Versions 4 Overview of the Installation Procedure 5 Prerequisites 6
Supported Process Commander Platforms 6 Check the Pega Developer Network for the Latest Information 7 A Note for PRPC 42 Users 8
Chapter 2 Preparing the Database 9 Database Prerequisites10 Creating a PRPC Database 10 Creating Access to the Database11
User Permissions for the Microsoft SQL Database 11 User Privileges for the Oracle Database 11 User Privileges for the UDB Database12
Creating the PRPC Data Objects in the Database 12
Chapter 3 Preparing the Application Server 14 Verify the Java Environment 15 Configuring Database support on your Application Server 15
Microsoft SQL Server15 Oracle 9i or 1016 UDB 17
Chapter 4 Deploying Process Commander-WebLogic 9 18 Create a WebLogic Domain 19 Configuring WebLogic 92 20
Editing the setDomainEnv Script or Batch file 20 Start the Admin Server24
Enabling DNS Lookup25 Create a JDBC Connection Pool and Data Source27 Configure JMS Resources35
Create a JMS Server35 Deploy the Database Import Application46 Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files 53
iv Pegarules Process Commander Installation Guide V53
Assigning the PegaDiagnosticUser Role to your System Management Application Users55
Next Steps56
Chapter 5 Installing Process Commander 57 Start Your Application Server and Load the PegaRULES Database 57 Create a Systems Management Node69
Next Steps75
Chapter 1 Introduction
This document describes how to install a new instance of PegaRULES Process Commander 53 Upgrading an existing Process Commander installation is described in other documents
To upgrade a Process Commander 42 system to 53 your current system must first be at 42 SP6 If your current system is earlier than 42 SP6 see the Upgrade Guide for 42 SP6 for instructions on moving to SP6
To upgrade from 42 SP6 to 53 see the manual Upgrade Guide V42 SP6 to V5
For information about upgrading an existing Process Commander 5 installation (51 51 SP1 51 SP2 52 or 52 SP1) to 53 see the PegaRULES Process Commander Upgrade Guide 53 released with Process Commander 53
These documents and any updates to existing Process Commander documentation are available on the Pega Developer Network (pdnpegacom) Please check this site for the latest installation and configuration information
To create a new installation of Process Commander 53 you perform four basic procedures
1 Create a blank database on your database server and apply the Process Commander 53 schema
2 PegaRULES Process Commander Installation Guide v53
2 Configure your application server and deploy the Process Commander application components on your application server
3 Load the Process Commander application rulesets to the database
4 Perform initial configuration of the Process Commander system
You perform the first two steps with the database and application server administrator tools respectively You use the Process Commander Database Utilities application (prdbutil) to upload and install the application files and to set up the initial configuration of your Process Commander system
To set up a Process Commander system you deploy four software components in your application server
Process Commander Component
Description
prdbutilwar PegaRULES Process Commander Database Utilities ndash provides a checklist and steps for the initial configuration and deployment of Process Commander and utilities to load the Process Commander data objects
prwebwar or prpc_j2ee14ear
The Process Commander core application (See Process Commander Core Component Versions below)
prhelpwar The online help system for the Process Commander application user interface
prsysmgmtwar A JMX (Java Management Extensions) client that allows administrators to monitor multiple Process Commander nodes from a single location
The deployment of a basic installation instance is shown in the diagram below
3
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
copy Copyright 2007 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 andor 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 wwwpegacom PegaRULES Process Commander Document Installation Guide Software Version 53 Updated June 8 2007
Contents
Chapter 1 Introduction 1 Process Commander Core Component Versions 4 Overview of the Installation Procedure 5 Prerequisites 6
Supported Process Commander Platforms 6 Check the Pega Developer Network for the Latest Information 7 A Note for PRPC 42 Users 8
Chapter 2 Preparing the Database 9 Database Prerequisites10 Creating a PRPC Database 10 Creating Access to the Database11
User Permissions for the Microsoft SQL Database 11 User Privileges for the Oracle Database 11 User Privileges for the UDB Database12
Creating the PRPC Data Objects in the Database 12
Chapter 3 Preparing the Application Server 14 Verify the Java Environment 15 Configuring Database support on your Application Server 15
Microsoft SQL Server15 Oracle 9i or 1016 UDB 17
Chapter 4 Deploying Process Commander-WebLogic 9 18 Create a WebLogic Domain 19 Configuring WebLogic 92 20
Editing the setDomainEnv Script or Batch file 20 Start the Admin Server24
Enabling DNS Lookup25 Create a JDBC Connection Pool and Data Source27 Configure JMS Resources35
Create a JMS Server35 Deploy the Database Import Application46 Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files 53
iv Pegarules Process Commander Installation Guide V53
Assigning the PegaDiagnosticUser Role to your System Management Application Users55
Next Steps56
Chapter 5 Installing Process Commander 57 Start Your Application Server and Load the PegaRULES Database 57 Create a Systems Management Node69
Next Steps75
Chapter 1 Introduction
This document describes how to install a new instance of PegaRULES Process Commander 53 Upgrading an existing Process Commander installation is described in other documents
To upgrade a Process Commander 42 system to 53 your current system must first be at 42 SP6 If your current system is earlier than 42 SP6 see the Upgrade Guide for 42 SP6 for instructions on moving to SP6
To upgrade from 42 SP6 to 53 see the manual Upgrade Guide V42 SP6 to V5
For information about upgrading an existing Process Commander 5 installation (51 51 SP1 51 SP2 52 or 52 SP1) to 53 see the PegaRULES Process Commander Upgrade Guide 53 released with Process Commander 53
These documents and any updates to existing Process Commander documentation are available on the Pega Developer Network (pdnpegacom) Please check this site for the latest installation and configuration information
To create a new installation of Process Commander 53 you perform four basic procedures
1 Create a blank database on your database server and apply the Process Commander 53 schema
2 PegaRULES Process Commander Installation Guide v53
2 Configure your application server and deploy the Process Commander application components on your application server
3 Load the Process Commander application rulesets to the database
4 Perform initial configuration of the Process Commander system
You perform the first two steps with the database and application server administrator tools respectively You use the Process Commander Database Utilities application (prdbutil) to upload and install the application files and to set up the initial configuration of your Process Commander system
To set up a Process Commander system you deploy four software components in your application server
Process Commander Component
Description
prdbutilwar PegaRULES Process Commander Database Utilities ndash provides a checklist and steps for the initial configuration and deployment of Process Commander and utilities to load the Process Commander data objects
prwebwar or prpc_j2ee14ear
The Process Commander core application (See Process Commander Core Component Versions below)
prhelpwar The online help system for the Process Commander application user interface
prsysmgmtwar A JMX (Java Management Extensions) client that allows administrators to monitor multiple Process Commander nodes from a single location
The deployment of a basic installation instance is shown in the diagram below
3
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
Contents
Chapter 1 Introduction 1 Process Commander Core Component Versions 4 Overview of the Installation Procedure 5 Prerequisites 6
Supported Process Commander Platforms 6 Check the Pega Developer Network for the Latest Information 7 A Note for PRPC 42 Users 8
Chapter 2 Preparing the Database 9 Database Prerequisites10 Creating a PRPC Database 10 Creating Access to the Database11
User Permissions for the Microsoft SQL Database 11 User Privileges for the Oracle Database 11 User Privileges for the UDB Database12
Creating the PRPC Data Objects in the Database 12
Chapter 3 Preparing the Application Server 14 Verify the Java Environment 15 Configuring Database support on your Application Server 15
Microsoft SQL Server15 Oracle 9i or 1016 UDB 17
Chapter 4 Deploying Process Commander-WebLogic 9 18 Create a WebLogic Domain 19 Configuring WebLogic 92 20
Editing the setDomainEnv Script or Batch file 20 Start the Admin Server24
Enabling DNS Lookup25 Create a JDBC Connection Pool and Data Source27 Configure JMS Resources35
Create a JMS Server35 Deploy the Database Import Application46 Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files 53
iv Pegarules Process Commander Installation Guide V53
Assigning the PegaDiagnosticUser Role to your System Management Application Users55
Next Steps56
Chapter 5 Installing Process Commander 57 Start Your Application Server and Load the PegaRULES Database 57 Create a Systems Management Node69
Next Steps75
Chapter 1 Introduction
This document describes how to install a new instance of PegaRULES Process Commander 53 Upgrading an existing Process Commander installation is described in other documents
To upgrade a Process Commander 42 system to 53 your current system must first be at 42 SP6 If your current system is earlier than 42 SP6 see the Upgrade Guide for 42 SP6 for instructions on moving to SP6
To upgrade from 42 SP6 to 53 see the manual Upgrade Guide V42 SP6 to V5
For information about upgrading an existing Process Commander 5 installation (51 51 SP1 51 SP2 52 or 52 SP1) to 53 see the PegaRULES Process Commander Upgrade Guide 53 released with Process Commander 53
These documents and any updates to existing Process Commander documentation are available on the Pega Developer Network (pdnpegacom) Please check this site for the latest installation and configuration information
To create a new installation of Process Commander 53 you perform four basic procedures
1 Create a blank database on your database server and apply the Process Commander 53 schema
2 PegaRULES Process Commander Installation Guide v53
2 Configure your application server and deploy the Process Commander application components on your application server
3 Load the Process Commander application rulesets to the database
4 Perform initial configuration of the Process Commander system
You perform the first two steps with the database and application server administrator tools respectively You use the Process Commander Database Utilities application (prdbutil) to upload and install the application files and to set up the initial configuration of your Process Commander system
To set up a Process Commander system you deploy four software components in your application server
Process Commander Component
Description
prdbutilwar PegaRULES Process Commander Database Utilities ndash provides a checklist and steps for the initial configuration and deployment of Process Commander and utilities to load the Process Commander data objects
prwebwar or prpc_j2ee14ear
The Process Commander core application (See Process Commander Core Component Versions below)
prhelpwar The online help system for the Process Commander application user interface
prsysmgmtwar A JMX (Java Management Extensions) client that allows administrators to monitor multiple Process Commander nodes from a single location
The deployment of a basic installation instance is shown in the diagram below
3
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
iv Pegarules Process Commander Installation Guide V53
Assigning the PegaDiagnosticUser Role to your System Management Application Users55
Next Steps56
Chapter 5 Installing Process Commander 57 Start Your Application Server and Load the PegaRULES Database 57 Create a Systems Management Node69
Next Steps75
Chapter 1 Introduction
This document describes how to install a new instance of PegaRULES Process Commander 53 Upgrading an existing Process Commander installation is described in other documents
To upgrade a Process Commander 42 system to 53 your current system must first be at 42 SP6 If your current system is earlier than 42 SP6 see the Upgrade Guide for 42 SP6 for instructions on moving to SP6
To upgrade from 42 SP6 to 53 see the manual Upgrade Guide V42 SP6 to V5
For information about upgrading an existing Process Commander 5 installation (51 51 SP1 51 SP2 52 or 52 SP1) to 53 see the PegaRULES Process Commander Upgrade Guide 53 released with Process Commander 53
These documents and any updates to existing Process Commander documentation are available on the Pega Developer Network (pdnpegacom) Please check this site for the latest installation and configuration information
To create a new installation of Process Commander 53 you perform four basic procedures
1 Create a blank database on your database server and apply the Process Commander 53 schema
2 PegaRULES Process Commander Installation Guide v53
2 Configure your application server and deploy the Process Commander application components on your application server
3 Load the Process Commander application rulesets to the database
4 Perform initial configuration of the Process Commander system
You perform the first two steps with the database and application server administrator tools respectively You use the Process Commander Database Utilities application (prdbutil) to upload and install the application files and to set up the initial configuration of your Process Commander system
To set up a Process Commander system you deploy four software components in your application server
Process Commander Component
Description
prdbutilwar PegaRULES Process Commander Database Utilities ndash provides a checklist and steps for the initial configuration and deployment of Process Commander and utilities to load the Process Commander data objects
prwebwar or prpc_j2ee14ear
The Process Commander core application (See Process Commander Core Component Versions below)
prhelpwar The online help system for the Process Commander application user interface
prsysmgmtwar A JMX (Java Management Extensions) client that allows administrators to monitor multiple Process Commander nodes from a single location
The deployment of a basic installation instance is shown in the diagram below
3
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
Chapter 1 Introduction
This document describes how to install a new instance of PegaRULES Process Commander 53 Upgrading an existing Process Commander installation is described in other documents
To upgrade a Process Commander 42 system to 53 your current system must first be at 42 SP6 If your current system is earlier than 42 SP6 see the Upgrade Guide for 42 SP6 for instructions on moving to SP6
To upgrade from 42 SP6 to 53 see the manual Upgrade Guide V42 SP6 to V5
For information about upgrading an existing Process Commander 5 installation (51 51 SP1 51 SP2 52 or 52 SP1) to 53 see the PegaRULES Process Commander Upgrade Guide 53 released with Process Commander 53
These documents and any updates to existing Process Commander documentation are available on the Pega Developer Network (pdnpegacom) Please check this site for the latest installation and configuration information
To create a new installation of Process Commander 53 you perform four basic procedures
1 Create a blank database on your database server and apply the Process Commander 53 schema
2 PegaRULES Process Commander Installation Guide v53
2 Configure your application server and deploy the Process Commander application components on your application server
3 Load the Process Commander application rulesets to the database
4 Perform initial configuration of the Process Commander system
You perform the first two steps with the database and application server administrator tools respectively You use the Process Commander Database Utilities application (prdbutil) to upload and install the application files and to set up the initial configuration of your Process Commander system
To set up a Process Commander system you deploy four software components in your application server
Process Commander Component
Description
prdbutilwar PegaRULES Process Commander Database Utilities ndash provides a checklist and steps for the initial configuration and deployment of Process Commander and utilities to load the Process Commander data objects
prwebwar or prpc_j2ee14ear
The Process Commander core application (See Process Commander Core Component Versions below)
prhelpwar The online help system for the Process Commander application user interface
prsysmgmtwar A JMX (Java Management Extensions) client that allows administrators to monitor multiple Process Commander nodes from a single location
The deployment of a basic installation instance is shown in the diagram below
3
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
2 PegaRULES Process Commander Installation Guide v53
2 Configure your application server and deploy the Process Commander application components on your application server
3 Load the Process Commander application rulesets to the database
4 Perform initial configuration of the Process Commander system
You perform the first two steps with the database and application server administrator tools respectively You use the Process Commander Database Utilities application (prdbutil) to upload and install the application files and to set up the initial configuration of your Process Commander system
To set up a Process Commander system you deploy four software components in your application server
Process Commander Component
Description
prdbutilwar PegaRULES Process Commander Database Utilities ndash provides a checklist and steps for the initial configuration and deployment of Process Commander and utilities to load the Process Commander data objects
prwebwar or prpc_j2ee14ear
The Process Commander core application (See Process Commander Core Component Versions below)
prhelpwar The online help system for the Process Commander application user interface
prsysmgmtwar A JMX (Java Management Extensions) client that allows administrators to monitor multiple Process Commander nodes from a single location
The deployment of a basic installation instance is shown in the diagram below
3
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
3
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
4 PegaRULES Process Commander Installation Guide v53
Process Commander Core Component Versions The PRPC core application is packaged in five different versions to support the deployment of PRPC into different J2EE environments The following table summarizes all the packages provided and their use
Type of deployment PRPC package to use
All Tomcat deployments prwebwar
All new deployments on WebSphere 6x or WebLogic 9x or Oracle Application Server 10g Release 3
prwebwar or prpc_j2ee14ear
Note The legacy packages listed below are provided only for existing customers to support backward compatibility Contact customer support before deploying
All new deployments on WebSphere 5x or WebLogic 8x prwebwar or prpc_j2ee13ear
Existing deployments on WebSphere 6x or WebLogic 9x that used prwebear
prwebwar or prweb_j2ee14ear
Existing deployments on WebSphere 5x or WebLogic 8x that used prwebear
prwebwar or prweb_j2ee13ear
Components labeled lsquoj2ee14rsquo should be deployed in application servers that conform to the J2EE 14 specification The components labeled lsquoj2ee13rsquo should be deployed in application servers that conform to the J2EE 13 specification
Tomcat customers should install the WAR in all cases
WebSphere WebLogic or Oracle Application Server customers may also deploy the WAR if they are not using functionality in either of the EAR packages You must deploy the EAR file component if you intend to use any of the following container-managed features with your Process Commander application Two-phase commit JMS message services Rule-Service-EJB J2SE security
When upgrading Process Commander you should generally install the core component package that is currently in use in your environment That is existing WAR deployments should deploy the 53 WAR component existing EAR deployments should deploy the 53 EAR However if you upgrade the supporting platform components at the same time as Process Commander or if your integration requirements have changed you may need to change the PRPC core component and your system configuration
If you have any questions regarding the correct package to deploy contact Pega Support
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
5
Overview of the Installation Procedure The following outline details the steps in the 53 installation process
1 Prepare the Database server
ndash Create a database with a PRPC user and password
ndash Install the PRPC schema appropriate for your database vendor
2 Prepare the application server
ndash Configure the server environment
ndash Verify the Java environment
ndash Create and verify the database connection Create a Data source with the JNDI name of jdbcPegaRules
ndash Verify the PRPC Temporary directory
ndash Configure JMS (Java Messaging Service) resources
3 Deploy the PRPC components
4 Install the Process Commander rulesets
ndash Start the Process Commander Database Utilities application
ndash Upload the application files from the Process Commander distribution to your application server
ndash Install the Process Commander application instances to the database
5 Configure Your PRPC system
ndash Optionally configure a Lucene search engine to support Rule and Work Object searches in Process Commander
ndash Configure the Help and System Management applications
ndash Setup an initial user organization
The procedures to complete these steps are described in the rest of this document
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
6 PegaRULES Process Commander Installation Guide v53
Prerequisites The prerequisites for installing Process Commander are
An application server host computer with adequate memory and disk space for the installation
ndash 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
Configured relational database available for Process Commander use and support in your organization for the installation and configuration of relational databases
The database requires a minimum of 500 MB for the user tablespace The space required for your system may need to be higher depending on your specific configuration
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 mdash Java and J2EE technologies J2EE compliant application servers SQL databases web browsers XML and HTMLmdash 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 sitersquos deployment requirements with your IT representatives
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
7
3 Consult with your Pegasystems representative about your installation plans Pegasystemsrsquo 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 httppdnpegacom
Check the Pega Developer Network for the Latest Information Before beginning your installation procedure check the Pega Developer Network (PDN) located at httppdnpegacom for the latest information In addition to the Platform Support Guide described in the previous section also look on the PRPC Documentation page for updated versions of this document and the Upgrade guides
Deployment information and updates Check the Deployment page on the Pega Developer Network for information updates and platform bulletins on deploying Process Commander
This page also includes links to WebEx recordings demonstrating the deployment of the Process Commander software components and the use of the Process Commander Database Utilities application
Visit httppdnpegacom and click ldquoPRPC Deploymentrdquo
Pegasystems Documentation The latest Process Commander documentation is available on the Documentation page of the Pega Developer Network
Visit httppdnpegacom and click ldquoPRPC Documentationrdquo
Pegasystems Training A range of Pegasystems course offerings are available to increase the effectiveness of your deployment and development team members For more information visit httpwwwpegacomTraining
Check Knowledge Base Platform Bulletins
You should also consult the following Platform Bulletins to learn about any known issues that might affect the PRPC installation on your platform
Title PRPC KB
Sun JVM Issues 21247
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
8 PegaRULES Process Commander Installation Guide v53
IBM JVM Issues 21248
WebLogic Issues 21352
WebSphere Issues 21353
Oracle Issues 21864
You can search for these bulletins on the PDN using the KB number
A Note for PRPC 42 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 ldquoSetting the Explicit Temporary Directoryrdquo in the chapter that describes deployment with your application server
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
9
Chapter 2 Preparing the Database Server
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
Run Process Commander SQL scripts to create PRPC data objects in the database
Each of these steps is described in the following sections
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
10 PegaRULES Process Commander Installation Guide v53
Database Prerequisites Process Commander requires a working installation of one of the supported databases before installation Process Commander
For 53 the supported database versions are the following
ndash DB2 UDB v81 v82 v91
ndash DB2 for zOS v81
ndash Oracle 9i 10g
ndash SQL Server 2000 2005
For additional information see the Platform Support Guide which is available as a PDF file on the Pega Developer Network (PDN) Go to httppdnpegacom and click Product Documentation
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 500 MB for the user tablespace The space required for your system may need to be higher depending on your use of PRPC
Be sure to record
Database server name
Database port number
The Process Commander system requires this information to access this database
Additional UDB Requirements When using UDB
Process Commander requires a buffer pool and temporary tablespace with a page size of 16K for each tablespace that contains Process Commander tables By default the UDB database create process creates a bufferpool and temporary tablespace with only a 4K page size
In addition if you use the Process Commander System Usage History report create a temporary tablespace and its associated bufferpool for the PegaRULES database with a 32K page size If the page size is not changed to 32K PRPC generates a PRRuntimeException when attempting
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
11
to run the System Usage History report Initially allocate 3MB to the buffermdashenough for 100 pages If after configuring the database as required above the System Usage History report takes too long to complete increase the size of the buffer If the report appears immediately you may be able to decrease the buffer size freeing system memory
Process Commander requires a C++ compiler on the database machine to support stored procedures
Creating Access to the Database Create a user for this database with read and write permissions Process Commander requires
A valid username to access database as the Process Commander user
A valid password for the above username
Note The Process Commander user must have appropriate permissions to run SQL scripts on the database
Follow the guidelines for the appropriate database in the following sections
User Permissions for the Microsoft SQL Database Set the user account for the ldquoPegaRULES Userrdquo with a public and db_owner role with all corresponding System Permissions granted
User Privileges for the Oracle Database Set the user account for the ldquoPegaRULES Userrdquo 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 userrsquos 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
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
12 PegaRULES Process Commander Installation Guide v53
User Privileges for the UDB Database Create a user account for a PegaRules user according to the IBM instructions
Creating the PRPC Data Objects in the Database To create the Process Commander data objects (tables indexes views triggers and procedures) in the database the database administrator (DBA) must run a SQL script to create the appropriate objects in the relational database into which Process Commander will load its rules Process Commander V53 includes SQL scripts for each supported database Scripts are available for
bull db2 zOS
bull mssql
bull oracle (oracledate)
bull udb
Each of databases has a folder located in the Distribution Image under the schemaDDL directory Choose the appropriate database folder and find the ltdatabasegt_install0503sql file
Example
schemaDDLoracledateoracledate_install0503sql
The DBA should review this script and customize it (if necessary) When satisfied with the script the DBA can run it to create the tables The default scripts create an ASCII database Modify the scripts if you require Unicode
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 The message indicates that there are too many columns in the table which is only an issue if data is present in all columns When installed Process Commander theoretically exceeds this limit but in practice the limit is not exceeded Because Process Commander has a number of different rules mapped to this table the entries into the table do not each use all the columns
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
13
(Some types of rules only use some of the columns in a table) This leaves blank spaces in the columns avoiding the error
Other Process Commander SQL scripts
The directory for each database also includes SQL scripts to drop and truncate the Process Commander schema tables
ltdatabasegt_dropsql
ltdatabasegt_truncatesql
For example
mssql_dropsql
mssql_truncatesql
Your database administrator may find these scripts useful when maintaining the Process Commander database
In addition this directory contains the following upgrade scripts that modify an existing PRPC database to conform to the schema for a later release
ndash oracledate_upgrade_alters_0402SP6to0503sql
ndash oracledate_upgrade_alters_0501GAto0503sql
ndash oracledate_upgrade_alters_0502to0503sql
ndash oracledate_upgrade_drops_0402SP6to0503sql
ndash oracledate_upgrade_drops_0501GAto0503sql
ndash oracledate_upgrade_drops_0502to0503sql
The scripts labeled ldquoaltersrdquo add columns to the current database for a release to make it conform to the database for the new release No data is changed The scripts labeled ldquodropsrdquo drops objects from the current database that is no longer present in the new releasersquos schema Customer data may be deleted by this script
For more information see the appropriate upgrade guide
Important Your database administrator should review the commands in these SQL scripts to understand the changes they will make in your PRPC database before they are run Contact Customer Support if you have questions about the use of these scripts
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
14 PegaRULES Process Commander Installation Guide v53
Chapter 3 Preparing the Application Server
This chapter describes tasks you must complete on your application server before beginning to deploy the PRPC application
Verify the Java Environment
Configuring Database support on your Application Server
Procedures for deploying the PRPC application components on WebLogic are given in Chapter 4 Deploying Process Commander - WebLogic 92
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
15
Verify the Java Environment Confirm that the Java JDK environment used by your application server is Java JDK 14 or higher
Refer to the Platform Support Guide available as a PDF file on the Pega Developer Network (PDN) located at httppdnpegacom for specific recommendations for your platform
Important During installation Process Commander requires access to the directory specified by the javaiotmpdir 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
Configuring Database support on your Application Server 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 gold platform database systems
Microsoft SQL Server Download the latest drivers from the Microsoft website
For Microsoft SQL Server 2005 be sure that the driver file sqljdbcjar is installed correctly
For Microsoft SQL Server 2000 the following files are required
ndash msbasejar
ndash msutiljar
ndash mssqlserverjar
These drivers for Microsoft SQL Server JDBC are Type 4
For WebLogic configure the application server so that these drivers are loaded in the classpath
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
16 PegaRULES Process Commander Installation Guide v53
Oracle 9i or 10
Note For Oracle 9i the JDBC driver 9204 (for the client) is not supported Supported versions include 9201 9202 9203 and 9205
Oracle Installation Edits For Process Commander to work with the application server using Oracle follow all Oracle instructions for installing the client software and the JDBC drivers
Install the JDBC driver ojdbc14jar with the Oracle Client software in the jdbclib directory
oracle-homejdbclib
Example
coracleora92jdbclib
Edit as follows for Solaris
Set ORACLE_HOME and LD_LIBRARY_PATH environment variables
Add $ORACLE_HOMElib32 to the LD_LIBRARY_PATH before the reference to the standard $ORACLE_HOMElib directory (as Process Commander uses 32-bit libraries)
Edit as follows for AIX
Set ORACLE_HOME and LIBPATH environment variables
Add $ORACLE_HOMElib32 to the LIBPATH before the reference to the standard $ORACLE_HOMElib 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 is configured to load this JDBC driver in the classpath
Validating the Oracle Connection Login to SQLPlus to validate the Oracle connection For example enter the following command on the server
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
17
useridpasswordSID
Example
$sqlplus oratestoratestoratestrpegacom
In this example oratest is the userid oratest is the password and oratestrpegacom is the SID This should return Oracle system information and the Connected to message
SQLPlus Release 101020 - Production on Mon Nov 27 110828 2006
Copyright (c) 1982 2004 Oracle Corporation All rights reserved
Connected to
Oracle Database 10g Enterprise Edition Release 101020 ndash Production
With the Partitioning OLAP and Data Mining options
SQLgt
If problems logging in occur (that is the above messages do not appear) resolve these issues first before loading Process Commander
UDB For Process Commander to work with a web application server using DB2 UDB follow the IBM instructions for installing the client software and the JDBC drivers For DB2 the JDBC driver db2jccjar file is required
This JDBC driver is Type 4
For WebLogic configure the application server so that this driver is loaded in the classpath
Note In UDB Process Commander requires a 16K-page buffer pool and tablespace for each tablespace that contains Process Commander tables
Note Process Commander uses stored procedures It therefore requires a C++ compiler on the database machine
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
18 PegaRULES Process Commander Installation Guide v53
Chapter 4 Deploying Process Commander-WebLogic 92
This chapter describes a sample deployment procedure for Process Commander 53 on WebLogic 92 If you are installing 53 on an earlier WebLogic release the Administrative 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 Gold Platforms for this release For more information see Supported Process Commander Platforms on page 6
To deploy on WebLogic you complete the following tasks
1 Create a WebLogic domain for PRPC
2 Edit the WebLogic setDomainEnv file to
ndash set JVM memory parameters
ndash set a location for the PRPC explicit temp directory
ndash include the location of the JDBC driver in the WebLogic classpath
3 Create a data source for the Pega database
4 Create and configure Java Messaging Services (JMS) resources
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
19
Create a WebLogic Domain Run the WebLogic Configuration Wizard to create a WebLogic domain in which to run the PegaRULES application
For information on starting and completing the Configuration Wizard see the WebLogic online documentation ldquoCreating WebLogic Domains Using the Configuration Wizardrdquo at httpe-docsbeacomcommondocs92confgwizindexhtml
Be sure to note the User name and password for the Administrative user you configure for this domain This is the user you will use to access the WebLogic administrative console for this domain
When making the JDK Selection select the Sun SDK not the JRocket SDK
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
20 PegaRULES Process Commander Installation Guide v53
Configuring WebLogic 92
Editing the setDomainEnv Script or Batch file Open the setDomainEnv batch file or shell script to configure it for the Process Commander installation
In a basic WebLogic installation the start script is located in a subdirectory under the name you specified as the domain name ndash that is the name you entered as the Configuration Name in the Create WebLogic Configuration form
ltapp-server-install-rootgtuser_projectsdomainsdomain-namebin
Example
wl_homeuser_projectsdomainspegarulesbin
Open the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file as appropriate for your server platform in a text editor Then add settings and values as described in the rest of this section
Set JVM Memory Parameters The default values for several WebLogic Server 92 memory parameters must be increased before you deploy the Process Commander software components Although the PegaRULES engine might start with the default settings its scalability will be severely limited
Depending on the use of Process Commander memory consumption requirements can vary The minimum values for initial setup are
Minimum Heap Size (-Xms) must be at least 256 MB
Maximum Heap Size (-Xmx) must be at least 768 MB
If your application server is using the Sun JVM add the PermSize and MaxPermSize settings as well
PermSize (-XXPermSize) must be at least 64MB
MaxPermSize must be at least 256MB to prevent out-of-memory errors
Note These are the minimum values for the memory parameters The values may need to be higher based on your server hardware and the number of other applications on the server
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
21
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set USER_MEM_ARGS= to include the memory settings as follows
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -XXMaxPermSize=256m
Add this line in the MEM_ARGS section of the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file before the following lines
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
For example your file may look like the following
set MEM_ARGS=-Xms256m -Xmx768m
if JAVA_VENDOR==Sun (
if PRODUCTION_MODE== (
set MEM_DEV_ARGS=-XXCompileThreshold=8000 -XXPermSize=64m
)
)
REM Had to have a separate test here BECAUSE of immediate variable
expansion on windows
if JAVA_VENDOR==Sun (
set MEM_ARGS=MEM_ARGS MEM_DEV_ARGS -XXMaxPermSize=256m
)
if JAVA_VENDOR==HP (
set MEM_ARGS=MEM_ARGS -XXMaxPermSize=128m
)
REM IF USER_MEM_ARGS the environment variable is set use it to
override ALL MEM_ARGS values
set USER_MEM_ARGS=-Xms256m -Xmx768m -XXPermSize=64m -
XXMaxPermSize=256m
if NOT USER_MEM_ARGS== (
set MEM_ARGS=USER_MEM_ARGS
)
Setting an Explicit Temporary Directory
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
22 PegaRULES Process Commander Installation Guide v53
You must create a JVM property to set an explicit Temporary directory for Process Commander This 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 the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir= and specify the location of the temporary directory you have allocated for example
set EXTRA_JAVA_PROPERTIES=-Dpegatmpdir=CPegaTemppr_temp
Setting the AWT ldquoheadlessrdquo Java Property
You must add a ldquoheadlessrdquo AWT setting to the JAVA_OPTIONS that are passed to Java at startup to allow the system to render graphics PRPC requires this setting in order to display graphical reports
Add or modify the JAVA_OPTIONS setting to include
ndashDjavaawtheadless=true
For example add the following line to the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file
set JAVA_OPTIONS=JAVA_OPTIONS ndashDjavaawtheadless=true
Note The process described above describes where to put this setting for a basic WebLogic installation For more complex setups that use different startup scripts review this section with the WebLogic administrator Determine the appropriate script in which to enter this JAVA_OPTION so it will be read during startup
Put the JDBC Driver in the WebLogic classpath For Process Commander to connect to the relational database the database driver(s) must be in the WebLogic classpath
In the setDomainEnvcmd (Windows) or the setDomainEnvsh (UNIX) file add the line set EXT_PRE_CLASSPATH= and specify the path to and the name of the appropriate JDBC driver for your database Using EXT_PRE_CLASSPATH ensures that the system finds these JDBC drivers first and so they are the ones used
For example for Oracle databases the settings might look similar to the following
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
23
set EXT_PRE_CLASSPATH=Dbeaweblogic92serverlibojdbc14jar
The setting provides the path to ojdbc14jar
For MS SQL Server 2005 databases supply the path to sqljdbcjar
For MS SQL Server 2000 databases supply the path to msbasejar mssjar and msutiljar
For UDB supply the path to db2jccjar
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
24 PegaRULES Process Commander Installation Guide v53
Start the Admin Server 1 Start the Administration server for the new domain
You can start the Administration Server by running the appropriate startWebLogic script startWebLogiccmd (Windows) or startWebLogicsh (UNIX) in the bin directory of your domain directory for example BEA_HOMEuser_projectsdomainsDOMAIN_NAMEbin
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Start Admin Server for WebLogic Domain
For more information see httpe-docsbeacomwlsdocs92server_startoverviewhtmlStartingAdministrationServer
2 Start the Administrative Console and login with the administrative user name and password that you specified in the Configuration Wizard
You can start the Administrative Console in a browser by opening the URL httphostnameportconsole where hostname is the name of the Administration Server and port is the listen port on which the Administration Server is listening for requests (port 7001 by default)
On Windows you can also start the Administration server from a shortcut on the Start menu BEA Products -gt User Projects -gtDOMAIN_NAME -gt Admin Server Console
For more information see httpe-docsbeacomwlsdocs92introconsolehtmlwp1122070
The administration console is displayed
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
25
Enabling DNS Lookup The Process Commander Tracer requires that DNS lookup be enabled in order to display the name of the client host rather than its IP address To enable DNS lookup perform the following steps
1 In the Admin console navigate to Environment -gt Servers -gt AdminServer -gt Configuration -gt Tuning
ndash Under Domain Structure click Environment -gt Servers
ndash On the Summary of Servers page click AdminServer
ndash On the Settings for AdminServer page make sure the Configuration tab is selected and click Tuning on the Configuration menu bar
The Tuning settings page is displayed
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
26 PegaRULES Process Commander Installation Guide v53
2 On the Tuning page check Reverse DNS Allowed
ndash Click Lock amp Edit in the Change Center at the top-left of the page
ndash Select the checkbox Reverse DNS Allowed
ndash Click Save on the Settings page
ndash Click Activate Changes in the Change Center
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
27
Create a JDBC Connection Pool and Data Source Complete the following procedure to create a JDBC Connection Pool and Data Source in WebLogic to allow PRPC to connect to the PRPC database As shown in the procedure below you use Oraclersquos JDBC driver to create the new JDBC provider
For more information on JDBC configuration in WebLogic see the WebLogic online documentation ldquoDatabase Connectivity (JDBC) for BEA WebLogic Server 92rdquo at httpedocsbeacomwlsdocs92jdrivershtml
To create the PRPC data source 1 In the Administrative Console under Domain Structure open the Services -
gtJDBC-gtData Sources page
The page Summary of JDBC Data Sources appears
2 In the Change Center click Lock amp Edit
3 On the Data Source page click New
The page Create a New JDBC Data Source appears
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
28 PegaRULES Process Commander Installation Guide v53
4 Supply the values for the data source name and the JNDI name of the resource
ndash Name the data source PegaRules
ndash Specify the JNDI Name jdbcPegaRULES
ndash Select the appropriate Database Type and Database Driver
Note The Database Type specifies the DBMS you want to use with your PRPC data source After you select the Database Type the Database Driver dropdown lists the JDBC drivers available for that DBMS The particular driver you choose for example XA or non-XA depends on how your company has configured your environment and how you will use PRPC If you are unsure about which JDBC driver to choose check with your database administrator Important If you choose an XA driver to enable two-phase commit you must install the prpcj2ee14ear file as the core Process Commander component For more information see Process Commander Core Component Versions on page 4
Note for Oracle users For Oracle 10g specify Type 4 (thin client) JDBC drivers For Oracle 9 specify Type 2 (thick client) JDBC driver PRPC stores some data in BLOBS (binary large objects) In Oracle 9 the
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
29
JDBC OCI (Oracle Call Interface) connection supported by the Type 2 driver is required to support PRPCrsquos use of BLOBS
For example the completed form for a typical Oracle environment might look like the following
5 Click Next
A Transactions Options page similar to the following displays The particular options that appear depend on the type of driver you selected
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
30 PegaRULES Process Commander Installation Guide v53
6 Unless instructed otherwise by your site database administrator accept the defaults for the transaction options and click Next
The Connection Properties page displays
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
31
7 On the connection properties specify the Name Host Name Port Database User Name and Password for the PRPC database you created on your database server Click Next
The next page varies depending on the type of database you are specifying For example an Oracle page might look like the following
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
32 PegaRULES Process Commander Installation Guide v53
8 For non-Oracle databases confirm the Driver Class Name and URL
For MS SQL Server 2005 Driver Class Name commicrosoftsqlserverjdbcSQLServerDriver URL jdbcsqlserver ltyour_sql_server_hostgt1433
For MS SQL Server 2000 Driver Class Name commicrosoftjdbcsqlserverSQLServerDriver URL jdbcmicrosoftsqlserverltyour_sql_server_hostgt1433
9 Update the Properties text box to add the necessary parameters for your database as listed below
ndash If using Oracle Client version 9205 as well as all later versions including 10g add the following property oraclejdbcV8Compatible=true
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
33
ndash If MS SQL Server add the following properties SendStringParametersAsUnicode=false SelectMethod=cursor
ndash If UDB add the following properties currentSchema = ltuser DB schema namegt currentFunctionPath = SYSIBM SYSFUNltuser DB schema namegt
Note SYSIBM and SYSFUN are system schemas provided by DB2 They are required because Process Commander 53 makes use of some functions made available in these schemas
10 Click the Test Configuration button If the test is successful click Finish
You will be returned to the Summary of JDBC Data Sources page
11 Click the Activate Changes button in the Change Center
12 Click the name of the data source you just created in the Data Sources table
13 On the Settings page for the data source click the Connection Pool tab
14 Verify that the Connection Pool properties are correct for the data source you created
15 Click the Lock amp Edit button in the Change Center to edit the data source Configuration
16 Select the Targets tab and select the AdminServer as the target for the data source
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
34 PegaRULES Process Commander Installation Guide v53
17 Click Save then click Activate Changes
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
35
Configure JMS Resources Complete the following procedures to define JMS resources used by PRPC
Important PRPCrsquos EJB components make use of JMS Services internally You must complete this procedure even if your PRPC application does not use messaging to integrate with external systems
To configure the JMS resources required by PRPC you will complete the following tasks
1 Create a JMS Server targeted at your WebLogic server
2 Create a JMS Module
3 In the JMS Module create
ndash a Connection Factory and subdeployment targeted to the JMS Server
ndash a Queue and subdeployment targeted to the JMS Server
For more information about configuring JMS resources in WebLogic see the WebLogic online documentation ldquoMessaging (JMS) for BEA WebLogic Serverreg 92rdquo at httpedocsbeacomwlsdocs92messaginghtml
Create a JMS Server 1 On the Administration Console under Domain Structure click Services gt
Messaging gt JMS Servers
2 Click Lock amp Edit in the Change Center and then New to create a new server
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
36 PegaRULES Process Commander Installation Guide v53
3 In the Name field enter a name to identify the PRPC JMS server such as PRJMS_Server and click Next
4 In the Target dropdown select your Admin Server or the managed server you created for PRPC and click Finish
You will be returned to the Summary of JMS Servers page
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
37
5 Confirm that you see the message ldquoJMS Server created successfullyrdquo and click Activate Changes in the Change Center
Create a JMS Module 1 On the Administration Console under Domain Structure click Services -gt
Messaging -gt JMS Modules
This will become the container for the connection factory and queues
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
38 PegaRULES Process Commander Installation Guide v53
2 In the Change Center click Lock amp Edit and then New in the JMS Modules table
3 On the Create JMS System Module page enter a name such as PRJMS-Module and click Next
4 In the Targets table select the checkbox for your Admin Server or the server to which you will deploy PRPC and click Next
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
39
5 Check the checkbox for ldquoWould you like to add resources to this JMS system modulerdquo and click Finish
The Settings page for your JMS Module is displayed
6 Confirm that you see the message ldquoThe JMS module was created successfullyrdquo and click Activate Changes in the Change Center
Create a Connection Factory and Subdeployment 1 Still on the Settings page for your JMS Module click Lock amp Edit in the
Change Center and then New in the Summary of Resources table to display the page Create a New JMS System Module Resource
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
40 PegaRULES Process Commander Installation Guide v53
2 Select the radio button next to Connection Factory and click Next
3 Enter a name for the Connection Factory such as PRAsyncConnectionFactory and use exactly the JNDI name jmsPRAsyncQCF
Click Next
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
41
4 Click Advanced Targeting
5 Click Create a New Subdeployment
6 Under Subdeployment Properties enter a Subdeployment Name such as PRJMS_Subdeployment and click OK
You are returned to the Properties page for the Connection Factory
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
42 PegaRULES Process Commander Installation Guide v53
7 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
8 Confirm that you see the message ldquoConnection Factory created successfullyrdquo and click Activate Changes in the Change Center
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
43
Create a Queue and Subdeployment You will repeat the procedure you just completed for the Connection Factory to create a JMS Queue and Subdeployment in this JMS Module
1 Returned to the Settings page for your JMS Module click Lock amp Edit in the Change Center and New in the Summary of Resources table to display the page ldquoCreate a New JMS System Module Resourcerdquo again
2 From the list of resource types click the radio button next to Queue and Next to display the page Create a New JMS System Module Resource for the queue
3 Enter a name for the Queue such as PRAsyncQueue and use exactly the JNDI name jms PRAsyncQueue Click Next
4 From the Subdeployments dropdown select Create a New Subdeployment
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
44 PegaRULES Process Commander Installation Guide v53
5 On the Create a New Subdeployment page enter a new name for the subdeployment such as PRJMS_Subdeployment_Queue and click OK
Note Be sure to use a different name than the one you used for the Connection Factory Subdeployment The Connection Factory and the Queue should each have their own subdeployment
6 Under Targets select the checkbox for the JMS Server you created for PRPC and click Finish
You are returned to the Settings page for your JMS Module
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
45
7 Confirm that you see the message ldquoThe JMS Queue was created successfullyrdquo and click Activate Changes in the Change Center
This completes the configuration tasks for your WebLogic server Continue with the following section Deploy the Database Import Application
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
46 PegaRULES Process Commander Installation Guide v53
Deploy the Database Import Application Follow the procedure below to deploy the Process Commander Database Utilities application prdbutilwar You use the prdbutil application to load the initial PRPC rulesets into your database In addition prdbutil provides utilities to verify and manage your database configure rule search indexing configure the PRPC Help and JMX applications and set up your initial user and organization structure for Process Commander
Note In releases previous to 52 it was necessary to use the staging mode when deploying the PRPC WAR files Earlier Installation Guides required you to expand the WAR file into a directory on your server and then to deploy from that directory Beginning in 52 you can directly deploy the WAR file as described below
1 In the Domain Structure section click Deployments
2 Click Lock amp Edit to unlock the page and click Install
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
47
3 Click the link upload your file(s)
4 Click the Browse button next to the Deployment Archive field use the file dialog to navigate to and select the prdbutilwar file from your PRPC distribution When the file name is displayed in the Deployment Archive field click Next
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
48 PegaRULES Process Commander Installation Guide v53
5 On the Install Application Assistant click the radio button next to prdbutilwar and click Next
6 Select Install this deployment as an application and click Next to display the optional settings page
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
49
7 Click Next to accept the defaults
8 Review your choices Leave the radio button ldquoYes take me to the deployments configuration screenrdquo selected If the other settings are as expected click Finish to begin deploying the application
When the WAR file has deployed you are returned to the applicationrsquos Settings page
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
50 PegaRULES Process Commander Installation Guide v53
9 Review the Deployment Settings screen
10 Click on the Targets tab and verify that the target server is correct
11 Click Activate Changes in the Change Center to save the configuration
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
51
12 Click Start to start the application
If you are asked to select ldquoService all requestsrdquo or ldquoService only Admin requestsrdquo choose ldquoService all requestsrdquo
13 Open the prdbutil application in a browser window to test the deployment
ndash Type the application URL in a browser window Address field
httpltyourservergt7001prdbutilindexhtml
The Process Commander Database Utilities Introduction page is displayed
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
52 PegaRULES Process Commander Installation Guide v53
ndash Close the window
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
53
Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files Repeat the procedure described for prdbutil above to deploy each of the other Process Commander components
The Process Commander core application prpc_j2ee14ear
Important Pegasystems recommends deploying the EAR file component prpc_j2ee14ear for all new deployments on Weblogic 9x systems The WAR file core component prwebwar can be successfully deployed to the WebSphere and WebLogic 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 prwebwar and prpc_j2ee14ear Install prpc_j2ee14ear only on WebLogic 9x systems If you are installing PRPC 53 on a WebLogic 8x system install prpc_j2ee13ear For more information see ldquoProcess Commander Core Component Versionsrdquo on page 4
The online help application (prhelpwar)
Note The prhelpwar file is distributed in a ZIP file DocumentationImagezip which is separate from the Process Commander software distribution If you receive the software on CD there will be a separate Documentation Distribution CD In DocumentationImagezip file or on the Documentation Distribution CD the prhelpwar application is located in the archives directory
The PRPC System Management Application (prsysmgmtwar)
Note Do not start these applications after deployment
You configure these applications using the Database Utilities application as described in Chapter 7
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (pdnpegacom) at pdnpegacomDevNetPRPCv4SystemToolsdocumentsSysManagementAppGuidepdf
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
54 PegaRULES Process Commander Installation Guide v53
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
55
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
The role PegaDiagnosticUser is associated with the System Management Application through a security-constraint element in the prweb applicationrsquos webxml file
- ltsecurity-constraintgt - ltweb-resource-collectiongt ltweb-resource-namegtDiagnostic Dataltweb-resource-namegt ltdescriptiongtServes diagnostic files generated by the JMX clientltdescriptiongt lturl-patterngtDiagnosticDatalturl-patterngt lthttp-methodgtGETlthttp-methodgt lthttp-methodgtPOSTlthttp-methodgt ltweb-resource-collectiongt - ltauth-constraintgt ltrole-namegtPegaDiagnosticUserltrole-namegt ltauth-constraintgt ltsecurity-constraintgt
In EAR file deployments the webxml file is located in the prwebwar file packaged inside the prpc_j2ee14ear file
If you do not want to restrict access to the System Management Application remove this resource restriction through one of the two methods listed below
Edit the PegaRULES webxml file in the WEB-INF directory of the prweb deployment in your application server and delete this security constraint element
Note that changing this setting in the webxml file may require redeployment of the PegaRULES Web Application
Alternatively certain application servers (such as IBM WebSphere) allow roles to be mapped to all users including those who are unauthenticated If your application server supports this map the PegaDiagnosticUser role to all users Consult your application servers documentation to see if this is an option for your environment
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
56 PegaRULES Process Commander Installation Guide v53
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
Next Steps
When your deployments are complete continue with Chapter 7 Installing Process Commander to complete the installation process
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
57
Chapter 5 Installing Process Commander
Start Your Application Server and Load the PegaRULES Database
You will use the Process Commander Database Utilities to upload the Process Commander application rulesets and install them in your database
1 If necessary start your application server
2 Enter the URL for the prdbutil application in a browser window for example
httplocalhost7001prdbutilindexhtml
You will see the initial page of the Database Utilities interface
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
58 PegaRULES Process Commander Installation Guide v53
Note This interface leads you through a checklist to verify your preparation for installing the PegaRULES application rulesets and then through a series of steps that configure the system for use Some steps include a Skip button that allows you to move on to the next step without completing the current one During your first installation of Process Commander do not skip any steps Review and where necessary complete each step carefully In particular be sure to complete Step 7 Setup Organization In this step you supply an Organization name that will be used to create initial users and access groups for Process Commander You use the user Administratorltyour_organization_namegtcom with the password lsquorulesrsquo to log on to Process Commander for the first time You can then use the Process Commander facilities to configure other access groups and users
3 Click Begin to display the Verify Database Connection page
4 Click on Verify Connection
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
59
The utility displays ldquoChecking Connection to the Databaserdquo Results should return in a few moments
If it cannot make a successful connection the utility displays an error screen
You must have a working connection to your PRPC database to continue Exit from the utility and contact your Database and Application Server administrators to correct the problem and then run the Database Utilities again The requirements for creating the PRPC database and configuring your application server JDBC resources are described in Chapter 2 Preparing the Database on page 9 and ldquoCreate a JDBC Connection Pool and Data Sourcerdquo on page 27
If the connection is successful the utility displays a screen like the following
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
60 PegaRULES Process Commander Installation Guide v53
Use this screen to verify that
ndash you are connected to the correct database
ndash you are performing the expected Maintenance Action Install or Upgrade
It the database verification process identifies existing PRPC records with data in the database the utility assumes that the Maintenance Action is an upgrade If no data is found the utility assumes the Maintenance Action is an Installation
5 Click on Next to view the Installation checklist
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
61
6 Read and check each checkbox to verify that you have completed the prerequisites for the installation then click Next at the bottom of the page
Instructions for completing these tasks are given in the earlier chapters of this Installation Guide
PRPC displays the Upload Application Files page
7 Use this page to load the PRPC JAR file to your application server This file contains the initial application rule sets that you will load to your database
ndash Click Browse to find and select the PRPC JAR file PRPCv5jar in the PegaRULESapplicationJar directory of your software distribution for 53 The name of the file may include additional identifying characters for example PRPCv5_v52_relcand_0034jar
ndash Click Upload Note that this file is large and may take some time to be transferred to your server
ndash When the Upload completion page displays click Done
The Install Application Rules page is displayed
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
62 PegaRULES Process Commander Installation Guide v53
8 Use this page to install the PRPC rule instances to your PRPC database
ndash Confirm that the staging directory is the same as the directory to which you uploaded the file PRPC jar file
ndash Confirm that the PRPC jar file you uploaded is displayed in the Select File field
ndash Click Process
Process Commander will load the application Rule Base to your database Process Commander writes logging information to the Database Utilities page If the installation is not successful error messages are also written to the screen
If the install fails to complete successfully drop the tables that were created and rerun this procedure SQL scripts for each supported database type are available on the distribution media to drop the PRPC tables in the schemaDDL directory
Important Depending on the speed of your system and database this process can take anywhere from 10 to 45 minutes
When the installation is complete click Next on the confirmation page
Process Commander displays the Configure Rule Search Indexing page
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
63
9 Optionally complete this form and click Create to enable Lucene search capabilities in Process Commander or click Skip to pass over this step
This is an optional step If your system has a very large number of rules or work objects enabling the Lucene search engine can improve the performance of searches in the Process Commander interface
Process Commander will display an update page while the index file is imported When the import is complete click Next to continue
Process Commander displays the Configure Help and JMX Applications page
10 Complete this page to specify the URLs to access the Help (prhelpwar) and System Management (prsysmgmtwar) applications then click Create to enable these applications
Note The default URLs for the Help and System Management applications specify only localhost as the server name This will only allow users logged
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
64 PegaRULES Process Commander Installation Guide v53
into the same server on which the applications are deployed to access the applications Replace localhost with the appropriate server name and port number to allow access to the applications from other systems
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
When the import is complete click Next on the confirmation page
Process Commander displays the Setup Organization page
11 Enter the name of your organization in the appropriate field and click Preview to review the objects and users that will be created
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
65
ndash Click 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
ndash Click Create to create the organizational structure that will be used to initialize the Process Commander application
When the import is complete click Next on the confirmation page
Process Commander displays the Verify Installation page
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
66 PegaRULES Process Commander Installation Guide v53
12 Click Verify
A Waiting message displays while the utility verifies the ruleset loaded to the database The system checks the rows present in the database against the rows required for this release If all rows are present the utility displays a successful verification report
If problems are found error messages with instructions will be displayed
13 Click Next
Process Commander displays the Complete PRPC Installation Process page
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
67
You can close the Database Utilities browser window
14 Stop and restart the application server
15 Ensure that all the Process Commander applications have started
16 Access the Process Commander servlet PRServlet through a browser Type in the URL for Process Commander application This will be of the form httpltservergtltportnumbergtltcontext_rootgtPRServlet For example
httpprpc-server7001prwebPRServlet
If successful you should see the PegaRULES login screen (PRServlet)
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
68 PegaRULES Process Commander Installation Guide v53
17 Login using the Administrator user created with your organization name
during the Installation process Use the password rules
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
69
18 Select one of the Welcome topics or click Close to enter the Process Commander application
Continue with the next section to enable the System Management Application for your installation
Create a Systems Management Node Create a node for your Process Commander system in Pegasystemsrsquo System Management application to enable monitoring of the installation
For more details on the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
70 PegaRULES Process Commander Installation Guide v53
19 In the Process Commander Developer Portal click on Tools gtSystem Management Application
The System Management Console opens No nodes are set up initially
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
71
20 Click on the + button at the top of the left pane to open the form for creating a new node
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
72 PegaRULES Process Commander Installation Guide v53
21 Complete this form by entering the information appropriate to your installation of Process Commander You must complete all required fields
The example values above show the basic configuration for the a Process Commander instance on the same server as the prsysmgmtwar application You can also use this application to connect to remote instances of Process Commander by supplying the appropriate information for the remote server machine
22 When complete click on the Submit button to create your node
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
73
23 To view data on this node click the host name in this case localhost in the navigation pane on the left The console displays current data on this system
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
74 PegaRULES Process Commander Installation Guide v53
For information on all the functionality of the System Management Application refer to the System Management Application Reference Guide available on the Pega Developer Network (httppdnpegacom) Click PRPC System Tools in the navigation menu on the left of the PDN home page to find a link to the guide
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-
75
Next Steps When your Process Commander system is deployed successfully refer to the following documents to learn about managing and integrating Process Commander in your environment You can find links to these documents on the Process Commander Documentation page of the Pega Developer Network
Administration and Security This document describes how to perform the initial startup setup and day-to-day administration of your Process Commander system
Integrating with External Systems PegaRULES Process Commander provides a set of standard integration services for creating interfaces to and from external systems The documentation for these integration services is found in two places
ndash The manual Integrating with External Systems describes the Process Commander integration features and presents general concepts and information for integrating Process Commander applications with other systems
ndash The Integration Services section of the Pega Developer Network (PDN) presents individual documents for individual types of services and connectors along with appropriate RuleSet and code examples demonstrating their use
- Process Commander Core Component Versions
- Overview of the Installation Procedure
- Prerequisites
-
- Supported Process Commander Platforms
- Check the Pega Developer Network for the Latest Information
-
- Deployment information and updates
- Pegasystems Documentation
- Pegasystems Training
- Check Knowledge Base Platform Bulletins
-
- A Note for PRPC 42 Users
-
- Database Prerequisites
- Creating a PRPC Database
-
- Additional UDB Requirements
-
- Creating Access to the Database
-
- User Permissions for the Microsoft SQL Database
- User Privileges for the Oracle Database
- User Privileges for the UDB Database
-
- Creating the PRPC Data Objects in the Database
-
- Other Process Commander SQL scripts
-
- Verify the Java Environment
- Configuring Database support on your Application Server
-
- Microsoft SQL Server
- Oracle 9i or 10
-
- Oracle Installation Edits
- Validating the Oracle Connection
-
- UDB
-
- Create a WebLogic Domain
- Configuring WebLogic 92
-
- Editing the setDomainEnv Script or Batch file
-
- Set JVM Memory Parameters
- Setting an Explicit Temporary Directory
- Setting the AWT ldquoheadlessrdquo Java Property
- Put the JDBC Driver in the WebLogic classpath
-
- Start the Admin Server
-
- Enabling DNS Lookup
-
- Create a JDBC Connection Pool and Data Source
-
- To create the PRPC data source
-
- Configure JMS Resources
-
- Create a JMS Server
-
- Create a JMS Module
- Create a Connection Factory and Subdeployment
- Create a Queue and Subdeployment
-
- Deploy the Database Import Application
- Deploy the prpc_j2ee14ear prhelpwar and prsysmgmtwar files
- Assigning the PegaDiagnosticUser Role to your System Management Application Users
-
- Next Steps
- Start Your Application Server and Load the PegaRULES Database
- Create a Systems Management Node
-
- Next Steps
-