7.2.1 ibmdb2forlinux,unix,andwindows oracleweblogicserver ·...

Pega 7 Platform Installation Guide7.2.1

IBM DB2 for Linux, UNIX, and Windows

Oracle WebLogic Server

© Copyright 2016Pegasystems Inc., Cambridge, MA

All rights reserved.

Trademarks

For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. Other brand or product names are trademarks of theirrespective holders.

For information about the third-party software that is delivered with the product, refer to the third-party license file on yourinstallation media that is specific to your release.

Notices

This publication describes and/or represents products and services of Pegasystems Inc. It may contain trade secrets and proprietaryinformation that are protected by various federal, state, and international laws, and distributed under licenses restricting their use,copying, modification, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc.

This publication is current as of the date of publication only. Changes to the publication may be made from time to time at thediscretion of Pegasystems Inc. This publication remains the property of Pegasystems Inc. and must be returned to it upon request. Thispublication does not imply any commitment to offer or deliver the products or services described herein.

This publication may include references to Pegasystems Inc. product features that have not been licensed by you or your company. Ifyou have questions about whether a particular capability is included in your installation, please consult your Pegasystems Inc. servicesconsultant.

Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors, aswell as technical inaccuracies. Pegasystems Inc. may make improvements and/or changes to the publication at any time.

Any references in this publication to non-Pegasystems websites are provided for convenience only and do not serve as anendorsement of these websites. The materials at these websites are not part of the material for Pegasystems products, and use ofthose websites is at your own risk.

Information concerning non-Pegasystems products was obtained from the suppliers of those products, their publications, or otherpublicly available sources. Address questions about non-Pegasystems products to the suppliers of those products.

This publication may contain examples used in daily business operations that include the names of people, companies, products, andother third-party publications. Such examples are fictitious and any similarity to the names or other data used by an actual businessenterprise or individual is coincidental.

This document is the property of:

Pegasystems Inc.One Rogers StreetCambridge, MA 02142-1209USAPhone: 617-374-9600Fax: (617) 374-9620www.pega.com

DOCUMENT: Pega 7 Platform Installation Guide SOFTWARE VERSION: 7.2.1UPDATED: September 23, 2016

http://www.pega.com/

CONTENTS

Installation 7Related information 7Pega 7 Platform architecture 8Planning your installation 8Split-schema and single-schema configurations 9Installation methods 10

System requirements 11UI-based installation tool (Installation and Upgrade Assistant) 11Application server 11Database server 12

Pre-installation tasks 12Reviewing the documentation 12Selecting a transport-layer encryption method 13Configuring the Java Platform 13Configuring storage and logging 13Synchronizing time zones, character encoding, and regional settings 13

Setting up the database server 14Verifying the database configuration 14Configuring your IBM DB2 for Linux, UNIX, and Windows database 14Database users 14Creating an empty database 18Creating new schema 19

Installing the Pega 7 Platform 21Preparing to install 21Running the Installation and Upgrade Assistant (IUA) 22Editing the setupDatabase.properties file 25Database connection properties 26

Optional: Enabling Kerberos authentication 26Installing from the command line 27

Setting up the application server 29

Pega 7 Platform Installation Guide 3

Preparing to configure the application server 29EAR file and WAR file considerations 31Data source resources, data source entries, and default schema entries 31

Configuring the application server 31JVM memory parameters 32Fix HTTP authentication issue with Oracle WebLogic Server 9.2 and later 32Edit the setDomainEnv script or batch file 33Set an explicit temporary directory 34Adding the JDBC driver to the Oracle WebLogic Server classpath 34Configuring Oracle WebLogic Server to deploy the Pega 7 Platform archive files 35

Deploying the Pega 7 Platform application archives 41Configuring split-schema configurations 42Deploying single-schema configurations 44Assigning the PegaDiagnosticUser role to your System Management Application users 46

Post-deployment configuration 47Starting the Pega 7 Platform applications 47Logging in to the Pega 7 Platform 47Changing the administrator password 48Enabling online help and the System Management Application 48Configuring Directed Web Access 49Optional: Configuring the Pega 7 Platform to return absolute URLs 49Configuring search index host node settings 51Resizing the Pega 7 Platform log files 52Resizing the database 52Installing Industry applications 52Enabling server-side screen captures for application documents 52Configuring PhantomJS REST server security for including screen captures in an applicationdocument 54

Appendix A — Properties files 55

Appendix B — Troubleshooting installations 56Recovering from a failed installation 56PEGA0055 alert — clocks not synchronized between nodes 56


ClassNotFoundException error — session persistence 57System hangs with no error message — insufficient memory 57Obtaining database connection information 57

Appendix C — Optional: Generating and applying DDL 59Generating the DDL file 59Applying the DDL file 60Editing the setupDatabase.properties file to bypass DDL generation 60

Appendix D — Installing user-defined functions 61


InstallationThis guide describes how to install a new instance of the Pega 7 Platform on a system with IBM DB2for Linux, UNIX, and Windows and Oracle WebLogic Server. See the Platform Support Guide on thePDN for a list of supported platforms.

To upgrade, see the Pega 7.2.1 Upgrade Guide. To update from Pega 7.1.x, see the Pega 7.2.1Update Guide.

Installing the Pega 7 Platform is a multiple step process that involves configuring your database andapplication server, loading rules into the database, and then deploying application archives to theapplication server.

The Pega 7 Platform supports different deployment topologies and configuration options that affecthow the supporting infrastructure is configured and managed after installation. Engage yourdatabase administrator and any other infrastructure resources as soon as possible in the planningprocess.

Related informationThe Pega Discovery Network (PDN) at https://pdn.pega.com is Pegasystems' online documentationand information site. To access the latest documentation, use the Supportmenu.

l Pega 7 Platform Support Guide— The Platform Support Guide lists the databases, drivers andapplication servers supported for this release.

l Deployment guides— The PDN includes the latest installation, upgrade, and update guides.

l Pega 7 Platform release notes— The release notes include information about installing thePega 7 Platform that supplement the instructions in this guide. Review the release notes beforeyou continue.

l Updated help files— Pegasystems provides updated help on the PDN. To obtain these updates,download the current prhelp.war file from the PDN.

l Pega 7 Platform Multitenancy Administration Guide— TheMultitenancy AdministrationGuide describes how to configure the Pega 7 Platform in multitenant mode after installation.

l Pega 7 Platform Business Intelligence Exchange User Guide— The Business IntelligenceExchange User Guide describes how to install the Business Intelligence Exchange (BIX) product.BIX is included in the full distribution image, but has a separate installer.

l System Management Application Reference Guide— The optional System ManagementApplication monitors and controls caches, agents, requesters, listeners, and other processing.

Pega 7 Platform architectureThe Pega 7 Platform is a Java EE-compliant enterprise application that requires an application serverand a database server:

l The application server hosts the Pega 7 Platform application archives and also providesinterconnectivity to other systems through various protocols.

l The database server stores the rules, data, and work objects used and generated by the Pega 7Platform.

Application users and developers typically access the Pega 7 Platform through a web browser.Applications can also expose HTTP-based services (for example, SOAP, REST, or HTTP) foradministration or process automation in a headless environment.

Planning your installationThe Pega 7 Platform supports several configuration options that can affect the choices that you makeduring the installation. Before beginning, read this section thoroughly.

l Do not change your environment during an installation. For example, if you are making changesto your application server, or database server, do so before you install the Pega 7 Platform.

l Choose a configuration type: single-schema or split-schema configuration. Pegasystemsrecommends a split-schema configuration. See Split-schema and single-schema configurations.

l Choose whether to use the standard product edition or the multitenancy edition. The multitenancyedition has different requirements, different run-time behaviors, and different administrativeprocedures from the standard edition. Before you select the multitenancy edition, review theMultitenancy Administration Guide on the PDN.

Upgrading and updating from one edition to another is not supported. If you install one editionand later decide to use a different edition, you must drop and re-create the database or create anew database. The schema DDLs for the two editions are not compatible.

l Verify the Business Intelligence Exchange (BIX) and Pega 7 Platform product versions. Releaseversions of the Business Intelligence Exchange (BIX) are synchronized with release versions of the


Installation

Pega 7 Platform. BIX is included in the full distribution image, but has a separate installer. Verifythat the version of BIX is the same as the version of the Pega 7 Platform. For information aboutinstalling BIX, see the Pega 7.2.1 BIX User Guide.

l Choose an installation type: UI tool or command line. See Installation methods.

l Choose whether to use Kerberos functionality. Kerberos is a computer network authenticationprotocol that allows nodes communicating over a non-secure network to prove their identity toone another in a secure manner. If you enable Kerberos authentication, you must use thecommand line to install the Pega 7 Platform.

l Choose whether to have the installation make changes directly to the database. You can eitherhave the Pega 7 Platform installation apply changes directly to your database, or generate DDLfiles of changes for your database administrator to apply. For information about manuallygenerating and applying DDL, see Appendix C — Optional: Generating and applying DDL on page59.

l Choose whether to cluster the Pega 7 Platform nodes. The Pega 7 Platform supports clusterednodes without special configuration, but you will make different choices about ports, indexes, andclock synchronization depending on your node configuration.

l Determine the best configuration for your database. Involve your database administrator in thesedecisions. If necessary, contact Pegasystems Global Customer Support for more information.

l Choose either dual-user or single-user configuration. In a dual-user configuration, an Admin useris granted full privileges, and a Base user is granted a smaller subset of privileges. In the single-user configuration, a single Base user is granted full privileges. See Database server setup forinformation about user configuration.

Split-schema and single-schema configurations

There are two configuration types: single schema and split-schema. Pegasystems recommends split-schema configurations, particularly in critical development environments such as quality assurance,staging, and production.

l Single-schema configuration —One schema contains all rules and data objects.

l Split-schema configuration — The rules and data objects reside on separate schemas:

A Rules schema contains rules tables and associated data and objects.

AData schema contains transaction data, including work objects.


Installation

With a split-schema configuration, you can upgrade one environment, and then migrate theupgraded objects to other environments.

In a split-schema configuration, the Pega 7 Platform uses the Java Naming and Directory Interface(JNDI) standard to identify and access the appropriate schema. One of the benefits of using JNDI isthat it allows the Pega 7 Platform to access different schemas while using only a single datasource.

The following diagram illustrates the difference between a single-schema configuration and a split-schema configuration.

Installation methods

You can install the Pega 7 Platform either with the UI tool or from the command line. This guideincludes instructions for both methods.

l UI tool – Use the UI-based Installation and Upgrade Assistant to install either the rulebase or therulebase and the schema.

l Command line – Run scripts to install the Pega 7 Platform.

Regardless of whether you use the UI tool or the command-line scripts, you might need to edit thesetupDatabase.properties file that controls the behavior of the following scripts:

l The generateddl.bat or generateddl.sh script generates an SQL file that your databaseadministrator can use to apply schema changes to the database. You can run this script regardless


Installation

of whether you use the IUA or the command-line script to install.

l The install.bat or install.sh script performs the following functions:Installs the most recent version of the Pega 7 Platform.

Specifies whether to generate a DDL file of changes to the database.

Enables Kerberos authentication.

If you use the IUA to install, you do not use the install.bat or install.sh script.

System requirementsEnsure that your system meets the minimum requirements.

UI-based installation tool (Installation and Upgrade Assistant)

If you plan to use the UI-based Installation and Upgrade Assistant ensure that the system on whichyou will install meets these minimum system requirements in addition to all other requirements:

l Windows or Linux operating system

l 1.25 GB minimum available memory

l 10 GB minimum disk space plus at least 8 GB available space in the temporary directory of theroot file system

l Java Platform, Standard Edition Development Kit (JDK)

Application server

The application server requires:

l A supported 64-bit JDK. See the Platform Support Guide on the PDN for a list of supportedversions.

l 1 GB minimum free disk space. You might need additional storage space for debugging andlogging.

Install only the Pega 7 Platform be installed on the application server.


Installation

Application server memory requirements

The Pega 7 Platform runs in memory (heap) on Java Virtual Machines (JVMs). In general, all activity isdistributed over multiple JVMs (nodes) on the application server.

l Standard suggested system heap size is 4 - 8 GB based on monitoring of memory usage andgarbage collection frequency.

l Larger heaps are advisable if your applications allow a high number of concurrent open tasks persession or cache a large collection of transaction or reference data.

l Do not deploy the Pega 7 Platform in an environment where the heap size exceeds the vendor-specific effectiveness limit.

IBM JDKs use compression to minimize the cost of large heaps. The compression option is labeledCompressedRefs and is effective up to 28 GB.

In current 64-bit JVMs, compression is enabled by default.

The host application server memory size must be at least 4 GB larger than the Pega 7 Platform heapsize to allow space for the operating system, monitoring tools, operating system network filebuffering, and JVM memory size (-XMX option). The minimum host application server memory size is8 GB:

4 GB heap + 4 GB for native memory, operating system, and buffering

If the server does not have enough memory allocated to run the Pega 7 Platform, the system canhang without an error message. The correct memory settings depend on your server hardware, thenumber of other applications, and the number of users on the server, and might be larger than theserecommendations.

Database server

Confirm that your database server meets the requirements in the Pega Platform Support Guide onthe PDN.

Pre-installation tasksComplete the tasks in this section before you begin the installation.

Reviewing the documentation

Before you begin the installation, review the related information available on the PDN:


Installation

l Platform Support Guide— Review the Platform Support Guide before you install the Pega 7Platform to verify that your database and application servers are supported.

l Pega 7 Release notes— Review the important information in the release notes before youcontinue.

Selecting a transport-layer encryption method

Pegasystems recommends that you use a strong transport-layer encryption method (for example,Transport Layer Security 1.2) to secure Pega 7 Platform web applications. This encryption requiresthat you create and install transport-layer security and secure socket layer digital certificates on yourapplication server for the Pega 7 Platform. Before you continue, determine what transport-layerencryption method you will use. For more information, see the documentation for your applicationserver.

Configuring the Java Platform1. Set JAVA_HOME to the root directory of the JDK.

2. For Java 8, remove from the PATH any references to a Java shortcut.

Configuring storage and logging1. Allocate enough storage to accommodate debugging and other logging requirements.

2. Configure logging to avoid writing logs to the directory that contains the application server run-time components.

Synchronizing time zones, character encoding, and regional settings

Verify that your database server, application server, and the system on which you are running theinstallation use the same:

l Time zone

l Character encoding (UNICODE or EBCDIC)

l Regional settings/locale


Installation

Setting up the database serverThis section describes how to prepare and configure your database server:

l Configure the database users.

l Create an empty database.

Verifying the database configurationBefore you begin preparing your database, confirm that your database server is installedand running. Verify that your database meets the requirements described below.

l Your system includes a supported version of the JDBC4 driver for your version of the database.

l The LOGFILSIZ parameter is at least 4096 pages. The default logfile size is 1000 pages.

Note: If you edit the LOGFILSIZ parameter, restart the database to make sure the settings areloaded into the database correctly.

l If you plan to use user-defined functions (UDF), support for UDF installed by the Pega 7 Platform isenabled.

l If you plan to use user-defined functions (UDF), Java is enabled in the database.

Configuring your IBM DB2 for Linux, UNIX, and WindowsdatabaseTo prepare your IBM DB2 for Linux, UNIX, and Windows database server for use with the Pega 7Platform, complete the following steps:

1. Create database user accounts.

2. Create an empty database.

3. Create the database schema.

Database users

This guide refers to the following database users:

l Deployment user— The user who runs the installation. After the installation, you can removethis user.

l Run-time users — These users perform actions on the Pega 7 Platform after the installation. In adual-user configuration, an Admin user is granted full privileges, and a Base user is granted asmaller subset. Pegasystems recommends the dual-user configuration:

Base user— The user who will run the Pega 7 Platform. Most run-time operations use theBase user and associated data source.

Admin user— An optional user provided to the Pega 7 Platform that is preferentially used bycertain features that require creating, modifying, or dropping database schema objects; forexample, System Management facilities and certain decisioning operations.

Pegasystems recommends that you use the dual-user configuration with separate Admin and Baseusers; however, you can create a single Base user with both sets of privileges. If there is noseparate Admin user, the Pega 7 Platform uses the Base user for all run-time operations.

IBM DB2 Operating-system users

All users must also exist at the operating system level. Before you create the database user accounts,define the operating-system-level users and authorizations:

l Deployment user - This user must have Administrative privileges on the operating system. Forexample, in Windows this user is a member of the Administrators Group.

l Admin – This user must have Administrative privileges on the operating system. For example, inWindows this user is a member of the Administrators Group.

l Base – This user must not have Administrator privileges on the operating system. If the Base useris associated with the operating systems Administrators group, the database reports an error.

General user permissions and purposes

The following table describes the general permissions for each user and the purpose of eachpermission.

Pegasystems recommends the dual-user configuration. For a single-user configuration, the Base useralso requires the permissions listed for the Admin user.

Permission Deployment User Base User Admin UserInsert/select/update/deleteon data and rules tables

The deployment processsaves instances to data andrules tables.

User has basic readand write access todata and rules tables.

Select data and ruleschema metadata

The deployment processreads metadata about tables

PegaRULES readsmetadata about tables


Setting up the database server

Permission Deployment User Base User Admin Userand other objects todetermine the most efficientway to access and storedata.

and other objects todetermine the mostefficient way to accessand store data.

Execute stored proceduresin data and rules schemas

The deployment processuses stored procedures forsystem operations.

PegaRULES usesstored procedures forsystem operations.

Create/update/drop tables,indexes, and constraints indata and rules schema

The deployment processinstalls the tables, indexes,and constraints used byPegaRULES.

Various systemmanagement toolsallow you to create andmodify tablesand indexes. For data schemas,various facilities in decisioning createshort-lived tables to assist withstrategy analysis.

Create/update/drop viewsin data and rules schemas

The deployment processinstalls the views used byPegaRULES.

Various facilities in decisioning createshort-lived views to assist withstrategy analysis. Import alsorequires this when importing views.

Create/update/drop storedprocedures, triggers, andfunctions

The deployment processinstalls stored procedures,triggers, and functions usedby PegaRULES.

Enable and disabletriggers on rule tables

The installation and upgradeprocesses disable triggersin order to save largeamounts of records morequickly.

Truncate rule and datatables

Various tables must betruncated during aPegaRULES upgrade.

Grant object-levelprivileges on rules schemato data user

When the install andupgrade processes createtables and other objects inthe rules schema, they mustgrant the Base user accessto these objects.

When systemmanagement utilitiescreate tables and other objects in therules schema, they must grant theBase user access to these objects.

Note: If you plan to manually install the user-defined functions (UDFs) from Pegasystems, thedatabase user must also have create external routine authority. For more information about UDFs,see Appendix D — Installing user-defined functions on page 61.



IBM DB2 for Linus, UNIX, and Windows user permissions

The permissions needed for your database users depend on whether you have a split-schema or asingle-schema configuration, and whether you are using the recommended dual Admin/Base userconfiguration.

In a split-schema configuration, the Deployment user owns both the data and rules schemas until theinstallation is complete. After the installation, the Admin user owns both schemas. If there is noAdmin user, the Base user owns the schemas after the installation.

In a single-schema configuration, the Deployment user owns the schema until the installation iscomplete. After the installation, the Admin user owns the schema. If there is no Admin user, the Baseuser owns the schema.

Using IBM Data Studio to create user accounts

Use the Data Studio to create the Base user and Admin user accounts.

Before attempting to create the accounts, make sure they have been defined at the Operating Systemlevel.

1. In the Administration Explorer, expand the newly created database and the section namedUsers and Groups.

2. Right click Users and select Add and Manage User.

In the General tab, enter theName of the database user.

Note: The Base user must not have Administrator privileges on the operating system. If the useris associated with the operating systems Administrators group, the database reports an error.

3. Select the Privileges tab.

Select the appropriate privileges. For example, for the Base user, select CONNECT andDATAACCESS

Keep the remaining default values.

4. Execute the Change Plan.

Note: Repeat these steps if you are planning to use a dual Base and Admin user configuration.



Creating an empty database

Create a database with a minimum of 5 GB for the user tablespace. This minimum size allows you toload the initial rulebase and do simple development. Monitor the database use carefully. Asdevelopment begins, the size of the database will need to increase significantly, depending on youruse of the Pega 7 Platform and the number of users.

For each schema that contains Pega 7 Platform tables, allocate a 32K bufferpool, a 32K user regulartablespace, and a 32K user temporary tablespace.

For example:

CREATE BUFFERPOOL BP_32K SIZE 10000 AUTOMATIC PAGESIZE 32K;CREATE SYSTEM TEMPORARY TABLESPACE PRPCSYSTEMP_32K PAGESIZE 32KMANAGED BY AUTOMATIC STORAGE BUFFERPOOL BP_32K;

By default, the database create process creates a bufferpool and temporary tablespace with a 4Kpage size.

Creating an empty database by using the IBM Data Studio

To create the empty database:

1. Launch the IBM Data Studio.

2. Right-click the database instance and selectNew Database...

The Specify instance details screen is displayed.

3. Enter the user credentials to connect to the instance.

Note: The user must be first defined at the Operating System level and have Administratorprivileges — for example, in Windows, associate this user with the Administrators group.

4. Click Finish.

The Settings form Details tab is displayed.

5. Enter the following values:

l Database name = <DBname>

l Default buffer pool and table space page size = 32KB



l Complete the Storage and Locale tabs with values appropriate for your environment.

Note: By default, the database automatically manages storage and tablespace settings,expanding the size when necessary. The default settings on these tabs are sufficient for mostdevelopment environments and can be accepted as-is. If you want to use custom settings,configure a minimum of 5 GB in theUser Table Space tab.

6. Click Run when you complete entry of your database information.

Creating new schema

Create the required schema depending on whether you are using a single-schema or split-schemaconfiguration.

Creating database schema

Use the Data Studio to create the required schema objects:

1. In the Administration Explorer, expand the database object.

2. Right-click Schemas and select Create Schema.

In the General tab, enter the Name of the schema.

Note: In Pega 7.2.1, all table queries are schema-qualified. While the schema name itself isarbitrary, Pegasystems recommends choosing small names that are meaningful to yourconfiguration. For example, in a split-schema configuration, it is recommended that you name thetwo schema Data and Rules.

3. Select the Privileges tab.

Configure the privileges for your database user.

Accept the remaining defaults.

4. Execute the Change Plan.

Note: Repeat these steps if you are planning to use a split-schema configuration to create asecond schema.



Increase the Logfile Size

Increase the LOGFILSIZ parameter to at least 4096 pages before you install the Rulebase. Thedefault logfile size is 1000 pages.

Note: After making the change to the LOGFILSIZ parameter, restart the database to make surethe settings are loaded into the database correctly.



Installing the Pega 7 PlatformUse one of these methods to install the Pega 7 Platform:

l UI tool — The Installation and Upgrade Assistant is a Java-based UI tool that sets up the Pega 7Platform rules schema in the database and loads the Pega 7 Platform rules.

l Command-line script— A command-line script automates the installation of the Pega 7Platform in headless environments.

These methods use a batch process to load the rulebase. Because of the large number of rules andother data objects that must be loaded, Pegasystems strongly encourages you to install on the samenetwork as the database server. If this is not possible, install on a computer with fast, direct access tothe database server. Do not attempt to install on a virtual private network (VPN) or a multi-hop widearea network (WAN).

Preparing to installFollow these steps to extract and validate the installation files:

1. Copy the compressed distribution image to the computer that you will use to run the installation.Extract the contents of the compressed file into an empty directory.

If you are installing the software from a DVD, copy the contents of the DVD to an empty directory.

2. Verify the contents of the extracted distribution image.

The Pega-image\checksum directory provides an MD5 checksum for each the file in thedistribution image. To verify that the files downloaded and uncompressed correctly, calculate achecksum using the Jacksum tool at www.jonelo.de/java/jacksum/.For example, if you uncompressed the distribution image to Pega-image, enter the followingcommand:

java -jar jacksum.jar -m -a md5 -r -p -O outputFile.md5 Pega-image

Compare outputFile.md5 to the md5 file located in Pega-image\.checksum. The checksumvalues should be identical.

3. Choose the installation method: IUA or command line.

Running the Installation and Upgrade Assistant (IUA)Because of the large volume of data, run the IUA on the same network as the database server. If thisis not possible, run the tool on a system with fast, direct access to the database server. TheDeployment user performs these steps.

Note: The Pega 7 Platform writes command-line output to a file in the Pega-image\scripts\logsdirectory.

The installation can last for several hours and the time can vary widely based on network proximityto the database server.

To run the IUA:

1. Double-click the PRPC_Setup.jar file to start the IUA.

Note: If JAR files are not associated with Java commands on your system, start the IUA from thecommand line. Navigate to the directory containing the PRPC_Setup.jar file, and type java -jarPRPC_Setup.jar.

The IUA loads and the Pega icon is displayed in your task bar.

2. Click Next to display the license agreement.

3. Review the license agreement and click Accept.

4. On the Installer Mode screen, choose Installation and click Next.

5. Choose your database type and click Next.

6. Choose the product edition and click Next.

l Standard Edition — Install a new instance of Pega 7.2.1.

l Multitenancy Edition — Install Pega 7.2.1 in a specialized mode designed to supportsoftware-as-a-service (SaaS) run-time environments. For more information about multitenacy,see the Pega 7 Platform Multitenancy Administration Guide.

Note: Upgrading and updating from one edition to another is not supported. If you install oneedition and later decide to use a different edition, you must drop and re-create the database orcreate a new database. The schema DDLs for the two editions are not compatible.

7. Configure the database connection. The JDBC drivers allow the Pega 7 Platform application to


Installing the Pega 7 Platform

communicate with the database.

Note: Some of the fields on the Database Connection screen are pre-populated based on thetype of database you selected. If you edit these or any other fields on this screen, and then laterdecide to change the database type, the IUA might not populate the fields correctly. If this occurs,enter the correct field values as documented below, or exit and rerun the IUA to select theintended database type.

l JDBC Driver Class Name— Verify that the pre-populated value is accurate:

com.ibm.db2.jcc.DB2Driver

l JDBC Driver JAR Files— Click Select Jar to browse to the appropriate driver files for yourdatabase type and version. For a list of supported drivers, see the Pega 7 Platform SupportGuide.

l Database JDBC URL— Verify that the pre-populated value is accurate. For information aboutURLs, see Obtaining database connection information on page 57 Replace items in italics withthe values for your system:

jdbc:db2://server:50000/database:fullyMaterializeLobData=true;fullyMaterializeInputStreams=true;progressiveStreaming=2;progressiveLocators=2;useJDBC4ColumnNameAndLabelSemantics=2;

l Database Username and Password — Enter the user name and password that youcreated for the Deployment user on your database.

l Rules Schema Name — Enter the name of the rules schema in the database.

l Data Schema Name — Enter the name of the data schema in the database. For single-schema configurations the data schema name is identical to the rules schema name.

8. Click Test Connection. If the connection is not successful, review your connection information,correct any errors, and retest. When the connection is successful, click Next to choose how toapply the data schema.



Note: On IBM DB2 for Linux, UNIX, and Windows, and IBM DB2 for z/OS, Test Connectiondoes not verify that the schemas exist. Instead, the schemas are automatically generated whenthe first CREATE TABLE statement executes after the installation is complete.

9. Optional: Specify whether you will have your database administrator manually apply the DDLchanges to the schema. These changes include the user-defined functions (UDF) supplied byPegasystems. By default, the IUA generates and applies the schema changes to your database.

l To generate and apply the DDL outside the IUA, select Bypass Automatic DDL Applicationand continue the installation. After you complete the installation, manually generate and applythe DDL and UDF. For more information, see Optional: Generating and applying DDL andAppendix D — Installing user-defined functions on page 61.

l To have the Installation and Upgrade Assistant automatically apply the DDL changes and theUDF, clear Bypass Automatic DDL Application.

10. Click Next.

11. Enter the system name and production level and click Next:

l System Name — Enter a name for your Pega 7 Platform system. To find the system name,navigate to System > Settings > System Name.

l Production Level — Enter a production level. The production level affects many securityfeatures of your system. Both the system name and production level can be changed after thesystem is running. Depending on the type of installation, choose:

5 for a system that will be used in production

4 for a preproduction system

3 for a test system

2 for a development system

1 for an experimental system

The production level can be updated from the App Explorer. Enter Data-Admin-System in thesearch field and select SysAdmin > Class > Data-Admin-System to open your system.

12. Click Start to begin loading the rulebase.



Installation logs display in the log window and are also stored in the Pega-image\scripts\logsdirectory.

During the installation, the log window might appear inactive when the IUA is processing largerfiles.

13. Click Back to return to the previous screen, and then click Exit to close the IUA.

Editing the setupDatabase.properties fileSkip this section if your installation meets all of the following criteria:

l You will use the Installation and Upgrade Assistant to install.

l You will allow the installation to automatically apply the schema changes and do not need tocreate a DDL file.

l You will not enable Kerberos authentication.

If your installation does not meet all of these criteria, follow the steps in this section to edit thesetupDatabase.properties file to configure scripts to do any or all of the following tasks:

l Install the Pega 7 Platform. Use the install.bat or install.sh script.

l Enable Kerberos authentication. Use the install.bat or install.sh script.

l Generate a DDL file of schema changes. Use the generateddl.bat or generateddl.sh script.You can use the generateddl.bat or generateddl.sh script regardless of whether you use theIUA or the command-line script to install.

l Generate user-defined functions. Use the generateudf.bat or generateudf.sh script.

l Migrate schemas. Use themigrate.bat ormigrate.sh script.

To edit the setupDatabase.properties file:

1. Open the setupDatabase.properties file in the scripts directory of your distribution image:Pega-image\scripts\setupDatabase.properties

2. Specify the properties for your system. For each property, add the appropriate value after theequal sign. See Database connection properties.

3. Save and close the file.



Database connection properties

These properties specify the settings needed to connect to the database:

l The script arguments column lists the arguments for the command-line scripts.

l The Property column lists the corresponding property in the setupDatabase.properties file.

Scriptargument

Property Description

--dbType pega.database.type Database vendor type. Enter:

udb

--dbSchema rules.schema.name In a single schema environment, sets rules schema and data schema.

In a split-schema configuration, sets the rules schema only.

--dbDataSchema

data.schema.name For split-schema configurations only, sets the data schema name.

--mtSystem multitenant.system Specifies whether this a multitenant system.

--dbuser pega.jdbc.username User name of the Deployment user.

--dbpassword pega.jdbc.password Password of the Deployment user. For encrypted passwords, leavethis blank.

--dburl pega.jdbc.url The database JDBC URL. For more information, see Obtainingdatabase connection information on page 57

--driverJar pega.jdbc.driver.jar Path and file name of the JDBC driver

--driverClass pega.jdbc.driver.class Class of the JDBC driver

--tempdir user.temp.dir Optional: The location of the temp directory. Set this location to anyaccessible location, for example, C:\TEMP.

--connProperties

jdbc.custom.connection.properties Optional: Semicolon-delimited list of custom JDBC properties.

(for example: prop1=value;prop2=value;prop3=value)

Optional: Enabling Kerberos authenticationKerberos is a computer network authentication protocol that allows nodes communicating over anon-secure network to prove their identity to one another in a secure manner.

To enable Kerberos for authentication, you must use the command line to install the Pega 7 Platform:



1. Edit the setupDatabase.properties file.

a. Open the setupDatabase.properties file in the scripts directory of your distribution image:Pega-image\scripts\setupDatabase.properties

b. In the “Uncomment this property section” of the file, uncomment the custom property:

jdbc.custom.connection.properties

c. Provide the correct parameters as semicolon-delimited name/value pairs. The specificparameters depend on your security infrastructure, for example:

jdbc.custom.connection.properties=parameter1=value1;parameter2=value2;parameter3=value3;jdbc.custom.connection.properties=integratedSecurity=true;

d. Comment out all the user name and password properties so that they appear as follows:# pega.jdbc.username db username# pega.jdbc.password db password[lines removed here]# pega.jdbc.username=ADMIN# pega.jdbc.password=ADMIN

e. Save and close the file.

2. Configure your database to enable Kerberos functionality. This might include additional vendor-specific JDBC driver configuration, or other setup procedures. See the IBM DB2 for Linux, UNIX,and Windows documentation for details.

3. Continue at Installing from the command line.

Installing from the command lineBecause of the large volume of data, run the command-line script on the same network as thedatabase server. If this is not possible, run the script on a system with fast, direct access to thedatabase server. To use the install.bat or install.sh script, first configure thesetupDatabase.properties file.

Note: If no additional arguments are passed to the script, the script defaults to the values of theproperties set in the setupDatabase.properties file. See Editing thesetupDatabase.properties file.



1. If you have not done so already, edit the setupDatabase.properties file.


b. Configure the connection properties. For more information about parameter values, seeProperties file parameters.

# Connection Informationpega.jdbc.driver.jar=/path-to-the-database-JAR-file/DRIVER.jarpega.jdbc.driver.class=database driver classpega.database.type=database vendor typepega.jdbc.url=URL of the databasepega.jdbc.username=Deployment usernamepega.jdbc.password=passwordpega.rules.schema=rules-schema-namepega.data.schema=data-schema-name

c. Save and close the file.

2. Open a command prompt and navigate to the scripts directory.

3. Type install.bat or ./install.sh to run the script.

Installing the rulebase can take several hours, depending on the proximity of the database to thesystem running the installation script. When the installation is complete, you see a BUILDSUCCESSFUL message.

Note: The Pega 7 Platform writes command-line output to a file in the Pega-image\scripts\logsdirectory.



Setting up the application serverThis section describes how to configure your Oracle WebLogic Server application server:

l Ensure that your application server meets the prerequisites.

l Configure the application server.

l Deploy the Pega 7 Platform applications.

Preparing to configure the application serverComplete these steps before you configure the application server:

1. Set your JAVA_HOME environment variable to point to the Java JDK directory.JAVA_HOME=C:\Program Files\Java\jdk1.8.0_40\

2. Create an Oracle WebLogic Server domain. See the Oracle WebLogic Server documentation forinstructions.

3. Ensure that your operating system references a common time standard such as the one availableat www.time.gov.

l On UNIX, this is the Network Time Protocol daemon, ntpd.

l On Windows, you can set a similar service through the clock settings in the Windows ControlPanel or task bar.

See the documentation for your specific hardware operating system for information about settingthis critical service.

4. Ensure that the following ports are open and available:

l Search — One TCP port in the range 9300-9399 (the default is 9300). This port is used forinternal node-to-node communication only, and should not be externally accessible.

l Cluster communication — Leave open the port range 5701-5800. By default, the system beginswith port 5701, and then looks for the next port in the sequence (5702, followed by 5703 andso on). To override the default port range, set the value of cluster/hazelcast/ports in theprconfig.xml file.

Note: The number of available ports in this range must be greater than or equal to the greatestnumber of JVMs on any one node in the cluster. For example, if three JVMs are on one node, andseven JVMs on another node, at least seven ports must be available.

5. Obtain the following information from your database administrator to determine the databaseconnection URL:

l Connection method — Service or SID

l Host name

l Port number

l Service or SID name

6. Add a headless AWT setting to the Java options in the configuration file that is passed to Java toallow the Pega 7 Platform to render and display graphics:

a. Open the configuration file setDomainEnv.bat or setDomainEnv.sh that is passed to Javaat startup. The specific file name and location is site-specific.

b. Add or modify your JAVA_OPTIONS setting to include:

–Djava.awt.headless=true

For example:

set JAVA_OPTIONS=%JAVA_OPTIONS% –Djava.awt.headless=true


7. Optional: To support web SSO with encrypted assertions, add the following JAR files files to theendorsed directory of the application server:

l xercesImpl-2.10.0.jar— This file is included in thePega-image\scripts\lib directory.

l xml-apis-1.4.01.jar—This file is included in thePega-image\scripts\lib directory.

l xalan-2.7.1.jar—Obtain this file from the Apache Software Foundation Xalan project. Formore information about the Apache Software Foundation Xalan project, seehttps://xalan.apache.org/.


Setting up the application server

EAR file and WAR file considerations

The Pega 7 Platform application archive is available both as an EAR file and a WAR file. Using theEAR file enables you to add advanced J2EE features as your application grows or when you migrate toa production environment.

Before you continue, decide whether you will deploy the EAR file or the WAR file.

Data source resources, data source entries, and default schema entries

The application server configuration defines the required data source resources, data source entries,and default schema entries:

l Data source resources — Data source resources define the Pega 7 Platform database connectioninformation. The number of data source resources depends on whether you have a single-user ordual-user configuration:

All systems require one data source resource for the Base user.

Dual-user configurations also require a second data source resource for the Admin user.

l Data source entries — Data source entries specify which data source resource to use for databaseoperations in each schema. For dual-user environments, you must explicitly define two additionaldata source entries for the Admin user:

Admin data source entry for the rules schema

Admin data source entry for the data schema

l Default schema entries — Every system requires two entries that define the default schemanames:

Default rules schema, for example, PegaRULES.

Default data schema, for example, PegaDATA. For single-schema configurations, the defaultdata schema name is the same as the default rules schema name.

Configuring the application serverThese procedures describe a typical method for setting configuration properties in a basicinstallation.

These procedures describe a typical method for setting configuration properties in a basic OracleWebLogic Server installation by modifying the setDomainEnv file. More complex installationsmight use different start-up scripts. Review this section with your system administrator to determine



the appropriate script in which to enter these options so they are read when the Pega 7 Platformstarts.

JVM memory parameters

Set the JVM memory options in the setenv.bat or setenv.sh file to increase the amount of systemmemory allocated to the application server running the Pega 7 Platform.

Pegasystems recommends these settings:

l Initial Heap Size (Xms) — Between 4 GB - 8 GB, based on monitoring of memory usage andgarbage collection frequency

l Maximum Heap Size (Xmx) — Between 4 GB - 8 GB or larger, depending on your systemconfiguration. See Application server memory requirements for more information.

If your application server uses the recommended Oracle JVM, and you are using Java 7, also add thePermSize and MaxPermSize settings. (Java 8 does not require you to set PermSize or MaxPermSize.)

l PermSize (-XX:PermSize) — 512 MB

l MaxPermSize (-XX:MaxPermSize) — 1024 MB

If the server does not have enough memory allocated to run the Pega 7 Platform, the system canhang without an error message. The correct memory settings depend on your server hardware, thenumber of other applications, and the number of users on the server, and might be larger than theserecommendations.

For systems that do not require Transport Layer Security (TLS) to deploy the System ManagementApplication on a different server than the Pega 7 Platform application, modify the JAVA_OPTSenvironment variable to enable remote operation of the System Management Application. For moreinformation about setting JVM parameters, see the Oracle WebLogic Server documentation.

Fix HTTP authentication issue with Oracle WebLogic Server 9.2 and later

Oracle WebLogic Server 9.2 and later intercept requests with "Authentication" in the header and doesauthentication without forwarding requests to the application. This can cause authentication errorswith the Pega 7 Platform. To avoid this error, edit the WebLogic config.xml file to disable basicauthentication. For more information about the WebLogic config.xml file, see the WebLogicdocumentation.



1. Open the Oracle WebLogic Server config.xml file.

2. Add this line within the <security-configuration> element:

<enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials>


Edit the setDomainEnv script or batch file

Edit the files as follows:

1. Open the setDomainEnv file, setDomainEnv.cmd for Windows or setDomainEnv.sh for UNIXplatforms, in a text editor.

These scripts are located in the bin directory of your Oracle WebLogic Server domain.

<app-server-install-root>/user_projects/domains/domain-name/bin

Example:

C:\Oracle\Middleware\user_projects\domains\pega\bin

2. Find the setting for USER_MEM_ARGS:

@REM IF USER_MEM_ARGS the environment variable is set, use it tooverride ALL MEM_ARGS values

if NOT "%USER_MEM_ARGS%"=="" (set MEM_ARGS=%USER_MEM_ARGS%)

3. Before the override setting, add the line set USER_MEM_ARGS= to specify the memory settings.For more information, see Application server memory requirements. Use the following examplesas a guide, and substitute your values for those given:Note: This example is for Java 7. Java 8 does not require you to set PermSize or MaxPermSize.

set USER_MEM_ARGS=-Xms4096m –Xmx8192m -XX:PermSize=512m –XX:MaxPermSize=1024m

For example:

@REM IF USER_MEM_ARGS the environment variable is set, use it tooverride ALL MEM_ARGS valuesset USER_MEM_ARGS=-Xms4096m –Xmx8192m -XX:PermSize=512m -



XX:MaxPermSize=1024mif NOT "%USER_MEM_ARGS%"=="" (set MEM_ARGS=%USER_MEM_ARGS%)

4. Save the file.

Set an explicit temporary directory

In the setDomainEnv file, create a JVM property to set an explicit temporary directory for the Pega7 Platform. This directory stores static data during a session. It is important that it be properlyspecified and accessible to the Base user.

In the setDomainEnv.cmd file for Windows or the setDomainEnv.sh file for UNIX platforms,add the line set EXTRA_JAVA_PROPERTIES=-Dpega.tmpdir= and specify the full path to adirectory you have allocated, for example:

set EXTRA_JAVA_PROPERTIES=-Dpega.tmpdir=C:\PegaTemp\pr_temp

Adding the JDBC driver to the Oracle WebLogic Server classpath

To enable the Pega 7 Platform to connect to the relational database, the database driver must be inthe Oracle WebLogic Server classpath.

1. In the setDomainEnv.cmd (Windows) or the setDomainEnv.sh (UNIX) file, add the line setEXT_PRE_CLASSPATH= and specify the path to db2jcc.jar . Using EXT_PRE_CLASSPATH ensuresthat the system finds and uses this JDBC driver. See the Platform Support Guide for moreinformation about supported drivers.

For example, your setting will look similar to the following:

set EXT_PRE_CLASSPATH=C:\Oracle\Middleware\user_projects\domains\pega\lib\db2jcc.jar

This JDBC driver is the Type 4 universal driver: db2jcc4.jar.

2. Save and close the setDomainEnv file.



Configuring Oracle WebLogic Server to deploy the Pega 7 Platform archivefiles

The procedures below describe the steps you need to take in the Oracle WebLogic Serveradministration console to configure the server to deploy the Pega 7 Platform application archives.

For more information about installing and using the administration console, see the Oracle WebLogicServer documentation athttp://www.oracle.com/technetwork/middleware/weblogic/documentation/index.html.

Opening the Oracle WebLogic Server administration console

1. Start the administration server for the Pega 7 Platform domain.

You can start the administration server by running the appropriate startWebLogic script,startWebLogic.cmd (Windows) or startWebLogic.sh (UNIX,) in the bin directory of yourdomain directory, for example:

Oracle\Middleware\user_projects\domains\<domain>\bin

On Windows, you can also start the Administration server from a shortcut on the Start menu byselectingOracle WebLogic > User Projects > <domain> >Start Admin Server forWebLogic Domain.

2. Start the Administration Console and log in with the administrative user name and password thatyou specified in the Configuration Wizard.

You can start the Administration Console in a browser by opening the URLhttp://hostname:port/console where hostname is the name of the AdministrationServer and port is the listen port on which the Administration Server is listening for requests (port7001 by default).

The Administration Console opens.

Creating JDBC resources

Follow these steps to create a JDBC connection pool and data source in Oracle WebLogic Server toallow the Pega 7 Platform to connect to the Pega 7 Platform database.

Create a data source for the Base user. For dual-user configurations, repeat these steps to create adata source for the Admin user.



1. In the Oracle WebLogic Administration Console, under Domain Structure, select Services >Data Sources.

The Summary of JDBC Data Sources page opens.

Note: If configuration editing is not enabled, click Lock & Edit in the Change Center at thetop-left of the page.

2. On the Data Source page click New and select Generic Data Source.

The page Create a New JDBC Data Source opens.

3. Complete this page.

l In theName field, enter the name of the data source:

For the Base user, enter PegaRULES.

For the Admin user, enter AdminPegaRULES.

l In JNDI Name, enter the correct value:

For the PegaRules data source, enter jdbc/PegaRULES.

For the AdminPegaRules data source, enter jdbc/AdminPegaRULES.

l Select the Database Type DB2

l Select a Database Driver for your database. JDBC driver JAR file, db2jcc4.jar, driver class fileor files listed in the class path field. For more information about supported drivers, see thePega 7 Platform Support Guide.

Note: If you choose an XA driver to enable two-phase commit, you must install the prpc_j2ee14.ear file as the core Pega 7 Platform application archive.

If you are using XA drivers, also increase the maximum connections for the connection poolassociated with the JDBC data source for the Pega 7 Platform to more than 60. See yourapplication server documentation for instructions.

4. Click Next.

A Transactions Options page opens. The listed options depend on the type of driver youselected.



5. Unless instructed otherwise by your site database administrator, accept the defaults for thetransaction options and click Next.

The Connection Properties page opens.

6. Complete this page as follows:

l In the Database Name field enter the name of the Pega 7 Platform database.

l In theHost Name field, enter the name or IP address of the database server.

l In the Port field enter the port number to be used to connect to the database server.

l Complete theUser Name and Password fields with the credentials for the Base user youcreated for the database.

7. Click Next.

8. Confirm that the driver is correct.

com.ibm.db2.jcc.DB2Driver

9. Confirm that the connection URL is correct.

For more information, see Obtaining database connection information on page 57. Enter yourconnection similar to the following. Replace items in italics with the values for your system:

l jdbc:db2://server:port/database

10. Update the Properties text box to include the following connection properties.

Oracle WebLogic Server populates the user, databaseName and driverType properties. If they arenot present, add them to the text box.

user=<user>databaseName=<dbName>currentSchema=data-schema-namecurrentFunctionPath=SYSIBM,SYSFUN,,data-schema-namedriverType=4progressiveStreaming=2progressiveLocators=2useJDBC4ColumnNameAndLabelSemantics=2



fullyMaterializeInputStreams=truefullyMaterializeLobData=true

Make sure to replace the property values listed above as <> with the values for your environment.For example, if the schema name is PEGA, the relevant properties and property values would be:

currentSchema=PEGAcurrentFunctionPath=SYSIBM,SYSFUN,PEGA

Note: Be sure to enter the schema name in capital letters as in the example. SYSIBM and SYSFUNare system schemas provided by IBM and are required because the Pega 7 Platform makes use ofsome functions in these schemas.

11. Click Test Configuration. If the test is successful, click Finish.

If the test is not successful, review your settings and retest.

When you click Finish, you will be returned to Summary of JDBC Data Sources.

12. If Configuration editing is not enabled, click the Activate Changes button in the Change Center.

13. Click the name of the data source you just created in the Data Sources table.

14. On the Settings page for the data source, click the Connection Pool tab

15. If Configuration editing is not enabled, click the Lock & Edit button in the Change Center to editthe data source Configuration.

16. Verify that the Connection Pool properties are correct for the data source you created, and modifyas needed.

17. Select the Targets tab and select the AdminServer as the target for the data source.

18. Click Save.

19. If Configuration editing is not enabled, click Activate Changes.

20. Optional: Repeat these steps to create the data source for the Admin user.

Configuring JMS resources for EAR deployment

If you are deploying the WAR archive, prweb.war, you do not need to configure JMS resources. Skipthis section and continue at Deploying the Pega 7 Platform WAR file, prweb.war.



If you are deploying the EAR archive, prpc_j2ee14.ear, complete the following procedure to defineJMS resources.

Note:The Pega 7 Platform EJB components use JMS Services internally. If you are deploying the EARarchive, you must complete this procedure even if your Pega 7 Platform application does not usemessaging to integrate with external systems.

To configure the JMS resources:

1. Create a JMS Server targeted at your Oracle WebLogic Server.

2. Create a JMS Module.

3. In the JMS Module create:

l a Connection Factory and subdeployment, targeted to the JMS Server

l a Topic and subdeployment, targeted to the JMS Server.

Creating a JMS server

1. On the Administration Console, under Domain Structure, click Services > Messaging > JMSServers.

2. If Configuration editing is not enabled, click Lock & Edit in the Change Center. Click New tocreate a new server.

3. In theName field, enter a name to identify the Pega 7 Platform 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 thePega 7 Platform, and click Finish.

You will return to the Summary of JMS Servers page.

5. Confirm that you see the message, JMS Server created successfully. If Configuration editing isnot enabled, click Activate Changes in the Change Center.

6. Click Home to return to the Domain home page.



Creating a JMS module

1. On the Administration Console, under Domain Configurations, select Services > Messaging> JMS Modules.

This will become the container for the connection factory and topic.

2. If Configuration editing is not enabled, click Lock & Edit in the Change Center. Click New in theJMS 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 check box for Admin Server, or the server to which you will deploythe Pega 7 Platform and click Next.

5. CheckWould you like to add resources to this JMS system module? and click Finish.

The Settings page for your JMS Module opens:

6. Confirm that you see the message The JMS module was created successfully. IfConfiguration editing is not enabled, click Activate Changes in the Change Center.

Creating a Connection Factory and Subdeployment

1. Still on the Settings page for your JMS Module, click Lock & Edit in the Change Center ifConfiguration editing is not enabled. Click New in the Summary of Resources table to displaythe page.

2. Select Connection Factory, and click Next.

3. Enter a Name for the Connection Factory such as PRAsyncConnectionFactory and enter exactly theJNDI Name jms/PRAsyncTCF. Click Next.

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 return to the Properties page for the Connection Factory.

7. Under Targets, select the check box for the JMS Server you created for the Pega 7 Platform and



click Finish.

You return to the Settings page for your JMS Module.

8. Confirm that you see the message Connection Factory created successfully. If Configurationediting is not enabled, click Activate Changes in the Change Center.

Creating a Topic and Subdeployment

Repeat the procedure you just completed for the Connection Factory to create a JMS Topic andSubdeployment in this JMS Module.

1. On the Settings page for your JMS Module, click Lock & Edit in the Change Center if needed, andNew in the Summary of Resources table to display the page Create a New JMS SystemModule Resource again.

2. From the list of resource types, click Topic, and thenNext to display the page Create a NewJMS System Module Resource.

3. Enter a name for the Topic, such as PRAsyncTopic, and enter exactly the JNDI namejms/PRAsyncTopic. Click Next

4. Select Create a New Subdeployment.

5. On the page Create a New Subdeployment, enter a new name for the subdeployment, suchas PRJMS_Subdeployment_Topic, and click OK.

Note: Be sure to use a different name than the one you used for the Connection FactorySubdeployment. The Connection Factory and the Topic should each have their ownsubdeployment.

6. If the system displays a Targets section, select the check box for the JMS Server you created andclick Finish.

You return to the Settings page for your JMS Module.

7. Confirm that you see the message The JMS Topic was created successfully. If Configurationediting is not enabled, click Activate Changes in the Change Center.

Deploying the Pega 7 Platform application archivesAfter you configure your application server, deploy the application archive files. This includes:



Pega 7 Platformapplication

File name

Pega 7 Platform prweb.war or prpc_j2ee14.ear

SystemManagement prsysmgmt.war

Help prhelp.war

Note: When you restart the server after the applications are deployed, the first node you bring upbecomes the default search node.

The Pega 7 Platform is available both as an EAR file, prpc_j2ee14.ear and a WAR file, prweb.war.Pegasystems recommends deploying the EAR file for all new deployments. You can successfullydeploy the Pega 7 Platform application WAR file on the application server but if you use the EAR file,you can add advanced J2EE features as your application grows or when you migrate to a productionenvironment.

Caution: Do not install both the EAR and WAR files.

Oracle WebLogic Server requires a Deployment Plan for split-schema configurations.

Configuring split-schema configurations

For split-schema configurations, Oracle WebLogic Server uses a Deployment Plan to configure theJNDI setting in the application archive. A Deployment Plan is a user-configurable XML file thatcaptures environment-specific configuration properties. If you plan to use a split-schemaconfiguration, follow these steps.

1. Create or edit a Deployment Plan.

2. Configure a specific directory structure for the Deployment Plan and the EAR/WAR archive.

3. Deploy (or redeploy) the application archive and Deployment Plan using the Oracle WebLogicServer administration console or the command line.

Editing the Deployment Plan

The Pega 7 Platform includes a sample deployment plan that you can use for your environment. Thedeployment plan is located in the following directory:

EAR: Pega-image\archives\prpc\weblogic\ear\plan\Plan.xml

WAR: Pega-image\archives\prpc\weblogic\war\plan\Plan.xml



1. Make a backup of the sample plan, in case you need to back out your changes.

2. Open Plan.xml in a text editor, and locate the elements named defaultDataSchema anddefaultRulesSchema. Add the values for your schema in the <value> element, for example:

<variable><name>defaultDataSchema</name><value>DATA</value>

</variable><variable>

<name>defaultRulesSchema</name><value>RULES</value>

</variable>

3. Save Plan.xml.

Configuring the Directory Structure

If you plan to deploy the Oracle WebLogic Server archive and Deployment Plan using the OracleWebLogic Server administration console, you must use a specific directory structure.

The Pega 7 Platform includes a preconfigured structure. You do not have to re-create the requireddirectories. However, if you maintain your Oracle WebLogic Server EAR files (or WAR files) in aseparate location, you must replicate the proper directory structure.

For example: the directory structure for EAR file deployments is:

your_directory\app\prpc_wls_jee4.earyour_directory\plan\Plan.xml

Note: The names of your_directory and the EAR file can change, but the deployment plan must benamed exactly Plan.xml and must be located in the your_directory \plan\ directory.

Deploying the archive

To deploy the Oracle WebLogic Server archive with a Deployment Plan using the administrationconsole, log in to the console and deploy the archive as described above.

However, instead of selecting the EAR or WAR file, select your_directory. For example, select either:

l EAR: Pega-image\\archives\prpc\weblogic\ear

l WAR: Pega-image\archives\prpc\weblogic\war

Oracle WebLogic Server includes both the EAR (or WAR) file and the deployment plan, Plan.xml,when you select the directory. You can also deploy the archive and deployment plan using the



command line tool, weblogic.Deployer. For more information, see the Oracle WebLogic Serverdocumentation.

Deploying single-schema configurations

These instructions assume that the Pega 7 Platform is installed on the default schema of the databaseuser. If this is not the case, follow the instructions for Configuring split-schema configurations andspecify the same schema name for both the defaultDataSchema and defaultRulesSchema.

Deploying the Pega 7 PlatformWAR file

Note: Skip this procedure if you are planning to deploy the Pega 7 Platform EAR file.

1. In the Domain Structure section, click Deployments.

2. If Configuration editing is not enabled, click Lock & Edit to unlock the page. In the Deploymentstable, click Install.

3. In the Install Application Assistant, click the link upload your file(s).

4. Click the Browse button next to the Deployment Archive field and navigate toPega-image\archives\prpc\weblogic\war\app\.

5. Select the prweb.war file and click Open. When the file name is displayed in the DeploymentArchive field, click Next.

6. Make sure the radio button next to prweb.war is selected and click Next.

7. Select Install this deployment as an application and click Next to display the optionalsettings page.

8. Make sure theName is prweb and click Next to accept the defaults.

9. Select Yes, take me to the deployment's configuration screen and review the othersettings. Then, click Finish to begin deploying the application.

When the WAR file has deployed, you are returned to the application Settings page.

10. Review theOverview page to confirm that the settings are as expected.

11. Click on the Targets tab and verify that the target server is correct.

12. Click Save in the Assistant or Activate Changes in the Change Center to save the configuration.



13. In the Domain Structure panel, click Deployments again deploy prsysmgmt.war andprhelp.war.

Deploying the Pega 7 Platform EAR file

Note: Skip this procedure if you have deployed the Pega 7 Platform WAR file.

1. In the Domain Structure panel, click Deployments.

2. If Configuration editing is not enabled, click Lock & Edit to unlock the page. Click Install.

3. Click the link upload your file(s).

4. Next to the Deployment Archive field, click the Browse button and use the file dialog tonavigate to the archives directory of the Pega 7 Platform distribution image. Select the prpc_j2ee14.ear. When the file name is displayed in the Deployment Archive field, click Next.

5. On the Install Application Assistant, confirm the upload path and that the radio button nextto the archive name is selected and click Next.

6. Select Install this deployment as an application and click Next to display the optionalsettings page:

7. Click Next to accept the defaults.

8. Select Yes, take me to the deployment's configuration screen and review the othersettings. Then, click Finish to begin deploying the application.

When the archive deploys, you return to the application’s Settings page.

9. Review theOverview page to confirm that the settings are correct.

10. Click on the Targets tab to verify that the target server for the application is correct.

11. Click on theOverview tab again, and click Save.

12. In Domain Structure, click on Deployments to return to the Summary of Deployments page.

13. Continue with the deployments of the prsysmgmt.war and prhelp.war applications.

Deploying the prsysmgmt.war and prhelp.war applications

Repeat the procedure described for prweb above to deploy the two other Pega 7 Platformapplications, prsysmgmt.war and prhelp.war.



Note: Do not start these applications after deployment.

For more details on the System Management Application, refer to the System ManagementApplication Reference Guide available on the Pega Developer Network (pdn.pega.com).

Assigning the PegaDiagnosticUser role to your System ManagementApplication users

You can use the System Management Application to monitor and control caches, agents, requestors,listeners, and other processing. For more information, see the System Management ApplicationReference Guide on the PDN.

Users accessing the System Management Application must be assigned the role PegaDiagnosticUser.If the user does not have this role they will be challenged for authentication when they attempt toaccess the System Management Application.

The default deployment configuration assigns the PegaDiagnosticUser role to administrative users.To restrict access to the System Management Application, use your application server tools to assignthe PegaDiagnosticUser role to any other users that must be able to access the System ManagementApplication.

The role PegaDiagnosticUser is associated with the System Management Application through asecurity-constraint element on the Diagnostic Data servlet defined in the prweb.war application’sweb.xml file. In EAR file deployments, the web.xml file is located in the prweb.war file packagedinside the prpc_*.ear file:

<security-constraint><web-resource-collection>

<web-resource-name>Diagnostic Data</web-resource-name> <description>Serves diagnostic files generated by the JMX

client </description><url-pattern>/DiagnosticData</url-pattern><http-method>GET</http-method><http-method>POST</http-method>

</web-resource-collection><auth-constraint>

<role-name>PegaDiagnosticUser</role-name></auth-constraint>

</security-constraint>

If you do not want to restrict access to the System Management Application, edit the web.xml file anddelete the <security constraint> element.

Changing this setting in the web.xml file might require redeploying the PegaRULES Application.



Post-deployment configurationThis section describes the post-deployment activities that are performed in the system after you havecompleted the setup and configuration of your Oracle WebLogic Server application server anddeployed the archives.

l Starting applications

l Logging in to the Pega 7 Platform

l Changing the administrator password

l Enabling help and System Administration applications

l Configuring Directed Web Access

l Configuring a load balancer to log XFF headers

l Configuring search index host node settings

l Installing Industry applications

Starting the Pega 7 Platform applicationsEnsure that the application server is running and start the prsysmgmt, prweb, and prhelpapplications.

Logging in to the Pega 7 PlatformTo test the installation and index the rules, log in to the Pega 7 Platform web application.

1. Navigate to the PRServelet URL, replacing the server and port values with your specific values.

http://server:port/prweb/PRServlet

2. Use the following credentials to log in:

l User ID — [email protected]

l Password — install

After logging in, the Pega 7 Platform indexes the rules in the system to support full-text search.During the index process, there might be a delay in the responsiveness of the Pega 7 Platform userinterface. The process usually takes from 10 to 15 minutes to complete depending on your systemconfiguration.

If the index process ends without generating an error message, the installation is successful.

Changing the administrator passwordBecause the default password for the system administrator is widely published, it is important toprotect your system after an installation by changing the password for the [email protected] ID.

To change the password:

1. From theOperator Menu located to the right of the Designer Studio header, select the Profileoption.

2. Click Change Password.

3. Verify the Current Password, and then enter and confirm theNew Password.

4. Click Save.

Enabling online help and the System ManagementApplicationThe online help and the System Management Application are accessed through a URL and can bedeployed to any application server.

To enable these applications:

1. Click Designer Studio > System > Settings > URLs.

2. In theOnline Help URL field, enter the URL for the Help application in the format:

http://host:port/prhelp

3. In the SMA URL field, enter the URL for the System Management Application in the format:

http://host:port/prsysmgmt

4. Click Save.

Note: You must log out of the Pega 7 Platform and log back in for these changes to take effect.


Post-deployment configuration

Configuring Directed Web AccessA Directed Web Access (DWA) address allows you to grant one-time access to external users to enablethem to process an assignment in your application. When you grant the access, the Pega 7 Platformsends an email to the external user; this email includes a URL to access the application and canidentify a proxy server.

To configure the URL:

1. Click Designer Studio > System > Settings > URLs.

2. In the Public Link URL field, enter the URL that you want to provide in emails in this format:

http://host:port/prweb

3. Click Save.

4. Log out and log back in to Designer Studio for these changes to take effect.

Optional: Configuring the Pega 7 Platform to returnabsolute URLsIn some scenarios, you might want the Pega 7 Platform to return an absolute URL instead of arelative URL. Pega 7 Platform uses XF* headers to dynamically formulate absolute URLs withoutstatic configuration, when deployed behind a load balancer or reverse proxy.

Follow these steps to log the address of the Pega 7 Platform instance in XF* HTTP headers:

1. Enable XF* logging on your load balancer. See your load balancer documentation for informationabout how to enable logging.

2. Ensure that the web application context path of the load balancer and the Pega 7 Platform is thesame.

3. Open the configuration console or file of your load balancer or reverse proxy:

4. Update the configuration file with the following XML code:

The following configuration settings are for reference only. The settings specified in yourconfiguration file take precedence over the settings specified here.



when HTTP_REQUEST_SEND{

clientside{

HTTP::header insert X-Forwarded-Host [HTTP::host]HTTP::header insert X-Forwarded-Proto http

}}

5. Update the configuration file with the following XML code:

The following configuration settings are for reference only. The settings specified in theprconfig.xml file take precedence over the settings specified here.

l For Apache:

<VirtualHost *:80>ServerName your_server_nameProxyRequests off<Proxy *>

Order deny,allowAllow from all

</Proxy><Location "/prweb">

ProxyPass http://your_server_name:port /prweb/</Location>RequestHeader set X-Forwarded-Proto "http"

</VirtualHost>

l For F5 BIG-IP:

when HTTP_REQUEST_SEND{clientside

{HTTP::header insert X-Forwarded-Host [HTTP::host]HTTP::header insert X-Forwarded-Proto http

}}

6. Optional: If your load balancer or reverse proxy does not include the port number in the serverURL, insert a port number (X-Forwarded-Port) in the HTTP header.



Configuring search index host node settingsThe Pega 7 Platform supports full-text search for rules, data instances, and work objects. By default,search indexing is enabled and indexing starts when you start the application server after installingthe Pega 7 Platform. The first node that starts after installation becomes the default initial searchnode. The default index directory is PegaSearchIndex in your temporary directory.

After the search indexes are completely built, you can change the default settings. Do not stop orbring down the default node until the search indexes build completely. The Search Landing Pagedisplays the status.

Follow these steps to configure the search index host node settings:

1. Check your directory sizes. Ensure that the directories for all Elasticsearch host nodes havesufficient free space to hold the Elasticsearch indexes.

2. Open the Designer Studio > System > Settings> Search landing page and expand SearchIndex Host Node Setting.

3. Specify one node to set as the Host Node. If necessary, delete all but one node. This is the node onwhich Elasticsearch indexes will be built.

Note: Do not include more than one node in the Search Index Host Node Setting list.Including more than one node in the list at this point might cause duplicate index builds andcompromise system performance. You will create additional nodes later in this process.

4. Verify the Search Index Host Node ID and the Search Index File Directory.

5. Expand Automated Search Alerts, and enable Automatically Monitor Files.

6. Click Submit to save the settings.

7. After the first indexing is complete, add any needed additional host nodes. The system replicatesthe indexes on the new nodes.

Note: You must configure a minimum of two Elasticsearch host nodes. Pegasystemsrecommends that you configure a minimum of three nodes for maximum fault tolerance. Youmight need more than three nodes depending on the size of your cluster.

8. To enable communication between Elasticsearch host nodes in the cluster, open a TCP port in therange 9300-9399 on each node. (By default, Elasticsearch uses port 9300.) These ports are usedfor internal node-to-node communication only, and should not be externally accessible.



Resizing the Pega 7 Platform log filesThe initial log file size is 50 MB. After the installation is complete, increase the size of the log files. Thespecific size will depend on your environment and the size of your application. Contact PegasystemsGlobal Customer Support for more information about log file sizes.

Resizing the databaseMonitor the database use carefully. As development begins, the size of the database will need toincrease significantly, depending on your use of the Pega 7 Platform and the number of users.

Installing Industry applicationsInstall any Industry applications now. Follow the instructions in the Installation Guide for yourIndustry applications.

Caution: If you plan to install Industry applications on top of the Pega 7 Platform, grant thedatabase user permissions as described in Database users. Some Industry applications usetriggers. During startup, the Pega 7 Platform checks for triggers that reference the updates cache andrule view tables; if these triggers exist, the Pega 7 Platform attempts to drop them. If the user doesnot have the correct permissions, the Pega 7 Platform cannot drop the triggers and fails to start up.

If you installed the Industry applications before you deployed the Pega 7 Platform, the Pega 7Platform automatically drops the triggers and this error does not occur.

Enabling server-side screen captures for applicationdocumentsRegardless of which application server platform you use, you must set up a Tomcat server to supporttaking and storing screen captures on a server rather than on a client. By taking and storing screencaptures on a server, you avoid client-side limitations, such as browser incompatibilities or clientsoftware requirements.

Tip: As a best practice, virtually install Tomcat and deploy the prScreenShot.war file on the sameserver that is running the Pega 7 Platform. Otherwise, use a standalone Linux or Windows server. Ifyou use a Linux server, you must include the following components:

l fontconfig

l freetype



l libfreetype.so.6

l libfontconfig.so.1

l libstdc++.so.6

You can include screen captures in an application document that is generated by the DocumentApplication tool. Screen captures provide stakeholders with a realistic picture of an application's userinterface. Install a PhantomJS REST server to include screen captures in an application document.

1. Download the following WAR file: Pega_DistributionImage\Additional_Products\PhantomJS\prScreenShot.war

2. Deploy the WAR file on a Tomcat server.

3. Update the tomcat-users.xml file to add the following role and user. This file is located at\apache-tomcat-XX\conf\ tomcat-users.xml.

l Set the role:

<role rolename="pegascreencapture" />.

l Set the user:

<user username="restUser" password="rules"roles="pegascreencapture" />.

4. Start the Tomcat server. The service is hosted athttp://IPaddress:port/prScreenShot/rest/capture, where IPaddress is theaddress of the system where Tomcat is hosted, and port is the port on which the service isdeployed.

5. Log in to your Pega 7 Platform application and make the following updates:a. Update the Data-Admin-System-Setting instance Pega-AppDefinition -

CaptureScreenshotsResourcePath with the URL of the service, for example,http://10.224.232.91:8080/prScreenShot/rest/capture.

b. Update the Data-Admin-Security-Authentication profile instanceCaptureScreenshotsAuthProfile with the user that you created in step 3.



Configuring PhantomJS REST server security for including screen captures inan application document

To ensure a secure installation of the Pega 7 Platform, you must enable the PhantomJS REST server totake and store server-side screen captures. In application documents generated by the DocumentApplication tool, screen captures provide stakeholders with a realistic picture of the application's userinterface.

1. Obtain the SSL certificate from the Pega 7 Platform administrator.

2. Add the SSL certificate to the list of trusted certificates:a. Double-click the certificate.

b. Click Install certificate to start the Certificate Import wizard.

c. Click Next, and select Place all certificates in the following store.

d. Click Browse, select Trusted Root certificate, and click OK.

e. Click Next, and then click Finish to complete the wizard.

3. Add the certificate to the truststore of the JVM on which the REST server is installed:a. Open a command prompt.

b. Change the root directory to the security folder in the Java installation folder, for example,C:\Program Files (x86)\Java\jre7\lib\security.

c. Run the following command:

keytool -keystore cacerts -importcert -alias certificate alias -file certificate name

d. When prompted, enter the password for the cacerts keystore. The default password ischangeit.



Appendix A — Properties filesThe Pega 7 Platform properties files include several database-specific properties:

IBM DB2 for Linux, UNIX and Windows

l JDBC driver JAR file — db2jcc4.jar

l Database driver class — com.ibm.db2.jcc.DB2Driver

l Database vendor type — udb

l JDBC URL — url="jdbc:db2://host:port/dbname

Appendix B — Troubleshooting installationsUse the information in this section to troubleshoot installation errors. Installation error logs aredisplayed in the Installation and Upgrade Assistant window and are also stored in the Pega-image\scripts\logs directory.

Recovering from a failed installationIf the installation fails, follow these steps to drop the schemas and start a new installation:

1. Review the log files in the \scripts\logs directory.

2. Make any necessary changes to your system. If the error was due to a data entry mistake, makenote of the correct information.

3. Generate the DDL files and drop the schemas:

a. Verify the settings in the setupDatabase.properties file. For information about theproperties, see Editing the setupDatabase.properties file on page 25.

b. At a command prompt, navigate to the Pega-image\scripts directory.

c. Run the generateddl.bat or generateddl.sh script with the --action=drops option, forexample:

generateddl.bat --action=drops

d. Review the DDL files in the Pega-image\schema\generated\ output directory.

e. Have your database administrator apply the DDL to drop the schemas.

4. Repeat the installation steps.

PEGA0055 alert — clocks not synchronized between nodesThe Pega 7 Platform validates time synchronization to ensure proper operations and displays aPEGA0055 alert if clocks are not synchronized between nodes.

For information about how to reference a common time standard, see the documentation for youroperating system.


Appendix B — Troubleshooting installations

ClassNotFoundException error — session persistenceDuring application server shutdown, Tomcat persists session information into the session.ser file inthe server file directory. When the application server restarts, it reloads the session information fromthe session.ser file and deletes the file. If serialized session objects refer to classes that are notvisible to the container layer, you see a ClassNotFoundException error, such as the following:

May 19, 2016 2:37:46 PM org.apache.catalina.session.StandardManagerdoLoad SEVERE: ClassNotFoundException while loading persistedsessions:java.lang.ClassNotFoundExceptioncom.pega.pegarules.session.internal.authorization.ContextMapDiagCallbackjava.lang.ClassNotFoundException:com.pega.pegarules.session.internal.authorization.ContextMapDiagCallback

To suppress these errors, turn off Tomcat session persistence in the context.xml file.

System hangs with no error message — insufficientmemoryIf the server does not have enough memory allocated to run the Pega 7 Platform, the system canhang without an error message. The correct memory settings depend on your server hardware, thenumber of other applications, and the number of users on the server, and might be larger than therecommendations in System requirements on page 11.

For more information about setting memory parameters, see JVM memory parameters on page 32.

Obtaining database connection informationWhen you configure the data source resources, you need the correct database connection URL. Todetermine the database connection URL, obtain the following information from your databaseadministrator:

l Connection method — Service or SID

l Host name

l Port number

l Service or SID name



When you configure the application server, enter the connection string, pega.jdbc.url. Replace itemsin italics with the values for your system:

jdbc:db2://host:port/database

l jdbc:db2://server:port/database



Appendix C — Optional: Generating andapplying DDLSkip this section if you will have the Installation and Upgrade Assistant automatically apply the DDL

Generating the DDL fileFollow these steps to generate a DDL file:




# Connection Informationpega.jdbc.driver.jar=\path-to-the-database-JAR-file\DRIVER.jarpega.jdbc.driver.class=database driver classpega.database.type=database vendor typepega.jdbc.url=URL of the databasepega.jdbc.username=Deployment usernamepega.jdbc.password=passwordpega.rules.schema=rules-schema-namepega.data.schema=data-schema-name


2. At a command prompt, navigate to the Pega-image\scripts directory.

3. Type generateddl.bat or generateddl.sh and pass in the required --action installargument:

#generateddl.bat --action install

If you do not specify an output directory, the script writes the output to the default directory:

Pega-image\schema\generated\

Note: The output directory is deleted and re-created each time the generateddl script runs. To savea copy of the DDL, rename the directory before you run the script.


Appendix C — Optional: Generating and applying DDL

Applying the DDL fileBefore you continue, have your database administrator follow these general steps to apply theschema changes; these schema changes can include changes to user-defined functions:

1. Review the DDL file in the output directory and make any necessary changes. The default directoryis:

Pega-image\schema\generated\database\udb

2. Apply the DDL file.

a. Register the Java .jar file with the database.

b. Apply the CREATE FUNCTION DDL.

Note: The output directory is deleted and re-created each time the generateddl script runs. To savea copy of the DDL, rename the directory before you rerun the script.

Editing the setupDatabase.properties file to bypass DDLgenerationAfter your database administrator applies the changes to your database, configure thesetupDatabase.properties file to bypass applying a schema that already exists. Reapplying anexisting schema would cause the installation to fail.

To edit the setupDatabase.properties file:

1. Open the setupDatabase.properties file in the scripts directory of your distribution image:Pega-image\scripts\setupDatabase.properties

2. Set the property bypass.pega.schema=true.



Appendix C — Optional: Generating and applying DDL

Appendix D — Installing user-defined functionsThe user-defined functions (UDFs) enable the Pega 7 Platform to read data directly from the BLOBwithout creating and exposing columns. Skip this section if you installed the UDFs as part of theinstallation.

There are several ways you might have bypassed generating and installing the UDFs during theinstallation:

l Setting either bypass.pega.schema=true or bypass.udf.generation=true in thesetupDatabase.properties file

l Setting pega.target.bypass.udf=true in themigrateSystem.properties file

l Selecting Bypass Automatic DDL Application from the Installation and Upgrade Assistantduring the installation

Before you install the UDFs, verify that you have the appropriate user permissions. For moreinformation about user permissions, see Database users on page 14.




# Connection Informationpega.jdbc.driver.jar=\path-to-the-database-JAR-file\DRIVER.jarpega.jdbc.driver.class=database driver classpega.database.type=database vendor typepega.jdbc.url=URL of the databasepega.jdbc.username=Deployment user namepega.jdbc.password=passwordpega.rules.schema=rules-schema-namepega.data.schema=data-schema-name


2. On the rules schema, navigate to the Pega-image\scripts directory and run the followingcommands to remove any partially installed UDFs:


Appendix D — Installing user-defined functions

DROP FUNCTION rules-schema-name.pr_read_from_stream;DROP FUNCTION rules-schema-name.pr_read_decimal_from_stream;DROP FUNCTION rules-schema-name.pr_read_int_from_stream;

3. Optional: If you have a split-schema, on the data schema, navigate to the Pega-image\scriptsdirectory and run the following commands:

DROP FUNCTION data-schema-name.pr_read_from_stream;DROP FUNCTION data-schema-name.pr_read_decimal_from_stream;DROP FUNCTION data-schema-name.pr_read_int_from_stream;

4. From the Pega-image\scripts directory, run the generateudf.bat or generateudf.sh scriptwith the --action install argument, for example:

generateudf.bat --action install


Appendix D — Installing user-defined functions

7.2.1 ibmdb2forlinux,unix,andwindows oracleweblogicserver ·...

Documents