TIBCO ActiveMatrix® BPM Installation and Configuration

TIBCO ActiveMatrix® BPMInstallation and Configuration Software Release 4.3April 2019

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BPM, TIBCO Administrator, TIBCO BusinessStudio, TIBCO Enterprise Message Service, TIBCO General Interface, TIBCO Hawk, TIBCO iProcess,TIBCO JasperReports, TIBCO Spotfire, TIBCO Spotfire Server, and TIBCO Spotfire Consumer are eitherregistered trademarks or trademarks of TIBCO Software Inc. in the United States and/or othercountries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. Please see the readme.txt file forthe availability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

2

TIBCO ActiveMatrix® BPM Installation and Configuration

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

Copyright © 2005-2019 TIBCO Software Inc. All rights reserved.

3


https://www.tibco.com/patents

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

INTRODUCTION - READ THIS FIRST! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Using this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Installation Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Configuration Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

ActiveMatrix BPM System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

Distributed BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Basic BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Primary, Second Primary, and Remote Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Multiple BPM Systems in the Same ActiveMatrix Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Upgrading From an Earlier Version of ActiveMatrix BPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

Network Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

SYSTEM REQUIREMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Platform and Database Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

TIBCO Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Third-Party Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

User Account Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Additional System Requirements for a Distributed BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

INSTALLATION AND UPGRADE SCENARIOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Creating a Basic ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

A Basic ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Performing Required Pre-Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Installing ActiveMatrix BPM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Configuring JDBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Creating a BPM Node and Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Performing Required Post-Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Creating an ActiveMatrix Administrator Server (Single or Replicated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

An ActiveMatrix Administrator Server (Single or Replicated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39


Primary Machine: Installing ActiveMatrix BPM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Primary Machine: Configuring JDBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Primary Machine: Creating the Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Primary Machine: Sharing the ActiveMatrix Administrator Server Staging Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

4


Second Primary Machine: Installing ActiveMatrix BPM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Second Primary Machine: Configuring JDBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Second Primary Machine: Replicating the ActiveMatrix Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Creating a Distributed ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

A Distributed ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45


Remote Machine 1: Installing ActiveMatrix BPM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

Remote Machine 1: Creating a Host Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Primary Machine: Creating a BPM Node on Remote Machine 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Remote Machine 2: Installing ActiveMatrix BPM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

Remote Machine 2: Creating a Host Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50

Remote Machine 2: Creating a BPM Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51


Adding an Additional ActiveMatrix BPM System to an Existing ActiveMatrix Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Multiple BPM Systems in the Same ActiveMatrix Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53


Production Machine: Installing ActiveMatrix BPM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

Production Machine: Configuring JDBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

Production Machine: Creating a Host Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56

Production Machine: Creating a BPM Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56


Upgrading a Basic ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Performing Required Pre-Upgrade Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59


Upgrading the ActiveMatrix Administrator Server and ActiveMatrix BPM Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Performing Required Post-Upgrade Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Upgrading a Distributed ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Performing Required Pre-Upgrade Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61


Upgrading the ActiveMatrix Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62

Upgrading Runtime Hosts of Remote Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63

Upgrading the ActiveMatrix BPM Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64

Performing Required Post-Upgrade Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

INSTALLATION AND UPGRADE PROCEDURES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Preparing for Installation or Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Checking For Any Late-Breaking Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Checking the System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Configuring TIBCO Enterprise Message Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Creating the External ActiveMatrix Administrator Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

5


Creating the ActiveMatrix Administrator Database Using SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Creating the ActiveMatrix Administrator Database Using Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Creating the ActiveMatrix Administrator Database Using DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

Configuring the BPM Database Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Configuring the BPM Database Server Using SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Configuring the BPM Database Server Using Oracle 12c . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Configuring the BPM Database Server Using DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Creating a Database to Hold the BDS Case Data Store (DB2 Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Setting up a Content Management System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuring the External LDAP Directory Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuring System Parameters on UNIX or Linux Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuring Apache Ant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Downloading Required Third-Party Software Assemblies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

Downloading ActiveMatrix BPM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Backing Up the Existing ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Removing any Indexes Added to the BPM Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

Backing Up Openspace Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Backing up Customized Example Applications in Application Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76

Backing Up Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Installing ActiveMatrix BPM (TIBCO Universal Installer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

TIBCO Universal Installer: Installation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Deciding Whether to Use a New or Existing Installation Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

JRE Used by TIBCO Universal Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

Running TIBCO Universal Installer in GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Running TIBCO Universal Installer in Console mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79

Running TIBCO Universal Installer in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Configuring ActiveMatrix BPM Runtime Objects (TIBCO Configuration Tool) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

TIBCO Configuration Tool: Configuration Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

TIBCO Configuration Tool Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Running TIBCO Configuration Tool in GUI Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

Required External Libraries on an HP-UX (64-bit)/Itanium Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

TIBCO Configuration Tool Wizards Available on a Primary Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84

TIBCO Configuration Tool Wizards Available on a Remote Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

Running TIBCO Configuration Tool in Console Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

Running TIBCO Configuration Tool in Silent Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

The build.properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

A Simple Example: Adding a New Server Node to a Distributed System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Manually Creating the BPM and BDS Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Manually Running BPM Database Creation Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92

6


Manually Upgrading the BPM Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Method 1: Stopping the BPM Application Before Upgrading It . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94

Method 2: Performing the Upgrade in Two Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Manually Running BPM Database Upgrade Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96

Performing Post-Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Configuring the Business Data Services (BDS) Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Creating Any Other Required LDAP Connections to LDAP Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98

Configuring Client Communications Through the Load Balancer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Configuring the Work Presentation Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Configuring Launch Pages to Handle Context-Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99

Configuring Transaction Recovery (Oracle only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Setting Transaction Verification Property (SQL Server Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Copying Modified Process Engine-Related JVM Property Values to BPM Properties Files . . . . . . . . . . . . . . . . . . . . . . . . 102

Upgrading JDBC Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106

Reconfiguring JDBC Connection Resource Templates After Upgrade From a Pre-4.0 ActiveMatrix BPM System . . 106

Reorganizing Event Collector Tables (DB2 Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Verifying the Event Collector Rules Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Migrating Data Stored in Event Collector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

Updating the managedobjectlifecycle Target in the Event Collector Rules File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Modifying the Indexes Used on the 'ec_managed_obj_lifecycle' Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Editing TIBCO Hawk® Rulebase Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Minimizing Openspace Load Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Restoring any Openspace Customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Restoring Customized Example Applications in Application Development . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

Restoring Workspace Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114

Replacing the Existing ActiveMatrix BPM SSO Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Adding Jackrabbit Janitor Thread Configuration Parameters (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

Configuring Support for Internationalization (Windows Systems Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .116

IV - TIBCO CONFIGURATION TOOL WIZARD REFERENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Configure Third-Party Driver Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Third-Party Driver: Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Third-Party Driver: JAR Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Third-Party Driver: Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117

Create TIBCO ActiveMatrix BPM Server Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

ActiveMatrix BPM: Database Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

JDBC Connection String Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

ActiveMatrix BPM: Runtime Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121

ActiveMatrix BPM: BDS Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122

7


ActiveMatrix BPM: Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

ActiveMatrix BPM: Sizing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

ActiveMatrix BPM: LDAP Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128

ActiveMatrix BPM: CMIS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130

ActiveMatrix BPM: Authentication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

ActiveMatrix BPM: SiteMinder Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132

ActiveMatrix BPM: Kerberos Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

ActiveMatrix BPM: OpenID Connect Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134

ActiveMatrix BPM: SAML Web Profile Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

ActiveMatrix BPM: Administrator Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

ActiveMatrix BPM: JMS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

ActiveMatrix BPM: Host and Node Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Administrator Server Configuration: Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Create TIBCO ActiveMatrix Administrator Server Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Administrator Server Configuration: Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146

Administrator Server Configuration: TIBCO Host Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147

Administrator Server Configuration: Connection Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148

Administrator Server Configuration: Internal HTTP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Administrator Server Configuration: Notification and Messaging Bus Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Administrator Server Configuration: Enterprise Message Service Connection Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Administrator Server Configuration: Database Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152

Administrator Server Configuration: Authentication Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Administrator Server Configuration: Database Authentication Realm Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154

Administrator Server Configuration: LDAP Authentication Realm Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

Administrator Server Configuration: LDAP Authentication Realm Details (Screen 2) . . . . . . . . . . . . . . . . . . . . . . . . . .158

Administrator Server Configuration: LDAP Authentication Realm Details (Screen 3) . . . . . . . . . . . . . . . . . . . . . . . . . .159

Administrator Server Configuration: Credential Server Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160

Administrator Server Configuration: Credential Server Keystore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

Administrator Server Configuration: Logging Notification Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161

Administrator Server Configuration: Log Service Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Administrator Server Configuration: Payload Service Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164


Create TIBCO Host Instance Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

TIBCO Host Instance Configuration: Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

TIBCO Host Instance Configuration: Notification Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

TIBCO Host Instance Configuration: Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

TIBCO Host Instance Configuration: Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

8


Configure TIBCO ActiveMatrix BPM Server Node Type Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

ActiveMatrix BPM Node Type: Administrator Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172

ActiveMatrix BPM Node Type: Host and Node Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

ActiveMatrix BPM Node Type: Custom Keystore Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

ActiveMatrix BPM Node Type: Sizing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

ActiveMatrix BPM Node Type: Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

Replicate TIBCO ActiveMatrix Administrator Server Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Remote Administrator Server Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Create Replicated Instance Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178

Administrator Server Configuration Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Administrator Server TIBCO Host Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Administrator Server Connection Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Administrator Server Notification and Messaging Bus Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Administrator Server Database Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Administrator Server Database Authentication Realm Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Administrator Server Configuration LDAP Authentication Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181

Administrator Server Configuration Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181

Edit TIBCO ActiveMatrix BPM Instance Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

ActiveMatrix BPM Edit: Administrator Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

ActiveMatrix BPM Edit: Select Edit Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

ActiveMatrix BPM: Runtime Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185

JDBC Connection String Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186

ActiveMatrix BPM: BDS Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186

ActiveMatrix BPM: SOAP Version Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

ActiveMatrix BPM: CMIS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188

ActiveMatrix BPM: Authentication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

ActiveMatrix BPM: SiteMinder Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191

ActiveMatrix BPM: Kerberos Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

ActiveMatrix BPM: OpenID Connect Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193

ActiveMatrix BPM: SAML Web Profile Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

ActiveMatrix BPM: Package / unpack AMX Host for moving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

ActiveMatrix BPM Edit: Purge Process CLI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

ActiveMatrix BPM Edit: Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Upgrade TIBCO ActiveMatrix BPM Instance Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

ActiveMatrix BPM Upgrade: Administrator Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .200

9


ActiveMatrix BPM Upgrade: Upgrade Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202

ActiveMatrix BPM Upgrade: Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Delete TIBCO ActiveMatrix BPM Instance Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204

Using the Delete TIBCO ActiveMatrix BPM Instance Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

ActiveMatrix BPM Deletion: Administrator Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

ActiveMatrix BPM Deletion: Instance Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

ActiveMatrix BPM Deletion: Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Edit TIBCO ActiveMatrix Administrator Server Configuration Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Edit ActiveMatrix Administrator Server Configuration: Administrator Server Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Edit ActiveMatrix Administrator Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208

Administrator Server Configuration: Edit HTTP Connection Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208

Administrator Server Configuration: Edit Database Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209

Administrator Server Configuration: Edit Authentication Realm Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Administrator Server Configuration: Edit LDAP Authentication Realm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212


Upgrade or Downgrade TIBCO ActiveMatrix Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216

TIBCO ActiveMatrix Upgrade Manager: Upgrade or Downgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

TIBCO ActiveMatrix Upgrade Manager: Upgrade Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216

TIBCO ActiveMatrix Upgrade Manager: Upgrade Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

TIBCO ActiveMatrix Upgrade Manager: Validate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216

TIBCO ActiveMatrix Upgrade Manager: Upgrade Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217

TIBCO ActiveMatrix Upgrade Manager: Downgrade Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218

TIBCO ActiveMatrix Upgrade Manager: Downgrade Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

TIBCO ActiveMatrix Upgrade Manager: ActiveMatrix Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

TIBCO ActiveMatrix Upgrade Manager: Downgrade Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

IV - ADDITIONAL INFORMATION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Troubleshooting Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221

Installer Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Sanitizing After a Failed Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Uninstalling an ActiveMatrix BPM System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222

Disaster Recovery Using Data-Level Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Data-Level Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Configuring TIBCO ActiveMatrix BPM for Disaster Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225

Creating Host Aliases for TIBCO ActiveMatrix BPM System Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225

Creating Service Name Aliases for TIBCO ActiveMatrix BPM Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Storing EMS Queues in the Oracle Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Configuring TIBCO ActiveMatrix BPM to Use Hostname and Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

Enabling Halt on Error Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

10


Replicating TIBCO ActiveMatrix BPM File-Based Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Transaction Manager Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .230

Replicating TIBCO ActiveMatrix BPM Database-Based Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Recovering TIBCO ActiveMatrix BPM if the Primary Site Fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Before Starting TIBCO ActiveMatrix BPM on the Secondary Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

After Starting TIBCO ActiveMatrix BPM on the Secondary Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Disaster Recovery Using Device-Level Replication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Deleting a Replica ActiveMatrix Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233

Securing Communication Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234

Configuring TIBCO Enterprise Message Service Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .236

Using Third-Party Solutions to Configure a High Availability, Fault Tolerant ActiveMatrix BPM System . . . . . . . . . . . . . . . . . 239

11


Figures

Example ActiveMatrix BPM system using a basic configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Example configuration for a single ActiveMatrix Administrator server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Example configuration for a replicated ActiveMatrix Administrator server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Example configuration for a distributed ActiveMatrix BPM system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Example: Two separate BPM systems in a single ActiveMatrix Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Example configuration for data-level replication disaster recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Example configuration for device-level replication disaster recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

ActiveMatrix communication channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .234

High availability ActiveMatrix BPM system using third-party solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

12


TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

Product-Specific Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site. To directly access documentation for this product, double-click thefollowing file:

TIBCO_HOME/release_notes/TIB_amx-bpm_version_docinfo.html

where TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows,the default TIBCO_HOME is C:\tibco. On UNIX systems, the default TIBCO_HOME is /opt/tibco.

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO ActiveMatrix BPM SOA Concepts

● TIBCO ActiveMatrix BPM Concepts

● TIBCO ActiveMatrix BPM Developer's Guide

● TIBCO ActiveMatrix BPM Web Client Developer's Guide

● TIBCO ActiveMatrix BPM Tutorials

● TIBCO ActiveMatrix BPM Business Data Services Developer Guide

● TIBCO ActiveMatrix BPM Case Data User Guide

● TIBCO ActiveMatrix BPM Event Collector Schema Reference

● TIBCO ActiveMatrix BPM - Integration with Content Management Systems

● TIBCO ActiveMatrix BPM SOA Composite Development

● TIBCO ActiveMatrix BPM Java Component Development

● TIBCO ActiveMatrix BPM Mediation Component Development

● TIBCO ActiveMatrix BPM Mediation API Reference

● TIBCO ActiveMatrix BPM WebApp Component Development

● TIBCO ActiveMatrix BPM Administration

● TIBCO ActiveMatrix BPM Performance Tuning Guide

● TIBCO ActiveMatrix BPM SOA Administration

● TIBCO ActiveMatrix BPM SOA Administration Tutorials

● TIBCO ActiveMatrix BPM SOA Development Tutorials

● TIBCO ActiveMatrix BPM Client Application Management Guide

● TIBCO ActiveMatrix BPM Client Application Developer's Guide

● TIBCO Openspace User's Guide

● TIBCO Openspace Customization Guide

13


https://docs.tibco.com

https://docs.tibco.com

● TIBCO ActiveMatrix BPM Organization Browser User's Guide (Openspace)

● TIBCO ActiveMatrix BPM Organization Browser User's Guide (Workspace)

● TIBCO ActiveMatrix BPM Spotfire Visualizations

● TIBCO Workspace User's Guide

● TIBCO Workspace Configuration and Customization

● TIBCO Workspace Components Developer Guide

● TIBCO ActiveMatrix BPM Troubleshooting Guide

● TIBCO ActiveMatrix BPM Deployment

● TIBCO ActiveMatrix BPM Hawk Plug-in User's Guide

● TIBCO ActiveMatrix BPM Installation: Developer Server

● TIBCO ActiveMatrix BPM Installation and Configuration

● TIBCO ActiveMatrix BPM Log Viewer

● TIBCO ActiveMatrix BPM Single Sign-On

● Using TIBCO JasperReports for ActiveMatrix BPM

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

● For accessing the Support Knowledge Base and getting personalized content about products you areinterested in, visit the TIBCO Support portal at https://support.tibco.com.

● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, andtools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

14


http://www.tibco.com/services/support

https://support.tibco.com


https://ideas.tibco.com/

https://community.tibco.com

INTRODUCTION - READ THIS FIRST!

The following sections provide important information that you should be aware of before you try toinstall or upgrade TIBCO ActiveMatrix BPM.

Using this Guide

1. Read the INTRODUCTION. It contains important information that you should be aware of beforeyou try to install or upgrade TIBCO ActiveMatrix BPM.

2. Read SYSTEM REQUIREMENTS and make sure that you have everything in place.

3. Refer to I - INSTALLATION AND UPGRADE SCENARIOS and determine your installation/upgrade scenario.

4. Follow the high-level procedures for that scenario to install/upgrade your BPM system.

To help you find the right information at the right time, this guide is divided into the following parts:

Part Description

INTRODUCTION These sections provide important information that you should beaware of before you try to install or upgrade TIBCO ActiveMatrixBPM.

SYSTEM REQUIREMENTS These sections describe the basic system requirements that must bein place before you can install or upgrade to this version ofActiveMatrix BPM.

INSTALLATION ANDUPGRADE SCENARIOS

These sections describe the most common ActiveMatrix BPMinstallation/upgrade scenarios, and provide high-level proceduresfor how to implement them.

Find the scenario that matches your requirements and follow thehigh-level procedures. (Direct links to more detailed information inthe other parts of this guide are provided where appropriate.)

INSTALLATION ANDUPGRADE PROCEDURES

These sections provide detailed information about specificinstallation and upgrade procedures. Which of these you need touse will depend upon your particular installation/upgradescenario.

Use these sections as directed by the high-level procedures for yourinstallation/upgrade scenario.

TIBCO CONFIGURATIONTOOL WIZARD REFERENCE

These sections provide detailed reference information about theindividual TIBCO Configuration Tool wizards.

Use these sections as directed by the high-level procedures for yourinstallation/upgrade scenario.

ADDITIONALINFORMATION

These sections provide additional information that you may needwhen installing or upgrading ActiveMatrix BPM.

To install a Developer Server configuration of ActiveMatrix BPM to perform rapid development andtesting of a BPM application, see the TIBCO ActiveMatrix BPM Installation: Developer Server guideinstead of this guide.

15


Installation EnvironmentAn installation environment isolates product installations. A product installed into an installationenvironment does not access components in other installation environments.

An installation environment is the top-level installation directory for TIBCO products. It consists of thefollowing properties:

● Directory - Identifies the name of the directory where the product is installed. This directory isreferred to as TIBCO_HOME. The value depends on the operating system. For example, on Windows,the default value is:

C:\Program Files\tibco\amx-bpm

● Name - Identifies the installation environment. This name is referred to as ENV_NAME. On MicrosoftWindows, the name is appended to the name of the Windows services created by the installer and isa component of the path to the product shortcut in the Windows Start > All Programs menu.

TIBCO ActiveMatrix BPM installs into a directory within a TIBCO_HOME.

Configuration DirectoryThe directory that stores the ActiveMatrix BPM configuration information, such as property and logfiles, is referred to as CONFIG_HOME.

The value of CONFIG_HOME depends on the operating system. For example, on Windows systems, thedefault value is:

C:\ProgramData\amx-bpm\tibco\data

ActiveMatrix BPM System ArchitectureA BPM system comprises a single instance of the BPM application, including all nodes on which thatBPM application is distributed.

A BPM system can use either a distributed or basic architecture. Your choice of architecture impacts themethod you use to install or upgrade ActiveMatrix BPM.

See TIBCO ActiveMatrix BPM Concepts for more information about supported BPM systemarchitectures.

Distributed BPM SystemIn a production environment, it is good practice to use a distributed configuration for ActiveMatrixBPM (along with a suitable underlying architecture).

This configuration can provide the following advantages:

● Scalability: ActiveMatrix BPM software provides specialization and horizontal scalabilitycapabilities. You can:

— add BPM logical nodes (of type Client, Server or BPM) to boost the capacity of the BPM system.

— distribute BPM logical nodes to different TIBCO Host instances and physical machines asrequired.

See "TIBCO ActiveMatrix BPM Logical Nodes and Services" in BPM Concepts for moreinformation about the different types of BPM logical node and their uses.

● High availability and fault tolerance: ActiveMatrix BPM software provides active/active clusteringcapabilities. Adding a second BPM logical node (of type BPM) provides high availability and faulttolerance. In the event of a system-affecting failure on one node, load is automatically switched tothe remaining node.

16


It is good practice to use the active/active clustering capabilities of ActiveMatrix BPM toprovide high availability and fault tolerance is best practice. However, you can also usethird-party solutions - see Using Third-Party Solutions to Configure a High Availability,Fault Tolerant ActiveMatrix BPM System for more information.

It is good practice to host the ActiveMatrix Administrator server independently from ActiveMatrixBPM, using its own set of TIBCO Host instances. You should create the ActiveMatrix Administratorserver (if it does not already exist) before the distributed BPM system. See Creating an ActiveMatrixAdministrator Server (Single or Replicated) for more information about how to do this.

See Creating a Distributed ActiveMatrix BPM System for more information.

You need to create multiple BPM nodes to spread work across multiple groups. Make sure that eachBPM node is assigned to a different group so that they use different logical processors.

If you are running on Microsoft systems with a large number of logical cores (>64), running a singleBPM node on this type of system results in not all the CPUs being used by the BPM node. Windowssplits these cores into groups (each of which is treated as a single scheduling entity). Each groupcontains a subset of the cores available, up to a maximum of 64. Groups are numbered starting with 0.Systems with fewer than 64 logical processors always have a single group, Group 0.

Basic BPM SystemA basic configuration for ActiveMatrix BPM consists of a simple installation where ActiveMatrix BPMis installed on a single machine.

The basic configuration is intended for proof-of-concept, testing and validation or demonstrationpurposes. It is not intended for use in a production environment and TIBCO recommend that you donot use it in a production environment.

See Creating a Basic ActiveMatrix BPM System for more information.

You need to create multiple BPM nodes to spread work across multiple groups. Make sure that eachBPM node is assigned to a different group so that they use different logical processors.

If you are running on Microsoft systems with a large number of logical cores (>64), running a singleBPM node on this type of system results in not all the CPUs being used by the BPM node. Windowssplits these cores into groups (each of which is treated as a single scheduling entity). Each groupcontains a subset of the cores available, up to a maximum of 64. Groups are numbered starting with 0.Systems with fewer than 64 logical processors always have a single group, Group 0.

Primary, Second Primary, and Remote MachinesYou perform ActiveMatrix BPM installation and configuration tasks on either a primary machine,second primary machine, or remote machine.

These terms have the following specific meanings in the context of ActiveMatrix BPM:

● Primary means the machine that hosts the ActiveMatrix Administrator server, whether or not thatmachine also hosts any BPM nodes.

● Second primary means the machine that hosts a replicated ActiveMatrix Administrator server,whether or not that machine also hosts any BPM nodes.

● Remote means any other machine that hosts a BPM node (of any type, but not an ActiveMatrixAdministrator server.

17


A basic BPM system consists only of a primary machine. See Example ActiveMatrix BPM system usinga basic configuration.

A distributed BPM system contains:● a primary machine. See Example configuration for a single ActiveMatrix Administrator server.

● optionally, a second primary machine. See Example configuration for a replicated ActiveMatrixAdministrator server.

● one or more remote machines. See Example configuration for a distributed ActiveMatrix BPMsystem.

Multiple BPM Systems in the Same ActiveMatrix EnterpriseMultiple ActiveMatrix BPM systems can be installed in the same ActiveMatrix enterprise, dependingon the version of the ActiveMatrix Administrator server. In such cases, certain rules must be observed.

If the ActiveMatrix enterprise is managed by a version 3.3.0 (or later) ActiveMatrix Administratorserver, multiple version 2.2 (or later) BPM systems can be installed:

● in the same ActiveMatrix environment, or in separate ActiveMatrix environments.

● on the same physical machine or on different physical machines.

● using any combination of basic or distributed architectures - see ActiveMatrix BPM SystemArchitecture

● on the same TIBCO Host instance or on different TIBCO Host instances.

BPM systems that share a TIBCO Host instance cannot be independently lifecycled orupgraded at the host level. For example, if (on a Microsoft Windows system) the TIBCOHost instance is installed as a service, stopping that service would stop all BPM systemshosted by that service.

As a result, TIBCO recommend that each discrete BPM system should use its own set ofTIBCO Host instances. (If BPM systems do need to share a TIBCO Host instance, theymust be upgraded at the same time.)

When multiple BPM systems are installed in the same ActiveMatrix enterprise, the following rulesmust be observed:

● Each instance of the BPM application must have a unique name within an ActiveMatrixenvironment. This name identifies that BPM system within that ActiveMatrix environment. (Thecombination of the environment name and application name uniquely identifies that BPM systemwithin the ActiveMatrix enterprise.)

● An ActiveMatrix node can only host a single BPM system (or part of a distributed BPM system).

● Every BPM system in the ActiveMatrix enterprise must already be at version 2.2 (or later) before youadd another BPM system to that enterprise. You must upgrade any existing pre-version 2.2 BPMsystem in the enterprise to version 2.2 (or later) before adding an additional BPM system.

Upgrading From an Earlier Version of ActiveMatrix BPMYou can upgrade directly to version 4.3 of ActiveMatrix BPM from the following earlier versions:

● 3.1

● 4.0

● 4.1

● 4.2

18


If you wish to upgrade to version 4.3 from a pre-3.1 version of ActiveMatrix BPM, you must firstupgrade your system to one of the versions listed above. Refer to the ActiveMatrix BPM Installation andConfiguration guide for that version for more information.

Upgrade Overview

An ActiveMatrix BPM system can range in scale from a basic, single machine system to a distributed,multi-machine system involving many BPM nodes and a separate (single or replicated) ActiveMatrixAdministrator server.

The upgrade procedure differs according to the system topology. See:

● Upgrading a Basic ActiveMatrix BPM System● Upgrading a Distributed ActiveMatrix BPM System

If you are upgrading a distributed ActiveMatrix BPM system, configuration of the ActiveMatrixAdministrator internal HTTP port (default 19767) for load balancing is no longer necessary.

To perform the upgrade successfully:

● You must upgrade the ActiveMatrix Administrator server first, then the runtime hosts and nodes,then finally the BPM application.

● When you install ActiveMatrix BPM software on a machine, you must use the correct installationprofile.

You should perform each upgrade action that is required by the particular configuration of yourActiveMatrix enterprise. For example:

● If ActiveMatrix Administrator is not replicated there is no second primary machine to upgrade.● If you are upgrading two ActiveMatrix BPM systems in the same ActiveMatrix enterprise, you

would upgrade the first system as shown in the referenced procedures above. You would not thenneed to upgrade the ActiveMatrix Administrator server when upgrading the second system.

Upgrade Impact

No configuration is required prior to an upgrade and upgrade does not affect any of the configurationof your existing installation. For example, if an upgrade is performed:

● All existing process instances deployed on your existing installation will still be available.● Process instances and work items with a status of In Progress continue to be processed.● Configured LDAP containers, users and organization memberships will still be available.

Depending on the size of your system, upgrade can take some time. You should allow sufficient timefor the upgrade to be performed.

Note that:

● While the ActiveMatrix Administrator server is being upgraded, deployed applications willcontinue to run without service interruption. However, the Administrator server itself will beunavailable, which means you cannot perform functions such as deploying new applications andmanaging existing applications, and managing infrastructure.

● While a TIBCO Host instance and its nodes are being upgraded, the applications deployed on thenodes will be stopped. As a result, clients of those applications will experience service interruption.

BPM Node Types and Upgrade

If you are upgrading from a pre-4.0 version ActiveMatrix BPM system that includes BPM nodes of nodetype Web Components, Process Manager or Work Manager, these node types will automatically beconverted as part of the upgrade process to version 4.0 node types. (Web Components nodes are

19


converted to Client node type. Process Manager and Work Manager nodes are converted to Servernode type.)

The upgrade process could potentially take a significant amount of time because of the work involvedin this conversion.

Disaster RecoveryThere are two approaches you can use if you want to provide a Disaster Recovery (DR) capability for anActiveMatrix BPM system.

These are:

● Data-level replication. This approach:

— requires only file-based and database-based replication software.

— ensures that data on the DR site will be in a consistent state across the various TIBCOActiveMatrix BPM datastores and will therefore start-up when required.

If the primary site fails, there may be some data loss or lost state changes within executingbusiness processes. The extent of this loss is determined by the latency of the replication ofchanges on the primary site to the DR site.

See Disaster Recovery Using Data-Level Replication for more information.

● Device-level replication. This approach:

— requires dedicated device-level replication hardware and software (with commensurate highercosts).

— ensures that state information held in the file system or database remains synchronized afterreplication to the DR site.

See Disaster Recovery Using Device-Level Replication for more information.

Network SupportActiveMatrix BPM supports Internet Protocol version 6 (IPv6) and version 4 (IPv4).

Use of IPv6 requires an IPv6 compatible version of TIBCO Enterprise Message Service (EMS).

ActiveMatrix BPM supports:

● pure IPv4 configurations

● mixed-mode configurations where each network interface may have both IPv6 and IPv4 addresses

● pure IPv6 configurations

For more information on the use of IPv6 please see "Network Configuration > IPv6 Support" in TIBCOActiveMatrix BPM SOA Administration.

Wherever you need to provide a machine name (or hostname) when using ActiveMatrix BPM, TIBCOrecommend that you use names that are resolved by the system address translation mechanism (DNSaliases or local host files) rather than literal IPv6 or IPv4 addresses.

20


SYSTEM REQUIREMENTS

The following sections describe the basic system requirements that must be in place before you caninstall or upgrade to this version of ActiveMatrix BPM.

Hardware RequirementsTIBCO recommends a minimum specification for any server used to host a BPM system.

Processor

Two 3 GHz dual processors.

System Memory

8 GB of virtual memory available for user applications.

Disk Space

The installer requires space in the temporary directory before installation, and additional space in thetemporary directory for running the installer. You must also make sure sufficient space is in thedirectory you want to use as the installation environment (TIBCO_HOME) directory.

While performing installation, avoid running other processes that consume disk space in TIBCO_HOME.If another process consumes disk space while the installer is copying the files, the installer might failand display a failure message.

Directory Disk Space Requirement

Temporary directoryused to hold the installer

Before you start the installation process, extract the contents of theinstallation archive to a temporary directory. The installer files consumeup to 900 MB of disk space.

Temporary directoryused during installation

The installer requires at least 900 MB of free space in the temporarydirectory used by the installer. On Microsoft Windows, this directory istypically:

%SystemDrive%:\Documents and Settings\user_name\Local

Settings\Temp

If your system does not have sufficient disk space in the defaulttemporary area, you can run the installer with a different temporarydirectory by using the following option when starting the installer:

-is:tempdir /new_temp

where /new_temp has sufficient free disk space.

Installation environmentdirectory (TIBCO_HOME)

The installer calculates the disk space required in the installationenvironment directory for the selected components. The calculation isdone before the actual installation (copying of files to the system)begins. The installer will proceed only if sufficient free disk space isavailable in the installation environment directory.

ActiveMatrix BPM can consume up to 5 GB of free space underTIBCO_HOME.

21


Platform and Database RequirementsActiveMatrix BPM supports various platforms and databases.

Supported Platforms

There are various combinations of operating system and processor architecture that can be used to hostActiveMatrix BPM.

OperatingSystem (64 bit) Supported Versions

SupportedProcessorArchitectures

Windows● Microsoft Windows Server 2016 (with any subsequent

service packs for this version)

● Microsoft Windows Server 2012 R2 (with any subsequentservice packs for this version)

x86-64

Linux● Novell SUSE Linux Enterprise Server 11, 12 (and any

subsequent service packs for these versions)

● Red Hat Enterprise Linux Server v6.3, v7.1 (and anysubsequent updates for these versions)

● CentOS Linux v6.3, v7.1 (and any subsequent updates forthese versions)

● Oracle Linux v6.3, v7.1 (and any subsequent updates forthese versions)

When installing on Linux, the TIBCO ConfigurationTool (TCT) has a dependency on the extensionlibrary, libXtst. If the libXtst library is missing, TCTruns successfully, but the TCT logs may includemany glib/gtk/pango errors.

The libXtst library is normally installed by default.On RedHat Linux, for example, you can determine iflibXtst is installed using the following command:$ yum install libXtst

x86-64

Solaris Oracle Solaris 10, 11.0, 11.2, 11.3 (and any subsequent patchesfor these versions)

SPARC

AIX IBM AIX v7.1, v7.2 (and any subsequent fix packs for theseversions)

POWER

The Supported Versions specified are the minimum versions of each operating system that aresupported by ActiveMatrix BPM:

● Any subsequent service packs/patches/updates/fix packs released for the same major version are alsosupported.

● Higher major versions must be validated by TIBCO to determine if they are supported byActiveMatrix BPM. If you wish to use a higher major version of one of these operating systems with

22


ActiveMatrix BPM, contact TIBCO Support to find out if that version is supported. Major versions aredefined in this context as:

— Microsoft Windows Server 2012 R2 or 2016— Novell SUSE Linux Enterprise Server 11 or 12— Red Hat Enterprise Linux Server v6 or v7— CentOS Linux v6 or v7— Oracle Linux v6 or v7— Oracle Solaris 10— Oracle Solaris 11— IBM AIX v7

Supported Databases

There are various database versions that can be used to host the ActiveMatrix BPM, ActiveMatrixAdministrator, and (if required) BDS case data store databases.

Database (64 bit) Supported Versions Supported Editions

Microsoft SQLServer 2017

2017 (with any subsequent service packs for thisversion)

Standard or higher


2016 with Service Pack 1 (or any subsequentservice packs for this version)

Standard or higher



Standard or higher



Standard or higher

Oracle 12c R2 12.2.0.1 (with any subsequent 12.2.0.x patch sets) Standard or higher (withor without RAC enabled)

Oracle 12c R1 12.1.0.2 (with any subsequent 12.1.0.x patch sets) Standard or higher (withor without RAC enabled)

DB2 11.1 (with any subsequent Fix Packs for thisversion)

Workgroup or higher

DB2 10.5 (with Fix Pack 3 or later for this version) Workgroup or higher

Microsoft SQL Server and AlwaysON Availability Groups: When using Microsoft SQL Server (2012,2014, 2016 or 2017), AlwaysON Availability Groups must be disabled. ActiveMatrix BPM does notsupport the use of SQL Server AlwaysON Availability Groups.

The Supported Versions specified are the minimum versions of each database that are supported byActiveMatrix BPM:

● Any subsequent service packs/patches/updates/fix packs released for the same major version are alsosupported.

● Higher major versions must be validated by TIBCO to determine if they are supported byActiveMatrix BPM. (Major versions are defined in this context as: Microsoft SQL Server 2016 2014 or

23


2012, Oracle 12c R1 or R2, DB2 11.1 or 10.5.) If you wish to use a higher major version of one of thesedatabases with ActiveMatrix BPM, contact TIBCO Support to find out if that version is supported.

The platform being used to host ActiveMatrix BPM also affects which database can be used - see"Database and Platform Compatibility" below for more information.

Some database configuration is required before installing ActiveMatrix BPM, depending on thedatabase used and the installation scenario, as explained later.

Database and Platform Compatibility

The supported databases that can be used to host the ActiveMatrix BPM, ActiveMatrix Administrator,and (if required) BDS case data store databases vary depending on the supported platforms on whichActiveMatrix BPM can run.

Platform hosting ActiveMatrix BPM (64bit)

Microsoft SQLServer 2016,2014 or 2012

Oracle 12c R1or R2

DB2 11.1 or10.5

Microsoft Windows Server 2016 or 2012 R2 Supported Supported Supported

Novell SUSE Linux Enterprise Server 11 or12

Not tested Supported Supported

Red Hat Enterprise Linux v6.3 or v7.1 (andany subsequent v6.x or v7.x updates)

Supported Supported Supported

CentOS Linux v6.3 or v7.1 (and anysubsequent v6.x or v7.x updates)


Oracle Linux v6.3 or v7.1 (and anysubsequent v6.x or v7.x updates)


Oracle Solaris 10 or 11 Not tested Supported Not tested

IBM AIX v7.1 or 7.2 (and any subsequent fixpacks for these versions)

Not tested Supported Supported

Each supported database is listed as either "Supported" or "Not tested" against each supportedplatform. These terms have the following specific meanings:

● Supported - When ActiveMatrix BPM is hosted on this platform, this database can be used to hostthe ActiveMatrix BPM, ActiveMatrix Administrator and (if required) BDS case data store databases.In this case, either:

— TIBCO has extensively tested and validated this platform/database combination against thisversion or an earlier version of ActiveMatrix BPM, or

— According to the database vendor this version of the database is compatible with the specifiedplatform.

● Not tested - When ActiveMatrix BPM is hosted on this platform, TIBCO has not validated use of thisdatabase to host the ActiveMatrix BPM, ActiveMatrix Administrator, and (if required) BDS casedata store databases. Please contact TIBCO Support first if you want to use ActiveMatrix BPM withthis platform/database combination.

24


TIBCO Software RequirementsTIBCO ActiveMatrix BPM software uses various required and optional TIBCO ActiveMatrix softwarecomponents.

See the TIBCO ActiveMatrix BPM Readme file for details of required versions.

These components are distributed and installed separately from TIBCO ActiveMatrix BPM software.You can download them from the TIBCO Software Product eDelivery Site:

http://edelivery.tibco.com/

Enterprise Message Service

ActiveMatrix BPM requires TIBCO Enterprise Message Service (EMS) version 8.3.x, or 8.4.1 or later8.4.x. Note that:

● Use of version 8.4.1 or later 8.4.x is strongly recommended.

● TIBCO Enterprise Message Service is used as the notification and messaging backbone for TIBCOActiveMatrix BPM.

● You must install TIBCO Enterprise Message Service before you install TIBCO ActiveMatrix BPM.(See Configuring TIBCO Enterprise Message Service.)

● TIBCO Enterprise Message Service does not have to be installed on the same machine as TIBCOActiveMatrix BPM. (You will specify the connection details needed to contact the EMS Server as partof the installation and configuration process.)

● TIBCO Enterprise Message Service can also be used by the TIBCO ActiveMatrix SOAP and JMSbinding types. The TIBCO ActiveMatrix BPM license does not cover this usage of the includedTIBCO Enterprise Message Service software. You must separately license TIBCO Enterprise MessageService for this usage.

TIBCO Business Studio™

TIBCO Business Studio - BPM Edition 4.3 is required to model processes and deploy them.

TIBCO ActiveMatrix® Decisions

TIBCO ActiveMatrix Decisions 1.3 is required to execute decision services on TIBCO ActiveMatrixBPM.

Other TIBCO ActiveMatrix Software Components

The following TIBCO ActiveMatrix software components are not required to install ActiveMatrix BPM,but can be used with ActiveMatrix BPM if desired.

Product Description

TIBCO ActiveMatrix BindingType for Adapters

TIBCO ActiveMatrix Binding Type for Adapters integrates a legacyTIBCO adapter into the ActiveMatrix environment.

TIBCO ActiveMatrix BindingType for EJB

TIBCO ActiveMatrix Binding Type for EJB is an interface for EJBcomponents to the Service Oriented Architecture (SOA) world.

TIBCO ActiveMatrixImplementation Type for C++

TIBCO ActiveMatrix Implementation Type for C++ integrates C++applications into the TIBCO ActiveMatrix environment.

25



Third-Party Software RequirementsActiveMatrix BPM requires various third-party software.

Apache Ant

Apache Ant is required to run TIBCO Configuration Tool scripts, TIBCO ActiveMatrix runtime objectsupgrade, or TIBCO ActiveMatrix Administrator CLI scripts.

Apache Ant is supplied as part of the ActiveMatrix BPM software distribution.

Content Management Systems

If you want to use an external content management system (CMS) for the Business Data Services casefolder feature, you can use any CMIS 1.0-compliant CMS. TIBCO has tested the following:

● Alfresco Community Edition 5.0a (5.0.0 r75118-b23)

● SharePoint 2013

You do not need to use an external CMIS to host case folders. You can instead, if you wish, use theTIBCO DocumentStore - an internal CMS that is installed as part of ActiveMatrix BPM. It usesAtomPub binding and is CMIS 1.0 compliant.

Eclipse Standard Web Toolkit (SWT) Graphical Tool Kit (GTK) Module

If you are installing ActiveMatrix BPM on a Linux or Solaris platform, the Eclipse SWT GTK modulesoftware assemblies are required. (These assemblies are not required if you are installing ActiveMatrixBPM on any other platform.)

You can obtain the Eclipse SWT GTK module in two ways:

● You can download the assemblies automatically when you run the ActiveMatrix BPM installer, ifthe machine on which you are running the installer has internet access.

● You can download the assemblies from the TIBCO Software Product eDelivery Site before youinstall ActiveMatrix BPM:


You should do this if the machine on which you are running the ActiveMatrix BPM installer doesnot have internet access. See Downloading Required Third-Party Software Assemblies for moreinformation.

Hibernate

ActiveMatrix BPM requires Hibernate version 3.2.7. You can obtain this version of Hibernate in twoways:

● You can download Hibernate automatically when you run the ActiveMatrix BPM installer, if themachine on which you are running the installer has internet access.

● You can download Hibernate from the TIBCO Software Product eDelivery Site before you installActiveMatrix BPM:



26




When downloading Hibernate, the number in the package name refers to the assembly number and notthe version of Hibernate. This can be misleading as the assembly number is not the same as theHibernate version number. For example, the package name when downloading Hibernate Version 3.2.7is:

assembly_tibco_com_tpcl_ord_hibernate_feature_3.2.500.002.zip

Java Virtual Machine (JVM)

ActiveMatrix BPM requires a 64-bit JVM.

Java Runtime Environment (JRE) 1.8 is supplied as part of the ActiveMatrix BPM software distribution.

JDBC Drivers

ActiveMatrix BPM requires JDBC drivers for the databases that will be used to host the ActiveMatrixBPM and ActiveMatrix Administrator databases, as shown in the following table:

Database Required JDBC driver

Microsoft SQL Server2017

Microsoft SQL Server JDBC Driver 7.0 (mssql-jdbc-7.0.0.jre8.jar)


Microsoft SQL Server JDBC Driver 7.0 (mssql-jdbc-7.0.0.jre8.jar),6.0 (sqljdbc42.jar), or 4.2 (sqljdbc42.jar)


Microsoft SQL Server JDBC Driver 6.0 (sqljdbc42.jar), or 4.2(sqljdbc42.jar)


Microsoft SQL Server JDBC Driver 4.2 (sqljdbc42.jar)

Oracle 12c R2 Version 12.2.0.1 (ojdbc8.jar)

Oracle 12c R1 Version 12.1.0.1.0 (ojdbc7.jar)

To determine if you have the correct version of ojdbc7.jar, do one ofthe following:

● In the BPM log file on system startup, look for the following entry:

[INFO ] org.hibernate.cfg.SettingsFactory -JDBC driver:

Oracle JDBC driver, version: 12.2.0.1.0

● In the following folder:

TIBCO_HOME/components/shared/1.0.0/plugins/

com.tibco.tpcl.gen.oracle.jdbc_12.2.0.001

open the ojdbc8.jar file, and examine the META-INF/MANIFEST.MFfile for the following entry:

Implementation-Version: 12.2.0.1.0

DB2 11.1 or 10.5 db2jcc4.jar

Different versions of the db2jcc4.jar file correspond todifferent DB2 releases and Fix Pack levels. Refer to IBMSupport for more information.

Refer to your database documentation for information on how to obtain these JDBC drivers.

27


You will need to configure these JDBC drivers for use with ActiveMatrix BPM as part of the installationprocess.

LDAP Server

All users who may need to log in to ActiveMatrix BPM (using Openspace, Workspace or a custom clientapplication) must exist in one or more LDAP directories that are accessible to ActiveMatrix BPM.

ActiveMatrix BPM requires one or more LDAP servers that use the Lightweight Directory AccessProtocol (LDAP) version 3.

If you are installing:

● a system that is intended for production use (generally a distributed BPM system), you must use anexternal LDAP directory server.

● a basic BPM system that is not intended for production use, you can either use an external LDAPdirectory server, or the internal LDAP directory server that is provided with ActiveMatrix BPM.

Oracle Java 8 Elliptic Curve Cryptography (ECC) Library

If you are installing ActiveMatrix BPM on a Windows, Linux or Solaris platform, the Oracle Java 8 ECClibrary is required. (This library is not required if you are installing ActiveMatrix BPM on any otherplatform.)

You can obtain the Oracle Java 8 ECC library in two ways:

● You can download a software assembly automatically when you run the ActiveMatrix BPMinstaller, if the machine on which you are running the installer has internet access.

● You can download the assembly from the TIBCO Software Product eDelivery Site before you installActiveMatrix BPM:



Web Browsers

ActiveMatrix BPM requires a web browser to run Openspace, Workspace, Application Management(and its example myWork application) and the ActiveMatrix Administrator GUI.

The following tables list the web browsers that are supported by the different ActiveMatrix BPMruntime user interfaces.

The Supported Versions specified are the minimum versions of each browser that are supported byActiveMatrix BPM. Unless otherwise specified, you can use a more recent version of a browser as longas the vendor claims the recent version to be compatible with the specified version.

In the event of a problem with a more recent browser version, TIBCO will employ reasonable efforts toprovide support on that browser version. However, TIBCO may request that you reproduce theproblem on a supported version of the browser. This may mean that you potentially change to adifferent version that does not exhibit the issue; ideally only on a temporary basis.

28



Openspace and Workspace

BrowserVersions Notes

Microsoft Edge 42 Includes support for EdgeHTML 17.

The Openspace Spotfire gadget has not been tested with MicrosoftEdge, but it is expected that it will largely run satisfactorily.

Internet Explorer 11 Enterprise Mode and Native Mode are supported. CompatibilityView is not supported.

Openspace has not been tested with Internet Explorer 11, but it isexpected that it will largely run satisfactorily.

Internet Explorer 11 is:

● Supported on Windows Server 2012 R2.

● Provided with Windows 10, alongside Microsoft Edge, on whichit is supported for backward compatibility.

See https://support.microsoft.com/en-us/help/17454/lifecycle-faq-internet-explorer for more information.

Chrome 72

Openspace (Accessible)


Internet Explorer 11 Openspace (Accessible) has not been tested with Internet Explorer 11,but it is expected that it will largely run satisfactorily.





Application Development


Microsoft Edge 42

29


https://support.microsoft.com/en-us/help/17454/lifecycle-faq-internet-explorer






Application Development has not been tested with Internet Explorer11, but it is expected that it will largely run satisfactorily.





Chrome 72

Safari

(on iOS 11.4.x oniPad)

11.4.1 The ActiveMatrix BPM 4.3.0 MyWork application and TIBCO Formshave been tested on an Apple iPad Air 2 running iOS 11.4.1. TIBCOanticipates that these components will work equally well on an AppleiPad Pro and Apple iPad Mini although the display content will besmaller on the latter.

Apple iPhone and iPod Touch devices are not supported.

Note: Application Development itself is not supported on Safari.

Safari

(on OS X 10.12.x)

11.13 The ActiveMatrix BPM 4.3.0 MyWork application and TIBCO Formshave not been tested with Safari on an Apple Mac running OS X10.12.x or above, but it is expected that they will largely runsatisfactorily.Note: Application Development itself is not supported on Safari.

Mobilespace

Device Notes

iOS Mobilespace uses WKWebView (1.1.4) to render the webcontent on iOS devices.

Mobilespace and the Mobile Case Management app have been tested on AppleiPhone and iPad running iOS 11.4.1.

Android Mobilespace uses crosswalk-webview (2.3.0) to render the webcontent onAndroid devices.

Mobilespace and the Mobile Case Management app have been tested onAndroid version 6.

30




TIBCO ActiveMatrix Administrator (GUI)


Microsoft Edge 42






Chrome 72

Firefox 61

User Account RequirementsInstalling and configuring ActiveMatrix BPM requires the involvement of two roles.

They are:

● BPM installer - responsible for installing and configuring ActiveMatrix BPM.● Database administrator (DBA) - responsible for creating and upgrading the ActiveMatrix

Administrator server and BPM server databases.Depending on your operational and security environment, these roles can be performed either by thesame person, or by different departments or individuals.

Operating System User Account

The user account used to install or upgrade ActiveMatrix BPM must have the appropriate privileges:

● Microsoft Windows - You must have administrator privileges for the machine on which thisproduct is installed. If you do not have administrator privileges, the installer exits. You must thenlog out of the system and log in as a user with the required privileges, or request your systemadministrator to assign the privileges to your account.

If you intend to install the product on a network drive, ensure that the account used for installationhas permission to access the network drive.

● UNIX or Linux - Any type of user (regular (non-root) user or super-user (root)) can install thisproduct. While installing this product on UNIX platforms, ensure that the same installer account isused to install all TIBCO ActiveMatrix products.

A graphic environment such as CDE or X Windows is required to run the installer in GUI mode.

Database User Account

When you create or upgrade a BPM system, you can allow TIBCO Configuration Tool to automaticallycreate or upgrade the ActiveMatrix BPM database.

To do this, you must have the username and password of a database server user account that hasdatabase administrator privileges (a DBA user). You will need to specify these credentials in the

31




ActiveMatrix BPM: Database Administrator screen of the Create TIBCO ActiveMatrix BPM ServerWizard.

If you do not have the credentials of a DBA user, a DBA user will need to manually create the BPMdatabase before you can complete installation and configuration with TIBCO Configuration Tool. See Manually Creating the BPM Database.

Additional System Requirements for a Distributed BPM SystemA distributed ActiveMatrix BPM system has additional architectural requirements.

An example of a distributed BPM system is shown in Example configuration for a distributedActiveMatrix BPM system. The requirements are shown in the following table.

Requirement Description

Load Balancer Manages HTTP requests from ActiveMatrix BPM clients across themachines hosting BPM nodes.

Shared File System Holds shared configuration data used by ActiveMatrix BPM and/orActiveMatrix Administrator.

LDAP Server Must be external. Do not use the internal LDAP server supplied withActiveMatrix BPM.

The load balancer, shared file system, database server, LDAP server, SMTP server (if used) and TIBCOEnterprise Message Service server must each be available to each machine that is part of the BPMsystem.

For a high availability configuration, they must also each be configured to provide high availability andfault tolerance.

Load Balancer

The load balancer must be configured as follows:

● The following ports must be configured for load balancing across the relevant machines:

— ActiveMatrix Administrator external HTTP port (default 8120) - used for communicationbetween ActiveMatrix Administrator and external web/CLI clients and Business Studio.

— ActiveMatrix BPM HTTP port (default 8080) - used for communication between ActiveMatrixBPM and external clients (Openspace, Workspace and custom clients).

If you are upgrading a distributed ActiveMatrix BPM system, configuration of theActiveMatrix Administrator internal HTTP port (default 19767) for load balancing is nolonger necessary.

● Sticky connections should be used so that client session context is maintained. (If the server hostingthis session dies the client will be logged out and need to log back in again.)

Shared File System

The shared file system must:

● be available to each machine that is part of the BPM system.

● be mounted in an identical location on each machine. For example, if you create a network drive orfolder on machine 1 and map it to x:\shared on the primary machine , the shared drive or foldermust be mapped to x:\shared on each remote machine as well.

32


● contain the folders shown in the following table (where SHARED_DIR is the root folder of the sharedfile system).

Folder Notes

SHARED_DIR\admin

\enterpriseName\shared

Shared staging area folder used by ActiveMatrix Administrator.

This folder is only required for a high availabilityconfiguration, where the Administrator server isreplicated on two machines.

Use this folder when configuring the ActiveMatrix Administratoron the primary machine - see Primary Machine: Moving theActiveMatrix Administrator Server Staging Area to the SharedFile System.

SHARED_DIR\bpm_config Shared configuration folder in which ActiveMatrix BPM storesBPM properties files. (bpm_config is the suggested name for thisfolder, but you can use any name that you wish.)

Use this location when configuring ActiveMatrix BPM on:

● the main BPM node - see ActiveMatrix BPM: Configuration

● each remote BPM node - see ActiveMatrix BPM Host andNode Configuration

SHARED_DIR\keystores Shared authentication folder in which ActiveMatrix BPM storeskeystores (or trust stores) used for SSL and/or WSSauthentication. This folder is created automatically if you selectOverride BPM Configuration Folder in the ActiveMatrix BPM:Configuration screen of the Create TIBCO ActiveMatrix BPMServer Wizard.

To ensure that authentication operates correctly, you must:

1. store any keystores needed for SSL or WSS authentication inthis folder.

2. reference this folder as the location of any keystores asrequired, either:

● from TIBCO Configuration Tool dialogs (for example,when defining SSL connections)

● when configuring a Keystore Provider resource templatein TIBCO Administrator.

See TIBCO ActiveMatrix BPM - BPM Administration formore information about enabling SSL and configuringTIBCO ActiveMatrix BPM to use SSO for authentication.

The following user accounts must have at least read/write permissions to these folders:● the account used to install ActiveMatrix BPM.

● any accounts that will be used to run ActiveMatrix BPM (specifically the tibcohost process).

33


Server Time Synchronization

The primary and remote machines must have their time/date synchronized with each other. If servertimes are offset (even by a few seconds), the ActiveMatrix BPM node log file:

CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\data_3.2.x\nodes\nodeName

\logs\BPM.log

may show significant numbers of errors like the following:05 Jun 2011 14:12:02,465 [QuartzScheduler_PVM:Quartz Scheduler-LINAramis1307296618457_ClusterManager] [WARN ] com.tibco.pvm.persist.quartz.jdbcjobstore.IpmQuartzJobStoreTX - This scheduler instance (LINAramis1307296618457) is still active but was recovered by another instance in the cluster. This may cause inconsistent behavior

25 Jan 2012 01:33:48,698 [QuartzScheduler_PVM:Quartz Scheduler-mjkmssqlbe1327088686491_ClusterManager] [INFO ] com.tibco.pvm.persist.quartz.jdbcjobstore.IpmQuartzJobStoreTX - ClusterManager: Scanning for instance "threemjkv121327089184017"'s failed in-progress jobs.

25 Jan 2012 01:33:56,200 [QuartzScheduler_PVM:Quartz Scheduler-mjkmssqlbe1327088686491_ClusterManager] [INFO ] com.tibco.pvm.persist.quartz.jdbcjobstore.IpmQuartzJobStoreTX - ClusterManager: detected 1 failed or restarted instances.

30 Jan 2012 09:43:38,067 [QuartzScheduler_PVM:Quartz Scheduler-twomjkv121327596401015_ClusterManager] [WARN ] com.tibco.pvm.persist.quartz.jdbcjobstore.IpmQuartzJobStoreTX - This scheduler instance (twomjkv121327596401015) is still active but was recovered by another instance in the cluster. This may cause inconsistent behavior.

34


INSTALLATION AND UPGRADE SCENARIOS

The following sections describe the most common ActiveMatrix BPM installation and upgradescenarios, and provide high-level procedures for how to implement them.

To install a Developer Server configuration of ActiveMatrix BPM to perform rapid development andtesting of a BPM application, see the TIBCO ActiveMatrix BPM Installation: Developer Server guideinstead of this guide.

Creating a Basic ActiveMatrix BPM SystemThis section describes how to install and configure a BPM system using a basic configuration (with allcomponents installed on a single machine).

A Basic ActiveMatrix BPM SystemA basic configuration consists of a simple installation where ActiveMatrix BPM is installed on a singlemachine.

The basic configuration is intended for proof-of-concept, testing and validation or demonstrationpurposes. It is not intended for use in a production environment and TIBCO recommend that you donot use it in a production environment.

The following figure shows an example of a basic ActiveMatrix BPM configuration. Note that:

● ActiveMatrix BPM and the ActiveMatrix Administrator server are both hosted on the same machine.

● The ActiveMatrix BPM database and ActiveMatrix Administrator database are hosted in the samedatabase server. They can be hosted in different databases and/or on different machines.

● TIBCO Enterprise Message Service is installed on a separate machine. It can be installed on the samemachine as ActiveMatrix BPM.

Example ActiveMatrix BPM system using a basic configuration

35


Performing Required Pre-Installation Tasks

Procedure

● Perform all required pre-installation tasks.

Installing ActiveMatrix BPM SoftwareTo install ActiveMatrix BPM, run the TIBCO Universal Installer on the primary machine.

Procedure

1. Log on to the primary machine.

2. Run TIBCOUniversalInstaller to install ActiveMatrix BPM software. (See Installing ActiveMatrixBPM (TIBCO Universal Installer).)

3. Make sure that you complete the following screens/fields as shown.

Screen Requirement

Installation Profile Selection Select the Primary machine profile.

TIBCO Installation Home Select Create a new TIBCO_HOME.

Post-Install summary Select Launch TIBCO Configuration Tool.

Configuring JDBC DriversYou must configure the JDBC drivers that ActiveMatrix BPM uses to access the ActiveMatrix BPMdatabase and the ActiveMatrix Administrator database.

Procedure

1. Make sure that the .jar files for the required JDBC drivers are available on the primary machine.(See JDBC Drivers.)

2. In TIBCO Configuration Tool, enter a local location for the TIBCO configuration folder(CONFIG_HOME), or click OK to use the default location.

3. Run the Configure Third-Party Driver Wizard.

4. Configure the JDBC driver needed for the database server that will be used to host the ActiveMatrixBPM database.

5. If a different database server will be used to host the Administrator database, configure the JDBCdriver for that database server as well.

6. Return to the Create new configurations screen, but do not close TIBCO Configuration Tool.

Creating a BPM Node and Administrator ServerTo create the ActiveMatrix Administrator server and a BPM node, run the Create TIBCO ActiveMatrixBPM Server wizard on the primary machine.

Procedure

1. In TIBCO Configuration Tool, choose the Create TIBCO ActiveMatrix BPM Server Wizard.

36


Make sure that you complete the following screens/fields as shown. (See Create TIBCOActiveMatrix BPM Server Wizard and Create TIBCO ActiveMatrix Administrator Server Wizard forfull details of the data you need to enter in this wizard.)

Screen Requirement

Welcome If you want to perform an Express installation, clear Configure forStandard Installation of all details.

An Express installation allows you to quickly create a new BPM systemand ActiveMatrix Administrator server, using mostly defaultconfiguration options.

ActiveMatrix BPM:DatabaseAdministrator

Enter the details of the database server that will be used to host theActiveMatrix BPM database. (See Configuring the BPM DatabaseServer.)

ActiveMatrix BPM:Runtime DatabaseConfiguration

Enter the details of the ActiveMatrix BPM database.

ActiveMatrix BPM:Configuration

Make sure that Override BPM Configuration Folder is cleared.

ActiveMatrix BPM:Administrator ServerConfiguration

Clear Use Existing ActiveMatrix Administrator Server.

When you click Next, the Administrator Server Configuration:Database Details screen is displayed. This wizard allows you toconfigure the ActiveMatrix Administrator server.

This screen is not displayed if you have chosen to do anExpress installation.

Administrator ServerConfiguration:Database Details

Enter the details of the database server that hosts the Administratordatabase, making sure that the Database URL field contains a DNSname. (See Creating the External ActiveMatrix AdministratorDatabase.)

Administrator ServerConfiguration:Credential ServerDetails

Ensure that Bind to Network Adapter is set to 0.0.0.0.

This screen is not displayed if you have chosen to do anExpress installation.

37


Screen Requirement

Administrator ServerConfiguration:Summary

Select Create TIBCO ActiveMatrix Administrator server and CreateActiveMatrix BPM, then:

● If the string [Creating Database Instance] is appended to theCreate ActiveMatrix BPM action (indicating that you chose toautomatically create the ActiveMatrix BPM database), clickConfigure.

● If the string [Not Creating Database Instance] is appended tothe Create ActiveMatrix BPM action (indicating that you chose tomanually create the ActiveMatrix BPM database):

1. Click Save to save the configuration information gathered inthe preceding screens to the specified Session Scripts and LogFolder.

2. Click Cancel to exit the Create TIBCO ActiveMatrix BPM Serverwizard.

3. Get a database administrator to manually create the BPMdatabase - see Manually Creating the BPM Database.

4. Run the Create TIBCO ActiveMatrix BPM Server wizard again.

5. Click Load, then select the Session Scripts and Log Folder inwhich you saved the configuration information.

6. Click OK when the Loaded data model successful messageis displayed.

7. Click Next repeatedly until you reach the ActiveMatrix BPM:Runtime Database Configuration screen, then click TestConnection (to verify that TIBCO Configuration Tool canconnect to the BPM database).

8. Click Next repeatedly until you reach the Administrator ServerConfiguration: Summary screen, then click Configure.

TIBCO Configuration Tool creates the ActiveMatrix Administrator server and a BPM node on thehost machine.

2. Click Close to exit TIBCO Configuration Tool.

Performing Required Post-Installation Tasks

Procedure

● Perform all required post-installation tasks.

38


Creating an ActiveMatrix Administrator Server (Single or Replicated)This section describes how to install and configure an ActiveMatrix Administrator server on a separatemachine from any BPM systems. This configuration is recommended for use in a productionenvironment.

An ActiveMatrix Administrator Server (Single or Replicated)In a production environment, TIBCO recommend that the ActiveMatrix Administrator server is hostedindependently from ActiveMatrix BPM, using its own set of TIBCO Host instances.

If a high availability, fault tolerant configuration is required, the ActiveMatrix Administrator servershould also be replicated.

The following figure shows an example configuration for a single ActiveMatrix Administrator server.

Example configuration for a single ActiveMatrix Administrator server

For details of the associated configuration for a distributed ActiveMatrix BPM system, see Exampleconfiguration for a distributed ActiveMatrix BPM system.

The following figure shows an example configuration for a replicated ActiveMatrix Administratorserver.

39


Example configuration for a replicated ActiveMatrix Administrator server

For details of the associated configuration for a distributed ActiveMatrix BPM system, see Exampleconfiguration for a distributed ActiveMatrix BPM system.


Procedure


Primary Machine: Installing ActiveMatrix BPM SoftwareTo install ActiveMatrix BPM on the primary machine, run the TIBCO Universal Installer on the primarymachine.

Procedure




40


Screen Requirement




Primary Machine: Configuring JDBC DriversYou must configure the JDBC drivers that ActiveMatrix BPM uses to access the ActiveMatrixAdministrator database.

Procedure

1. Make sure that the jar files for the required JDBC drivers are available on the primary machine. (See JDBC Drivers.)


3. In the Create new configurations screen, choose the Configure Third-Party Driver Wizard.

4. Configure the JDBC driver needed for the database server that will be used to host the ActiveMatrixAdministrator database.


Primary Machine: Creating the Administrator ServerTo create the ActiveMatrix Administrator server on the primary machine, run the Create TIBCOActiveMatrix Administrator Server wizard on the primary machine.

Procedure

1. In TIBCO Configuration Tool, choose the Create TIBCO ActiveMatrix Administrator Server Wizard.


Screen Requirement

Administrator ServerConfiguration: TIBCOHost Configuration

Clear Create Development Node.

Administrator ServerConfiguration:Database Details

1. Clear Use Default In-Process Database.

2. Enter the details of the database server that hosts the Administratordatabase, making sure that the Database URL field contains a DNSname. (See Creating the External ActiveMatrix AdministratorDatabase.)

Administrator ServerConfiguration:Credential ServerDetails

Ensure that Bind to Network Adapter is set to 0.0.0.0.

41


Screen Requirement


Select Create TIBCO ActiveMatrix Administrator server then clickConfigure.

See Create TIBCO ActiveMatrix Administrator Server Wizard for full details of theinformation that you need to enter in this wizard.

TIBCO Configuration Tool creates the ActiveMatrix Administrator server on the primary machine.


What to do next

If you want to replicate the ActiveMatrix Administrator server, perform the following tasks:

● Primary Machine: Move the ActiveMatrix Administrator Server Staging Area to the Shared FileSystem

● Second Primary Machine: Install ActiveMatrix BPM Software

● Second Primary Machine: Configure JDBC Drivers

● Second Primary Machine: Replicate the ActiveMatrix Administrator Server

Primary Machine: Sharing the ActiveMatrix Administrator Server Staging AreaWhen the ActiveMatrix Administrator server is replicated, you must move the staging area to theshared file system so that it can be shared between the servers.

Procedure

1. Copy the folder CONFIG_HOME\admin\enterpriseName\shared to a location on the shared filesystem (see Shared File System).For example: SHARED_DIR\admin\enterpriseName\shared

2. Open a command window in the following folder:TIBCO_HOME\administrator\n.n\scripts

3. Run the following command to update the ActiveMatrix Administrator server with the new stagingarea location:ant -f sharedWorkFolder_build.xml -Dadmin.shared.folder="sharedFileSystemLocation" -Dconfig.home="CONFIG_HOME" -Denterprise.name="enterpriseName"

where sharedFileSystemLocation is the location on the shared file system from step 1 above.

4. Open a command window in the following folder:CONFIG_HOME\tibcohost\Admin-enterpriseName-hostName\host\bin

5. Run the following commands to stop and restart the system node (thereby restarting theActiveMatrix Administrator server):tibcohost.exe stopNodes -nodeName SystemNodetibcohost.exe startNodes -nodeName SystemNode

42


Second Primary Machine: Installing ActiveMatrix BPM SoftwareTo install ActiveMatrix BPM on the second primary machine, run the TIBCO Universal Installer on thesecond primary machine.

Procedure

1. Log on to the second primary machine.



Screen Requirement


TIBCO Installation Home1. Select Create a new TIBCO_HOME.

2. Enter a location that is identical to the value of TIBCO_HOMEon the primary machine. For example, if the location ofTIBCO_HOME on the primary machine is C:\tibco\amx-admin, the location of TIBCO_HOME on the second primarymachine must also be C:\tibco\amx-admin.


Second Primary Machine: Configuring JDBC DriversYou must configure the JDBC drivers that ActiveMatrix BPM on the second primary machine uses toaccess the ActiveMatrix Administrator database.

Procedure

1. Make sure that the jar files for the required JDBC drivers are available on the remote machine. (See JDBC Drivers.)

2. In TIBCO Configuration Tool, enter an identical location for the TIBCO configuration folder(CONFIG_HOME) to the one that you used on the primary machine. (See Primary Machine:Configuring JDBC Drivers.)

3. In the Create new configurations screen, run the Configure Third-Party Driver Wizard.

4. Configure the JDBC driver needed for the database server that was used to host the ActiveMatrixAdministrator database on the primary machine. (See Primary Machine: Configuring JDBCDrivers.)


43


Second Primary Machine: Replicating the ActiveMatrix Administrator ServerTo replicate the ActiveMatrix Administrator server on the second primary machine, run the ReplicateTIBCO ActiveMatrix Administrator Server wizard on the second primary machine.

Procedure

1. Copy the content of the CONFIG_HOME\tct\keystore folder from the primary machine to the samelocation on the second primary machine. (Create this folder on the second primary machine if itdoes not already exist.)

2. In TIBCO Configuration Tool, run the Replicate TIBCO ActiveMatrix Administrator Server Wizard.


Screen Requirement

RemoteAdministratorServer Details

Specify the details of the Administrator server that you created on theprimary machine.

AdministratorServerConfigurationDetails

1. Enter a unique Host Name for the SystemHost instance that will beassociated with the replicated ActiveMatrix Administrator server(SystemHostReplica in Example configuration for a replicatedActiveMatrix Administrator Server).

2. Enter a unique Node Name for the SystemNode instance that will beassociated with the replicated ActiveMatrix Administrator server(SystemNodeReplica in Example configuration for a replicatedActiveMatrix Administrator Server).

AdministratorServerConfigurationSummary

1. Select Replicate TIBCO ActiveMatrix Administrator server.

2. Click Configure.

See Replicate TIBCO ActiveMatrix Administrator Server Wizard for full details of theinformation that you need to enter in this wizard.

TIBCO Configuration Tool:

● creates the specified SystemHost instance and SystemNode.

● replicates the ActiveMatrix Administrator server. The replicated server runs on the specifiedSystemNode.

For example, in Example configuration for a replicated ActiveMatrix Administrator Server, a TIBCOHost instance named SystemHostReplica is created and started. A node namedSystemNodeReplica is created in the environment named SystemEnvironment and started. Thereplicated Administrator server runs on SystemNodeReplica.

When you log in to either of the Administrator servers there will be two hosts in theInfrastructure > Hosts screen and two nodes in the SystemEnvironment environment inthe Infrastructure > Nodes screen. Requests can be processed by either Administratorserver. If one node is unavailable, the other can process requests.

4. Return to the Create new configurations screen, then close TIBCO Configuration Tool.

44


Creating a Distributed ActiveMatrix BPM SystemThis section describes how to install and configure a BPM system using a distributed configuration(with components distributed across multiple machines to provide scalability and/or high availabilityand fault tolerance).

A Distributed ActiveMatrix BPM SystemIn a production environment, TIBCO recommend the use of a distributed configuration forActiveMatrix BPM (along with a suitable underlying architecture).

This configuration can provide the following advantages:

● Scalability: ActiveMatrix BPM software provides specialization and horizontal scalabilitycapabilities. You can:

— add BPM logical nodes to boost the capacity of the BPM system in the required areas - web tier,process management or work management.

— distribute BPM logical nodes to different TIBCO Host instances and physical machines asrequired.

See "TIBCO ActiveMatrix BPM Logical Nodes and Services" in BPM Concepts for moreinformation about the different types of BPM logical node and their uses.

● High availability and fault tolerance: ActiveMatrix BPM software provides active/active clusteringcapabilities. Adding a second BPM logical node (of type BPM) provides high availability and faulttolerance. In the event of a system-affecting failure on one node, load is automatically switched tothe remaining node.

TIBCO also recommend that the ActiveMatrix Administrator server is hosted independently fromActiveMatrix BPM, using its own set of TIBCO Host instances.

You must create the ActiveMatrix Administrator server (if it does not already exist) before you create thedistributed BPM system. See Creating an ActiveMatrix Administrator Server (Single or Replicated) formore information about how to do this.

The following figure shows an example configuration for a distributed ActiveMatrix BPM system.

45


Example configuration for a distributed ActiveMatrix BPM system

For details of the associated ActiveMatrix Administrator server configuration, see Exampleconfiguration for a single ActiveMatrix Administrator server or Example configuration for a replicatedActiveMatrix Administrator server.


Procedure


Remote Machine 1: Installing ActiveMatrix BPM SoftwareTo install ActiveMatrix BPM on remote machine 1, run the TIBCO Universal Installer on remotemachine 1.

Procedure

1. Log on to remote machine 1.


3. In the installer wizard, make sure that you complete the following screens/fields as shown.

46


Screen Requirement

Installation Profile Selection Select the Remote machine profile.



Remote Machine 1: Creating a Host InstanceTo create a host instance on remote machine 1, run the Create TIBCO Host Instance wizard on remotemachine 1.

Procedure

1. In TIBCO Configuration Tool, choose the Create TIBCO Host Instance Wizard.


Screen Requirement

TIBCO Host InstanceConfiguration: Details 1. Enter a unique Name for this TIBCO Host instance (BPMHost1 in

Example configuration for a distributed ActiveMatrix BPM system).

2. Enter the ActiveMatrix Enterprise Name (AMX BPM Enterprise in Example configuration for a distributed ActiveMatrix BPM system).

TIBCO Host InstanceConfiguration:Administrator Server

1. Select Bind to Administrator server.

2. Enter the Machine Name on which the ActiveMatrix Administratorserver is running.

TIBCO Host InstanceConfiguration:Summary

Select:

● Create TIBCO Host instance● Launch TIBCO Host instance● Register TIBCO Host instance to the Administrator server

then click Configure.

Result

TIBCO Configuration Tool creates the specified TIBCO host instance (if it does not already exist),binding it to the ActiveMatrix Administrator server that manages this ActiveMatrix enterprise.

For example, in Example configuration for a distributed ActiveMatrix BPM system, BPMHost1 iscreated on BPM_Machine1 and bound to the ActiveMatrix Administrator server.

47


Primary Machine: Creating a BPM Node on Remote Machine 1To create a BPM node on remote machine 1, run the Create TIBCO ActiveMatrix BPM Server wizard onthe primary machine.

Procedure

1. Log on to the primary machine (on which ActiveMatrix Administrator is running).



Screen Requirement


Enter the details of the database server that will be used to host theActiveMatrix BPM database. (See Configuring the BPM DatabaseServer.)


Enter the details of the ActiveMatrix BPM database.

ActiveMatrix BPM:Configuration 1. Select Override BPM Configuration Folder.

2. In the Configuration Folder field, enter the location of theconfiguration folder on the shared file system (in which BPMproperties files are to be stored).

For example, SHARED_DIR\bpm_config.

See Shared File System.

ActiveMatrix BPM:LDAP Configuration

If the LDAP server is SSL enabled, the Trust Store Location must beSHARED_DIR\keystores. See Shared File System.


1. Select Use Existing ActiveMatrix Administrator Server.

2. Specify the details of the ActiveMatrix Administrator server beingused by the ActiveMatrix enterprise (AMX BPM Enterprise in Example configuration for a distributed ActiveMatrix BPM system).

ActiveMatrix BPM:Host and NodeConfiguration

1. Host: Enter the name of the TIBCO Host instance on which the BPMsystem will be created. This must be an existing host that is boundto the specified ActiveMatrix Administrator server (BPMHost1 in Example configuration for a distributed ActiveMatrix BPM system).

2. Environment Name: Enter the name of the new ActiveMatrixenvironment in which the BPM system will be created(BPMEnvironment in Example configuration for a distributedActiveMatrix BPM system).

3. Node Name: Enter a unique name for the ActiveMatrix node onwhich the BPM system will be created (BPMNode1 in Exampleconfiguration for a distributed ActiveMatrix BPM system).

4. Node Management Port: Enter a unique port number.

48


Screen Requirement


Select Create ActiveMatrix BPM, then:


● If the string [Not Creating Database Instance] is appended tothe Create ActiveMatrix BPM action (indicating that you chose tomanually create the ActiveMatrix BPM database:



3. Get a database administrator to manually create the BPMdatabase - see Manually Running BPM Database UpgradeScripts.







● creates and starts a BPM node (of type BPM Node) on the specified TIBCO host instance.

● creates the specified ActiveMatrix environment and adds the new node to it.

For example, in Example configuration for a distributed ActiveMatrix BPM system:

● BPMNode1 is started on BPMHost1.

● BPMEnvironment is created to include BPMNode1.


Remote Machine 2: Installing ActiveMatrix BPM SoftwareTo install ActiveMatrix BPM on remote machine 2, run the TIBCO Universal Installer on remotemachine 2.

Procedure

1. Log on to the second machine.

49




Screen Requirement


TIBCO Installation Home1. Select Create a new TIBCO_HOME.

2. Enter a location that is identical to the value of TIBCO_HOMEon remote machine 1. For example, if the location ofTIBCO_HOME on remote machine 1 is C:\tibco\amx-bpm, thelocation of TIBCO_HOME on the second primary machine mustalso be C:\tibco\amx-bpm.


Remote Machine 2: Creating a Host InstanceTo create a host instance on remote machine 2, run the Create TIBCO Host Instance wizard on remotemachine 2.

Procedure



Screen Requirement

TIBCO Host InstanceConfiguration: Details 1. Enter a unique Name for this TIBCO Host instance (BPMHost2 in

Example configuration for a distributed ActiveMatrix BPM system).

2. Enter the ActiveMatrix Enterprise Name (AMX BPM Enterprise in Example configuration for a distributed ActiveMatrix BPM system).

TIBCO Host InstanceConfiguration:Administrator Server




Select:



50


Result

TIBCO Configuration Tool creates the specified TIBCO host instance (if it does not already exist),binding it to the ActiveMatrix Administrator server.

For example, in Example configuration for a distributed ActiveMatrix BPM system, BPMHost2 iscreated on BPM_Machine2 and bound to the ActiveMatrix Administrator server.

Remote Machine 2: Creating a BPM NodeTo create a BPM node on remote machine 2, run the Configure TIBCO ActiveMatrix BPM Server NodeType wizard on remote machine 2.

Prerequisites

If you are adding a new BPM node to an existing system, and you have custom BPM applications thatuse custom resource instances or custom substitution variables:

1. Change any custom resource instance (that has been created for a custom BPM application) to theamx.bpm.app scope.

2. Delete any custom SVAR that is defined at the Node scope. Evaluate if that custom SVAR can be re-created at any other scope, then reconfigure all custom resource instances and custom BPMapplications that use that SVAR to cope with the change.

If you do not do this, node creation may fail, or custom applications may remain Out-of-Sync after thenew BPM node is created. See "Adding a New BPM Node to an Existing System Fails Because aResource Instance is Missing or Cannot be Installed " in TIBCO ActiveMAtrix BPM Troubleshooting formore information.

Procedure

1. In TIBCO Configuration Tool, run the Configure TIBCO ActiveMatrix BPM Server Node TypeWizard.


Screen Requirement

ActiveMatrix BPM NodeType: Administrator ServerConfiguration

Specify the details of the ActiveMatrix Administrator server.

51


Screen Requirement

ActiveMatrix BPM NodeType: Host and NodeConfiguration

1. Node Type: Select:

● BPM if you want to provide high availability and faulttolerance to the BPM system.

● BPM, Server or Client, as appropriate, if you want toscale that particular component of the BPM runtime so asto boost the performance of the BPM system.

2. Node Name: Enter a unique name for the node (BPMNode2in Example configuration for a distributed ActiveMatrix BPMSystem).

3. Node Port: Enter a unique port number.

4. Host: Enter the name of the host that is running on thismachine (BPMHost2 in Example configuration for adistributed ActiveMatrix BPM System).

5. HTTP Port: Enter a unique port number.

6. Environment Name: Enter the name of the BPM environmentthat contains the existing BPM node (BPMEnvironment in Example configuration for a distributed ActiveMatrix BPMSystem).

7. Override BPM Configuration Folder: Select this.

8. Configuration Folder: Enter the location of the configurationfolder on the shared file system. For example, SHARED_DIR\bpm_config - see Shared File System.

ActiveMatrix BPM NodeType: Summary 1. Select Create new ActiveMatrix BPM Server Node Type.

2. Click Configure.

Result


● starts a BPM node of the specified type on the specified TIBCO host instance.

● adds the new node to the specified ActiveMatrix environment (creating that environment ifnecessary).

● distributes the BPM application to the new node.

For example, in Example configuration for a distributed ActiveMatrix BPM System, BPMNode2 isstarted on BPMHost2. The BPMEnvironment is extended to include BPMNode2. The BPM applicationis distributed to BPMNode2.


Procedure


52


Adding an Additional ActiveMatrix BPM System to an Existing ActiveMatrixEnterprise

Multiple BPM Systems in the Same ActiveMatrix EnterpriseMultiple BPM systems (version 2.2 or later) can be installed in the same ActiveMatrix enterprise,administered by the same ActiveMatrix Administrator server (version 3.3 or later).

Every BPM system in an ActiveMatrix enterprise must already be at version 2.2 (or later) before you addanother BPM system to that enterprise.

You must upgrade any existing pre-version 2.2 BPM system in the enterprise to version 2.2 (or later)before adding an additional BPM system.

The following figure shows a simple example in which a development BPM system and a productionBPM system are installed in the same ActiveMatrix enterprise.

Example: Two separate BPM systems in a single ActiveMatrix Enterprise

Note the following points about this example:

53


In this example...In general, in the same ActiveMatrixEnterprise...

Development and production BPM systems areboth managed by the same ActiveMatrixAdministrator server.

Each ActiveMatrix host that hosts (any part of) aBPM system must be bound to the sameActiveMatrix Administrator server.

Development and production BPM systems arehosted on separate physical machines.

Multiple BPM systems can be hosted on thesame physical machine.

Development and production BPM systems bothuse the basic architecture (althoughActiveMatrix Administrator is hostedseparately).

Multiple BPM systems can use different (basic ordistributed) architectures as required.

Development and production BPM systems arehosted on separate ActiveMatrix Host instances.

TIBCO recommend that:

● each discrete BPM system is hosted on itsown set of TIBCO Host instances.

● ActiveMatrix Administrator is hosted on itsown set of TIBCO Host instances.

Development and production BPM systems usedifferent ActiveMatrix environments.

Multiple BPM systems can either share the sameActiveMatrix environment or use differentActiveMatrix environments:

● A shared environment allows each BPMsystem to access shared services, usingservice virtualization.

● Using separate environments allows eachBPM system to be completely isolated fromother BPM systems.

Development and production BPM systems arehosted on separate ActiveMatrix nodes.

Each BPM system must be hosted on a separate set ofActiveMatrix nodes.

The BPM application in the Development systemis called BPM_Dev_App.

The BPM application in the Production system iscalled BPM_Prod_App.

Each instance of a BPM application in the sameenvironment must have a unique name.

Development and production BPM databasesare hosted on the same database server.

Multiple BPM systems can use differentdatabase servers, and different types ofdatabase. (For example, one system may useOracle, another SQL Server.)

The same LDAP and SMTP servers are used byboth BPM systems.

Multiple BPM systems can either use the sameor separate LDAP or SMTP servers.

54


In this example...In general, in the same ActiveMatrixEnterprise...

The same EMS server is used by both BPMsystems.

BPM systems that share the same ActiveMatrixenvironment must use the same EMS server.

BPM systems in different ActiveMatrixenvironments can use different EMS servers.

The starting point for this procedure assumes that a (version 2.2 or later) development BPM system hasalready been installed, and that the ActiveMatrix Administrator server has been separately created.(See Creating an ActiveMatrix Administrator Server (Single or Replicated).)


Procedure


Production Machine: Installing ActiveMatrix BPM SoftwareTo install ActiveMatrix BPM on the Production machine, run the TIBCO Universal Installer on theProduction machine.

Procedure

1. Log on to the Production machine.



Screen Requirement




Production Machine: Configuring JDBC DriversYou must configure the JDBC drivers that ActiveMatrix BPM uses to access the ActiveMatrix BPMdatabase.

You can skip this task if the machine on which you want to install the new BPM system alreadycontains the appropriate configured JDBC driver.

Procedure

1. Make sure that the jar files for the required JDBC drivers are available on the production machine.(See JDBC Drivers.)


55


3. In the Create new configurations screen, run the Configure Third-Party Driver Wizard.

4. Configure the JDBC driver needed for the database server that will be used to host the ActiveMatrixBPM database.


Production Machine: Creating a Host InstanceTo create a host instance on the Production machine, run the Create TIBCO Host Instance wizard on theProduction machine.

Procedure



Screen Requirement

TIBCO Host InstanceConfiguration: Details 1. Enter a unique Name for this TIBCO Host instance.

2. Enter the ActiveMatrix Enterprise Name.

TIBCO Host instanceConfiguration:Administrator Server




Select:



Result

TIBCO Configuration Tool creates the specified TIBCO host instance (if it does not already exist),binding it to the ActiveMatrix Administrator server.

For example, in Example: Two separate BPM systems in a single ActiveMatrix Enterprise,BPM_Prod_Host is created on the Production machine and bound to the ActiveMatrix Administratorserver.

Production Machine: Creating a BPM NodeTo create a BPM node on the Production machine, run the Create TIBCO ActiveMatrix BPM Serverwizard on the Production machine.

Procedure



56


Screen Requirement


Enter the details of the database server that will be used to host theActiveMatrix BPM database for the new ActiveMatrix BPM system.(See Configuring the BPM Database Server.)

This can either be the same database server that is hosting any existingActiveMatrix BPM databases, or a different database server.


Enter the details of the ActiveMatrix BPM database for the newActiveMatrix BPM system.

ActiveMatrix BPM:Configuration

Change AMX-BPM Application Name to a unique name (not used byany other BPM system) in this ActiveMatrix environment.

ActiveMatrix BPM:LDAP Configuration

Select Use External LDAP Server and specify the connection details foran external LDAP server.


1. Select Use Existing ActiveMatrix Administrator Server.

2. Specify the details of the ActiveMatrix Administrator server beingused by the development BPM system.

ActiveMatrix BPM:Host and NodeConfiguration

1. Host: Enter the name of the TIBCO Host instance on which the BPMsystem will be created. This must be an existing host that is boundto the specified ActiveMatrix Administrator server (for example, in Example: Two separate BPM systems in a single ActiveMatrixEnterprise, BPM_Prod_Host).

2. Environment Name: Enter the name of the ActiveMatrixenvironment in which the BPM system will be created. This can beeither:

● a new environment (for example, in Example: Two separateBPM systems in a single ActiveMatrix Enterprise,BPMProdEnvironment), or

● an existing environment that is part of the ActiveMatrixenterprise managed by the specified ActiveMatrixAdministrator server.

3. Node Name: Enter a unique name for the ActiveMatrix node onwhich the BPM system will be created (for example, in Example:Two separate BPM systems in a single ActiveMatrix Enterprise,BPM_Prod_Node).

4. Node Management Port: Enter a unique port number.

57


Screen Requirement


Select Create ActiveMatrix BPM, then:


● If the string [Not Creating Database Instance] is appended tothe Create ActiveMatrix BPM action (indicating that you chose tomanually create the ActiveMatrix BPM database):



3. Get a database administrator to manually create the BPMdatabase - see Manually Running BPM Database UpgradeScripts.






Result


● creates and starts a BPM node (of type BPM Node) on the specified TIBCO host instance.

● adds the new node to the specified ActiveMatrix environment (creating that environment ifnecessary).

For example, in Example: Two separate BPM systems in a single ActiveMatrix Enterprise:

● BPM_Prod_Node is started on BPM_Prod_Host.● BPMProdEnvironment is created to include BPM_Prod_Node.


Procedure


58


Upgrading a Basic ActiveMatrix BPM SystemThis section describes how to upgrade a BPM system using a basic configuration (with all componentsinstalled on a single machine).

Performing Required Pre-Upgrade Tasks

Procedure

● Perform all required pre-upgrade tasks.

Installing ActiveMatrix BPM Software

Procedure

1. Log on to the primary machine.2. Stop the TIBCO Host instance.

For example, use the command:

CONFIG_HOME\tibcohost\Admin-ActiveMatrixEnterpriseName-ActiveMatrixServerName

\host\bin\tibcohost.exe stop -wait true

See "Stopping a TIBCO Host Instance" in TIBCO ActiveMatrix BPM - SOA Administration for moreinformation.

3. Run TIBCOUniversalInstaller to install ActiveMatrix BPM software.

Make sure that you complete the following screens/fields as shown.

Screen Requirement

Installation ProfileSelection

Select the Primary machine profile.

TIBCO InstallationHome

Select Use an existing TIBCO_HOME, then select the TIBCO_HOMElocation used by the existing installation.

Warning dialog If a Warning dialog appears, prompting you to re-install any existingfeatures, click NO.


See Installing ActiveMatrix BPM (TIBCO Universal Installer).

Upgrading the ActiveMatrix Administrator Server and ActiveMatrix BPM Application

Prerequisites

If you are running ActiveMatrix BPM on a Windows platform, make sure that the TIBCO Hostconfiguration folder, or any sub-folder or file in this folder’s hierarchy, is not currently locked byWindows. This folder is:


For example, a folder is locked if it is displayed in Windows Explorer or if a command shell is openwith the folder as the current directory.

59


If a folder or file in this hierarchy is locked, the upgrade will fail.

Procedure

1. On the primary machine, run TIBCO Configuration Tool (if you did not run it automatically whenyou finished installing ActiveMatrix BPM software).

2. In the TIBCO Configuration Folder dialog, select the existing CONFIG_HOME folder of theActiveMatrix BPM system that you want to upgrade, then click OK.

3. Run the Edit ActiveMatrix BPM > Upgrade or Downgrade TIBCO ActiveMatrix wizard. Makesure that you complete the following screens/fields as shown.

Screen Requirement

ActiveMatrixUpgrade Manager:Upgrade orDowngrade

Select Upgrade.

ActiveMatrixUpgrade Manager:Upgrade Options

Select Upgrade All TIBCO Hosts.

ActiveMatrixUpgrade Manager:Validate

Make sure that the specified CONFIG_HOME is shown as ELIGIBLE,then click Next.

ActiveMatrixUpgrade Manager:Upgrade Summary

1. Select all four options:

● Stop ALL TIBCO Hosts

● Upgrade ALL TIBCO Hosts

● Perform post-upgrade tasks

● Start ALL TIBCO Hosts

2. Click Upgrade.

3. Click Finish.

4. Run the Edit ActiveMatrix BPM > Upgrade TIBCO ActiveMatrix BPM Instance wizard. Make surethat you complete the following screens/fields as shown.

Screen Requirement

ActiveMatrix BPMUpgrade:Administrator ServerConfiguration

Enter the details of the ActiveMatrix Administrator server that managesthe BPM system that you want to upgrade.

60


Screen Requirement

ActiveMatrix BPMUpgrade: UpgradeConfiguration

1. In the ActiveMatrix BPM Upgrade Details section, enter theApplication Name and Environment Name of the BPM system thatyou want to upgrade.

2. In the ActiveMatrix BPM Shaed Configuration Folder section,select the existing CONFIG_HOME folder of the ActiveMatrix BPMsystem that you want to upgrade as the Configuration Folder.

ActiveMatrix BPMUpgrade: Summary

Select the Upgrade ActiveMatrix BPM Instance Application option.Then:

● If the string [Upgrading Database] is appended to the UpgradeActiveMatrix BPM Instance Application action (indicating that youchose to automatically upgrade the ActiveMatrix BPM database),click Configure.

● If the string [Not Upgrading Database Instance] is appended tothe Upgrade ActiveMatrix BPM Instance Application action(indicating that you chose to manually upgrade the ActiveMatrixBPM database), see Manually Upgrading the BPM Database forinformation about how to complete the configuration process.

Performing Required Post-Upgrade Tasks

Procedure

● Perform all required post-upgrade tasks.

Upgrading a Distributed ActiveMatrix BPM SystemThis section describes how to upgrade a BPM system using a distributed configuration.

Performing Required Pre-Upgrade Tasks

Procedure

● Perform all required pre-upgrade tasks.

Installing ActiveMatrix BPM SoftwareInstall ActiveMatrix BPM software on each machine used by the ActiveMatrix BPM system that youwant to upgrade.

Procedure


2. Stop the TIBCO Host instance.

For example, use the command:


\host\bin\tibcohost.exe stop -wait true

61


See "Stopping a TIBCO Host Instance" in TIBCO ActiveMatrix BPM - SOA Administration for moreinformation.

3. Run TIBCOUniversalInstaller to install ActiveMatrix BPM software. Make sure that youcomplete the following screens/fields as shown.

Screen Requirement

Installation ProfileSelection

Select the appropriate profile for the machine on which you areinstalling:

● Primary machine, on each machine that hosts an ActiveMatrixAdministrator server (main or replicated).

● Remote machine, on each machine that hosts a BPM node (of anytype), but not an ActiveMatrix Administrator server.

TIBCO InstallationHome

Select Use an existing TIBCO_HOME, then select the TIBCO_HOMElocation used by the existing installation.

Warning dialog If a Warning dialog appears, prompting you to re-install any existingfeatures, click NO.

Post-Install summary Clear Launch TIBCO Configuration Tool.

See Installing ActiveMatrix BPM (TIBCO Universal Installer).

4. Log on to the second primary machine (if there is one) and repeat steps 2 and 3.

5. Log on to each remote machine and repeat steps 2 and 3.

Upgrading the ActiveMatrix Administrator Server

Prerequisites

If you are running the ActiveMatrix Administrator server on a Windows platform, make sure that theTIBCO Host configuration folder, or any sub-folder or file in this folder’s hierarchy, is not currentlylocked by Windows. This folder is:




Procedure


2. Run TIBCO Configuration Tool.

3. In the TIBCO Configuration Folder dialog, select the CONFIG_HOME folder for the ActiveMatrixAdministrator server that you want to upgrade, then click OK.


62


Screen Requirement


Select Upgrade.


Select Select TIBCO Hosts to be upgraded.

ActiveMatrixUpgrade Manager:Upgrade Selection

Select the host that is running the ActiveMatrix Administrator server.









2. Click Upgrade.

5. If you are using a replicated ActiveMatrix Administrator server, log on to the second primarymachine and repeat steps 2 to 4 to upgrade that server as well.

Upgrading Runtime Hosts of Remote MachinesUpgrade the runtime hosts on each remote machine used by the ActiveMatrix BPM system that youwant to upgrade.

Prerequisites

If you are running the ActiveMatrix Administrator server on a Windows platform, make sure that theTIBCO Host configuration folder, or any sub-folder or file in this folder’s hierarchy, is not currentlylocked by Windows. This folder is:




Procedure

1. Log on to the remote machine.


63


3. In the TIBCO Configuration Folder dialog, select the CONFIG_HOME folder for the ActiveMatrixBPM system that you want to upgrade, then click OK.


Screen Requirement


Select Upgrade.


Select Select TIBCO Hosts to be upgraded.

ActiveMatrixUpgrade Manager:Upgrade Selection

Select the hosts that are running BPM nodes on this machine.









2. Click Upgrade.

5. Repeat steps 1 through 4 on every other remote machine used by the ActiveMatrix BPM system thatyou want to upgrade.

Upgrading the ActiveMatrix BPM ApplicationTo upgrade the ActiveMatrix BPM application, run the Upgrade TIBCO ActiveMatrix BPM Instancewizard on the primary machine.

Prerequisites

If you are running ActiveMatrix BPM on a Windows platform, make sure that the TIBCO Hostconfiguration folder, or any sub-folder or file in this folder’s hierarchy, is not currently locked byWindows. This folder is:




64


Procedure



3. In the TIBCO Configuration Folder dialog, select the existing CONFIG_HOME folder of theActiveMatrix BPM system that you want to upgrade, then click OK.

4. Run the Edit ActiveMatrix BPM > Upgrade TIBCO ActiveMatrix BPM Instance wizard. Make surethat you complete the following screens/fields as shown.

Screen Requirement

ActiveMatrix BPMUpgrade:Administrator ServerConfiguration

Enter the details of the ActiveMatrix Administrator server that managesthe ActiveMatrix BPM system that you want to upgrade.

ActiveMatrix BPMUpgrade: UpgradeConfiguration

In the ActiveMatrix BPM Upgrade Details section, enter theApplication Name and Environment Name of the BPM system thatyou want to upgrade.

ActiveMatrix BPMUpgrade: Summary

Select the Upgrade ActiveMatrix BPM Instance Application option.Then:

● If the string [Upgrading Database Instance] is appended to theUpgrade ActiveMatrix BPM Instance Application action(indicating that you chose to automatically upgrade theActiveMatrix BPM database), click Configure.

● If the string [Not Upgrading Database Instance] is appended tothe Upgrade ActiveMatrix BPM Instance Application action(indicating that you chose to manually upgrade the ActiveMatrixBPM database), see Manually Upgrading the BPM Database forinformation about how to complete the configuration process.

Performing Required Post-Upgrade Tasks

Procedure

● Perform all required post-upgrade tasks.

65


INSTALLATION AND UPGRADE PROCEDURES

The following sections provide detailed information about specific installation and upgradeprocedures. Which of these you need to use depends upon your particular installation/upgradescenario.

Preparing for Installation or UpgradeThere are tasks you may need to perform before installing or upgrading a BPM system.

The tasks you need to perform vary according to your installation/upgrade scenario.

Use the information in this section in the context of your particular installation/upgrade scenario. See I -INSTALLATION AND UPGRADE SCENARIOS.

Checking For Any Late-Breaking InformationCheck if there are any restrictions, known issues, or other late-breaking information that may affectyour installation, but that were not known about when this document was published.

Procedure

1. Read the Release Notes and Readme documents for this version of the ActiveMatrix BPM software.

If you are upgrading, pay particular attention to the "Migration Issues" section in theRelease Notes.

These documents are available from:

● the TIBCO Software Product eDelivery Site (http://edelivery.tibco.com/).

● the TIBCO Product Documentation site (https://docs.tibco.com/). Select the appropriate Versionstab.

2. Consult the Late Breaking News section of TIBCO Support Central (at https://support.tibco.com).

Checking the System RequirementsMake sure that the following meet all the requirements described in System Requirements:

● the machines on which you wish to install the BPM system.

● any supporting infrastructure.

Configuring TIBCO Enterprise Message ServiceActiveMatrix BPM uses TIBCO Enterprise Message Service for notification and messaging. A supportedversion of TIBCO Enterprise Message Service must be installed.

If TIBCO Enterprise Message Service is currently:

● not installed, you must install it before you install ActiveMatrix BPM.

● installed, you may need to upgrade it before you install or upgrade ActiveMatrix BPM. See theActiveMatrix BPM Readme to see which versions of TIBCO Enterprise Message Service aresupported.

66



https://docs.tibco.com/


Procedure

1. If necessary, install or upgrade TIBCO Enterprise Message Service according to the instructions inthe product’s Installation and Configuration guide.

TIBCO Enterprise Message Service does not have to be installed on the same machine as aTIBCO ActiveMatrix BPM system. (You will specify the connection details needed tocontact the EMS Server as part of the configuration process. See Administrator ServerConfiguration: Notification and Messaging Bus Server.)

2. If the TIBCO Enterprise Message Service server user does not have administrator privileges,reconfigure the server as described in Configuring TIBCO Enterprise Message Service Servers.

3. Make sure that the TIBCO Enterprise Message Service server is running.

On Windows, if you manually start the TIBCO Enterprise Message Service server, makesure that you use the same configuration files as the Windows service. Use the followingcommand:

TIBCO_HOME\ems\version number\bin\tibemsd -config EMS_CONFIG_HOME\tibco

\cfgmgmt\ems\data\tibemsd.conf

where EMS_CONFIG_HOME is the configuration directory for TIBCO Enterprise MessageService.

4. Make sure that the clocks of all machines within the same enterprise are synchronized to within 30minutes of each other.

You can run an NTP synchronization daemon on each machine to achieve synchronization.

5. If you intend to enable SSL communications, make sure that the TIBCO Enterprise Message Serviceserver is enabled with SSL and configured with a certificate file that contains both the server andissuer certificates.

Creating the External ActiveMatrix Administrator DatabaseCreate the database that is used to store the ActiveMatrix Administrator database tables.

You only need to perform this task if you intend to create an ActiveMatrix Administrator server. Youcan skip this task if you intend to use an existing ActiveMatrix Administrator server.

You will identify this database using the Database URL field in the Administrator ServerConfiguration: Database Details screen when you run the Create TIBCO ActiveMatrix BPM ServerWizard or Create TIBCO ActiveMatrix Administrator Server Wizard.

See:

● Creating the ActiveMatrix Administrator Database Using SQL Server

● Creating the ActiveMatrix Administrator Database Using Oracle

● Creating the ActiveMatrix Administrator Database Using DB2

These procedures briefly describe what you need to do on the database server, but do not describe indetail how to perform each task. If necessary, you should work with your database administrator toperform these tasks.

67


Creating the ActiveMatrix Administrator Database Using SQL Server

Create a SQL Server database, configure it, and create a database user to access it.

Procedure

1. Create an empty database which will be used to hold the ActiveMatrix Administrator databasetables - for example, amx.

The ActiveMatrix BPM database (for each BPM system) and ActiveMatrix Administratordatabase can, if desired, use the same SQL Server database instance.

2. Enable snapshot isolation by setting the ALLOW_SNAPSHOT_ISOLATION ON database option.

For example, use the following statements:

ALTER DATABASE DatabaseName

SET READ_COMMITTED_SNAPSHOT ON

3. Create a database user (or identify an existing one) for the system to use to connect to theActiveMatrix Administrator database - for example, amx_db_user. This user:

● must be a member of the db_owner role for this database

● must have this database assigned as their default database.

You will specify this user in the Username field of the Administrator Server Configuration:Database Details screen when you run the Create TIBCO ActiveMatrix BPM Server Wizard or Create TIBCO ActiveMatrix Administrator Server Wizard.

4. Ensure that the database is set to use case insensitive (CI) collation.

5. Make sure that the database is available.

Creating the ActiveMatrix Administrator Database Using Oracle

Create an Oracle database and create a database user to access it.

Procedure

1. Create an empty database which will be used to hold the ActiveMatrix Administrator databasetables - for example, amx.

The ActiveMatrix BPM database (for each BPM system) and ActiveMatrix Administratordatabase must use separate Oracle database users/schemas. Use of separate tablespaces isalso advised.

2. Set the OPEN_CURSORS initialization parameter to a value of 400 or greater.

3. Create a database user (or identify an existing one) for the system to use to connect to theActiveMatrix Administrator database - for example, amx_db_user. This user:

● must not possess "dba" privileges.

● must have "connect" and "resource" privileges.

● must be assigned to the default schema.



68


Creating the ActiveMatrix Administrator Database Using DB2

Create a DB2 database, configure it, and create an operating system user account to access it.

Procedure

1. Create a new, empty database that will be used to hold the ActiveMatrix Administrator databasetables - for example, amx.

The ActiveMatrix BPM database tables (for each BPM system) and ActiveMatrixAdministrator database tables must be stored in separate databases.

2. Set the database page size to 32768.

3. Make sure that the DB2 cur_commit database configuration parameter is set to ON.

4. Create an operating system user account for the system to use to connect to the ActiveMatrixAdministrator database - for example, amx_db_user. (Alternatively, you can identify an existingoperating system account to use.)



Configuring the BPM Database ServerConfigure the external database server that is used to store the ActiveMatrix BPM database.

When you run the Create TIBCO ActiveMatrix BPM Server Wizard, TIBCO Configuration Tool willeither create the BPM database for you, or generate the necessary scripts that a database administratorcan use to create the database.

See:

● Configuring the BPM Database Server Using SQL Server

● Configuring the BPM Database Server Using Oracle

● Configuring the BPM Database Server Using DB2

These procedures briefly describe what you need to do on the database server, but do not describe indetail how to perform each task. If necessary, you should work with your database administrator toperform these tasks.

Configuring the BPM Database Server Using SQL Server

Create a SQL Server instance, configure it, and restart it.

Procedure

1. Create a SQL Server instance that will be used to hold the ActiveMatrix BPM database.

The ActiveMatrix BPM database (for each BPM system) and ActiveMatrix Administratordatabase can, if desired, use the same SQL Server instance.

2. Configure the SQL Server instance to use mixed (Windows and SQL Server) authentication.

3. Enable the TCP/IP network protocol for the SQL Server instance.

For example:a) In SQL Server Configuration Manager, expand SQL Server Network Configuration.

69


b) Click Protocols for instance_name where instance_name is the name of the SQL Server instance.c) Right-click TCP/IP and click Enable.

4. Enable support for XA transactions.To do this:a) Download and install the Microsoft SQL Server JDBC Driver. See JDBC Drivers for details of

supported versions.b) Copy the extended stored procedure dll (sqljdbc_xa.dll) from the location where you

installed the Microsoft SQL Server JDBC Driver to the SQL Server instance's Binn folder.

For example, copy the dll to:

C:\Program Files\Microsoft SQL Server\MSSQL10.MSSQLSERVER\MSSQL\Binn

c) Run SQL Server Management Studio as an administrator of the SQL Server instance.d) From the location where you installed the Microsoft SQL Server JDBC Driver, run the

sqljdbc_n.n\enu\xa\xa_install.sql script against the master database, where n.n is theversion number of the Microsoft SQL Server JDBC Driver you are using.

The first time you run this you may see errors about failing to drop procedures. Theseerrors may be ignored as the procedures do not exist yet.

e) Click Control Panel > Administrative Tools .f) Double-click Component Services.g) Right-click Component Services > Computer > My Computer > Distributed Transaction > Local

DTC and select Properties.h) Click Security. Select Enable XA transactions.

5. Restart the SQL Server instance.

Configuring the BPM Database Server Using Oracle 12c

Create an Oracle database instance (including a pluggable database for BPM), configure it, and start it.

Procedure

1. Create an Oracle database instance that will be used to hold the ActiveMatrix BPM database.You must create a pluggable database (PDB) in your container database (CDB) for BPM to use. Thisis because BPM users have exclusive rights to perform actions; if you install ActiveMatrix BPM onthe CDB, BPM users have exclusive rights to perform actions on the CDB.

The ActiveMatrix BPM database (for each BPM system) and ActiveMatrix Administratordatabase must use separate Oracle database users/schemas. Use of separate tablespaces isalso advised.

2. Set the OPEN_CURSORS initialization parameter to a value of 400 or greater.

3. Configure the character sets for the Oracle database instance as follows: NLS_CHARACTERSETmust be AL32UTF8 and NLS_NCHAR_CHARACTERSET must be AL16UTF16.

4. Start the Oracle database instance.After the startup of the CDB, the PDBs are not opened automatically. You must make sure that thePDB on which BPM is running is opened after startup. For more information, please refer to thedocumentation supplied with Oracle12c.

70


Configuring the BPM Database Server Using DB2

Create a DB2 database, configure it, and start it.

Procedure

1. Create a new, empty database that will be used to hold the ActiveMatrix BPM database tables.

You will specify this database name as part of the URL field in the ActiveMatrix BPM: DatabaseAdministrator and ActiveMatrix BPM: Runtime Database Configuration screens when you run the Create TIBCO ActiveMatrix BPM Server Wizard.

The ActiveMatrix BPM database tables (for each BPM system) and ActiveMatrixAdministrator database tables must use separate databases.

2. Set the database page size to 16384.

3. Make sure that the DB2 cur_commit database configuration parameter is set to ON.

4. Make sure that the SYSTOOLSPACE tablespace exists. If it does not, create it. Some BPMinstallation scripts require access to this tablespace.

5. Create a suitable 32K temporary tablespace.

For example:

db2 "CREATE BUFFERPOOL tbsp_pool PAGESIZE 32K"

db2 "CREATE SYSTEM TEMPORARY TABLESPACE tmp_tbsp PAGESIZE 32K MANAGED BY SYSTEM

USING ('/tmp/tmp_tbsp') BUFFERPOOL tbsp_pool"

6. Create an operating system user account for the BPM system to use to connect to the BPM database- for example, bpmuser. (Alternatively, you can identify an existing operating system account touse.)

You will specify this user in the Username field of the ActiveMatrix BPM: Runtime DatabaseConfiguration screen when you run the Create TIBCO ActiveMatrix BPM Server Wizard.

7. Start the database.

Creating a Database to Hold the BDS Case Data Store (DB2 Only)Create a DB2 database and create a database user to access it.

You only need to perform this task if you intend to host the BDS case data store on a separate DB2database to the ActiveMatrix BPM database.

You can skip this task if you intend to host the BDS case data store in the ActiveMatrix BPM database,or if you intend to use a separate BDS database on a platform other than DB2 (in that case, the databaseis created automatically).

Procedure

1. Create an empty database which will be used to hold the BDS case data store - for example, cds.

2. Create a database user (or identify an existing one) for the BPM system to use to connect to thisdatabase - for example, bpm_cds_user. Make sure that the user exists in the database. Make surethat the database is available.

71


Setting up a Content Management SystemIf you want to use a content management system (CMS) for the Business Data Services case folderfeature, choose a suitable CMS and make a note of the CMS details for configuring ActiveMatrix BPMduring installation.

Procedure

1. Choose a CMS that is CMIS 1.0-compliant.

2. Make a note of the path of the CMS folder that will be the ActiveMatrix BPM root folder, underwhich all the case folder data will be stored. If a suitable folder does not exist, create one.

3. Make a note of the following CMS details:

● ID of the main repository within the CMS that is to be connected to

● Name and password of the administrator user for authenticating against the CMIS URL

Configuring the External LDAP Directory ServerIf you are installing a system that is intended for production use (generally a Distributed BPM System),you must use an external LDAP directory server.

● Make sure that:

● the LDAP server is running.

● an LDAP directory on this LDAP server contains the user that you want to use as the tibco-admin user.

This LDAP directory may also hold details of other LDAP users who may need to login to ActiveMatrix BPM, but it does not have to. You can configure additional LDAPconnections to other LDAP directories as a post-installation task - see Creating AnyOther Required LDAP Connections to LDAP Directories .

● the user that you want to use as the tibco-admin user has at least read access to the LDAPdirectory that you intend to use.

You will use this information in the ActiveMatrix BPM: LDAP Configuration screen when you runthe Create TIBCO ActiveMatrix BPM Server Wizard.

Configuring System Parameters on UNIX or Linux PlatformsIf you are installing on a Linux or UNIX platform, you must configure the platform for runningActiveMatrix BPM.

You must:

● install 3 additional packages. You can use yum to install the following packages:

— glibc.i686

— libstdc++.so.5

— compat-libstdc++-33-3.2.3-72. el7.x86_64

● set the maximum number of open files/file descriptors, as described below.

Procedure

1. Set the maximum number of open files/file descriptors.

72


The maximum number of open files/file descriptors that a user can open is controlled by theoperating system. However, the default threshold on Linux systems is typically too low and has tobe increased.

TIBCO recommend that you set the system-wide, hard limit to a value of at least 10000, on eachmachine that will be part of the ActiveMatrix BPM system.

2. If you are using IBM AIX v6.x or v7.x, make sure that the system-wide, soft limit for the data userprocess resource is set to a value of at least 512Mb. If this limit is set to a lower value, theActiveMatrix system node and any BPM nodes will fail to start, with an OutOfMemory Nativememory exhausted error.

The following is an example of how you can set this value:a) Log in as root and run the following command:

$ chuser data=1048576 root

where 1048576 is the number of 512-byte blocks needed.b) Log in as the BPM user and run the following command (as the root user):

$ ulimit -Sd

Configuring Apache AntOn each machine that will be part of the ActiveMatrix BPM system, configure Apache Ant.

Procedure

1. Create an environment variable that points to TIBCO_HOME.

2. Open a command window.

3. Run the following commands:

On Windows

set JAVA_HOME=%TIBCO_HOME%\tibcojre64\1.8.0

set CLASSPATH=%TIBCO_HOME%\tools\lib\antpackage.jar

set RUN_ANT="%JAVA_HOME%/bin/java" -cp "%CLASSPATH%" org.apache.tools.ant.Main

set ANT_OPTS=-Xmx1024m -Xms256

On UNIX/Linux

JAVA_HOME=$TIBCO_HOME/tibcojre64/1.8.0

CLASSPATH=$TIBCO_HOME/tools/lib/antpackage.jar

RUN_ANT="$JAVA_HOME/bin/java -cp $CLASSPATH org.apache.tools.ant.Main"

ANT_OPTS="-Xmx1024m -Xms256"

export JAVA_HOME RUN_ANT ANT_OPTS

Downloading Required Third-Party Software AssembliesIf the machine on which you will be running the ActiveMatrix BPM installer does not have internetaccess, you must download third-party LGPL software assemblies before you install ActiveMatrixBPM.

The required assemblies are:

● Hibernate

● Eclipse SWT GTK module (only required if you are installing on a Linux or Solaris platform)

73


● Oracle Java 8 Elliptic Curve Cryptography (ECC) library (only required if you are installing on aLinux, Solaris or Windows platform)

You will make these assemblies available to the ActiveMatrix BPM installer as part of the installationprocess. (See Installing ActiveMatrix BPM (TIBCO Universal Installer).)

Procedure

1. Locate the required assemblies from the TIBCO Software Product eDelivery Site.a) Log into eDelivery -- http://edelivery.tibco.com/.b) Search for, and select, TIBCO ActiveMatrix BPM.c) Click Download.d) Select the version and operating system.e) Accept the TIBCO End User License Agreement.f) Select Individual file download.g) Expand "TIBCO ActiveMatrix BPM Software (version)".

2. Download Hibernate(TIB_assembly_tibco_com_tibco_tpcl_org_hibernate_feature_3.2.500.002_all.html).

3. Save the .zip file to a temporary directory accessible to the machine on which you will be runningthe ActiveMatrix BPM installer.

4. If you are installing on a Linux or Solaris platform:a) Download the Eclipse SWT GTK module for your platform

(TIB_product_tibco_eclipse_lgpl_rcp_4.4.2.001_platform_64.html).b) Save the .zip file to a temporary directory accessible to the machine on which you will be

running the ActiveMatrix BPM installer.

5. If you are installing on a Windows, Linux or Solaris platform:a) Download the Oracle ECC library for your platform

(TIB_product_tibco_sunec_1.8.0.192_platform_64.html).b) Save the .zip file to a temporary directory accessible to the machine on which you will be

running the ActiveMatrix BPM installer.

Downloading ActiveMatrix BPM SoftwareDownload ActiveMatrix BPM from the TIBCO download site to the machine on which you are going toinstall it.

Procedure

1. Sign in to the TIBCO Software Product eDelivery Site (http://edelivery.tibco.com/).

2. Download the TIBCO ActiveMatrix BPM software package for your platform.

3. Extract the ActiveMatrix BPM archive file to a temporary, empty directory on the machine on whichyou will be running the ActiveMatrix BPM installer.

On a Linux system, open a terminal window and use the unzip command to unzip thefile. Do not double-click the archive file to extract it - doing so may cause a problem if youtry to launch TIBCO Configuration Tool after running the installer.

Backing Up the Existing ActiveMatrix BPM SystemBack up the existing ActiveMatrix BPM system before upgrading it. Depending on your operationalrequirements, you can take an offline or online backup:

74




● An offline backup requires you to shut down the ActiveMatrix enterprise that hosts theActiveMatrix BPM system. You cannot use the ActiveMatrix BPM system until the backup hascompleted and you have restarted the system.

● An online backup requires you to suspend the ActiveMatrix Enterprise that hosts the ActiveMatrixBPM system, but you do not need to shut down the ActiveMatrix BPM system. You can continue touse theActiveMatrix BPM system while the online backup is being performed. (This allows you totake a backup if your operational requirements do not allow for a suitable window in which toperform an offline backup.)

See "Backing up and Restoring the ActiveMatrix BPM System" in ActiveMatrix BPM Administration formore information about these backup types and how to perform them.

Do not take a backup of the ActiveMatrix BPM system without first either shutting down (to take anoffline backup) or suspending (to take an online backup) the ActiveMatrix enterprise. Taking a backupof a running ActiveMatrix BPM system while the ActiveMatrix enterprise is unsuspended can result inconflicts between the states of BPM applications as recorded in the backups of the CONFIG_HOME filesystem and the ActiveMatrix Administrator database. For example, an application's state could berecorded as READY_FOR_UNDEPLOY in the backup of the file system, but asPREPARING_FOR_UNDEPLOY in the backup of the ActiveMatrix Administrator database. If theActiveMatrix BPM system were subsequently restored from this backup set, these conflicts may resultin stuck or failed applications or process instances on the restored system.

Removing any Indexes Added to the BPM DatabaseIf you are upgrading an existing ActiveMatrix BPM system, you must remove any indexes that youhave added to your ActiveMatrix BPM database.

This is because, as part of the upgrade, a new database schema is supplied that may include newindexes. If the new indexes have the same name as your original indexes, this could result in duplicateindexes which, in turn, would adversely affect the performance of TIBCO ActiveMatrix BPM.

Backing Up Openspace CustomizationsIf you are upgrading an existing ActiveMatrix BPM system, you should back up any TIBCO Openspacecustomizations that you have made.

Procedure

1. Back up any Openspace configuration files that you have changed under the following location:

CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\host\plugins

\com.tibco.openspace.login_version\resources

See TIBCO Openspace Customization Guide for more information.

After completing the upgrade, you will need to replace the installed configuration files with thebacked up configuration files.

The location of the Openspace resources folder changed in ActiveMatrix BPM version 2.2to:

CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\data_version

\host\plugins\com.tibco.openspace.login_version\resources

2. If you have changed the configuration of the Standard persona (themes, layouts, tabs and/orgadgets), make a note of the changes. The upgrade process resets the Standard personaconfiguration to be the same as the Default persona. You will therefore need to re-apply yourchanges to the Standard persona after completing the upgrade.

75


Backing up Customized Example Applications in Application DevelopmentAs part of the upgrade process, the example applications and bundled applications included inApplication Development are overwritten with new versions. If you have made any changes to theseapplications, you need to make a backup of them so that you can re-implement those changes in theupgraded versions.

For example, to use the Case Management application (or Mobile Case Manager application), you mustmodify the application's caseMgtAppName.config.json file to include the details of a case model thatis available on the ActiveMatrix BPM system. That file will be overwritten as part of the upgrade, so ifyou have modified it and want to retain the changes on the upgraded system, you should take abackup.

You do not need to do this for any clones you have made of the example applications and bundledapplications.

Procedure

● Back up any files that you have changed in:

● the example applications - Workapp, Case Management, Mobile Case Manager, ComponentShowcase.

● the bundled applications - Open Work Item, Start Biz Action.

Backing Up WorkspaceIf you are running the default Workspace application, and upgrading ActiveMatrix BPM, you may needto back up the Workspace configuration files prior to the upgrade.

When you upgrade ActiveMatrix BPM, the installer overwrites all of the existing configuration files forthe default Workspace application on the runtime machine. Whether or not you need to back up theseconfiguration files prior to upgrading ActiveMatrix BPM depends on how the default Workspaceapplication was configured, as follows:

● If you had made configuration changes to the default Workspace application using theConfiguration Administrator, these changes are saved in the database. Consequently, you do NOTneed to back up the Workspace configuration files prior to upgrading ActiveMatrix BPM. When youstart the default Workspace application after upgrading, the configuration is read from the database.

● If you had made configuration changes to the default Workspace application by directly modifyingfiles on the runtime machine (for example, config.xml, userAccess.xml, and so on), you mustback up those files prior to running the ActiveMatrix BPM installer. After completing the upgrade,replace the installed configuration files with the backed up configuration files.

For information about the location of the Workspace configuration files, see the TIBCO WorkspaceConfiguration and Customization guide.

Upgrading ActiveMatrix BPM has NO impact on configuration files for custom WCC applications onyour runtime machine. Therefore, you do not need to back up custom WCC application configurationfiles prior to upgrading ActiveMatrix BPM.

However, new releases of ActiveMatrix BPM are typically accompanied by a new release of TIBCOBusiness Studio. If you upgrade TIBCO Business Studio on a development machine, a post-upgradetask is to redeploy any custom WCC applications to the runtime machine so that the applications canmake use of new features. For information about this, see the TIBCO Business Studio Installation guide.

76


Installing ActiveMatrix BPM (TIBCO Universal Installer)You install ActiveMatrix BPM on a machine by using the TIBCO Universal Installer.

How, when and where you need to install ActiveMatrix BPM software depends on your installation/upgrade scenario.


TIBCO Universal Installer: Installation ModesYou can install ActiveMatrix BPM on a machine using one of three installation modes.

These are:

● GUI mode - presents a series of screens that allow you to make choices about product selection,product location, and so on. To invoke the installer in GUI mode, double-click the executable. See Running TIBCO Universal Installer in GUI Mode.

● Console mode - allows you to run the installer on the command line. This is useful if your machinedoes not have a GUI environment. See Running TIBCO Universal Installer in Console mode.

● Silent mode - installs the product using either default or custom settings that are saved in aresponse file and does not prompt for inputs. See Running TIBCO Universal Installer in SilentMode.

For ease of explanation, the instructions for the specific scenario in part I assume the use of GUI mode.You can instead use console mode or (where appropriate) silent mode.

Deciding Whether to Use a New or Existing Installation EnvironmentBefore installing ActiveMatrix BPM, you must decide whether to install it into an existing installationenvironment or into a new installation environment separate from other TIBCO products.

TIBCO recommends the following:

● If you are upgrading an existing installation of TIBCO ActiveMatrix BPM, use the existingTIBCO_HOME.

● If you are installing TIBCO ActiveMatrix BPM to work together with other TIBCO products that arealready installed, such as TIBCO ActiveMatrix BusinessWorks Service Engine, and to share the sameTIBCO Administrator as these products, then use the existing TIBCO_HOME in which these productsare installed.

● If you are installing TIBCO ActiveMatrix BPM for the first time, and either there will be no otherTIBCO products that share TIBCO Administrator or else you have not yet installed any suchproducts, then select a new TIBCO_HOME.

JRE Used by TIBCO Universal InstallerThe JRE (Java Runtime Environment) that is used by TIBCO Universal Installer depends on whetheryou are installing or upgrading ActiveMatrix BPM on a Windows or non-Windows system.

TIBCO Universal Installer is bundled with its own JRE. It may use that JRE, or one already on thesystem, as described below.

● Windows - When installing or upgrading ActiveMatrix BPM on a Windows system, TIBCOUniversal Installer uses the bundled JRE by default. However, you can specify that a different JREbe used when invoking TIBCOUniversalInstaller from the command line.

To specify that a different JRE be used, invoke TIBCOUniversalInstaller using the followingswitch: -is:javahome path_to_jre

77


● Non-Windows - When installing or upgrading ActiveMatrix BPM on a non-Windows system,TIBCO Universal Installer searches for a suitable pre-installed JRE to use. It looks in the followingfor a JRE to use: PATH, JDK_HOME, JAVAHOME, JAVA_HOME, /opt, and /usr. If it cannot find asuitable JRE in those locations, it uses the JRE bundled with TIBCO Universal Installer.

Part of TIBCO Universal Installer's job is to install/update the JRE for the target TIBCO_HOME. If,during its search for a suitable JRE, it chooses the JRE already used by TIBCO_HOME (for example,the JAVA_HOME environment variable was set to JAVA_HOME=TIBCO_HOME/tibcojre64/1.8.0),you could get a "File in use" error when running TIBCO Universal Installer. The reason is that theinstaller is trying to update the JRE that it is using. In this situation, you can specify that the TIBCOUniversal Installer forego the search for a JRE, and use the bundled one. This is done using thefollowing switch when invoking TIBCOUniversalInstaller:-is:skipJVMSearch

Running TIBCO Universal Installer in GUI ModeTo install ActiveMatrix BPM by making choices in a series of dialog box screens, run TIBCO UniversalInstaller in GUI mode.

Procedure

1. Navigate to the temporary directory containing the extracted ActiveMatrix BPM archive file. (See Downloading ActiveMatrix BPM Software.)

2. Run TIBCOUniversalInstaller.

On a Linux system, run TIBCOUniversalInstaller from the command line. Do notdouble-click the file to run it - doing so may cause a problem if you try to launch TIBCOConfiguration Tool after running the installer.

3. Read through the license agreement, select I accept the terms of the license agreement, and clickNext.

4. Choose a new installation environment (TIBCO_HOME) or an existing installation environment, asdescribed in Deciding Whether to Use a New or Existing Installation Environment:

● For a new installation environment, select Create a New TIBCO_HOME. Specify theproperties:

Directory The directory into which the product is installed. The directory cannot bethe same as the directory of an existing installation environment.

Accept the default location, type a directory, or click Browse to choose thedirectory. The directory path cannot contain special characters such as "*","#", "?", ">", "<", "%", "&", "$", "`" or "|".

Name Identifies the installation environment. The installer automatically createsa default environment name for the location you specify, which is amx-bpm.

The name cannot contain special characters such as "*", "?", ">", "<", ":", "|","/", "\", or quotes (").

● For an existing installation environment, select Use an Existing TIBCO_HOME. Select thehome from the drop-down list.

5. Click Next.

6. In the Installation Profile Selection screen, select:

78


● Primary machine, if you are installing BPM software on a machine that will (or does already)host an ActiveMatrix Administrator server (whether or not it also hosts any BPM nodes).

● Remote machine, if you are installing BPM software on a machine that will (or does already)host a BPM node (of any type) but not an ActiveMatrix Administrator server.

7. In the TIBCO Configuration Directory screen, select the directory where configuration informationfor this BPM system will be stored (CONFIG_HOME). Make sure that the selected directory is not theconfiguration directory for another TIBCO installation environment.

You will now need to accept license agreements for third-party LGPL assemblies that arerequired by the installer, and make those assemblies available to the installer.

8. Click Next. An LGPL License Agreement screen appears - this is for Hibernate.

9. Read the text and click I accept the terms of the license agreement, then click Next. If the Hibernatesoftware assembly is not already in the assemblies subdirectory of your temporary directory, theDownload Hibernate screen appears. Choose either:

● Download Hibernate assembly from TIBCO to let the installer download the Hibernateassembly from TIBCO. Click Next. The installer downloads the assembly to the assembliessubdirectory of the temporary directory containing the extracted ActiveMatrix BPM archivefile.

● Select the Hibernate assembly previously downloaded from TIBCO to select the location of apreviously downloaded Hibernate assembly that the installer can use (see DownloadingRequired Third-Party Software Assemblies). Click Next.

10. If you are installing on a Linux or Solaris platform, an LGPL License Agreement screen appears -this is for the Eclipse SWT GTK module. Accept the license agreement and download or select theassembly in the same way that you did for Hibernate. (Note that the Download screen refers to theEclipse GNOME Binding assembly.)

11. If you are installing on a Windows, Linux or Solaris platform, an LGPL License Agreement screenappears - this is for the Oracle Elliptic Curve Cryptography library. Accept the license agreementand download or select the assembly in the same way that you did for Hibernate.

12. In the Pre-Install Summary screen, verify the list of products selected for installation, then clickInstall.

13. When the Post-Install Summary screen is displayed:a) Review the list of products that have been installed.b) Select or Clear Launch TIBCO Configuration Tool, as appropriate for your particular

installation/upgrade scenario and stage.c) Click Finish to complete the installation process and close the installer window.

Running TIBCO Universal Installer in Console modeTo install ActiveMatrix BPM from the command line, run TIBCO Universal Installer in console mode.

Procedure

1. Open the physical media or download the TIBCO ActiveMatrix BPM package.

2. Extract the archive file to a temporary directory.

3. Using a console window, navigate to the temporary directory.

4. Run TIBCOUniversalInstaller -console.

5. Complete the installation by responding to the console window prompts.

6. Once the installation completes, you can create the TIBCO ActiveMatrix BPM server and TIBCOActiveMatrix Administrator server using TIBCO Configuration Tool (TIBCO Configuration Tool).See Configuring ActiveMatrix BPM Runtime Objects (TIBCO Configuration Tool) for details.

79


Running TIBCO Universal Installer in Silent ModeTo install ActiveMatrix BPM using either default or custom settings that are saved in a response file,run TIBCO Universal Installer in silent mode.

In silent mode, the universal installer does not prompt for any inputs during installation. Instead, theinstaller uses the values specified in the TIBCOUniversalInstaller-amx-bpm_n.n.n.silent file.

The TIBCOUniversalInstaller-amx-bpm_n.n.n.silent file is packaged in the directory that containsthe universal installer. Edit the file with information for your environment before launching the silentinstallation, as explained below.

Procedure

1. Download the TIBCO ActiveMatrix BPM package.

2. Extract the contents of the package to a temporary directory.

3. Using a console window, navigate to the temporary directory.

4. Make a backup copy of the TIBCOUniversalInstaller-amx-bpm_n.n.n.silent file.

5. Using a text editor, open the TIBCOUniversalInstaller-amx-bpm_n.n.n.silent file and specifythe required entry keys. Refer to the comments in the file for a description of each entry key.

Make sure that all drive letters are specified in upper case, otherwise the silent installationmay fail.

6. Run the command:

TIBCOUniversalInstaller.exe -silent

Result

When installation completes, a line similar to the following is written to the installer log file:

Install, com.tibco.installer.util.TIBCOInstaller, dbg.Debug, The installation has

completed. Please check the log file for additional information.

Configuring ActiveMatrix BPM Runtime Objects (TIBCO Configuration Tool)You configure ActiveMatrix BPM runtime objects by using the TIBCO Configuration Tool.

How, when and where you need to use TIBCO Configuration Tool depends on your installation/upgrade scenario.


TIBCO Configuration Tool: Configuration ModesYou can configure ActiveMatrix BPM runtime objects on a machine using one of three configurationmodes.

These are:

● GUI mode - presents a number of different wizards. Each wizard allows you to enter the necessaryconfiguration data, then choose and execute the relevant configuration actions. You can also save theconfiguration data for subsequent editing and use in silent mode. See Running TIBCOConfiguration Tool in GUI Mode.

● Console mode - presents a number of different menus and pages that you can use from thecommand line. (These menus and pages correspond to the wizards and screens provided in GUImode.) Each menu allows you to enter the necessary configuration data, then choose and execute

80


the relevant configuration actions. You can also save the configuration data for subsequent editingand use in silent mode. See Running TIBCO Configuration Tool in Console Mode.

● Silent mode - allows you to run a particular TIBCO Configuration Tool wizard without any userinteraction, using configuration data saved (and subsequently edited as required) from an earlierGUI or console mode session. See Running TIBCO Configuration Tool in Silent Mode.

For ease of explanation, the instructions for specific installation or upgrade scenarios (see I -INSTALLATION AND UPGRADE SCENARIOS) assume the use of GUI mode. You can instead useconsole mode or (where appropriate) silent mode.

TIBCO Configuration Tool Log FilesWhen you run a TIBCO Configuration Tool wizard to perform a particular configuration task, log filesare created. Examining the files may help you if you have a problem when running a TIBCOConfiguration Tool wizard.

The log files are stored under the folder specified in the Session Scripts and Log Folder field of thewizard’s Summary screen.

By default this folder is:

CONFIG_HOME\tct\wizardID\timestamp

where wizardID is one of the values in the following table.

wizardID Wizard

tpclshells Configure Third-Party Driver Wizard

bpm Create TIBCO ActiveMatrix BPM Server Wizard

admin Create TIBCO ActiveMatrix Administrator Server Wizard

tibcohost Create TIBCO Host Instance Wizard

bpmnodetype Configure TIBCO ActiveMatrix BPM Server Node Type Wizard

admin.replicate Replicate TIBCO ActiveMatrix Administrator Server Wizard

bpmedit Edit TIBCO ActiveMatrix BPM Instance Wizard

bpmupgrade Upgrade TIBCO ActiveMatrix BPM Instance Wizard

bpmdelete Delete TIBCO ActiveMatrix BPM Instance Wizard

admin.editor Edit TIBCO ActiveMatrix Administrator Server Configuration Wizard

The logs sub-folder contains a separate log file for each configuration action executed by TIBCOConfiguration Tool. Log files are created when you click Save or Configure from a wizard screen.

Running TIBCO Configuration Tool in GUI ModeTo configure ActiveMatrix BPM runtime objects by running a wizard and entering configuration data ina series of dialog box screens, run TIBCO Configuration Tool in GUI mode.

Prerequisites

If you are using an HP-UX (64-bit)/Itanium platform, make sure that the external libraries listed in Required External Libraries on an HP-UX (64-bit) Itanium Platform are installed on the machine on

81


which you are trying to run TIBCO Configuration Tool. If any of these libraries are missing, TIBCOConfiguration Tool will not run in GUI mode.

Procedure

1. Run TIBCO_HOME\bpm\n.n\bin\tct.

2. In the TIBCO Configuration Folder dialog, specify CONFIG_HOME, then click OK.

CONFIG_HOME is the folder in which configuration data generated by the BPM system -- scripts,session data, configured binaries, logs, and so on -- is stored. The value of CONFIG_HOME dependson the operating system. For example, on Windows systems, the default value is:


If this is an upgrade, CONFIG_HOME must be set to the same folder that was specifiedduring the original installation.

3. In the Create new configurations screen, click the wizard that you want to run. Which wizards areavailable depends on whether you installed ActiveMatrix BPM software on this machine using thePrimary machine or Remote machine installation profile. The wizards are described in TIBCOConfiguration Tool Wizards Available on a Primary Machine and TIBCO Configuration ToolWizards Available on a Remote Machine, respectively.

4. Complete the wizard to perform the appropriate configuration task:

● Follow the instructions provided for your specific installation or upgrade scenario. See I -INSTALLATION AND UPGRADE SCENARIOS.

● For full details of the screens and fields available in each wizard, see III - TIBCOCONFIGURATION TOOL WIZARD REFERENCE.

● Use the following buttons to navigate through and control the actions of the wizard.

Button Description

Load Load a set of configuration data saved from an earlier session of this wizard.

Save Save the current configuration data (to the location specified in the SessionScripts and Log Folder field of the Summary screen).

Back Go to the previous screen of the wizard.

Next Go to the next screen of the wizard.

Finish Skip the remaining screens of the wizard and go directly to the Summaryscreen, from which you can execute the appropriate configuration actionsusing the specified configuration data. (Default values will be used for allfields on skipped screens.)

This button is only enabled if subsequent screens do not containany empty fields that you must complete.

82


Button Description

Configure Clicking Configure performs the following:

● Executes the configuration action(s) selected on the Summary screen.

● Reports and logs the progress of the configuration actions as it executesthem.

● Saves the configuration data.

Logs and scripts are saved to the location specified in the Session Scriptsand Log Folder field of the Summary screen.

This button only appears on the Summary screen.

Cancel Discard your changes, exit the wizard without performing any configurationactions and return to the Create new configurations screen.

Close Exit the wizard and return to the Create new configurations screen.

This button only appears on the Summary screen when the wizardhas successfully completed execution of the selected configurationtasks.

On Windows systems, after the TIBCO Host instance is started, if a dialog is displayedasking if you want to keep blocking TIBCO Java Launcher, click Unblock.

Required External Libraries on an HP-UX (64-bit)/Itanium Platform

Before trying to run TIBCO Configuration Tool in GUI mode on an HP-UX (64-bit)/Itanium platform,make sure that the required libraries are installed on the machine on which you are trying to runTIBCO Configuration Tool.

The libraries are:

● gtk+2-2.24.10-ia64-11.23.depot

● gcc-ia64-4.7.0.depot

● libgcc-4.2.3-ia64-11.23.depot

● glib2-2.32.3-ia64-11.23.depot

● cairo-1.12.2-ia64-11.23.depot

● atk-2.4.0-ia64-11.23.depot

● pixman-0.26.0-ia64-11.23.depot

● gdk_pixbuf-2.26.1-ia64-11.23.depot

● libpng-1.5.12-ia64-11.23.depot

● libXft-2.2.0-ia64-11.23.depot

● libXrender-0.9.7-ia64-11.23.depot

● bzip2-1.0.6-ia64-11.23.depot

● fontconfig-2.9.0-ia64-11.23.depot

● freetype-2.4.10-ia64-11.23.depot

● zlib-1.2.7-ia64-11.23.depot

83


● expat-2.1.0-ia64-11.23.depot

● libffi-3.0.11-ia64-11.23.depot

● intltool-0.50.2-ia64-11.23.depot

● gettext-0.18.1.1-ia64-11.23.depot

● libiconv-1.14-ia64-11.23.depot

TIBCO Configuration Tool will fail to launch in GUI mode if any of these external libraries are notinstalled.

TIBCO Configuration Tool Wizards Available on a Primary Machine

If you installed ActiveMatrix BPM software on a machine using the Primary machine installationprofile, there is a set of TIBCO Configuration Tool wizards that are appropriate and available for you torun on a primary machine.

Wizard Function

Create ActiveMatrix BPM

Configure Third-Party DriverWizard

Package and install third-party client driver libraries required byActiveMatrix BPM.

Create TIBCO ActiveMatrixBPM Server Wizard

Create a new BPM system in an ActiveMatrix enterprise.

You use this wizard to create a new BPM system in an ActiveMatrixenterprise (whether it uses a basic or distributed architecture). See I- INSTALLATION AND UPGRADE SCENARIOS.

Create TIBCO ActiveMatrixAdministrator Server Wizard

Create the ActiveMatrix Administrator server for an ActiveMatrixenterprise.

ActiveMatrix BPM HA/FT Configurations

Create TIBCO Host InstanceWizard

Specify the communication and management properties of astandalone TIBCO Host instance and optionally create and launchthe TIBCO Host instance.

Replicate TIBCOActiveMatrix AdministratorServer Wizard

Replicate the ActiveMatrix Administrator server in an ActiveMatrixenterprise to provide high availability/fault tolerance.

See Creating an ActiveMatrix Administrator Server (Single orReplicated).

Configure TIBCOActiveMatrix BPM ServerNode Type Wizard

Add a new BPM node to an existing BPM system.

You can use this wizard to add a node of type BPM, Work Manager,Process Manager or Web Components. See Creating a DistributedActiveMatrix BPM System.

Edit ActiveMatrix BPM

Edit TIBCO ActiveMatrixBPM Instance Wizard

Perform specific edits to the configuration of an existing BPMsystem, start or stop an ActiveMatrix BPM application, or move anActiveMatrix host from or to this machine.

84


Wizard Function

Upgrade TIBCOActiveMatrix BPM InstanceWizard

Upgrade an existing BPM system. See "Upgrading a BasicActiveMatrix BPM System" or "Upgrading a DistributedActiveMatrix BPM System".

Delete TIBCO ActiveMatrixBPM Instance Wizard

Delete an existing BPM system.

Edit TIBCO ActiveMatrixAdministrator ServerConfiguration Wizard

Edit the existing ActiveMatrix Administrator server configuration.

TIBCO Configuration Tool Wizards Available on a Remote Machine

If you installed ActiveMatrix BPM software on a machine using the Remote machine installationprofile, there is a set of TIBCO Configuration Tool wizards that are appropriate and available for you torun on a remote machine.

Wizard Function

ActiveMatrix BPM HA/FT Configurations

Create TIBCO Host InstanceWizard

Specify the communication and management properties of astandalone TIBCO Host instance and optionally create and launchthe TIBCO Host instance.

Configure TIBCOActiveMatrix BPM ServerNode Type Wizard

Add a new BPM node to an existing BPM system.

You can use this wizard to add a node of type BPM, Work Manager,Process Manager or Web Components. See Creating a DistributedActiveMatrix BPM System.

Edit ActiveMatrix BPM

Edit TIBCO ActiveMatrixBPM Instance Wizard

Perform specific edits to the configuration of an existing BPMsystem, start or stop an ActiveMatrix BPM application, or move anActiveMatrix host from or to this machine.

Upgrade TIBCOActiveMatrix BPM InstanceWizard

Upgrade an existing BPM system. See "Upgrading a BasicActiveMatrix BPM System" or "Upgrading a DistributedActiveMatrix BPM System".

Running TIBCO Configuration Tool in Console ModeTo configure ActiveMatrix BPM runtime objects from the command line, run TIBCO Configuration Toolin console mode.

Procedure

1. Open a command window in the TIBCO_HOME\bpm\n.n\bin folder and run the followingcommand:

tct console

85


2. At the TIBCO Configuration Folder prompt, specify the CONFIG_HOME to be used by this BPMsystem.

CONFIG_HOME is the folder in which configuration data generated by the BPM system -- scripts,session data, configured binaries, logs, and so on -- is stored. The value of CONFIG_HOME dependson the operating system. For example, on Windows systems, the default value is:


The wizard selection menu is displayed, listing the available wizards (see TIBCO ConfigurationTool Wizards Available on a Primary Machine and TIBCO Configuration Tool Wizards Available ona Remote Machine). For example, on a primary machine:

Choose one option from the list below.

[X] 1 - Create Express Developer Environment - V3.4

[ ] 2 - Create TIBCO ActiveMatrix Administrator Server - V3.4

[ ] 3 - Delete TIBCO ActiveMatrix BPM Instance - V4.3

[ ] 4 - Create TIBCO ActiveMatrix BPM Server - V4.3

[ ] 5 - Configure TIBCO ActiveMatrix BPM Server Node Type - V4.3

[ ] 6 - Upgrade TIBCO ActiveMatrix BPM Instance - V4.3

[ ] 7 - Edit TIBCO ActiveMatrix BPM Instance - V4.3

[ ] 8 - Create TIBCO Host Instance - V3.4

[ ] 9 - Configure Third-Party Driver

[ ] 10 - Edit TIBCO ActiveMatrix Administrator Server Configuration - V3.4

[ ] 11 - Replicate TIBCO ActiveMatrix Administrator Server - V3.4

[ ] 12 - Upgrade or Downgrade TIBCO ActiveMatrix - V3.4

[ ] 13 - Update JRE used by TIBCO ActiveMatrix - V3.4

To select an item enter its number, or enter 'q' to quit: [1]

3. Enter the number for the wizard that you want to run. The menu corresponding to the first screen ofthe selected wizard is displayed. For example, if you chose option 5 - Configure TIBCOActiveMatrix BPM Server Node Type, the menu that corresponds to the Welcome screen of thiswizard is displayed:

===============================================================================

TIBCO ActiveMatrix BPM Server Node Type Creation Wizard

===============================================================================

Welcome to the ActiveMatrix BPM Server Node Type configuration wizard

This wizard will help you Create new ActiveMatrix BPM Server Node Type on this

machine.

Refer to TIBCO ActiveMatrix BPM installation guide for details.

[1] Configure to Secure All Communication with SSL: [no]

Choose 'N' for Next Page, 'S' for Save, 'F' for Finish, 'L' for Load File, 'C'

for Cancel, or enter field number [1]

4. Complete the wizard to perform the appropriate configuration task:

● Follow the instructions provided for your specific installation or upgrade scenario. See I -INSTALLATION AND UPGRADE SCENARIOS.

● For full details of the screens and fields available in each wizard, see III - TIBCOCONFIGURATION TOOL WIZARD REFERENCE.

● Use the following commands (which are case-insensitive) to navigate through and control theactions of the wizard.

86


Command Description

n Enter an item’s number to select it.

ENTER Select the default option for the current page. The number of the defaultitem for each page is shown at the end of the prompt - for example [1].

L Load a set of configuration data saved from an earlier session of thiswizard.

S Save the current configuration data (to the location specified in the SessionScripts and Log Folder field of the Summary menu.)

N Go to the next page of the wizard.

P Go to the previous page of the wizard.

F Skip the remaining pages of the wizard and go directly to the Summarymenu, from which you can execute the appropriate configuration actionsusing the specified configuration data. (Default values will be used for allfields on skipped pages.)

This command is only available if subsequent pages do notcontain any empty fields that you must complete.

G Entering G performs the following:

● Executes the configuration action(s) selected on the Summary menu.

● Reports and logs the progress of the configuration actions as it executesthem.

● Saves the configuration data.

● Returns to the wizard selection menu.

Logs and scripts are saved to the location specified in the SessionScripts and Log Folder field of the Summary menu.

This command is only available on the Summary menu.

C Discard your changes, exit the wizard without performing anyconfiguration actions and return to the wizard selection menu.

Q Exit TIBCO Configuration Tool.

This command is only available on the wizard selection menu.

87


Running TIBCO Configuration Tool in Silent ModeTo configure ActiveMatrix BPM runtime objects by running a particular wizard using configurationdata saved from an earlier GUI or console mode session, run TIBCO Configuration Tool in silent mode.

Procedure

1. Generate and save a build.properties file for the wizard that you want to run silently, by runningTIBCO Configuration Tool in GUI mode or console mode. See The build.properties File.

2. Using a text editor, edit the build.properties file so that it contains the values you want to usewhen you run the wizard silently.

If you are going to run the Create TIBCO ActiveMatrix BPM Server Wizard or UpgradeTIBCO ActiveMatrix BPM Instance Wizard, and you have chosen to manually create orupgrade the BPM database, get a database administrator to manually create or upgradethe database. See Manually Running BPM Database Upgrade Scripts. You must do thisbefore you run the wizard silently.


tct command propertiesFile

where:

● command is one of the commands listed in the following table.

● propertiesFile is the full pathname of the build.properties file that contains theconfiguration data you want to use in this session. (If the pathname includes spaces you mustenclose it within quotation marks.)

TIBCO Configuration Tool Silent Mode Commands

tct command Description

Silent deployment options:

tpcl Runs the Configure Third-Party Driver Wizard.

tibcohost Runs the Create TIBCO Host Instance Wizard.

admin Runs the Create TIBCO ActiveMatrix BPM Server Wizard, but onlyexecutes the Create TIBCO ActiveMatrix Administrator serverconfiguration action.

bpmonly Runs the Create TIBCO ActiveMatrix BPM Server Wizard, but onlyexecutes the Create ActiveMatrix BPM configuration action.

bpm Runs the Create TIBCO ActiveMatrix BPM Server Wizard.

bpmnodetype Runs the Configure TIBCO ActiveMatrix BPM Server Node TypeWizard.

Upgrade options:

upgrade-tibcohost Runs the Upgrade or Downgrade TIBCO ActiveMatrix Wizard toupgrade the local TIBCO Host and all nodes on it.

88


tct command Description

upgrade-bpm Runs the Upgrade TIBCO ActiveMatrix BPM Instance Wizard andexecutes the Upgrade ActiveMatrix BPM Instance Applicationconfiguration action.

downgrade-bpm Enables you to remove a hotfix from a running instance of ActiveMatrixBPM. TIBCO ActiveMatrix BPM only supports downgrading from ahotfix version either to a lower hotfix version, or to the last GA orservice release the hotfix was applied to. For example, you candowngrade from 4.2.0_HF001 to 4.2.0 GA but not from 4.2.0 GA to 4.1.0GA. Please refer to the documentation supplied with your hotfix forinformation on how to downgrade TIBCO ActiveMatrix BPM.

Edit options:

delete-bpm Runs the Delete TIBCO ActiveMatrix BPM Instance Wizard.

edit-bpm Runs the Edit TIBCO ActiveMatrix BPM Instance Wizard.

To display usage instructions for TIBCO Configuration Tool from the command window,enter the command:

tct help

The build.properties File

When you run a TIBCO Configuration Tool wizard to perform a particular configuration task,configuration data gathered and generated by the wizard is stored in a build.properties file.

The file is stored in the scripts folder in the folder that is specified in the Session Scripts and LogFolder field of the wizard’s Summary screen. The file is created when you click Save or Configure froma wizard screen.

For example, the following is an extract from a build.properties file generated by running the Configure TIBCO ActiveMatrix BPM Server Node Type Wizard.# The following properties may be modifiedtibco.home=C:/Program Files/tibco/amx-bpmtibco.config.mgmt.home=C:/ProgramData/amx-bpm/tibco/datatct.scripts.dir=#BPM Node Type settingbpm.nodetype.host=BPMHostbpm.nodetype.environment=BPMEnvironmentbpm.nodetype.node=BPMNode1bpm.nodetype.node.port=6031bpm.nodetype.node.type=BPMNodebpm.nodetype.http.connector.port=8081bpm.nodetype.app.name=amx.bpm.app# Database sizing detailsbpm.nodetype.install.size=Developmentbpm.nodetype.jvm.xms=512bpm.nodetype.jvm.xmx=1536

The file contains a set of property/value pairs, grouped by the wizard screens to which they relate.Generally, each property represents a field on the wizard screen. In the example above:

● tibco.home is the TIBCO_HOME folder for this BPM system.● tibco.config.mgmt.home is the CONFIG_HOME folder for this BPM system (as specified in the

TIBCO Configuration Folder dialog).● the bpm.nodetype.app.name property represents the Application Name field on the ActiveMatrix

BPM Node Type: Host and Node Configuration screen. It has the value amx.bpm.app.

89


A Simple Example: Adding a New Server Node to a Distributed System

Editing and using the build.properties file can be demonstrated by a simple example.

Suppose you have installed and configured a distributed BPM system:

You now want to add a second Server node to BPM_Machine2.

Procedure

1. Open the following file:CONFIG_HOME\tct\bpmnodetype\timestamp\scripts\build.properties

# The following properties may be modifiedtibco.home=C:/Program Files/tibco/amx-bpmtibco.config.mgmt.home=C:/ProgramData/amx-bpm/tibco/data/tcttct.scripts.dir=#BPM Node Type settingbpm.nodetype.host=BPMHost2bpm.nodetype.environment=BPMEnvironmentbpm.nodetype.node=BPMNode2bpm.nodetype.node.port=6031bpm.nodetype.node.type=ServerNodebpm.nodetype.http.connector.port=8081bpm.nodetype.app.name=amx.bpm.app# Database sizing detailsbpm.nodetype.install.size=Developmentbpm.nodetype.jvm.xms=512bpm.nodetype.jvm.xmx=1536

90


2. Change the following values (which must be unique to the new node), then save the file.bpm.nodetype.node=BPMNode3bpm.nodetype.node.port=6033bpm.nodetype.http.connector.port=8082


tct bpmnodetype C:\ProgramData\amx-bpm\tibco\data\tct\bpmnodetype\timestamp

Result

TIBCO Configuration Tool creates a new Server node, BPMNode3, on BPM_Machine2, as part of theBPM system.

Manually Creating the BPM and BDS DatabasesWhen creating a BPM system, although TIBCO Configuration Tool can create the BPM and (if it isseparate) BDS databases automatically, there may be situations in which you need to create thesedatabases manually.

When you use the Create TIBCO ActiveMatrix BPM Server Wizard to create a BPM system, TIBCOConfiguration Tool can automatically create the BPM and BDS databases, provided you have theusername and password of a database server user account that has database administrator privileges (aDBA user).

TIBCO recommend that you allow TIBCO Configuration Tool to automatically create the BPM and BDSdatabases unless either of the following applies:● You do not have access to the credentials of a DBA user.

● Your database administrator wants to examine and possibly edit the database creation scripts beforethey are run - for example, to customize or optimize them for your particular database environment.

If you decide that you need to manually create the BPM and (if it is separate) BDS database, you mustperform the following steps.

Procedure

1. On the ActiveMatrix BPM: Database Administrator screen, clear Create BPM Database Instance.

2. On the ActiveMatrix BPM: Runtime Database Configuration screen, click Generate Scripts to createthe SQL scripts required to create the BPM database.

3. On the ActiveMatrix BPM: BDS Database Configuration screen, if you have selected Use differentdatabase to other AMX-BPM components, click Generate Scripts to create the SQL scripts requiredto create the BDS database.

TIBCO Configuration Tool writes both sets of scripts to the following folder:

CONFIG_HOME\bpm\BPMApplicationName\database

4. On the Administrator Server Configuration: Summary screen, Save your configuration session data,then Cancel the wizard.

Do NOT click Configure at this point!

5. Get a database administrator to manually create the BPM and BDS databases - see ManuallyRunning BPM Database Creation Scripts.

6. Run the Create TIBCO ActiveMatrix BPM Server Wizard again to complete the configurationprocess, as described in your particular installation scenario.

91


Manually Running BPM Database Creation Scripts

A database administrator can, when required, manually create the BPM database and (if it is separate)the BDS database by running the necessary scripts, previously generated by TIBCO Configuration Tool.

Procedure

1. If necessary, edit the database scripts to run correctly on the target database, as shown in thefollowing table.

Database Changes required

SQL Server When manually running scripts, incorrect use of ANSI_PADDING statementsmay change the ANSI_PADDING setting for SQL Server, causing all tablescreated or upgraded subsequently during the same query session to have thewrong setting.

Before manually running any SQL scripts, ensure that you do the following:

● Delete any SET ANSI_PADDING ON and SET ANSI_PADDING OFFstatements in the script.

● Check the database query session settings and ensure thatANSI_PADDING is turned ON. To do this, right click the query windowand select Query Options, then select the Execution->ANSI section andensure that SET ANSI_PADDING is selected.

Oracle If you need to manually amend any of the BPM database scripts, make surethat you do not include any blank lines. If there are any blank lines, you willreceive an error similar to the ones below:

SP2-0734: unknown command beginning "CONSTRAINT..."

SP2-0042: unknown command ")"

and the rest of the line is ignored. To resolve this, you can:

● remove all blank lines from the script

● set sqlblanklines on on the sqlplus session

DB2 Not all the database scripts use the same termination character. For example,the termination character for WorkManagerCreate.sql is "/" and forcreatedb-admin.sql and ProcessManagerCreate.sql scripts is ";".

Ensure that you examine the scripts and set the appropriate terminationcharacter using the DB2 Control Center. Doing so ensures that the scripts canbe used from either the DB2 Control Center or the DB2 Command LineProcessor.

You can set the statement termination character from the DB2 Control Center.

The SQL Server schema name is hardcoded as "amxbpm" and cannot be changed.

2. To manually create the BPM database, run the following scripts in the order shown.

Ensure that you commit the changes after running each script.

92


Step Run the script... as ... Description

1. CONFIG_HOME\bpm

\BPMApplicationName

\database\admin\setup-

admin.sql

a DBA user On:

● SQL Server: Creates requiredlogins that own the BPM schemaand database.

● Oracle: Creates requiredtablespaces.

● DB2: You do not need to run thisscript.

2. CONFIG_HOME\bpm

\BPMApplicationName

\database\admin\createdb-

admin.sql

a DBA user Creates the BPM database and/orschema.

3. CONFIG_HOME\bpm

\BPMApplicationName

\database

\ProcessManagerCreate.sql

the BPMdatabaseuser

Creates the schema objects requiredby the BPM Process Manager.

4. CONFIG_HOME\bpm

\BPMApplicationName

\database

\WorkManagerCreate.sql

the BPMdatabaseuser

Creates the schema objects requiredby the BPM Work Manager.

The BPM database user is the database server user account that ActiveMatrix BPM shoulduse to connect to the BPM database, as specified in the ActiveMatrix BPM: RuntimeDatabase Configuration screen of the Create TIBCO ActiveMatrix BPM Server Wizard.

3. To manually create the BDS database, run the following scripts in the order shown.

You only need to do this if you selected Use different database to other AMX-BPMcomponents on the ActiveMatrix BPM: BDS Database Configuration screen. If you left thisoption cleared, so that the BDS case data store will be hosted in the ActiveMatrix BPMdatabase, you should not run these scripts.



1. CONFIG_HOME\bpm

\BPMApplicationName

\database\admin\setup-

admin-bds.sql

a DBA user On:

● SQL Server: Creates requiredlogins that own the BDS schemaand database.

● Oracle: Creates requiredtablespaces.

● DB2: You do not need to run thisscript.

93



2. CONFIG_HOME\bpm

\BPMApplicationName

\database\admin\createdb-

admin-bds.sql

a DBA user Creates the BDS database and/orschema.

Manually Upgrading the BPM DatabaseWhen upgrading a BPM system, although TIBCO Configuration Tool can upgrade the BPM databaseautomatically, there may be situations in which you need to upgrade the database manually.

When you use the Upgrade TIBCO ActiveMatrix BPM Instance Wizard to upgrade an existing BPMsystem, TIBCO Configuration Tool can automatically upgrade the BPM database if the BPM databaseuser has the appropriate permissions on the BPM database.

TIBCO strongly recommend that you allow TIBCO Configuration Tool to automatically upgrade theActiveMatrix BPM database unless either of the following applies:● The BPM database user’s permissions have been restricted post-installation - for example, to comply

with corporate database usage policies.

The BPM database user is the database server user account that ActiveMatrix BPM uses to connectto the BPM database, as specified when the BPM system was created (in the ActiveMatrix BPM:Runtime Database Configuration screen of the Create TIBCO ActiveMatrix BPM Server Wizard).

● Your database administrator wants to examine and possibly edit the database upgrade scriptsbefore they are run - for example, to customize or optimize them for your particular databaseenvironment.

If you decide that you need to manually upgrade the BPM database, you must use either of thefollowing methods to perform the upgrade:

● Method 1: Stopping the BPM Application Before Upgrading It

● Method 2: Performing the Upgrade in Two Stages

Method 1: Stopping the BPM Application Before Upgrading It

You can upgrade the BPM system by creating the necessary SQL scripts, stopping the BPM application,manually running the scripts, and then upgrading the application.

Procedure

1. On the ActiveMatrix BPM Upgrade: Upgrade Configuration screen of the Upgrade TIBCOActiveMatrix BPM Instance Wizard:a) Clear Automatically upgrade BPM Database Schema.b) Click Generate Scripts to create the SQL scripts required to upgrade the database.

TIBCO Configuration Tool writes the required upgrade scripts to the following folder:


2. Click Next.

The ActiveMatrix BPM Upgrade: Summary screen is displayed.

Do NOT click Configure at this point!

3. In ActiveMatrix Administrator:a) Select the BPM application (for example, amx.bpm.app > System > amx.bpm.app ), then click

Stop.

94


b) In the Application Dependencies to Stop dialog, clear every application that is selected (as shownin the following example), then click Stop.

c) Refresh the display until the BPM application status displays as Stopped.

4. Get a database administrator to manually upgrade the BPM database - see Manually Running BPMDatabase Upgrade Scripts.

5. On the ActiveMatrix BPM Upgrade: Summary screen of the Upgrade TIBCO ActiveMatrix BPMInstance Wizard, click Configure.

Method 2: Performing the Upgrade in Two Stages

You can upgrade the BPM system by creating the necessary SQL scripts, starting to upgrade the BPMapplication, manually running the scripts, and then finishing the upgrade of the application.

Procedure

1. On the ActiveMatrix BPM Upgrade: Upgrade Configuration screen of the Upgrade TIBCOActiveMatrix BPM Instance Wizard:a) Clear Automatically upgrade BPM Database Schema.b) Click Generate Scripts to create the SQL scripts required to upgrade the database. TIBCOConfiguration Tool writes the required upgrade scripts to the following folder:


2. Click Next.

The ActiveMatrix BPM Upgrade: Summary screen is displayed.

3. Click Configure.

The upgrade process will fail when it attempts to execute the Upgrade ActiveMatrix BPMInstance Application configuration task, because the BPM database has not yet beenupgraded.

4. Get a database administrator to manually upgrade the BPM database - see Manually Running BPMDatabase Upgrade Scripts.

5. On the ActiveMatrix BPM Upgrade: Summary screen, select Upgrade ActiveMatrix BPM InstanceApplication, then click Configure.

95


Manually Running BPM Database Upgrade Scripts

A database administrator can, when required, manually upgrade the BPM database by running thenecessary scripts, previously generated by TIBCO Configuration Tool.

Procedure

1. If necessary, edit the database scripts to run correctly on the target database, as shown in thefollowing table.

Database Changes required

SQL Server When manually running scripts, incorrect use of ANSI_PADDING statementsmay change the ANSI_PADDING setting for SQL Server, causing all tablescreated or upgraded subsequently during the same query session to have thewrong setting.

Before manually running any SQL scripts, ensure that you do the following:

● Delete any SET ANSI_PADDING ON and SET ANSI_PADDING OFFstatements in the script.

● Check the database query session settings and ensure thatANSI_PADDING is turned ON. To do this, right click the query windowand select Query Options, then select the Execution->ANSI section andensure that SET ANSI_PADDING is selected.

Oracle If you need to manually amend any of the BPM database scripts, make surethat you do not include any blank lines. If there are any blank lines, you willreceive an error similar to the ones below:

SP2-0734: unknown command beginning "CONSTRAINT..."

SP2-0042: unknown command ")"

and the rest of the line is ignored. To resolve this, you can:

● remove all blank lines from the script

● set sqlblanklines on on the sqlplus session

DB2 Not all the database scripts use the same termination character. For example,the termination character for WorkManagerCreate.sql is "/" and forcreatedb-admin.sql and ProcessManagerCreate.sql scripts is ";".

Ensure that you examine the scripts and set the appropriate terminationcharacter using the DB2 Control Center. Doing so ensures that the scripts canbe used from either the DB2 Control Center or the DB2 Command LineProcessor.

You can set the statement termination character from the DB2 Control Center.

2. To manually upgrade the BPM database, run the following scripts in the order shown.


96


Step Run the script... as... Description

1. CONFIG_HOME\bpm

\BPMApplicationName

\database

\ProcessManagerUpgrade.sql

the BPMdatabase user

Upgrades the schema objectsrequired by the BPM ProcessManager.

2. CONFIG_HOME\bpm

\BPMApplicationName

\database

\WorkManagerUpgrade.sql

the BPMdatabase user

Upgrades the schema objectsrequired by the BPM WorkManager.

The BPM database user is the database server user account that ActiveMatrix BPM shoulduse to connect to the BPM database, as specified in the ActiveMatrix BPM: RuntimeDatabase Configuration screen of the Create TIBCO ActiveMatrix BPM Server Wizard.

Performing Post-Installation TasksThere are tasks you may need to perform after creating or upgrading a BPM system.

The tasks you need to perform vary according to your installation/upgrade scenario.


Configuring the Business Data Services (BDS) DatabaseIn particular cases, you may need to configure ActiveMatrix BPM so that names that are used in theBDS database are limited in length to 30 characters. This is to avoid issues that may arise if you latermigrate BDS database tables from SQL Server or DB2 to Oracle.

Prerequisites

If all the following conditions apply to your situation, we strongly advise you to perform thisprocedure:

● You are upgrading ActiveMatrix BPM (fresh installations are not affected).

● ActiveMatrix BPM is using DB2 or SQL Server.

● You have not yet deployed any BDS Global Data Applications to your running system, or areupgrading ActiveMatrix BPM from a version before 3.0.

If you have a system to which existing BDS Global Data Applications have been deployed, you shouldnot perform this procedure unless you are happy to first undeploy the Applications.

Procedure

1. Open the bds.properties file in a text editor.

The file is typically stored on the machine where you installed ActiveMatrix BPM, in the followingfolder:

CONFIG_HOME/bpm/BPM_APP_NAME/configuration/

2. Set the following properties to the values shown:# Allows the specification of the maximum length to use for table names.# It is recommended that this is set to 30 to provide the most# flexibility across all database typescaseDataStoreTableNameMaxLength=30

97


# Allows the specification of the maximum length to use for column names.# It is recommended that this is set to 30 to provide the most# flexibility across all database typescaseDataStoreColumnNameMaxLength=30 # Allows the specification of the maximum length to use for a database index.# It is recommended that this is set to 30 to provide the most# flexibility across all database typescaseDataStoreIndexNameMaxLength=30

These settings limit the length of the names used in the BDS generated database.

3. Save and close the file.When you have set these properties and deployed a BDS Global Data Application, you should notchange the property values again.

Creating Any Other Required LDAP Connections to LDAP DirectoriesCreate LDAP connections to additional LDAP directories that contain details of users who may need tolog in to the BPM system using Openspace, Workspace, or a custom client application.

You only need to do this if the LDAP directory that you specified when running the Create TIBCOActiveMatrix BPM Server Wizard (in the ActiveMatrix BPM: LDAP Configuration screen) does notcontain details of all users who may need to log in to the BPM system using Openspace, Workspace or acustom client application.

Procedure

1. Log in to ActiveMatrix Administrator.

2. Create the necessary shared resources to define an LDAP connection to each required LDAPdirectory. These resources are:

● LDAP Connection resource template

● LDAP Connection resource instance

3. Create the necessary shared resources to authenticate login attempts against users in that LDAPdirectory. These resources are:

● LDAP Authentication resource template

● LDAP Authentication resource instance

These resources must have their scope set to the name of the BPM application thatidentifies this BPM system. (This is the name specified in the AMX-BPM ApplicationName field of the ActiveMatrix BPM: Configuration screen, in the Create TIBCOActiveMatrix BPM Server Wizard.)

See the following references for more detailed information about these steps:

● "Configuring TIBCO ActiveMatrix BPM to Use a New LDAP Directory Server" in TIBCOActiveMatrix BPM - BPM Administration

● "Resource Templates" in TIBCO ActiveMatrix BPM - SOA Administration

What to do next

You can now use the Organization Browser (logging in as tibco-admin) to create BPM resources(users) from the LDAP users available in each LDAP container. For more information, see:

● "Creating the Organization Model" in TIBCO ActiveMatrix BPM Concepts

98


● TIBCO ActiveMatrix BPM Organization Browser User’s Guide

Configuring Client Communications Through the Load BalancerIf you have installed a BPM system using a distributed configuration, you must configure the system tobe able to communicate properly with Openspace and Workspace via the load balancer.

Perform the steps in the following procedures:

● Configuring the Work Presentation Component

● Configuring Launch Pages to Handle Context-Switching

If you do not do this, you will not be able to display work item forms or start business services.

Configuring the Work Presentation Component

If you are using Openspace or Workspace, you must specify the URL that the Work Presentationcomponent of ActiveMatrix BPM uses to locate forms.

● In the CONFIG_HOME\bpm\configuration\wpextender.properties file, change theUseHttpRequestContextURL and formContextURL properties to the following values:

UseHttpRequestContextURL=false

formContextURL=http://webServerHost:port/bpmresources

where webServerHost and port are the IP address/hostname and port number of the load balancerthat exposes the Openspace and Workspace applications.

webServerHost and port should match the hostname and port found in the address box in theinternet browser used to access Openspace or Workspace so as to comply with the same-originpolicy enforced by most internet browsers.

You may need to clear the cache in a browser session to pick up these changes.

See "Configuring TIBCO ActiveMatrix BPM Components" in TIBCO ActiveMatrix BPM - BPMAdministration for more information about property files.

Configuring Launch Pages to Handle Context-Switching

You must configure the Openspace or Workspace launch page(s) to handle the different format of theURL that results from context-switching.

The load balancer may use context-switching (for example, to allow dynamic routing of endpoints) inthe URL that it uses to access Openspace or Workspace.

For example:

loadbalancer:port/context/openspace

If multiple contexts are used, for example:

loadbalancer:port/context1/context2/openspace

Openspace and Workspace cannot by default resolve the URL properly to load the TIBCO Formsruntime and display a form.

To correct this, you must edit the appropriate Openspace or Workspace HTML launch page(s) toaccount for the different format of the URL.

99


Procedure

1. Identify each Openspace or Workspace HTML launch page that you need to edit, depending on theclient types that you use. The following table lists the different launch pages - there are two copiesof each launch page, one in each of the following folders:

● CONFIG_HOME\tibcohost\Admin-enterpriseName-serverName\host\plugins\

● TIBCO_HOME\components\shared\1.0.0\plugins\

You should edit both copies.

File Description

com.tibco.openspace.login_version\resources

\openspace.html

Openspace launch page

com.tibco.openspace.login_version\resources\mobile

\mobile.html

Openspace - Mobilelaunch page

com.tibco.openspace.login_version\resources\openform

\openform.html

Openspace launch pagefor pushed work items

com.tibco.n2.rtc.ws_version\resources\workspace.html Workspace launch page

com.tibco.n2.rtc.ws_version\resources\openworkitem.html Workspace launch pagefor pushed work items

2. In each file:a) Find the following entry:

<script type="text/javascript" language="javascript" src="../bpmresources/formsclient/formsclient.nocache.js"></script>

b) Prefix the src path with an additional "../" for each additional nesting level used in the contextpath of the load balancer URL.

c) Save the file.

100


Example

If the URL used to access Openspace from the load balancer is:

loadbalancer:port/context1/context2/openspace

change the entry in the launch page to:<script type="text/javascript" language="javascript" src="../../bpmresources/formsclient/formsclient.nocache.js"></script>

Openspace or Workspace can, by default, resolve a request and display a form if theURL used to access Openspace or Workspace from the load balancer has the format:

loadbalancer:port/BPMclient

or

loadbalancer:port/context/BPMclient

For example, if the URL used to access Openspace from the load balancer is:

loadbalancer:port/openspace

or

loadbalancer:port/openspace.html

or

loadbalancer:port/context1/openspace.html

no additional configuration of launch pages is required.

Configuring Transaction Recovery (Oracle only)Ensure that the BPM database user has sufficient privileges to enable the ActiveMatrix BPM runtime toperform transaction recovery. (If a separate BDS user has been created, that user must also be givenprivileges to perform transaction recovery.)

ActiveMatrix shared resources that are XA-enabled participate in global transactions (coordinated bythe transaction manager within a TIBCO host instance). If the TIBCO host instance fails, the sharedresources can update themselves to the decided state of the global transaction when they recover. Formore information, see "Transaction Recovery" in TIBCO ActiveMatrix BPM - SOA Administration.

Procedure

1. Connect to the Oracle database server as a user that has SYSDBA system privilege.For example:

SQL > connect sys/password as sysdba

2. Execute the following SQL statements:

GRANT SELECT ON sys.dba_pending_transactions TO user

GRANT EXECUTE ON sys.dbms_xa TO user

GRANT SELECT ON sys.dba_2pc_pending TO user

where user is the name of the BPM database user (as defined by the Username field in the ActiveMatrix BPM: Runtime Database Configuration screen of the Create TIBCO ActiveMatrix BPMServer Wizard - for example, bpmuser).

101


Setting Transaction Verification Property (SQL Server Only)Microsoft SQL Server cannot handle the scenario where commits return successfully (in XA mode) evenwhen the transaction has not completed. Consequently, duplicate work items can occur when the BPMruntime is running against a Microsoft SQL Server. To work around this, you must set the transactionverification property.

There is a case open with Microsoft for this issue (Case Reference 112010377500682). You must set theproperty until Microsoft provides a fix for this issue. Once the fix is applied, this property setting mustbe removed.

Procedure

1. Open the pvm.properties file.This file is typically located in the following folder (it may be different in a distributedenvironment):

CONFIG_HOME/bpm/bpm_app_name/configuration

For more information about properties files, see "BPM Properties Files" in TIBCO ActiveMatrix BPMAdministration.

2. Locate the txVerificationEnable property and set its value to "true".

3. Save and close the pvm.properties file.

Copying Modified Process Engine-Related JVM Property Values to BPM Properties FilesAfter upgrading, you must copy any previously specified Process Engine-related JVM property valuesthat you have set to non-default values, to the appropriate BPM properties files.Prior to version 4.3 of ActiveMatrix BPM, properties on the Java Virtual Machine (JVM) could be usedto configure aspects of the Process Engine. Those configurations are now specified by properties ineither the bx.properties or pvm.properties file, in the CONFIG_HOME\bpm\bpm_app_name\configuration folder.

JVM properties that are related to application- or signal-level locking are still specified on the node inActiveMatrix Administrator.

Therefore, if your system is using any Process Engine-related JVM property that you have set to a non-default value, you should note its value and compare it to the default value of the correspondingproperty in the appropriate BPM property file after upgrading. If you want to use your previous valueinstead of the new default, manually update that property value in the property file.

Use the following steps to determine the current values of the JVM properties, and modify those valuesin the BPM properties files (you can do this post-upgrade, as the installer does not remove anypreviously specified JVM properties during the upgrade, but the system no longer references ProcessEngine-related JVM properties):

Procedure

1. Log in to ActiveMatrix Administrator.

2. Select Infrastructure > Nodes.

3. In the Nodes list, select BPMNode.

4. In the lower pane, select the Configuration tab.

5. Select the JVM Configuration link.

6. For each Process Engine-related JVM property listed in the Properties section (with the exception ofthe locking properties noted above), if you have set a non-default value, update the equivalentproperty in the BPM properties file with that value.

102


Note that some of the property names in the bx.properties and pvm.properties files don't matchexactly the names used for the JVM properties. Use the following table to determine whatproperties are used in the bx.properties and pvm.properties files for the JVM properties thatwere used in your system.

JVM Property Equivalent bx.properties and pvm.properties Property

com.tibco.bx.allow.null.msgpart allowNullMessagePart (pvm.properties)

com.tibco.bx.arrayDelimiter arrayDelimiter (bx.properties)

com.tibco.bx.autoDelete autoDeleteProcesses (bx.properties)

com.tibco.bx.autoDeleteFailedProcesses

autoDeleteFailedProcesses (bx.properties)

com.tibco.bx.bg.globalSignalProcessor.interval

globalSignalProcessorInterval (pvm.properties)

com.tibco.bx.bg.globalSignalProcessor.numMsgs

globalSignalProcessorNumMessages (pvm.properties)

com.tibco.bx.bg.requestQueueCleanup.batchCount

requestQueueCleanupBatchCount (pvm.properties)

com.tibco.bx.bg.requestQueueCleanup.batchSize

requestQueueCleanupBatchSize (pvm.properties)

com.tibco.bx.bg.requestQueueCleanup.interval

requestQueueCleanupInterval (pvm.properties)

com.tibco.bx.bg.workItemCleanup.batchCount

workItemCleanupBatchCount (pvm.properties)

com.tibco.bx.bg.workItemCleanup.batchSize

workItemCleanupBatchSize (pvm.properties)

com.tibco.bx.bg.workItemCleanup.interval

workItemCleanupInterval (pvm.properties)

com.tibco.bx.blob.compress blobCompress (pvm.properties)

com.tibco.pvm.bx.blob.compress.bufferSize

blobCompressBufferSize (pvm.properties)

com.tibco.bx.blob.compress.threshold

blobCompressThreshold (pvm.properties)

com.tibco.bx.bpel.bg.moduleCleanup.interval

bpelMaintenanceModuleCleanupInterval(pvm.properties)

com.tibco.bx.bpel.bg.pendingMsgProcessor.interval

bpelInMemoryRecoveryInterval (pvm.properties)

103



com.tibco.bx.bpel.bg.pendingMsgProcessor.numMsgs

bpelPendingMessageProcessorNumMessages(pvm.properties)

com.tibco.bx.bpel.bg.unclaimedMsgProcessor.interval

bpelUnclaimedPendingMsgProcessorInterval(pvm.properties)

com.tibco.bx.bpel.bg.unclaimedMsgProcessor.numMsgs

bpelUnclaimedPendingMsgProcessorNumMsgs(pvm.properties)

com.tibco.bx.bpel.maintenance.purgeProcess.interval

bpelMaintenancePurgeProcessInterval (pvm.properties)

com.tibco.bx.engine.checkParms checkParms (bx.properties)

com.tibco.bx.engine.clearInMemoryTrackers

clearInMemoryTrackers (bx.properties)

com.tibco.bx.engine.recovery.failure.threshold

recoveryFailureThreshold (pvm.properties)

A minimum value of 120 is recommended forthis property.

com.tibco.bx.engine.threadPool.size

inMemoryThreadPoolSize (pvm.properties)

com.tibco.bx.filterByOrgs filterByOrgsError (bx.properties)

com.tibco.bx.groupRQ.batchSize requestQueueBatchSize (pvm.properties)

com.tibco.bx.groupRQ.fillLevel requestQueueFillLevel (pvm.properties)

com.tibco.bx.groupRQ.idleSleep requestQueueIdleSleep (pvm.properties)

com.tibco.bx.groupRQ.lowWaterLevel

requestQueueLowLevel (pvm.properties)

com.tibco.bx.lockOperation Still used as a JVM property

com.tibco.bx.lockOperation.ModuleName

Still used as a JVM property

com.tibco.bx.lockOperation.ModuleName.PortType.OperationName


com.tibco.bx.lockPerOperation Still used as a JVM property

com.tibco.bx.lockPerSignal Still used as a JVM property

com.tibco.bx.lockSignal Still used as a JVM property

com.tibco.bx.lockSignal.SignalAppName.SignalAppVersion


104



com.tibco.bx.lockSignal.SignalAppName.SignalAppVersion.signalName


com.tibco.bx.management.queryMaxResultSize

queryMaxResultSize (bx.properties)

com.tibco.bx.maxCancelChildrenBatchSize

maxCancelChildrenBatchSize (bx.properties)

com.tibco.bx.maxGlobalSignalListenerCount

maxGlobalSignalListenerCount (bx.properties)

com.tibco.bx.maxSubProcessCallDepth

maxSubProcessCallDepth (bx.properties)

com.tibco.bx.maxTasksPerInstance maxTasksPerInstance (bx.properties)

com.tibco.bx.showExtendedPriorities

showExtendedPriorities (bx.properties)

com.tibco.bx.suspendOnError suspendOnError (bx.properties)

com.tibco.pvm.deleteRequestQueueItem

requestQueueCleanupInline (pvm.properties)

com.tibco.pvm.deleteWorkItem workItemCleanupInline (pvm.properties)

com.tibco.pvm.sequence.cacheSize.Link

sequenceCacheSizeInstLink (pvm.properties)

com.tibco.pvm.sequence.cacheSize.instProcess

sequenceCacheSizeInstProcess (pvm.properties)

com.tibco.pvm.sequence.cacheSize.instProcessIm

sequenceCacheSizeInstProcessIm (pvm.properties)

com.tibco.pvm.sequence.cacheSize.Task

sequenceCacheSizeInstProcessTask (pvm.properties)

com.tibco.pvm.txVerification.enable

txVerificationEnable (pvm.properties)

com.tibco.pvm.txVerification.retryInterval

txVerificationRetryInterval (pvm.properties)

com.tibco.pvm.txVerification.timeout

txVerificationTimeout (pvm.properties)

com.tibco.pvm.txVerification.warn txVerificationWarn (pvm.properties)

For more information about the available properties, see "Process Instance Properties(bx.properties)" and "Process Engine Properties (pvm.properties)" in TIBCO ActiveMatrix BPMAdministration.

105


7. Optional: Remove the no longer needed JVM properties (except the locking-related properties), asthe system no longer references them in ActiveMatrix BPM version 4.3 and later.

Upgrading JDBC DriversIf, as part of this upgrade of ActiveMatrix BPM, you have upgraded the database version used to hostany of the following:

● the ActiveMatrix Administrator database tables

● the ActiveMatrix BPM database tables

● BDS Case Data Store tables (if they are hosted separately from the ActiveMatrix BPM database)

you must upgrade the JDBC driver used by that database.

Procedure

1. Make sure that the .jar files for the required JDBC drivers are available on the primary machine.(See JDBC Drivers.)

2. Stop the TIBCO Host instance.

3. In TIBCO Configuration Tool, run the Configure Third-Party Driver Wizard.

4. Configure the JDBC driver needed for the database server that will be used to host the database.

5. Start the TIBCO Host instance.

6. Using the ActiveMatrix Administrator CLI, run the "updateJDBCDriver" action. For example:a) Open the CONFIG_HOME/admin/enterpriseName/samples/enterprise_data.xml file in a text

editor.b) Locate the <OldFeature> and <NewFeature> entries for the appropriate jdbc.feature and

update the version strings to the appropriate version numbers. For example, if you haveupgraded from using Microsoft SQL Server 2012 with TIBCO enabled JDBC driver for MicrosoftSQL Server 4.2.0, to Microsoft SQL Server 2016 with TIBCO enabled JDBC driver for MicrosoftSQL Server 6.0.0:<OldFeature xsi:type="amxdata_base:FeatureID" componentID="com.tibco.tpcl.gen.sqlserver.jdbc.feature" version="4.2.0.001"/><NewFeature xsi:type="amxdata_base:FeatureID" componentID="com.tibco.tpcl.gen.sqlserver.jdbc.feature" version="6.0.0.001"/>

c) Save your changes to the file.d) Run the command:

ant -f CONFIG_HOME/admin/enterpriseName/samples/enterprise_build.xml

updateJDBCDriver

For more information about the "updateJDBCDriver" action, see "Using Command-Line Interface(CLI)" in the SOA Administration guide.

7. If necessary, repeat steps 1 to 6 for the other databases.

Reconfiguring JDBC Connection Resource Templates After Upgrade From a Pre-4.0ActiveMatrix BPM System

Use of XA transactions in TIBCO ActiveMatrix BPM 4.0 has been significantly reduced. As part of thischange, Process Engine and Event Collector now share the use of the common DataSource andDataSourceDirect database connection pools with other BPM components, instead of having their ownpools. As there are now less connection pools you should review and, if necessary, increase the numberof connections per pool.The following JDBC resource templates are deleted as part of an upgrade from a pre-4.0 BPM system:

106


● DataSourcePE Used by Process Engine (PE) for database operations required when starting andprocessing process instances within an XA transaction.

● DataSourceEC Used by Event Collector (EC) to persist audit events to the database via an XA-based transaction.

● DataSourceDirectPE Used by Process Engine for database operations required when starting andprocessing process instances within a non-XA transaction.

● DataSourceDirectEC Used by Event Collector (EC) to persist audit events to the database via anon-XA based transaction.

If you have upgraded from a pre-4.0 BPM system, you should review and possibly increase theMaximum Connections or preparedStatementCacheSize values for the DataSource andDataSourceDirect resource templates.

Prerequisites

Procedure

1. Stop the ActiveMatrix BPM application:a) In TIBCO Configuration Tool, on the Create new configurations screen, click Edit ActiveMatrix

BPM > Edit ActiveMatrix BPM Instance.b) In the wizard, select Stop AMX-BPM Product Application from the Edit Action to be

Performed list.c) On the Summary screen, click Configure, then wait until the ActiveMatrix BPM application has

stopped.

2. Review and, if desired, update the resource templates:a) Log into ActiveMatrix Administrator.b) Select Shared Objects > Resource Templates.c) Find the DataSource JDBC resource template and change the following settings to appropriate

values for your upgraded system: Maximum Connections (on the General tab) andpreparedStatementCacheSize (on the Advanced tab).

d) Do the same for the DataSourceDirect JDBC resource template.

3. Restart the ActiveMatrix BPM application:a) In TIBCO Configuration Tool, on the Create new configurations screen, click Edit ActiveMatrix

BPM > Edit ActiveMatrix BPM Instance.b) In the wizard, select Start AMX-BPM Product Application from the Edit Action to be

Performed list.c) On the Summary screen, click Configure, then wait until the ActiveMatrix BPM application has

restarted.

Reorganizing Event Collector Tables (DB2 Only)After the upgrade, it is likely that several event collector tables need to be reorganized.

You only need to perform this task if:● you are upgrading an existing BPM system

and

● you are using a DB2 database.

Perform this task for the following tables:

● ec_event_int

● ec_pe_status

107


Procedure

1. To determine if a table needs to be reorganized, connect to the BPM database and enter thefollowing command:db2 load query table user.table_name

● For example:

● db2 load query table bpmuser.ec_event

If a reorganization is required, the command returns the following:

Tablestate:

Reorg Pending

In this case, you must perform the following steps before continuing to use the system.

Failing to reorganize the tables can lead to events not being audited, and event viewsfailing to display, with error messages such as:

Event Viewer: My Activity Today - View is unavailable due to server side

fault

Also, the following error in the logs indicates that the tables needs to be reorganized:SQLCODE=-668, SQLSTATE=57016

2. Log into the BPM database.

3. Run the following command :db2 reorg table user.table_name

4. After reorganization, enter the following command:db2 load query table user.table_name

The command should return the following:

Tablestate:

Normal

Verifying the Event Collector Rules FilesThe event collector rules files ec-probe-rules.xml and ec-event-rules.xml changed inActiveMatrix BPM version 3.0. If you are using modified rules, you should check that the rules files areOK after upgrade.

● You should:

● Check that each channel is now defined in the following format:<channel name='abcde' target='target'>

● Verify that the rules files are configured as desired.

● Ensure the BPM.log file has no errors that concern the parsing of the rules files. For moreinformation, see "Configuring TIBCO ActiveMatrix BPM Auditing" in the TIBCO ActiveMatrixBPM Administration guide.

Migrating Data Stored in Event CollectorIf you are upgrading to this version of ActiveMatrix BPM from:

● a pre-4.0 version: The Event Collector schema used in ActiveMatrix BPM 4.x versions is significantlydifferent from the schema used in earlier versions. As a result, audit data from your earlier version

108


is not automatically available after the upgrade. For example, events that have not been migrated donot appear in the graphical audit trail.

If you want to migrate existing audit data so that it is still available after the upgrade, you must runthe amxbpm_migrate_events and amxbpm_set_lifecycle_ids stored procedures.

● version 4.0, 4.0.0_HF_x, 4.1, 4.1.0_HF-001: Version 4.1.0_HF-002 introduced a change to the way thatlifecycle events for process instances are recorded in the BPM database. As a result, the followingprocess instances are not correctly recorded as completed in the ec_managed_obj_lifecycle databasetable when upgrading from a system using one of these versions:

— any process instance that was started on the pre-upgrade version 4.x system prior to theupgrade to this version.

— any sub-process instance that is started on this version, but which has a parent process instancethat was started on the pre-upgrade version 4.x system.

This results in a warning message in the BPM log file, and also means that these instances cannot bepurged or archived. To correct this, you may need to run the amxbpm_set_lifecycle_root_idsstored procedure, to ensure that completed or cancelled process instances can be purged or archivedcorrectly.

Migration Scripts

The following migration scripts are supplied in TIBCO_HOME\bpm\n.n\scripts\migration\database,where n.n is the version of ActiveMatrix BPM and database is the type of database you are using (db2,mssql or oracle):

Script Description

install-migration-

tools.sql

Creates the ec_migration table and a number of stored procedures.

execute-

migration.sql

Executes the amxbpm_migrate_events stored procedure to perform eventmigration.

execute-set-

lifecycle-ids.sql

Executes the amxbpm_set_lifecycle_ids stored procedure. This ensuresthat when data is purged, sub-process instance data is only purged whenits parent process instance has already completed.

execute-set-

lifecycle-root-

ids.sql

Executes the amxbpm_set_lifecycle_root_ids stored procedure. Thiscorrects the information held in the ec_managed_obj_lifecycle table forprocess instances that were started on a pre-upgrade version 4.x system,meaning that they can be subsequently purged or archived.

remove-migration-

tools.sql

Removes the ec_migration table and the stored procedures.

Duplicate Message ID Values

Instead of all the message-related attributes being persisted in the ec_event_int table for every event,they are now persisted once in the ec_message table. They are then referenced from the ec_messagetable by the message_id value. This means the message_id value in the ec_message table must beunique. However, it is possible that existing data on your system could have multiple events that usedifferent values for message, priority, severity, component_id and/or message_category, but usethe same message_id, therefore creating more than one message type with the same message_id.When upgrading, two different message types with the same message_id cannot be inserted into theec_message table. Therefore, migration will insert all the message variants for a message_id, but theevents will only reference the first instance that is inserted and subsequent, duplicate message_id

109


inserts will add a sequence number to the message_id to make it unique. For example, CUST_MSG,CUST_MSG_1, CUST_MSG_2 and so on. These messages are not referenced from the event. They aresimply being persisted so that the information is not lost.

amxbpm_migrate_events Stored Procedure

The amxbpm_migrate_events stored procedure is used to perform event migration. You can execute iteither directly, or by running the execute-migration.sql script.

amxbpm_migrate_events takes the following parameters:amxbpm_migrate_events (num_events, batch_size)

where:

● num_events - is the number of events to be migrated (default: 20000).

● batch_size - is the batch size to commit (default: 500).

Depending on the number of events migrated and commit batch size used, each execution ofamxbpm_migrate_events() could result in large transactions and take a long time to execute. Initially,you should execute amxbpm_migrate_events() with the default values. Depending on your databaseresources and load, you can then gauge how many events can be processed safely in a single call toamxbpm_migrate_events(), without exceeding the database resources.

amxbpm_set_lifecycle_ids Stored Procedure

The amxbpm_set_lifecycle_ids stored procedure ensures that when data is purged, sub-processinstance data is only purged when its parent process instance has already completed. You can execute iteither directly, or by running the execute-set-lifecycle-ids.sql script.

amxbpm_set_lifecycle_ids takes the following parameters:amxbpm_set_lifecycle_ids (batch_size, max_updates, insert_active, set_orphaned_as_root)

where:

● batch_size - is the number of rows to update before performing a commit (default: 20000).

● max_updates - is the maximum number of updates to perform before exiting (default: 1000000).

● insert_active - must be set to '1' when migrating to this version.

● set_orphaned_as_root - defines how any orphaned sub-process data (which may exist if only someaudit data was migrated from the old version) is treated when data is purged:

— 0 - Data for orphaned sub-process instances will not be purged (default option).

— 1 - Data for orphaned sub-process instances will be purged.

amxbpm_set_lifecycle_root_ids Stored Procedure

The amxbpm_set_lifecycle_root_ids stored procedure corrects the information held in theec_managed_obj_lifecycle table for affected process instances, meaning that they can be subsequentlypurged or archived. You can execute it either directly, or by running the execute-set-lifecycle-root-ids.sql script.amxbpm_set_lifecycle_root_ids (batch_size, max_updates)

where:

● batch_size - is the number of rows to update before performing a commit.

● max_updates - is the maximum number of updates to perform before exiting.

110


Prerequisites

● These stored procedures do not include any provision for backing up or archiving your database.You must back up your database, according to whatever backup strategy your organization hasimplemented, before initiating the stored procedures. Refer to the documentation supplied withyour database server for information on how to do this.

● The amxbpm_migrate_events stored procedure copies data from the ec_event_old table to theec_event_int table. Therefore, you must make sure that your database is the correct size. Yourdatabase must be of sufficient size to store the current ec_event_old table, twice over. Dependingon the database you are using, you need to consider the following resource limits:

— TEMP space for SQL Server

— Rollback space for Oracle

— Transaction Log Files for DB2

Procedure

1. Copy the migration scripts from TIBCO_HOME\bpm\n.n\scripts\migration\database to atemporary location on the server.

2. From an appropriate database query/management tool (for example, SQL Server ManagementStudio, Oracle SQL*Plus or a DB2 command window), connect to the BPM database using the BPMdatabase user credentials (default: bpmuser).

3. Run the install-migration-tools.sql script.

4. If you are upgrading from a pre-4.0 version:a) Execute the amxbpm_migrate_events stored procedure to migrate the audit data.

Execute the procedure as many times as you need to migrate all of your audit data.

b) When migration is complete, execute the amxbpm_set_lifecycle_ids stored procedure.

5. If you are upgrading from version 4.0, 4.0.0_HF_x, 4.1 or 4.1.0_HF-001:a) Execute the amxbpm_set_lifecycle_root_ids stored procedure, using appropriate parameters.

You may need to run amxbpm_set_lifecycle_root_ids repeatedly, until all processinstances that were started on thepre-upgrade version 4.x system have completed orbeen cancelled.

You may then need to run amxbpm_set_lifecycle_root_ids again periodically, tocatch any newly completed or cancelled process instances. Repeat this cycle until youare certain that all process instances started on the pre-upgrade version 4.x systemhave completed or been cancelled.

6. Run the remove-migration-tools.sql script.

7. Delete the scripts from the temporary location.

Updating the managedobjectlifecycle Target in the Event Collector Rules FileYou must update the managedobjectlifecycle target to ensure that the doPurgeAudit operation (in theEventCollectorManagementService) purges all process instance-related data when Statistics Collectionis disabled.

You only need to do this if you have upgraded from ActiveMatrix BPM version 4.0 or later.

111


Procedure

● Locate the managedobjectlifecycle target in the CONFIG_HOME\bpm\amx.bpm.app\configuration\ec-event-rules.xml file, and replace the existing definition with the followingdefinition:<channel name="default_lifecycle" target="managedobjectlifecycle"> <rules> <rule name="BaseLifecycleRule" ruleOrder="1000"> <filter> <messageIds> <messageId>BX_INSTANCE_PROCESS_STARTED</messageId> <messageId>BX_INSTANCE_PROCESS_CANCELLED</messageId> <messageId>BX_INSTANCE_PROCESS_COMPLETED</messageId> <messageId>BX_INSTANCE_PROCESS_FAILED</messageId> <messageId>BX_INSTANCE_PROCESS_FAILED_WHILE_CANCELLING</messageId> <messageId>BX_INSTANCE_PROCESS_CANCELLED_WHILE_CANCELLING</messageId> </messageIds> </filter> <action> <messageProcess>TriggerProcess</messageProcess> </action> </rule> </rules></channel>

The StagingAreaTrigger channel in the ec-event-rules.xml file MUST also contain theBX_TEMPLATE_DEPLOYED messageId. Do NOT delete this channel, nor theBX_TEMPLATE_DEPLOYED messageId in this channel.<channel name="default_stagingareatrigger" target="StagingAreaTrigger"> <rules> <rule name="TriggerMessages" ruleOrder="800"> <filter> <messageIds> . .  . . <messageId>BX_TEMPLATE_DEPLOYED</messageId>

Modifying the Indexes Used on the 'ec_managed_obj_lifecycle' TableModifying the indexes used on the ec_managed_obj_lifecycle table:

1. On SQL Server: prevents a known issue from occurring where, in certain circumstances, deadlockscan occur on the ec_managed_obj_lifecycle table.

If deadlocks occur on the ec_managed_obj_lifecycle table, an error similar to thefollowing example is written to the BPM log file:[ERROR] org.hibernate.util.JDBCExceptionReporter - Transaction (Process ID 110) was deadlocked on lock | communication buffer resources with another process and has been chosen as the deadlock victim. Rerun the transaction.

2. On SQL Server, Oracle or DB2: improves database query performance.

The required index modifications are:

1. Remove the existing clustered index - the event_pk primary key - from theec_managed_obj_lifecycle table. (event_pk can be safely removed as it is not used by any queries.)

2. Add a new clustered index on the managed_obj_id column of the ec_managed_obj_lifecycle table.

112

Procedure

1. Take a backup of the BPM database.

2. Create and run a SQL script that executes the following SQL commands on the BPM database:Database Required SQL Commands

SQL Server BEGINDECLARE @pk NVARCHAR(256);BEGIN SELECT @pk = nameFROM sys.indexes WHERE name LIKE 'PK__ec_manag__%' AND object_id = (SELECT object_idFROM sys.tables WHERE name = 'ec_managed_obj_lifecycle');EXECUTE ('ALTER TABLE amxbpm.ec_managed_obj_lifecycle DROP CONSTRAINT ' + @pk);ENDENDGO CREATE CLUSTERED INDEX ix_ec_managed_obj_lifecycle_idx2 ON amxbpm.ec_managed_obj_lifecycle(managed_obj_id)GO

Oracle ALTER TABLE ec_managed_obj_lifecycle DROP CONSTRAINT pk_ec_managed_obj_lifecycle;

CREATE INDEX ix_ec_lifecycle_idx2 ON ec_managed_obj_lifecycle(managed_obj_id);

DB2 ALTER TABLE ec_managed_obj_lifecycle DROP CONSTRAINT pk_ec_managed_obj_lifecycle/

CREATE INDEX ix_ec_managed_obj_lifecycle_idx2 ON ec_managed_obj_lifecycle(managed_obj_id)/

As Event Collector tables can be very large, these commands can take a significant amountof time to complete.

Editing TIBCO Hawk® Rulebase FilesTIBCO Hawk® is a tool for monitoring and managing distributed applications and operating systems.The TIBCO Configuration Tool automatically generates TIBCO Hawk rulebase files when you use it toconfigure your TIBCO ActiveMatrix BPM installation. If you intend to use TIBCO Hawk, you must editthe rulebase files, as explained in the TIBCO ActiveMatrix BPM Administration guide.

If you are upgrading ActiveMatrix BPM, or if you are creating a second or subsequent system node, theHawk rulebase files are not automatically generated. Use the genhawkrulebase utility to create them, asexplained in the TIBCO ActiveMatrix BPM Administration guide.

Minimizing Openspace Load TimeOpenspace can take a long time to load when it checks which language packs have been installed. Youcan minimize the time taken by limiting the number of packs that it checks for.

By default, Openspace automatically provides two built-in language packs (American English andBritish English). Openspace also provides a locale.properties file that lists all 57 known locales thatare available.

When Openspace loads, it checks whether any of the language packs for the 57 locales have beeninstalled. If a language pack is installed, then Openspace loads the relevant data for the installed

113


language pack. However, testing for a large number of potential locales can have an impact on the timetaken to load Openspace.

To minimize the time that Openspace takes to load, TIBCO recommend that you do as follows.

● In the Openspace config.properties file, amend the locale.limit property to limit the numberof locales that Openspace tests for to suit your requirements.

See the TIBCO Openspace Customization Guide for information about how to do this.

Restoring any Openspace CustomizationsIf you are upgrading a BPM system, you must restore any Openspace customizations that you madepreviously.

Procedure

1. Restore any Openspace configuration files that you backed up to the following location:CONFIG_HOME\tibcohost\Admin-enterpriseName-adminServerName\data_version\host

\plugins\com.tibco.openspace.login_version\resources

See Backing Up Openspace Customizations for more information.

2. If you have been using the Standard persona, re-apply any changes that you want to keep to theconfiguration of the Standard persona (themes, layouts, tabs and/or gadgets), then apply theStandard persona to all users.

Restoring Customized Example Applications in Application DevelopmentIf you have upgraded ActiveMatrix BPM, you should restore any changes in the example applicationsand bundled applications included in Application Development that you backed up prior to theupgrade.

Procedure

● Re-implement any changes to the example applications and bundled applications that you want touse on the upgraded system - either by modifying or replacing the appropriate files from yourearlier backups. See Backing up Customized Example Applications in Application Development formore information.

Restoring Workspace ConfigurationsIf you have upgraded ActiveMatrix BPM, and backed up default Workspace application configurationfiles prior to the upgrade, those configurations need to be restored after the upgrade.To restore the default Workspace application configurations, copy the backed up configuration filesover the configuration files that were installed during the upgrade.

For more information, see Backing Up Workspace.

Replacing the Existing ActiveMatrix BPM SSO CertificatesIn Java 8, the MD5withRSA algorithm has been disabled. This change invalidates the existingActiveMatrix BPM SSO certificates in the default keystores (amx-bpm-wss-keystore.jks and amx-bpm-wss-truststore.jks) If you use these certificates for SSO authentication, you must manuallyreplace the existing keystores with new, compliant versions that are supplied with ActiveMatrix BPM4.3.

The ActiveMatrix BPM SSO certificates in the default keystores are only intended for demonstration ortesting purposes. They are not intended for use in a production environment.

114


The new keystores are not installed automatically as part of an upgrade, because doing so wouldoverwrite any other certificates that you may have written to those keystores.

You only need to perform this step if you use the existing ActiveMatrix BPM SSO certificates in thedefault keystores, and if you are upgrading from ActiveMatrix BPM version 4.1 or earlier. If you useyour own certificates and different keystores, you do not need to do anything.

Procedure

● Copy the amx-bpm-wss-keystore.jks and amx-bpm-wss-truststore.jks keystore files from theTIBCO_HOME\bpm\4.3\scripts\deployer\templateFiles folder to the CONFIG_HOME\bpm\bpmApplicationName\keystores folder.

This will overwrite any other certificates in these keystores that you have added/replaced,and you will need to add/replace those certificates yourself.

Adding Jackrabbit Janitor Thread Configuration Parameters (Optional)ActiveMatrix BPM Version 4.3.0 uses a new Jackrabbit janitor thread. If you are upgrading, you can(optionally) add new configuration parameters for this janitor thread to the CONFIG_HOME\bpm\bpm_app_name\appdev\repository.xml file.

If you are installing a new ActiveMatrix BPM installation, these parameters are already present in therepository.xml file, so you do not need to perform this task.

On a distributed ActiveMatrix BPM system, when adding a new node to the system, the operation toadd the new node can take a long time to complete if the BPM database contains a large number ofJackrabbit journal entries (in the APA_JL_Journal table).

(The Jackrabbit content repository is used by Application Development. Jackrabbit maintains aninternal journal of all changes made to the repository, and replays those journal entries when a newnode gets added. If the journal contains a large number of entries, the time taken to replay them can besignificant.)

Configuring the Jackrabbit janitor thread can prevent this problem. The thread periodically cleans upthe journal entries so that the number of records in the APA_JL_Journal database table does notcontinually grow.

Procedure

1. Open the CONFIG_HOME\bpm\bpm_app_name\appdev\repository.xml file in a text editor.

2. Locate the <Cluster> element and its child <Journal> element:<Cluster id="@NODE_ID@" syncDelay="2000"> <Journal class="org.apache.jackrabbit.core.journal.MSSqlDatabaseJournal"> <param name="schemaCheckEnabled" value="false"/> . . . <param name="password" value="@DB_PSWD@"/> </Journal></Cluster>

3. Add the following parameters to the <Journal> element:<-- Enable clean-up thread --><param name="janitorEnabled" value="true"/>

<-- Sleep time in seconds (default = 24 hours) --><-- <param name="janitorSleep" value="86400"> -->

<-- Initiate the first run at 1:00 am (default = 3:00 am) --><param name="janitorFirstRunHourOfDay" value="1"/>

115


4. Change the janitorEnabled, janitorSleep and janitorFirstRunHourOfDay values as required.Do NOT change any other values in the file.

If you want to change the janitorSleep value, remember to uncomment it as well. Forexample, to set janitorSleep to 12 hours instead of the default 24 hours, change thevalue to:<param name="janitorSleep" value="43200"/>

5. Save your changes.

Configuring Support for Internationalization (Windows Systems Only)If you want to support internationalization, your system must be configured to use UTF-8. OnWindows systems, UTF-8 is not set by default, so you must manually set your Windows system to useUTF-8.

If you are using a Linux or UNIX system, then UTF-8 is set by default.

You should check that the database you are using also has UTF-8 set as default. Refer to your databasedocumentation for more information about how to do this.

Procedure

1. Log on to TIBCO ActiveMatrix Administrator.

2. Click Infrastructure > Nodes.

3. Select BPMNode.

4. From the Configuration tab, click JVM Configuration.

5. Find the file.encoding property in the Property column and change the value in the Valuecolumn to UTF-8. If the file.enconding property is not listed, then you must add it by clickingAdd.

6. Click Save.

7. From the Nodes pane, select Install or sync > Install/Sync.

8. Stop and restart your BPM Node for your changes to take effect. To do this, from the Nodes pane:a) Select Stop.b) Once the BPM Node is stopped, select Restart.

116


IV - TIBCO CONFIGURATION TOOL WIZARD REFERENCE

The following sections provide detailed reference information about the individual TIBCOConfiguration Tool wizards.

Configure Third-Party Driver WizardThis section provides reference information about the TIBCO Configuration Tool Configure Third-PartyDriver wizard.

You can only run this wizard on a machine if you used the Primary machine installation profile whenyou installed the ActiveMatrix BPM software on that machine.

If you installed the ActiveMatrix BPM software using the Remote machine installation profile, youcannot run this wizard.

Third-Party Driver: Details

Field Description

Driver Type The type of driver being configured.

Default: JDBC

Driver The supported JDBC, JMS or SiteMinder drivers.

Third-Party Driver: JAR Folder

Field Description

JAR Folder The folder containing the client driver JARs to deploy to the ActiveMatrixAdministrator server.

Third-Party Driver: Summary

Field/Button Description

Session Scripts andLog Folder

The location where scripts and logs generated by this TIBCO ConfigurationTool session are stored.

Default: CONFIG_HOME\tct\tpclshells\timestamp

Click Configure to execute the following action:

Configure Third-Party Driver

Whether to configure the specified third-party driver.

Default: Selected

117


Create TIBCO ActiveMatrix BPM Server WizardThis section provides reference information about the TIBCO Configuration Tool Configure TIBCOActiveMatrix BPM Server wizard.



Welcome


Standard Installation(all wizard panels)

Whether to choose a Standard (selected) or Express (cleared) installation.

Choosing Standard gives you access to all configuration options. You haveaccess to all subsequent screens in this wizard.

You must choose Standard if you want to use an existingActiveMatrix Administrator server.

Choosing Express (cleared) allows you to quickly create a new BPM systemand ActiveMatrix Administrator server, using mostly default configurationoptions. You only have access to the following screens in this wizard.Settings for all other screens will take their default values (or, those from apreviously saved set of configuration data, if you have Loaded one).

1. ActiveMatrix BPM: Database Administrator

2. ActiveMatrix BPM: Runtime Database Configuration

3. ActiveMatrix BPM: Configuration

4. Administrator Server Configuration: Database Details

5. Administrator Server Configuration: Summary

Default: Selected (Standard)

Configure to SecureAll Communicationwith SSL

Whether all communication channels used by ActiveMatrix BPM should besecured with SSL.

Select this to pre-select all SSL Enabled check boxes in subsequent pages ofthis wizard. (You will be able to override this choice and select or clearthose check boxes on their individual pages.)

Default: Cleared

118


ActiveMatrix BPM: Database Administrator


Create BPMDatabase Instance

Whether TIBCO Configuration Tool should automatically create theActiveMatrix BPM database (and, if it is hosted separately, the BDS database).When selected, the remaining fields on this page are available. See ManuallyCreating the BPM Database for more information about how to choosewhether to automatically or manually create the database.

When cleared, you must manually create the database instead, using thescripts generated from the ActiveMatrix BPM: Runtime DatabaseConfiguration screen.

Default: Selected

build.properties entry: bpm.db.create.schema

Database Driver Database driver used to connect to the database server that hosts the BPMdatabase. The drivers available are those that have been previously installedusing the TIBCO Configuration Tool Configure Third-Party Driver Wizard .

build.properties entries (do not edit these entries manually):

● bpm.db.type

● bpm.db.feature.name

● bpm.db.feature.version

● bpm.db.driver

● bpm.db.xa.driver

● bpm.db.dialect

URL JDBC connection string needed to connect to the database server.

For the format to use, see JDBC Connection String Formats.

build.properties entry: bpm.db.admin.url

DBA Username Credentials of a database server user account that has database administratorprivileges. See Database User Account.

TIBCO Configuration Tool will use this account to connect to the databaseserver to create the BPM database. If you do not have access to a suitableaccount, you will need to manually create the BPM database.

build.properties entry: bpm.db.admin.username

DBA Password Password for the specified DBA Username.

build.properties entry: bpm.db.admin.password

119



Tablespace Name Name of the Oracle tablespace in which the BPM database will be created:

● TIBCO Configuration Tool will create this tablespace if it does not alreadyexist.

● The Administrator database and the BPM database must each use aseparate tablespace.

● If multiple BPM databases are hosted on this server, each subsequent BPMdatabase must also use a separate tablespace.

If the BPM database is being hosted on SQL Server or DB2 this field isignored.

Default: bpm_tablespace

build.properties entry: bpm.db.tablespace

Test Connection Verifies that TIBCO Configuration Tool can connect to the database serverusing the information supplied on this page.

JDBC Connection String Formats

The JDBC connection string that you specify in the Create TIBCO ActiveMatrix BPM Server wizard orthe Edit TIBCO ActiveMatrix BPM Instance wizard must have a specific format depending on thedatabase type.

DB2

jdbc:db2://host:port/dbName

Microsoft SQL Server

jdbc:sqlserver://host:port;DatabaseName=dbName

You cannot use a literal IPV6 address for host.

Oracle 12c

You must use one of the following formats:

● jdbc:oracle:thin:@host:port/serviceName

● jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST="host")(PORT="port")))(CONNECT_DATA=(SERVICE_NAME="serviceName")(SERVER = DEDICATED)))

where serviceName is the service name of the pluggable database that ActiveMatrix BPM is using.

120


ActiveMatrix BPM: Runtime Database Configuration


URL JDBC connection string that identifies the ActiveMatrix BPM database to beused by this BPM system.

ActiveMatrix BPM will use this string to connect to this ActiveMatrix BPMdatabase.


build.properties entries: bpm.db.url, plus other database specific entriesrepresenting the different URL components - for example, on SQL Server:

● bpm.db.dbname

● bpm.db.port

● bpm.db.servername

Username Database server user account that ActiveMatrix BPM should use to connect tothis ActiveMatrix BPM database. TIBCO Configuration Tool automaticallycreates the specified account if it does not already exist.

The specified Username must be unique to this BPM system; you cannot usean existing user account that is used by a different BPM database on thisserver.

If you are using a DB2 database, this must be the name of an existingoperating system user - see Configuring the BPM Database Server Using DB2.

Default: bpmuser

build.properties entry: bpm.db.username

Password Password for the specified Username.

build.properties entry: bpm.db.password

Confirm Password Password for the specified Username.

Test Connection Verifies that TIBCO Configuration Tool can connect to the specifiedActiveMatrix BPM database using the information supplied on this page.

This field is only enabled if you chose to manually create the database in the ActiveMatrix BPM: Database Administrator screen. Connection will only bepossible when:

1. You have generated the database creation scripts (by clicking GenerateScripts).

2. The database administrator has run the database creation scripts.

The database administrator must run the database creationscripts before you click Configure in the Summary screen at theend of this wizard.

121



Generate Scripts Generates the SQL scripts needed to create the specified ActiveMatrix BPMdatabase.

You must generate the database creation scripts if you chose to manuallycreate the database in the ActiveMatrix BPM: Database Administrator screen.See Manually Running BPM Database Creation Scripts for more informationabout how to manually create the database.

ActiveMatrix BPM: BDS Database Configuration


Use differentdatabase to otherAMX-BPMcomponents

Whether ActiveMatrix BPM should host the BDS case data store in theActiveMatrix BPM database or in a separate database.

● When selected, the BDS case data store will be hosted in a separatedatabase. The remaining fields on this page are available. The databasetype of both BDS case data store and the ActiveMatrix BPM databaseshould be the same.

● When cleared, the BDS case data store will be hosted in the ActiveMatrixBPM database, as specified on the ActiveMatrix BPM: Runtime DatabaseConfiguration screen.

Default: Cleared

build.properties entry: bpm.bds.owndatabase

URL JDBC connection string that identifies the database to be used to host the BDScase data store.

In the case of DB2, this database must have been created previously. For otherdatabases, the specified string will be used to automatically create thedatabase.

ActiveMatrix BPM will use this string to connect to the BDS case data store.


build.properties entries: bpm.bds.url, plus other database specific entriesrepresenting the different URL components - for example, on SQL Server:

● bpm.bds.dbname

● bpm.bds.port

● bpm.bds.xadriver

● bpm.bds.dialect

● bpm.bds.servername

122



BDS Username Database server (or for DB2, operating system) user account that ActiveMatrixBPM should use to connect to the specified database URL.

If you are using a DB2 database, this must be the name of an existingoperating system user.

Default: bpmuser

build.properties entry: bpm.bds.username

BDS Password Password for the specified BDS Username.

build.properties entry: bpm.bds.password

Tablespace Name Name of the Oracle tablespace in which the tables for the BDS case data storewill be created:

● TIBCO Configuration Tool will create this tablespace if it does not alreadyexist.

● The Administrator database, BPM database, and BDS case data store musteach use a separate tablespace.

● If multiple BDS case data stores (for different BPM systems) are hosted onthis server, each BDS case data store must use a separate tablespace.

If the BDS case data store is being hosted on SQL Server or DB2 this field isignored.

Default: bds_tablespace

build.properties entry: bpm.bds.tablespace

Test Connection Verifies that TIBCO Configuration Tool can connect to the specified databaseusing the information supplied on this page.

Generate Scripts Generates the SQL scripts needed to create the specified BDS database.

You must generate the database creation scripts if you chose to manuallycreate the BPM and BDS databases in the ActiveMatrix BPM: DatabaseAdministrator screen. See Manually Running BPM Database Creation Scriptsfor more information about how to manually create the BDS database.

ActiveMatrix BPM: Configuration


AMX-BPMApplication Name

The name by which to identify this particular ActiveMatrix BPM applicationinstance (that is, this particular BPM system).

Each BPM system in the same ActiveMatrix environment must have a uniqueapplication name.

Default: amx.bpm.app

build.properties entry: bpm.app.name

123



HTTP WorkPresentation Host

Name used to externally identify the machine that hosts this BPM system.

This name is used when Work Manager distributes work using the pushdistribution model. When a user receives an email notification of a work item,the specified name is embedded in the URL in the email body that the userclicks to access the work item. (See "Work Management > Distributing Workto Users" in TIBCO ActiveMatrix BPM Concepts for more information.)

This name must be specified using a fully qualified domain name or IPaddress that is accessible to external clients. For example, this may be thename of the machine itself or of a proxy server.

If this BPM system is distributed across different machines (toprovide high availability and/or scalability), this should be thename of the load balancer. See Load Balancer.

Default: localhost

build.properties entry: bpm.http.host

HTTP Port HTTP port number used by this BPM node for communication with externalclients (Openspace, Workspace and custom client applications).

This port must not be in use by any other ActiveMatrix node on the samemachine.

If this BPM system is distributed across different machines (toprovide high availability and/or scalability), this port should beconfigured for load balancing across all required machines - see Load Balancer.

Default: 8080

build.properties entry: bpm.http.port

SOAP BindingVersion

Version of the SOAP specification that will be applied to all SOAP bindings:

● on services exposed by this instance of the ActiveMatrix BPM application.

● on services and references exposed by process applications deployed tothis BPM system.

SOAP versions 1.1 and 1.2 are supported.

Default: 1.1

build.properties entry: bpm.soap.version

SMTP Host Name of the machine that hosts the SMTP server that is used by this BPMsystem to send pushed email work notifications and to execute email servicetasks.

If the machine is not the one on which TIBCO ActiveMatrix BPM is running,its name must be specified using a fully qualified domain name or IP address.

Default: localhost

build.properties entry: bpm.smtp.host

124



SMTP Port Port number on which the SMTP server is running.

Default: 25

build.properties entry: bpm.smtp.port

Override BPMConfigurationFolder

Whether to override the default location of the BPM configuration folder.Select this option if this BPM system is distributed across different machines(to provide high availability and/or scalability).

If selected, the Configuration Folder field is displayed.

Default: Cleared

build.properties entry: bpm.config.home.root.override

ConfigurationFolder

This is a folder under CONFIG_HOME that stores configuration datagenerated by the BPM system.

If this BPM system is distributed across different machines (toprovide high availability and/or scalability), this must be a locationon a suitable shared network drive. For example, SHARED_DIR\bpm_config - see Shared File System.

Default: CONFIG_HOME\bpm

build.properties entry: bpm.config.home.root

Enable SSL forHTTP Port

Whether communication between ActiveMatrix BPM and clients (Workspace,Openspace or custom client applications) should be secured by SSL.

If this option is enabled for a BPM system that is distributed acrossdifferent machines (to provide high availability and/or scalability):● The keystore containing the certificate to be used when a client

requests an SSL connection using the httpConnector (by default,install-server-store.jks) must be stored in SHARED_DIR\keystores - see Shared File System.

● In TIBCO Administrator, the Keystore Provider resourcetemplate (by default, KeystoreCspRT) must be configured toreference the keystore on the shared network drive.

See "Enabling SSL Communication with TIBCO ActiveMatrix BPMRuntime Clients" in TIBCO ActiveMatrix BPM - BPM Administrationfor more information.

Default: Follows the value selected for Configure to Secure AllCommunication with SSL.

build.properties entries:

● bpm.http.secure

● bpm.client.enablessl

SSL Configuration fields (only visible if Enable SSL for HTTP Port is selected)

125



Self-signedCertificate

Indicates that this BPM system will identify itself to clients with a self-signedcertificate generated by the TIBCO Credential Server (see AdministratorServer Configuration: Credential Server Details).

Do not use a self-signed certificate in a production environment.

Default: Selected

build.properties entry: bpm.client.autogeneratekeystore=true

ImportedCertificate

Indicates that this BPM system will identify itself to clients with a certificatethat should be imported into ActiveMatrix Administrator.

When selected, the Keystore fields are enabled.

Default: Cleared

build.properties entry: bpm.client.autogeneratekeystore=false

Keystore Location The location of the keystore to import.

build.properties entry: bpm.client.keystorelocation

Keystore Type The type of the keystore.

Default: JKS

build.properties entry: bpm.client.keystoretype

Keystore Password The password required to access the keystore.

build.properties entry: bpm.client.keystorepassword

Key Alias The key alias that identifies the entry in the keystore for this BPM system.

build.properties entry: bpm.client.keyalias

Key Password The password required to access the key alias.

build.properties entry: bpm.client.keypassword

Verify Keystore Verifies that TIBCO Configuration Tool can connect to the keystore andretrieve the alias using the information supplied on this page.

ActiveMatrix BPM: Sizing Configuration


Environment Type of sizing environment being set up. Choose from the options: Developmentand Production.

The sizing environment you choose in this field determines the default valuesprovided for the remaining fields on this screen.

Default: Development

build.properties entry: bpm.sizing.install.size (The property value can beeither dev or prod.)

126



DatabaseConnectionPool Size

Number of database connections available for each of the ActiveMatrix BPMDataSource resource templates.

Development default: 10

Production default: 50

build.properties entry: bpm.sizing.database.connection.pool.size

DatabaseStatementCache Size

Number of prepared statements that can be cached by each connection in theDataSource resource template pool. Caching prepared statements improves theperformance but it uses more memory.



build.properties entry: bpm.sizing.database.stmt.cache.size

Number ofProcess EngineThreads

Number of threads in the Process Engine background thread pool.



build.properties entry: bpm.sizing.pvm.threads

Java Heap Size Range for the Java heap size.

Development default: Minimum: 512 Maximum: 1536

Production default: Minimum: 1024 Maximum: 4096


● (Minimum) bpm.sizing.jvm.xms

● (Maximum) bpm.sizing.jvm.xmx

The value for Java Heap Size is a starting point. You should monitor thesystem under load and adjust this value if necessary. For moreinformation, refer to TIBCO ActiveMatrix Performance Tuning .

127


ActiveMatrix BPM: LDAP Configuration


DeployInternal LDAPServer

Whether to use the internal LDAP Directory Server provided with ActiveMatrixBPM. When selected, the Port Number field is enabled.

If this BPM system is distributed across different machines (to providehigh availability and/or scalability), an external LDAP server must beused. See Additional System Requirements for a Distributed BPMSystem.

If the internal LDAP Directory Server has already been deployed on thismachine (when configuring another BPM system), you must select UseExternal LDAP Server instead of this option. Do not deploy a secondinstance of the internal LDAP Directory Server to the same machine.

Default: Selected

build.properties entry: bpm.ldap.useinternal

Port Number Port number used by the internal LDAP server.

Default: 10801

build.properties entry: bpm.ldap.internal.port

Use ExternalLDAP Server

Whether to use an external LDAP directory server (see Configuring the ExternalLDAP Directory Server). When selected, the LDAP Provider Details fields areenabled.

Default: Cleared

build.properties entry: None. This option is automatically selected ifbpm.ldap.useinternal=false.

Provider Details:

URL URL used to log in to the external LDAP server.

Default: ldap://localhost:10389

build.properties entry: bpm.ldap.url

Base DN Base Distinguished Name (DN) from which to search/navigate the LDAPdirectory.

Default: OU=system

build.properties entry: bpm.ldap.basedn

Username Distinguished Name of the LDAP user who will be used as the tibco-admin userfor this BPM system.

This user must have (at least) read access to the LDAP directoryspecified by Base DN.

Default: uid=admin,ou=system

build.properties entry: bpm.ldap.username

128



Password Password of the specified LDAP user.

build.properties entry: bpm.ldap.password

LDAP Server isSSL Enabled

Whether the external LDAP server is enabled for SSL. When selected, the SSLTrust Store Configuration fields are enabled.

If this BPM system is distributed across different machines (to providehigh availability and/or scalability), the Trust Store Location must beSHARED_DIR\keystores - see Shared File System.

build.properties entry: bpm.ldap.enablessl

TestConnection

Verifies that TIBCO Configuration Tool can connect to the LDAP server using theinformation supplied on this page.

SSL Trust Store Configuration:

Create a TrustStore

Obtains certificates from the specified LDAP server and creates a new trust store,which will be used to establish the trust relationship with the external LDAPserver:

1. Click Create a Trust Store.

2. Specify a password to protect the keystore and click Next . The SSL setupwizard displays the certificates imported from the external LDAP server.

3. In the Trust Selected Certifications area, select the certificates to trust and clickFinish. The wizard fills in the Keystore Location, Keystore Type, and KeystorePassword fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship with theexternal LDAP server.

Trust StoreLocation

Either:

● the location in which the created trust store will be stored, or

● the location of the trust store to be uploaded to ActiveMatrix Administrator.(You can either type this directly or use the Browse button to find it.)

build.properties entry: bpm.ldap.keystorelocation

Trust KeystoreType

The type of the created or uploaded trust store: JKS or JCEKS.

Default: JKS.

build.properties entry: bpm.ldap.keystoretype

Trust StorePassword

Either:

● the password specified in the Create a Trust Store wizard, or

● the password required to access the trust store that is to be uploaded.

build.properties entry: bpm.ldap.keystorepassword

129


ActiveMatrix BPM: CMIS Configuration


Use CMISRepository

Whether Business Data Services (BDS) will use a content management system(CMS) to provide case folders. This can be either the internal TIBCODocumentStore, or an external CMS.

When selected, the User Details for CMIS Server (Internal or External) fieldsare displayed.

Default: Cleared

build.properties entry: bpm.cmis.enabled

User Details for CMIS Server (Internal or External)

Admin User Name of the CMS administrator user. If you are using the TIBCODocumentStore, specify whatever name you want to use for the administratoruser. If you are using an external CMS, you must supply the correct name asdefined on the external CMS.

Default: Admin

The supplied value is stored in the ECMCredentialsKeystore shared resourceand used when authenticating against the CMS server.

build.properties entry: bpm.cmis.adminuser

Admin UserPassword

Password for the CMS administrator user. If you are using the TIBCODocumentStore, specify whatever value you want to use for the administratoruser password. If you are using an external CMS, you must supply the correctpassword as defined on the external CMS.

Default: admin

The supplied value is stored in the ECMCredentialsKeystore shared resourceand used when authenticating against the CMS server.

build.properties entry: bpm.cmis.adminpassword (stored in encryptedformat)

External CMIS Whether BDS will use the internal TIBCO DocumentStore or an external CMS toprovide case folders:

● When cleared (the default option), BDS uses the internal TIBCODocumentStore as its CMS.

● When selected, the External CMIS Server Details fields are displayed.

Default: Cleared

build.properties entry: bpm.cmis.useinternal

External CMIS Server Details:

130



URL URL that is used to connect to the CMS's CMIS interface.

Default: http://localhost:9090/alfresco/api/-default-/public/cmis/versions/1.0/atom

build.properties entry: bpm.cmis.url

CMIS BindingType

Type of binding that is used against the CMIS URL. Currently, only atompub issupported.

Default: atompub

build.properties entry: bpm.cmis.bindingtype

Repository ID ID of the main repository within the CMS that is to be connected to.

Default: -default-

build.properties entry: bpm.cmis.repositoryid

AMX BPM FolderPath

Path of an existing folder in the main repository that is used to store case folderdata. You must either specify a folder that already exists or create a new foldermanually and specify that folder.

Default: /Sites/amxbpm/documentLibrary

build.properties entry: bpm.cmis.amxbpmfolderid

CMIS Server isSSL Enabled

Whether the external CMS server is enabled for SSL. When selected, the SSLTrust Store Configuration fields are displayed.

SSL Trust Store Configuration

Create a TrustStore

Obtains certificates from the specified CMS server and creates a new trust store,which will be used to establish the trust relationship with the external CMSserver:


2. Specify a password to protect the keystore and click Next . The SSL setupwizard displays the certificates imported from the external CMS server.

3. In the Trust Selected Certifications area, select the certificates to trust andclick Finish. The wizard fills in the Trust Store Location, Trust KeystoreType, and Trust Store Password fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship withthe external CMS server.

Trust StoreLocation

Either:



build.properties entry: bpm.cmis.keystorelocation

131



Trust KeystoreType


Default: JKS.

build.properties entry: bpm.cmis.keystoretype

Trust StorePassword

Either:



build.properties entry: bpm.cmis.keystorepassword

Test Connection Verifies that TIBCO Configuration Tool can connect to the external CMS serverusing the information supplied on this page.

The defaults on this wizard screen are based on Alfresco Community Edition 5.0a. You may need toenter different values depending on your chosen CMS.

ActiveMatrix BPM: Authentication Configuration

Field Description

SelectAuthenticationType

LDAP, SiteMinder, Kerberos, OpenID, or SAML SSO Web Profile.

The SiteMinder option is only provided if you set up SiteMinder device driverinstallation (see Configure Third-Party Driver Wizard) and Shared Resourceinstallation for SiteMinder (see Create TIBCO ActiveMatrix BPM Server Wizard).

Default: LDAP

build.properties entry: bpm.edit.auth.authtype

Allow also basicusernameauthentication

Default: Cleared (false)

build.properties entry: bpm.edit.auth.allowUsername

Setting this option causes the authAllowUsername substitution variable to be setto true. The authAllowUsername substitution variable is used to configureOpenspace and Workspace applications (including custom WCC applications)for dual authentication:

● true - causes applications to concurrently support both direct and SSOauthentication.

● false - only SSO authentication is supported.

For information, see "Dual Authentication" in ActiveMatrix BPM Single Sign-On.

ActiveMatrix BPM: SiteMinder Configuration

This screen is only displayed if you selected SiteMinder as the Authentication Type on theAuthentication Configuration screen. The name of the Shared Resource Instance must beamx.bpm.auth.siteminder.

132


Field Description

Agent Name The name of the SiteMinder Wb-Agent (configured on the SiteMinderinstallation) that will filter authentication requests.

Client IPAddress

The IP address of the machine on which the Shared Resource will be installed.This is the client that will contact the SiteMinder service.

Configuration File Options

SelectedConfigurationFile Type

Identifies the location of the SiteMinder generated, host configuration file, fromwhich the remaining configuration properties will be taken. Choose between:

● System Specific Default Location

If the SiteMinder installation is on the same machine as the Shared Resourceinstallation.

● Custom File Location

If the configuration file has been copied to the same machine as the SharedResource installation.

● Generated

If the configuration file is not available, but the properties are known. Createsa local file at a given location.

The following properties assume Generated has been selected. These values will be available from yourSiteMinder installation.

ConfigurationFile Name

The name (without path) of the file that will be generated to record the propertyvalues. You can use any name.

Trusted HostName

A trusted host is a client that is registered with the Policy Server and is,therefore, allowed to connect to the Policy Server. A unique name that representsthe host to the Policy Server.

HostConfigurationObject

The name of the Host Configuration Object specified in the Policy Server. Namesthe object that holds parameters for a Trusted Host.

Shared Secret An automatically generated encryption key used for encrypting traffic betweenthe trusted host and the Policy Server.

Policy Server The server IP address and port numbers for the Policy Server that the TrustedHost accesses.

Further configuration of ActiveMatrix BPM and configuration of TIBCO Openspace and TIBCOWorkspace (if you are using them) is contained in the TIBCO ActiveMatrix BPM Single Sign-On guide.

ActiveMatrix BPM: Kerberos Configuration

This screen is only displayed if you selected Kerberos as the Authentication Type on theAuthentication Configuration screen. The name of the Shared Resource Instance must beamx.bpm.auth.kerberos.

133



Kerberos Realm The name of the domain where the Kerberos configuration applies. For example,XYZCOMPANY.COM.

Key DistributionCenter

The name or IP address of the host running the Kerberos KDC for the Kerberosrealm.



Identifies the location of the Kerberos generated, host configuration file, fromwhich the remaining configuration properties will be taken. Choose between:


If the Kerberos installation is on the same machine as the Shared Resourceinstallation.



● Generated


The following properties assume Generated has been selected. These values will be available from yourKerberos installation.



Default DNSDomain

The domain used to expand hostnames when translating Kerberos 4 serviceprincipals to Kerberos 5 principals. Domain names should be in lower-case.

Service PrincipalName (SPN)

The principal name of the service that is to be protected. When a service ticket isreceived, it is verified, using the KDC, against the SPN specified here.

Key Tab FileName:

The path to the key tab file containing the credentials of the service to be verifiedagainst the incoming request.


ActiveMatrix BPM: OpenID Connect Configuration

This screen is only displayed if you selected Open ID as the Authentication Type on theAuthentication Configuration screen.

Microsoft Active Directory Federation Services (ADFS) is the only Identity Provider (IdP) that issupported by, and has been tested with, ActiveMatrix BPM.

134


Field / Option Description

Client ID The ID that identifies the client at the Identify Provider. This, and the ClientSecret (see below), are obtained from the IdP when the client registers anapplication with the IdP for the purpose of providing authentication for users.

For information, see "Registering an Application at an Identity Provider" in theTIBCO ActiveMatrix Single Sign-On guide.

Client Secret The password for the Client ID account. See the description above.

Redirect URI The URI to which the IdP will redirect the user after authenticating the user andgenerating an ID Token. For all ActiveMatrix BPM applications, this must be thefollowing:http://host:port/openspace/sso/bpmssoapp.html

where host is the DNS name or IP address of the server that hosts theActiveMatrix BPM runtime, and port is the port used by the application.

Also note that this URI must match exactly the Redirect URI that was specifiedwhen registering the application with the IdP.

For more information, see "Registering an Application at an Identity Provider" inthe TIBCO ActiveMatrix Single Sign-On guide.

AuthorizationInfo URI

The REST Open ID user claims/information service URI, which is used to obtainuser profile information.

This URI, which is unique to the IdP, can be obtained from the IdP's website onwhich they describe how to register an application with the IdP.

For Microsoft ADFS, this must be:https://host:port/adfs/oauth2/authorize


Access TokenURI

The REST OpenID token service URI, which is used to obtain an ID Token for theauthenticated user.

Using the OpenID Access Token is not currently supported inActiveMatrix BPM. The OpenID ID Token is used to identify the user.


For Microsoft ADFS, this must be:https://host:port/adfs/oauth2/token


135



JSON Web KeySet URI

The URI to the JSON Web Key Set (JWKS), which is a JSON data structure thatrepresents a set of public keys used to verify the signature of the JSON WebToken (JWT) ID Token issued by the IdP.


For Microsoft ADFS, this must be:https://host:port/adfs/discovery/keys


Auth ScopeOptional)

Defines the claims to be returned by the IdP when the IdP authenticates the userand issues an ID Token. These claims are user attributes and are intended toprovide the application with user details.

The openid scope is included by default (even though it does not appear in theAuth Scope field by default). (The openid scope causes the sub claim to bereturned, which uniquely identifies the user.) However, if any scope is entered inthe Auth Scope field, it overrides the default value of openid. Because of that,for ActiveMatrix BPM applications, you MUST include openid, and possiblyanother scope, depending on your IdP.

For Microsoft ADFS, this must be:openid,upn

Multiple scopes can be either comma- or space-separated in the Auth Scopefield.

User Key(optional)

From the list of claims that are returned from the IdP (based on the Auth Scope),this specifies the claim that is used to identify the user.

For Microsoft ADFS, this must be:upn

The upn claim contains the user's email address, which is used in the finalauthentication step to verify that the user is a valid ActiveMatrix BPM user.

Logout Path When a user logs out of an ActiveMatrix BPM application, the browser sendsthis value to the ActiveMatrix BPM server. This property must be set to:

/bpm/logout

This value indicates to the server that it needs to send a request to the IdP to logthe user out, using the value specified in the SignOutURL property (see below).

If you are using Openspace, Workspace, or a custom WCC application, you mustalso specify this same logout path in the respective configuration file for thoseapplications. For Openspace, see "Configuring What Happens on OpenspaceLogout" in the TIBCO Openspace Customization Guide. For Workspace and customWCC applications, see "Logout Path" in the TIBCO Workspace Configuration andCustomization Guide.

136



Signout URL Upon receiving "/bpm/logout" in the LogOutPath property, the server uses thisURL to send the IdP a request to log the user out of the IdP.

The signout URL is specific to the IdP.

For Microsoft ADFS, this must be:https://host:port/adfs/ls/?wa=wsignout1.0


Redirecting to the application landing page

Depending on the IdP, you may be able to append an additional URL to theSignout URL to cause the IdP to redirect the user to the ActiveMatrix BPMapplication's landing page after logging out the user. Not all IdPs support thisfeature; they may just display a standard logout page stating that the user hasbeen successfully logged out. Also, the parameter name appended to the SignoutURL used to specify user redirect varies between IdPs.

For Microsoft ADFS, this must be:https://host:port/adfs/ls/?wa=wsignout1.0&wreply=http://host:port/appPath

where host is the DNS name or IP address of the server that hosts theActiveMatrix BPM runtime, port is the port used by the application, and appPathis the path to the application's landing page.

For additional information about using OpenID Connect for authentication, see the TIBCO ActiveMatrixBPM Single Sign-On guide.

ActiveMatrix BPM: SAML Web Profile ConfigurationUse the fields on this screen to configure ActiveMatrix BPM to use SAML Web Profile to authenticateusers of ActiveMatrix BPM applications.

This screen is only displayed if you selected SAML SSO Web Profile as the Authentication Type onthe Authentication Configuration screen.

This screen contains a subset of the available SAML Web Profile configuration parameters. All otherSAML Web Profile configuration parameters contain default values, and can be modified postinstallation using TIBCO ActiveMatrix Administrator. For information about all of the availableparameters, see "Using ActiveMatrix Administrator to Create a SAML Web Profile Shared Resource" inTIBCO ActiveMatrix BPM Single Sign-On.


Entity ID A unique ID that identifies the service provider and application that has beenregistered with an IdP.

This must match the ID that was configured at the IdP.

IDP MetadataURL

The HTTP URL of the metadata file that was returned by the IdP when yourapplication was registered with the IdP. (You cannot specify a file path, nor a"file://xx/xx" URL. This can only be specified as an HTTP URL.)

137



AuthenticationSuccessful URL

The URL to which the user is redirected after being authenticated by the IdP.This must be:http://host:port/openspace/sso/bpmssoapp.html


Although the Authentication Successful URL is used for all ActiveMatrix BPMapplications, the response from the IdP is routed to the appropriateActiveMatrix BPM application based on an interceptor script (bpm-sso-interceptor.min.js) that is included in the application that submitted therequest to the IdP (for more information about the interceptor script, see "UsingSAML Web Profile Authentication with Custom Applications" in TIBCOActiveMatrix BPM Single Sign-On).

ActiveMatrix BPM: Administrator Server Configuration


Use ExistingActiveMatrixAdministratorServer

Whether to use an existing ActiveMatrix Administrator server.

When this option is selected, the remaining fields on the screen are enabled. (Inthis case, the ActiveMatrix BPM: Host and Node Configuration screen is displayedwhen you click Next on this screen.) Select this option if you are installing thisBPM system into an existing ActiveMatrix enterprise.

When this option is cleared, you use subsequent screens in the wizard to create anew ActiveMatrix Administrator server - see Create TIBCO ActiveMatrixAdministrator Server Wizard for more detailed information about the remainingscreens. (In this case, the Administrator Server Configuration: Details screen isdisplayed when you click Next on this screen.)

Default: Selected

build.properties entry: bpm.adminserver.bindadmin

Machine Name Name of the machine that hosts the ActiveMatrix Administrator server for thisActiveMatrix enterprise. The value of this property must either be a hostnameresolvable through DNS or 0.0.0.0; it cannot be an IP address.

Default: Name of the machine on which TIBCO Configuration Tool is running.

build.properties entry: bpm.adminserver.bpm.host

Port Browser port used to access the ActiveMatrix Administrator server.

If this BPM system is distributed across different machines (to providehigh availability and/or scalability), this port should be configured forload balancing across all required machines - see Load Balancer.

Default: 8120

build.properties entry: bpm.adminserver.port

138



Username ID of the ActiveMatrix Administrator superuser.

Default: root

build.properties entry: bpm.adminserver.username

Password Password of the ActiveMatrix Administrator superuser.

Default: t

build.properties entry: bpm.adminserver.password

Admin serveris SSL enabled

Whether the Administrator server internal port is enabled for SSL. When selected,SSL Keystore Configuration fields are displayed.

If this BPM system is distributed across different machines (to providehigh availability and/or scalability), the Trust Store Location must beSHARED_DIR\keystores - see Shared File System.

build.properties entry: bpm.adminserver.enablessl

TestConnection

Verifies that TIBCO Configuration Tool can connect to the Administrator serverusing the information supplied on this page.

SSL Keystore Configuration:

Create a TrustStore

Obtains certificates from the specified Administrator server and creates a newtrust store, which will be used to establish the trust relationship with theAdministrator server:


2. Specify a password to protect the keystore and click Next . The SSL setupwizard displays the certificates imported from the Administrator server.

3. In the Trust Selected Certifications area, select the certificates to trust and clickFinish. The wizard fills in the Keystore Location, Keystore Type, and KeystorePassword fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship with theAdministrator server.

Trust StoreLocation

Either:



build.properties entry: bpm.adminserver.ssl.truststore

Trust KeystoreType


Default: JKS.

build.properties entry: bpm.adminserver.ssl.truststoretype

139



Trust StorePassword

Either:



build.properties entry: bpm.adminserver.ssl.truststorepassword

ActiveMatrix BPM: JMS Configuration


Use Admin EMSConfiguration

Whether to use the internal EMS server to handle inbound JMS requests. If thisoption is:

● selected, the remaining fields show the internal EMS server details. Youcannot edit these values.

● cleared, the remaining fields are enabled, allowing you to enter the detailsof an external JMS server to use instead.

Default: Selected

Server Type The JMS server type.

Default: TIBCO EMS

JMS Url The URL of the JMS server to be used by this BPM system to handle JMSmessages.

Default: tibjmsnaming://localhost:7222

build.properties entry: bpm.userapp.jndi.jms.url

Initial Context The initial context factory to use for the JNDI lookup of the JMS server. TIBCOrecommend that you do not change the default value.

Default: com.tibco.tibjms.naming.TibjmsInitialContextfactory

build.properties entry: bpm.userapp.jms.initial.context

ConnectionFactory

The name of the connection factory used to create the connection to the JMSserver. TIBCO recommend that you do not change the default value.

Default: GenericConnectionFactory

build.properties entry: bpm.jms.connection.factory

Inbound RequestQueue

The name of the JMS server queue that this BPM system uses to receivemessages. TIBCO recommend that you do not change the default value.

Default: queue.sample

build.properties entry: bpm.userapp.jms.request

140



Username The user account to be used to connect to the JMS server.

Default: admin

build.properties entry: bpm.userapp.jms.username

Password The password for the user account to be used to connect to the JMS server.

build.properties entry: bpm.userapp.jms.password

JMS Connection isSSL Enabled

Whether the external JMS server is enabled for SSL. When selected, the SSLTrust Store Configuration fields are enabled. (This option is not available if theinternal EMS server is being used.)

If this BPM system is distributed across different machines (toprovide high availability and/or scalability), the Trust Store Locationmust be SHARED_DIR\keystores - see Shared File System.

Default: Cleared

build.properties entry: bpm.userapp.jms.enablessl

Test Connection Verifies that TIBCO Configuration Tool can connect to the JMS server using theinformation supplied on this page.


Create a TrustStore

Obtains certificates from the specified JMS server and creates a new trust store,which will be used to establish the trust relationship with the JMS server:


2. Specify a password to protect the keystore and click Next. The SSL setupwizard displays the certificates imported from the JMS server.

3. In the Trust Selected Certifications area, select the certificates to trust andclick Finish. The wizard fills in the Keystore Location, Keystore Type, andKeystore Password fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship withthe JMS server.

Trust StoreLocation

Either:



build.properties entry: bpm.userapp.jms.ssl.keystorelocation

Trust KeystoreType


Default: JKS

build.properties entry: bpm.userapp.jms.ssl.keystoretype

141



Trust StorePassword

Either:



build.properties entry: bpm.userapp.jms.ssl.keystorepassword

This information is used to create the following BPM runtime resource templates/instances, which thisBPM system uses to communicate with the JMS server.

Type Name Description

JNDI ConnectionConfiguration

amx.bpm.userapp.jndiConnConf

Provides a JNDI connection to look up the JMSserver.

JMS ConnectionFactory Configuration

amx.bpm.userapp.jmsConnFactoryConf

These two are used (with the JNDI ConnectionConfiguration) to establish inboundcommunication with the JMS server.

JMS DestinationConfiguration

amx.bpm.userapp.jms.request.conf

JMS ConnectionFactory

amx.bpm.userapp.jmsConnFactory

Used (with the JNDI Connection Configuration)to establish outbound communication with theJMS server.

The following table shows how certain ActiveMatrix BPM: JMS Configuration fields are mapped to thespecified resource templates, via BPM application substituion variables (SVars).

Value of theActiveMatrix BPM:JMS Configurationfield ...

... is written to theBPM applicationSVar...

... which is used inResourceTemplate(s) ...

... to populate thefield ...

JMS Url userappProviderUrl amx.bpm.userapp.jndiConnConf

Provider URL

Initial Context userappInitialContextFactory

amx.bpm.userapp.jndiConnConf

Initial Context Factory

Connection Factory userappConnectionFactory

amx.bpm.userapp.jmsConnFactoryConf

Connection FactoryJNDI Name

amx.bpm.userapp.jmsConnFactory

Connection FactoryJNDI Name

Inbound RequestQueue

userappJmsRequest amx.bpm.userapp.jms.request.conf

Destination JNDIName

See "Resource Templates > Shared Resource Templates" in TIBCO ActiveMatrix BPM - SOAAdministration for more information about these shared resources.

142


ActiveMatrix BPM: Host and Node Configuration

This screen is only displayed if you selected Use Existing ActiveMatrix Administrator Server on the Administrator Server Configuration screen.

The Administrator Server Configuration: Summary screen is displayed when you click Next on thisscreen.


Host Name of the TIBCO Host instance on which the BPM system will be created.

This can be either a new host, or an existing host that is bound to the specifiedActiveMatrix Administrator server.

Default: None

build.properties entry: bpm.host

EnvironmentName

Name of the ActiveMatrix environment in which the BPM system will be created.

This can be either a new environment, or an existing environment (that is part ofthe ActiveMatrix enterprise managed by the specified ActiveMatrix Administratorserver).

Default: BPMEnvironment

build.properties entry: dev.envt.name

Node Name Name of the new ActiveMatrix node on which the BPM system will be created.(This node will be a BPM logical node of type BPM Node.)

Default: BPMNode

build.properties entry: dev.node.name

NodeManagementPort

Management port number used by the specified ActiveMatrix node. This portmust not be in use by another ActiveMatrix node on the same machine.

Default: 6031

build.properties entry: dev.node.port

Administrator Server Configuration: Summary

The following description applies to this screen only when it is displayed from the Create TIBCOActiveMatrix BPM Server Wizard.

If you are using the Create TIBCO ActiveMatrix Administrator Server Wizard , please see thealternative Administrator Server Configuration: Summary description instead.


Session Scripts and LogFolder

The location where scripts and logs generated by this TIBCOConfiguration Tool session are stored.

Default: CONFIG_HOME\tct\bpm\timestamp

143



Administrator URL The URL to be used to access the ActiveMatrix Administrator webinterface.

Default: http://machineName:port/amxadministrator/loginForm.jsp

where:

● machineName is the name of the machine on which you are runningTIBCO Configuration Tool.

● port is the External HTTP Port number used by the ActiveMatrixAdministrator server (as specified in the Administrator ServerConfiguration: Connection Settings screen).

Click Configure to execute the following actions:

Create TIBCOActiveMatrixAdministrator server

Whether to create the ActiveMatrix Administrator server.

This option is only displayed if you cleared Use ExistingActiveMatrix Administrator Server in the ActiveMatrixBPM: Administrator Server Configuration screen.

Default: Selected

Deploy Monitoring Service Whether to deploy the ActiveMatrix monitoring service. TIBCO doesnot recommend deploying the ActiveMatrix Monitoring service onBPM production systems without first verifying its performance on atest system configured for the desired system usage and load.

Default: Cleared

Deploy Log Service Whether to deploy the ActiveMatrix logging service. TIBCO does notrecommend deploying the ActiveMatrix logging service on BPMproduction systems without first verifying its performance on a testsystem configured for the desired system usage and load.

Default: Cleared

Create ActiveMatrix BPM Whether to create the BPM system.

The message [Not Creating Database Instance] is displayed ifyou chose not to create the ActiveMatrix BPM database in the ActiveMatrix BPM: Database Administrator screen (by clearing CreateBPM Database Instance).

In this case, TIBCO Configuration Tool will not automatically createthe BPM database, and you must manually create it instead - see Manually Creating the BPM Database for more information. You mustdo this before clicking Configure from this screen.

Default: Selected

144


Create TIBCO ActiveMatrix Administrator Server WizardThis section provides reference information about the TIBCO Configuration Tool Configure TIBCOActiveMatrix Administrator Server wizard.



Welcome

Field Description


Whether all communication channels used by TIBCO Administrator shouldbe secured with SSL. See Securing Communication Channels forbackground information.

Default: Cleared

145


Administrator Server Configuration: Details

Field Description

Enterprise Name Defines a communication group for notification messages sent betweenActiveMatrix Administrator server, the hosts that are bound to the server, andthe nodes that are managed by those hosts.

Default: Either:

● AMX BPM - if you are running the Create TIBCO ActiveMatrix BPM ServerWizard, or

● amxadmin - if you are running the Create TIBCO ActiveMatrixAdministrator Server Wizard

The enterprise name specified here is displayed, by default, on the ActiveMatrixAdministrator login banner as the default text, in default colors. The banner textand colors can be customized using the following properties in theSystemNode.tra file:

● java.property.com.tibco.admin.gui.login.screen.banner.text=<Lo

gin Banner Text>

Banner text for the Login screen.

● java.property.com.tibco.admin.gui.login.screen.banner.text.fon

tColor=<RGB, HEX or HTML Color Name>

Banner color for the Login screen.

● java.property.com.tibco.admin.gui.topPanel.banner.text=<Naviga

tion Banner Text>

Banner text for the Navigation page.

Both Banner texts, if not configured explicitly with System properties, currentlydisplay the name of the TIBCO Enterprise specified in the TIBCO ConfigurationTool during Enterprise creation. A maximum of 80 characters of the Banner textare displayed, after which they are truncated and the complete text is displayedvia a mouse-over HTML Tooltip.

Server Name The name of the ActiveMatrix Administrator server.

Default: Either:

● AMXBPM Server - if you are running the Create TIBCO ActiveMatrix BPMServer Wizard, or

● instanceOne - if you are running the Create TIBCO ActiveMatrixAdministrator Server Wizard

146


Administrator Server Configuration: TIBCO Host Configuration

Field Description

Machine Name Name of the machine on which the TIBCO Host instance runs. The value of thisproperty must either be a hostname resolvable through DNS or 0.0.0.0 or IPaddress.

Default: machineName, where machineName is the machine on which TIBCOConfiguration Tool is being executed.

Port Management port of the TIBCO Host instance.

Default: 6051

Register asWindows Service

Indicate whether the TIBCO Host instance should be registered as a Windowsservice named TIBCO ActiveMatrix Admin-enterpriseName-serverName withstartup type Automatic. The service is not started.

Default: Cleared

Create WindowsShortcut

Indicate whether a shortcut named TIBCO ActiveMatrix Admin-enterpriseName-serverName that points to:

CONFIG_HOME\tibcohost\Admin-enterpriseName-serverName\host\bin

\tibcohost.exe

should be added to the Windows desktop.

Default: Cleared

Customize BPMNode

Indicate whether to customize the BPM environment and node.

This field is only displayed if you are running the Create TIBCO ActiveMatrixBPM Server Wizard. When selected, the Environment Name, Node Name, andNode Management Port fields display.

Default: Selected

CreateDevelopmentNode

Indicate whether to create a development environment and node.

This field is only displayed if you are running the Create TIBCO ActiveMatrixAdministrator Server Wizard. When selected, the Environment Name, NodeName, and Node Management Port fields display.

Default: Selected

EnvironmentName

Name of the environment that contains the node.

Default: Either:

● BPM environment - if you are running the Create TIBCO ActiveMatrix BPMServer Wizard, or

● DevEnvironment - if you are running the Create TIBCO ActiveMatrixAdministrator Server Wizard

147


Field Description

Node Name Name of the node.

Default: Either:

● BPMNode - if you are running the Create TIBCO ActiveMatrix BPM ServerWizard, or

● DevNode - if you are running the Create TIBCO ActiveMatrix AdministratorServer Wizard

NodeManagement Port

Management port used by the node.

Default: Either:

● 6031 - if you are running the Create TIBCO ActiveMatrix BPM ServerWizard, or

● 6038 - if you are running the Create TIBCO ActiveMatrix AdministratorServer Wizard

Administrator Server Configuration: Connection Settings


Network Adapter The address of the network adapter on the machine on which the ActiveMatrixAdministrator server runs. The default is set to 0.0.0.0 so that ActiveMatrixAdministrator will listen on all network adapters (including http://localhost andhttp://hostname); clients can then connect to the ActiveMatrix Administratorserver using any of the conventions (localhost, IP address, hostname). The valueof this property must either be a hostname resolvable through DNS or 0.0.0.0; itcannot be an IP address.

Management Port The management port number of the node, SystemNode, that runs theActiveMatrix Administrator server.

Default: 6021

External HTTPPort

Port on which Administrator clients access the ActiveMatrix Administratorserver.

Default: 8120

Browser IdleSession Timeout(m)

The length of time before an inactive ActiveMatrix Administrator GUI loginsession times out.

Default: 30 (minutes)

Enable SSL forExternal HTTPPort

Indicate whether communication between ActiveMatrix Administrator serverand clients should be secured with SSL. When selected, the Self-SignedCertificate and Imported Certificate radio buttons display.

Default: Cleared

148



Self-SignedCertificate

Indicate that ActiveMatrix Administrator server will identify itself to clientswith a self-signed certificate. When selected it uses the self-signed certificatefrom the samples folder.

Do not use a self-signed certificate in production environments.

Default: Selected.

ImportedCertificate

Indicate that clients can identify the ActiveMatrix Administrator server with acertificate imported into ActiveMatrix Administrator server. When selected, theKeystore fields and Fetch Keystore button are enabled.

KeystoreLocation

The location of the keystore to import.

Keystore Type The type of the uploaded keystore.

KeystorePassword

The password that protects the keystore.

Fetch Keystore Retrieves the aliases from the specified keystore. The Key Alias field, KeyPassword field and Verify keystore button are displayed.

Key Alias The key alias that identifies the ActiveMatrix Administrator server entry in thekeystore.

Key Password The password that protects the specified Key Alias.

Verify Keystore Verifies that TIBCO Configuration Tool can retrieve the specified keystore aliasusing the information supplied on this page.

Administrator Server Configuration: Internal HTTP Settings

Field Description

Internal HTTP Port The number of the internal ActiveMatrix Administrator HTTP port.

Default: 19767

Enable SSL forInternal HTTP Port

Indicate whether communication between ActiveMatrix Administrator serverand hosts is secured with SSL.

Default: Cleared

149


Administrator Server Configuration: Notification and Messaging Bus Server


Machine NamePort List

A comma separated list of machinename:port addresses for a TIBCO EnterpriseMessage Service server.

Default: protocol://machinename:7222, where:

● protocol is tcp or, if the Enterprise Message Service server is SSL enabled,ssl.

● machinename is the machine on which TIBCO Configuration Tool is beingexecuted

Username A username for the TIBCO Enterprise Message Service server. The user musthave administrator privileges in the TIBCO Enterprise Message Service server.If the user does not have administrator privileges, see Configuring TIBCOEnterprise Message Service Servers.

Default: admin

Password A password for the TIBCO Enterprise Message Service user.

Default: None

TIBCO EnterpriseMessage ServiceServer is SSLEnabled

Indicate that the TIBCO Enterprise Message Service server is enabled for SSL.When selected, the SSL Keystore Configuration fields are enabled.

The TIBCO Enterprise Message Service server usually listens on port7243 when SSL-enabled. You must update the port value(s) in theMachine Name Port List field before proceeding with SSLconfiguration.

No MessagingBus

Indicates whether the enterprises uses a messaging bus.

Do not select this checkbox when configuring TIBCO ActiveMatrixBPM.

Default: Cleared.

Test Connection Verifies that TIBCO Configuration Tool can connect to the server using theinformation supplied on this page.

SSL KeyStore Configuration:

150



Create a TrustStore

Invokes a wizard to obtain certificates from the specified server and create thetrust store:


2. Specify a password to protect the keystore and click Next. The SSL setupwizard displays the certificates imported from the server.

3. In the Trusted Certificates area, select the certificates to trust and clickFinish. The wizard fills in the Keystore Location, Keystore Type andKeystore Password fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship withthe server.

KeystoreLocation

Either:


● the location of the trust store to be uploaded to ActiveMatrix Administrator.(You can either type this directly or click Browse to find it.)

Keystore Type The type of the created or uploaded trust store: JKS or JCEKS.

Default: JKS

KeystorePassword

Either:



Administrator Server Configuration: Enterprise Message Service Connection Factory

Field Description

Select NewConnectionFactory

Specify whether to use a connection factory that is configured for fault-tolerance.

Default: Cleared. If selected, the Connection Factory Name field displays.

ConnectionFactory Name

A connection factory that matches your input of multiple Enterprise MessageService servers.

151


Administrator Server Configuration: Database Details


Use Default In-Process Database

Indicate that the ActiveMatrix Administrator server database is an embeddedin-process database. If cleared, the external database configuration fieldsdisplay.

Use the embedded in-process database only during development.

Default: Either:

● Cleared - if you are running the Create TIBCO ActiveMatrix BPM ServerWizard, or

● Selected - if you are running the Create TIBCO ActiveMatrix AdministratorServer Wizard

The properties that the wizard sets in the build.properties filedepend on the context in which the prompts are displayed. Bydefault, specify the properties for the Administrator Server databaseand the information is then used for the Notification Service database,the Log Service database, and the Payload Service database. You can,however, overwrite the values for the Notification Service, LogService, and Payload Service, and you can change them in thebuild.properties file.

Database Driver The driver for the external database.

Default: TIBCO-provided JDBC driver for HSQL 1.8.400

Database URL The URL of the external database.

For a Microsoft SQL Server database, you must use the followingformat for the URL:

jdbc:sqlserver://host:port;DatabaseName=dbNname

Default: jdbc:hsqldb:hsql://localhost:1234/amx

Username The external database username.

Default: sa

Password The external database password.

Default: None

Max Connections The maximum number of database connections to allocate.

Default: 10

Database Serveris SSL Enabled

Indicate that the database server is enabled for SSL. When selected, the SSLKeystore Configuration fields are enabled.


152




Create a TrustStore






Trust KeystoreLocation

Either:



Trust KeystoreType


Default: JKS

Trust KeystorePassword

Either:



Administrator Server Configuration: Authentication Realm

Field Description

Authentication Realm

Realm Type The type of the authentication realm:

● Database - the Administrator Server Configuration: Database AuthenticationRealm Details screen displays.

● LDAP - the Administrator Server Configuration: LDAP Authentication RealmDetails screens display.

Superuser Credentials (This section is only displayed if the LDAP Realm Type is selected.)

Username The ID of the initial superuser.

Default: root

153


Field Description

Password The password of the superuser.

Default: t

Administrator Server Configuration: Database Authentication Realm Details

This screen is only displayed if you selected Database as the Realm Type on the Administrator ServerConfiguration Authentication Realm screen.


UseActiveMatrixAdministratorServerDatabase

Specify whether the database authentication realm should use the same databaseas the ActiveMatrix Administrator server.

Default: Selected. If cleared, the database configuration fields display.


The properties that the wizard sets in the build.properties filedepend on the context in which the prompts are displayed. By default,specify the properties for the Administrator Server database and theinformation is then used for the Notification Service database, the LogService database, and the Payload Service database. You can, however,overwrite the values for the Notification Service, Log Service, andPayload Service, and you can change them in the build.propertiesfile.

DatabaseDriver

The driver for the external database.





Default: sa


Default: None

MaxConnections

The maximum number of database connections to allocate.

Default: 10

DatabaseServer is SSLEnabled


TestConnection

Verifies that TIBCO Configuration Tool can connect to the server using theinformation supplied on this page.


154



Create a TrustStore




3. In the Trust Selected Certifications area, select the certificates to trust and clickFinish. The wizard fills in the Keystore Location, Keystore Type and KeystorePassword fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship with theserver.


Either:



Trust KeystoreType


Default: JKS


Either:



Administrator Server Configuration: LDAP Authentication Realm Details

This screen is only displayed if you selected LDAP as the Realm Type on the Administrator ServerConfiguration: Authentication Realm screen.

Field Description

Bind DN Name The superuser's distinguished name or superuser's name to be used to connectto the server.

Default: uid=Manager,ou=people,dc=example,dc=com

Password LDAP server password.

Context Factory The factory object that provides the starting point for resolution of nameswithin the LDAP server.

Default: com.sun.jndi.ldap.LdapCtxFactory

155


Field Description


Comma-separated list of URLs for an LDAP server. To achieve fault tolerance,you can specify multiple URLs. For example:

ldap://server1.example.com:686,ldap://server2.example.com:1686

Default: machineName:389

Fetch DN Retrieves the base DN of the LDAP server.

User Search Configuration

User Search BaseDN (optional)

Base distinguished name from which the search starts.

Default: ou=people,ou=na,dc=example,dc=org

User SearchExpression(optional)

The expression used for searching a user. For example: (CN=%U). "%U" isreplaced by the username being searched for. You can define any complex filtersuch as (&(cn=%U)(objectClass=account)).

Default: (&(uid={0})(objectclass=person))

User Attributewith User Name(optional)

The name of the attribute in the user object that contains the user's name.

Default: uid

Search Timeout(ms)

The time to wait for a response from the LDAP directory server.

Default: 30000

Follow Referrals Whether to follow LDAP referrals. When selected, requests to LDAP can beredirected to another server.

Select this field to indicate that the LDAP information might be available atanother location, or possibly at another server or servers.

Ask your LDAP administrator whether LDAP referrals are used inyour domain.

Default: Cleared

Field Description

Group Indication(optional)

Specifies how a user’s group memberships are found. Administrator uses groupinformation when a user, once authenticated, performs other activities in thesystem. Options:

● Group has users - List of users that belong to the group. When selected, theGroup Attribute with User Names field is enabled.

● User has groups - List of groups to which the user belongs. When selected,the User Attribute with Group Names field is enabled.

Default: Group has users.

Group SearchBase DN(optional)

Base distinguished name from which the search for the group starts.

Default: ou=groups,ou=na,dc=example,dc=org.

156


Field Description

Group SearchExpression(optional)

Search by matching this expression against potential groups.

Default: (&(cn={0})(objectClass=groupofuniquenames)).

Group Attributewith User Names(optional)

Name of the attribute in the group object containing its users.

Example: uniqueMember (OpenLDAP) or member (ActiveDirectory).

Default: uniqueMember.

Group Attributewith GroupName (optional)

Name of the attribute in the group object that contains the name of the group.

Example: cn (OpenLDAP) or sAMAccountName (ActiveDirectory).

Default: cn.

Group AttributeSubgroup Names(optional)

Name of the attribute in the group object that contains its subgroups.



User Attributewith GroupNames

Name of the attribute in the user object that lists the groups to which the userbelongs.

Default: None.

Group SearchScope Subtree

When searching the group, indicate whether to traverse into the subtree or tosearch only under the group base distinguished name.

Default: Selected.

Field Description

LDAP Realm

User SearchScope Subtree

Select to have the search include the entire subtree starting at the base DN.Otherwise, search only the nodes one level below the base DN.

Default: Selected.

SecurityAuthentication

Value of Simple Authentication and Security Layer (SASL) authenticationprotocol to use. Values are implementation-dependent. Some possible valuesare simple, none, strong.

Default: simple.

LDAP Authentication


Select to enable the LDAP server for SSL. When selected, the SSL KeystoreConfiguration fields are enabled.

Default: Cleared.

Test Connection Click the Test Connection button to ensure that you can connect to the LDAPdatabase.

157


Field Description


Create a TrustStore







Either:



Administrator Server Configuration: LDAP Authentication Realm Details (Screen 2)

Field Description

Group Indication Specifies how a user’s group memberships are found. Groupinformation is used by ActiveMatrix Administrator when a user,once authenticated, performs other activities in the system.

Options:

● Group has users — List of users that belong to the group. Whenselected, the Group Attribute with User Names field is enabled.

● User has groups — List of groups to which the user belongs.When selected, the User Attribute with Group Names field isenabled.

Default: Group has users

Group Search Base DN Base distinguished name from which the search for the groupstarts.

Default: ou=groups,ou=na,dc=example,dc=org

Group Search Expression Search by matching this expression against potential groups.

Default: cn={0}

158


Field Description

Group Attribute with UserNames


Example: uniqueMember (OpenLDAP) or member(ActiveDirectory).

Default: uniqueMember

Group Attribute with GroupName

Name of the attribute in the group object that contains the name ofthe group.


Default: cn

Group Attribute withSubgroup Names

Name of the attribute in the group object that contains itssubgroups.

Example: uniqueMember (OpenLDAP) or member(ActiveDirectory).

Default: uniqueMember

User Attribute with GroupNames

Name of the attribute in the user object that lists the groups towhich the user belongs.

Default: None

Group Search Scope Subtree When searching the group, indicate whether to traverse into thesubtree or to search only under the group base distinguished name.

Default: Selected

Administrator Server Configuration: LDAP Authentication Realm Details (Screen 3)


LDAP Realm


Whether to search the entire subtree starting at the base DN, or search only thenodes one level below the base DN.

Default: Selected


Value of Simple Authentication and Security Layer (SASL) authentication protocolto use. Values are implementation-dependent. Some possible values are:

● Simple - Username and password are required.

● None - No log-in is performed, any other settings are ignored, and the LDAPclient is anonymous.

● md-5

Default: Simple

LDAP Server isSSL-enabled

Indicate that the LDAP server is enabled for SSL. When checked, the SSL TrustStore Configuration fields are enabled.

159



TestConnection



Create a TrustStore




3. In the Trust Selected Certifications area, select the certificates to trust and clickFinish. The wizard fills in the Keystore Location, Keystore Type and KeystorePassword fields.


Trust StoreLocation

Either:



Trust KeystoreType


Default: JKS

Trust StorePassword

Either:



Administrator Server Configuration: Credential Server Details

Field Description

Network Adapter Address of the network adapter on the machine on which TIBCOCredential Server runs. The default is set to 0.0.0.0 so that TIBCOCredential Server will listen on all network adapters (including http://localhost and http://hostname). With the default setting, clients canconnect to TIBCO Credential Server using any of the conventions(localhost, IP address, hostname). The value of this property musteither be a hostname resolvable through DNS or 0.0.0.0; it cannot be anIP address.

Default: 0.0.0.0

160


Field Description

Port Management port number of the node, SystemNode, that runs TIBCOCredential Server.

Default: 6041

Username User identifier for TIBCO Credential Server clients.

Default: user1

Password Password for the client.

Administrator Server Configuration: Credential Server Keystore


Auto-generatedKeystore

Indicate that the TIBCO Credential Server keystore will be generated. Whenselected, Common Name is enabled.

Default: Selected

Common Name The TIBCO Credential Server’s issuer name.

Default: amxadmin

ProvidedKeystore

Indicate that the TIBCO Credential Server keystore will be provided. Whenselected, the Keystore fields are enabled.

KeystoreLocation



Default: Autodetect (The actual keystore type is displayed when you click FetchKeystore.)

KeystorePassword



Key Alias The key alias that identifies the required entry in the keystore.



Administrator Server Configuration: Logging Notification ServerA log service is a TIBCO ActiveMatrix application that offers logging services. The log serviceapplication com.tibco.amx.commonlogging.logservice.app is deployed in the environmentSystemEnvironment on SystemNode, the node that runs the Administrator server.

161



UseActiveMatrixAdministratorNotificationand MessagingBus Server

Specify whether the monitoring service should use the same notification server asthe ActiveMatrix Administrator server.

Default: Selected. If cleared, the notification server configuration fields areenabled.

As part of configuration, set up the notification and messaging bus server.


A comma-separated list of machinename:port addresses for a TIBCO EnterpriseMessage Service server.

Default: machinename:7222, where:

● protocol is tcp or, if the Enterprise Message Service server is SSL enabled, ssl.


Username A username for the TIBCO Enterprise Message Service server. The user must haveadministrator privileges in the TIBCO Enterprise Message Service server. If theuser does not have administrator privileges, see Configuring TIBCO EnterpriseMessage Service Servers.

Default: admin


Default: None

TIBCOEnterpriseMessageService Serveris SSL Enabled


The TIBCO Enterprise Message Service server usually listens on port7243 when SSL-enabled and you must update the Machine Name PortList value before proceeding with SSL configuration.

TestConnection



Create a TrustStore




3. In the Trusted Certificates area, select the certificates to trust and click Finish.The wizard fills in the Keystore Location, Keystore Type and KeystorePassword fields.


162



KeystoreLocation

Either:




Default: JKS

KeystorePassword

Either:



Administrator Server Configuration: Log Service Database ConfigurationA log service is a TIBCO ActiveMatrix application that offers logging services. The log serviceapplication is deployed in the environment SystemEnvironment on SystemNode, the node that runs theAdministrator server. A log service receives log entries sent to a JMS destination and stores the entriesin a database.

If you did not deploy the logging and payload services when you created the Administrator serverusing the TIBCO Configuration Tool, see TIBCO_HOME\administrator\version\scripts\logging\readme.txt.


Use ActiveMatrixAdministratorServer Database

Indicate that the log service should use the same database as the ActiveMatrixAdministrator server.


Default: Selected. If cleared, the remaining fields are enabled.






163




Default: sa


Default: None


Default: 10

Database serveris SSL Enabled

Indicate that the database server is enabled for SSL. When checked, the SSLKeystore Configuration fields are enabled.



Create a TrustStore






KeystoreLocation

Either:




Default: JKS

KeystorePassword

Either:



Administrator Server Configuration: Payload Service Database ConfigurationA payload service supports archiving, persisting and retrieving large size payload data. It is anindependent service and does not depend on a log service. However, a log record sent to a log service

164


can include a payload URL field to link a log message and payload data. You can store payload data inthe same database used by Administrator server or use another database.

If you did not deploy the logging and payload services when you created the Administrator serverusing the TIBCO Configuration Tool, see TIBCO_HOME\administrator\version\scripts\logging\readme.txt.


Use ActiveMatrixAdministratorServer Database

Indicate that the payload service should use the same database as theActiveMatrix Administrator server.


Default: Selected. If cleared, the remaining fields are enabled.



Default: TIBCO-provided JDBC driver for HSQLDB 1.8.400




Default: sa


Default: None


Default: 10


Indicate that the database server is enabled for SSL. When checked, the SSLKeystore Configuration fields are enabled.

Default: Cleared



165



Create a TrustStore




3. In the Trust Selected Certifications area, select the certificates to trust andclick Finish. The wizard fills in the Keystore Location, Keystore Type andKeystore Password fields.


KeystoreLocation

Either:




Default: JKS

KeystorePassword

Either:




The following description applies to this screen only when it is displayed from the Create TIBCOActiveMatrix Administrator Server Wizard.

If you are using the Create TIBCO ActiveMatrix BPM Server Wizard, please see the alternative Administrator Server Configuration: Summary description instead.

Field Description

Session Scriptsand Log Folder

Folder containing the script configured in the wizard and the log file if thescript is executed.

AdministratorURL

If an Administrator server was configured in the wizard, a link to the URL ofthe Administrator server.

Actions Actions that will be performed when you click the Configure button. Select thecheck boxes next to the actions you want to execute.

166


Field Description

Products toDeploy

Product applications that will be deployed on the node if one has beenconfigured. All products are selected by default. Clear the check boxes next toproducts you do not want deployed.

If you do not deploy the logging and payload services when you created theAdministrator server using the TIBCO Configuration Tool, see TIBCO_HOME\administrator\version\scripts\logging\readme.txt.

Save Saves the configuration in the location specified in the Session Scripts and LogFolder field.

Configure Saves the configuration in the location specified in the Session Scripts and LogFolder field and performs the actions specified in Actions and Products toDeploy.

Cancel Returns to the wizard selector screen.

Create TIBCO Host Instance WizardThis section provides reference information about the TIBCO Configuration Tool Create TIBCO HostInstance wizard.

If you create a TIBCO Host instance, you cannot use that instance with an older version of theActiveMatrix Administrator server.

Welcome

Field Description


Whether all communication channels used by this TIBCO Host instanceshould be secured with SSL.

Select this check box to pre-select all SSL Enabled check boxes insubsequent pages of this wizard. (You will be able to override this choiceand select or clear those check boxes on their individual pages.)

Default: Cleared

TIBCO Host Instance Configuration: Details

Field Description

Name Name of the TIBCO Host instance. The name must be unique within theenterprise.

Default: None

EnterpriseName

Name that defines a communication group for status messages sent betweenActiveMatrix Administrator server and the hosts that are bound to the server.

Default: amxadmin

167


Field Description

Machine Name Name of the machine on which the TIBCO Host instance runs.

Default: machineName, where machineName is the machine on which TIBCOConfiguration Tool is being executed.

ManagementPort

Management port of the TIBCO Host instance.

Default: 6001

Register asWindowsService

Whether the TIBCO Host instance should be registered as a Windows servicenamed "TIBCO ActiveMatrix instanceName", where instanceName is the Name youspecified, with startup type Automatic. The service is not started.

Default: Cleared

CreateWindowsShortcut

Whether to create a shortcut named instanceName on the Windows desktop thatpoints to

CONFIG_HOME\tibcohost\instanceName\host\bin\tibcohost.exe

and launches the TIBCO Host instance.

Default: Cleared

TIBCO Host Instance Configuration: Notification ServerWhen you create a standalone TIBCO Host instance, you can specify an associated notification server.This notification server can be the same server as that used by the Administrator, or you can define adifferent notification server.

The Notification Server is an Enterprise Message Service server that performs two essential systemfunctions within the TIBCO ActiveMatrix platform. It delivers status messages sent by hosts and nodesto the Administrator server.

If you intend to enable SSL communications, see Securing Communication Channels.



A comma-separated list of machinename:port addresses for a TIBCO EnterpriseMessage Service server.

Default: protocol://machinename:7222, where:

● protocol is tcp or, if the Enterprise Message Service server is SSL enabled,ssl.


Username A username for the TIBCO Enterprise Message Service server. The user musthave administrator privileges in the TIBCO Enterprise Message Service server.If the user does not have administrator privileges, see Configuring TIBCOEnterprise Message Service Servers.

Default: admin

168




Default: None

TIBCO EnterpriseMessage ServiceServer is SSLEnabled


The TIBCO Enterprise Message Service server usually listens on port7243 when SSL-enabled and you must update the Machine NamePort List value before proceeding with SSL configuration.



Create a TrustStore






KeystoreLocation

Either:




Default: JKS

KeystorePassword

Either:



169


TIBCO Host Instance Configuration: Administrator Server

Field Description

Bind toAdministratorServer

Indicate whether to bind the TIBCO Host instance to an Administrator server.When selected the Administrator server configuration fields are enabled.

Default: Selected

Machine Name The name of the machine on which the Administrator server is running. Thevalue of this property must either be a hostname resolvable through DNS or0.0.0.0 or IP address.

Default: None

Port The browser port used to access the Administrator server.

Default: 8120


Default: root


Default: t

Assign this Hostto AllEnvironments

Whether the host is assigned to all environments. When cleared, the host isassigned to no environment initially. You can use ActiveMatrix Administrator toexplicitly assign the host to selected environments after configuration iscomplete.

Default: Selected

Admin Server isSSL Enabled

Indicate that the Administrator server internal port (see Administrator ServerConfiguration: Internal HTTP Settings) is enabled for SSL. When selected, theSSL Keystore Configuration fields are enabled.


Create a TrustStore






170


Field Description


Either:



Trust KeystoreType


Default: JKS


Either:



TIBCO Host Instance Configuration: Summary




Default: CONFIG_HOME\tct\tibcohost\timestamp


Create TIBCO Hostinstance

Whether to create a new TIBCO Host instance.

Default: Selected

Launch TIBCO Hostinstance

Whether to launch the new TIBCO Host instance.

Default: Selected

Register TIBCO Hostinstance to theAdministrator server

Whether to bind the new TIBCO Host instance to the specifiedActiveMatrix Administrator server.

Default: Selected

Configure TIBCO ActiveMatrix BPM Server Node Type WizardThis section provides reference information about the TIBCO Configuration Tool Configure TIBCOActiveMatrix BPM Server Node Type wizard.

This wizard can be run directly on the remote machine (where the node is to be configured), or on theprimary node. Where it can, TIBCO Configuration Tool validates data entered in this wizard beforeperforming the actual configuration, and reports any errors that it detects.

TIBCO recommend that you run this wizard on the remote machine, as TIBCO Configuration Tool isable to perform more extensive validation.

Do not use this wizard if any of the child user applications that have been deployed to the productapplication are in a "Failed" state. See "Failures Creating a New BPM Node with TCT" in TIBCOActiveMatrix BPM Troubleshooting for more information.

171


Welcome





Default: Cleared

ActiveMatrix BPM Node Type: Administrator Server Configuration


Machine Name Name of the machine on which the ActiveMatrix Administrator server isrunning.

Default: Name of the machine on which TIBCO Configuration Tool is beingexecuted.

build.properties entry: bpm.nodetype.admin.host


If this BPM system is distributed across different machines (toprovide high availability and/or scalability), this port should beconfigured for load balancing across all required machines - see Load Balancer.

Default: 8120

build.properties entry: bpm.nodetype.admin.portnumber

Username ID of the ActiveMatrix Administrator superuser.

Default: root

build.properties entry: bpm.nodetype.admin.username

Password Password of the ActiveMatrix Administrator superuser.

Default: t

build.properties entry: bpm.nodetype.admin.password

Admin server isSSL enabled

Whether the Administrator server internal port is enabled for SSL. Whenselected, the SSL Keystore Configuration fields are enabled.

If this BPM system is distributed across different machines (toprovide high availability and/or scalability), the Trust StoreLocation must be SHARED_DIR\keystores - see Shared File System.

build.properties entry: bpm.nodetype.adminserver.enablessl

Test Connection Verifies that TIBCO Configuration Tool can connect to the Administratorserver using the information supplied on this page.

172




Create a Trust Store Obtains certificates from the specified TIBCO Administrator server andcreates a new trust store, which will be used to establish the trust relationshipwith the TIBCO Administrator server:


2. Specify a password to protect the keystore and click Next. The SSL setupwizard displays the certificates imported from the TIBCO Administratorserver.

3. In the Trust Selected Certifications area, select the check boxes next to thecertificates to trust and click Finish. The wizard fills in the KeystoreLocation, Keystore Type, and Keystore Password fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship withthe TIBCO Administrator server.

Trust StoreLocation

Either:


● the location of the trust store to be uploaded to ActiveMatrixAdministrator. (You can either type this directly or click the Browse buttonto find it.)

build.properties entry: bpm.nodetype.javax.net.ssl.trustStore

Trust KeystoreType


Default: JKS

build.properties entry: bpm.nodetype.javax.net.ssl.trustStoreType

Trust StorePassword

Either:



build.properties entry:bpm.nodetype.javax.net.ssl.trustStorePassword

173


ActiveMatrix BPM Node Type: Host and Node Configuration


Node Type Type of the (logical) BPM node to be created. One of:

● BPM Node Type

● Server Node Type

● Client Node Type

Default: BPM Node Type

build.properties entry: bpm.nodetype.node.type

Node Name Unique name to be used for this BPM node. This name must be unique both in theenvironment and in the enterprise.

Default: BPMNode

build.properties entry: bpm.nodetype.node

Node Port Management port number used by this BPM node. This port must not be in use byanother node on the same machine.

Default: 6031

build.properties entry: bpm.nodetype.node.port

Host Name of an existing host on which this BPM node will run.

Default: BPMHost

build.properties entry: bpm.nodetype.host

HTTP Port HTTP port number used by this BPM node for communication with externalclients (Openspace, Workspace and custom client applications).

This port must not be in use by another node on the same machine.

If this BPM system is distributed across different machines (to providehigh availability and/or scalability), this port should be configured forload balancing across all required machines - see Load Balancer.

Default: 8080

build.properties entry: bpm.nodetype.http.connector.port

EnvironmentName

Name of an existing environment in which this BPM node will run.


build.properties entry: bpm.nodetype.environment

ApplicationName

Name of the BPM application that identifies this BPM system.


build.properties entry: bpm.nodetype.app.name

174



Override BPMConfigurationFolder

Whether to override the default location of the BPM configuration folder. Selectthis option if this BPM system is distributed across different machines (to providehigh availability and/or scalability).

If selected, the Configuration Folder field is displayed.

Default: Cleared

build.properties entry: bpm.nodetype.home.root.override

ConfigurationFolder

Location of the BPM configuration folder.

If this BPM system is distributed across different machines (to provide highavailability and/or scalability), this must be a location on the shared file system.For example, SHARED_DIR\bpm_config - see Shared File System.


build.properties entry: bpm.nodetype.home.root

ActiveMatrix BPM Node Type: Custom Keystore Configuration

Field Description

Providecustomkeystorelocations forthis node

Whether to specify non-default paths to the keystore folder (or trust store folder)of each shared resource. When selected, the Custom Keystore Configurationfields are displayed.

Default: Cleared

build.properties entry: bpm.nodetype.customkeystores

The paths specified on this screen must match the non-default pathsspecified when the initial BPM node was created. These paths are storedin BPM node-level substition variables. To find these variables:1. Log in to TIBCO Administrator.

2. Click Infrastructure > Nodes.

3. Select the name of an existing BPM node name - for exampleBPMNode1.

4. Click Substitution Variables.

Custom Keystore Configuration:

HTTPKeystorelocation

Full path to the ActiveMatrix BPM SSL client keystore folder.

This must be the same path as the one in the BPM node substitutionvariabletibco.bpm.client.keystore.

build.properties entry: bpm.nodetype.clientkeystorelocation

LDAPTruststorelocation

Full path to the ActiveMatrix BPM LDAP trust store folder.

This must be the same path as the one in the BPM node substitution variabletibco.bpm.ldap.keystore.

build.properties entry: bpm.nodetype.ldapkeystorelocation

175


Field Description

WSS Keystorelocation

Full path to the ActiveMatrix BPM authentication keystore folder.

This must be the same path as the one in the BPM node substitution variabletibco.bpm.wss.keystore.

build.properties entry: bpm.nodetype.wsskeystorelocation

WSS Truststorelocation

Full path to the ActiveMatrix BPM authentication trust store folder.

This must be the same path as the one in the BPM node substitution variabletibco.bpm.wss.truststore.

build.properties entry: bpm.nodetype.wsstruststorelocation

Allow emptykeystorelocations

Whether to bypass validation of empty fields for keystores or trust stores that arenot in use.

Default: Cleared

ActiveMatrix BPM Node Type: Sizing Configuration


Environment Type of environment being set up. Choose from the options: Development andProduction.

The environment you choose in this field determines the default values providedfor the remaining fields on this screen.

Default: Development

build.properties entry: bpm.nodetype.install.size

Ranged Parameters:

Java Heap Size Range for the Java heap size.

Default:

● Development - Minimum: 512 Maximum: 1536

● Production - Minimum: 1024 Maximum: 4096


● (Minimum) bpm.nodetype.jvm.xms

● (Maximum) bpm.nodetype.jvm.xmx

ActiveMatrix BPM Node Type: Summary

Field Description



Default: CONFIG_HOME\tct\bpmnodetype\timestamp

176


Field Description

Create NewActiveMatrix BPMServer Node Type

Whether to create a new ActiveMatrix BPM server node type.

Default: Selected

Replicate TIBCO ActiveMatrix Administrator Server WizardThis section provides reference information about the TIBCO Configuration Tool Replicate TIBCOActiveMatrix Administrator Server wizard.



WelcomeThe Welcome screen lists the information you will need to complete this wizard and the replicationrequirements that must be in place for you to proceed.

These requirements are:

● The TIBCO_HOME location on this machine (the second primary machine) must be the same as on themachine that is running the existing ActiveMatrix Administrator (the primary machine).

● The primary ActiveMatrix Administrator server must use an external database. (See Creating theExternal ActiveMatrix Administrator Database.)

● The staging folder used by the primary ActiveMatrix Administrator server must be at a sharednetwork location. (See Shared File System.)

● The staging folder must be accessible from this machine at the same location used on the primarymachine. For example, if you create a network drive or folder on machine 1 and map it to x:\shared , the shared drive or folder must be mapped to x:\shared as well.

Remote Administrator Server Details


Machine Name Name of the machine on which the primary Administrator server runs. Thevalue of this property must be a hostname resolvable through DNS or an IPaddress.

Default: None

Port Management port that the primary Administrator server is using.

Default: 8120

Username User name of the administrator of the primary Administrator server. This usermust be a super user. This credential is used to access the first admin server toget the current configuration. Only super user is allowed to query the currentconfiguration.

Default: root

Password Password of the administrator of the primary Administrator server.

177



Administratorserver is SSLenabled

If the primary Administrator server is SSL enabled, select this check box so thatTIBCO Configuration Tool uses SSL to connect to the primary Administratorserver. When selected, SSL Keystore Configuration fields are displayed.

Test Connection Verifies that TIBCO Configuration Tool can connect to the primaryAdministrator server using the information supplied on this page.


Create a TrustStore







Either:



Trust KeystoreType


Default: JKS


Either:



Create Replicated Instance WizardThe Create Replicated Instance Wizard screen validates your system setup against the replicationrequirements given in the Welcome screen.

If the system setup meets the replication requirements the following message is displayed:

Retrieve admin config properties successfully, all values are valid.

If there are problems, a suitable error message is displayed, indicating what the problem is.

178


Administrator Server Configuration Details

Field Description

Enterprise Name The enterprise name of the primary Administrator server. You cannot changethis value as both the primary and replica Administrator servers must be in thesame enterprise.

Host Name Name of the SystemHost instance that will be associated with the replicaAdministrator server. The host name must be unique. You cannot use the nameyou used for the host associated with the primary Administrator server.

Default: SystemHostReplica

Node Name Name of the SystemNode instance that will be associated with the replicaAdministrator server. The node name must be unique. You cannot use the nameyou used for the node associated with the primary Administrator server.

Default: SystemNodeReplica

Administrator Server TIBCO Host Configuration

Field Description

Machine Name Name of the machine on which the TIBCO Host instance (for the replicaAdministrator server) runs.

Port Port for the TIBCO Host instance to communicate with other services in theenvironment.

Register asWindows Service

Indicate whether the TIBCO Host instance should be registered as a Windowsservice named:

TIBCO ActiveMatrix Admin-enterpriseName-serverName with startup typeAutomatic. The service is not started.

Default: Cleared

Create WindowsShortcut

Indicate whether a shortcut named:

TIBCO ActiveMatrix Admin-enterpriseName-serverName

that points to:CONFIG_HOME\tibcohost\Admin-enterpriseName-serverName\host\bin

\tibcohost.exe

should be added to the Windows desktop.

Default: Cleared

179


Administrator Server Connection Settings


Network Adapter Address of the network adapter on the machine on which the Administratorserver runs. The default is set to 0.0.0.0 so that Administrator will listen on allnetwork adapters (including http://localhost and http://hostname). If you leavethe default, clients can connect to the Administrator server using any of theconventions (localhost, IP address, hostname). The value of this property musteither be a hostname resolvable through DNS or 0.0.0.0; it cannot be an IPaddress.

Management Port Management port of the node that runs Administrator server.

Default: 6021.

External HTTPPort

Port on which Administrator clients access the ActiveMatrix Administratorserver.

Default: 8120.



Default: Same as for remote server.




Default: Same as for remote server.

ImportedCertificate

Indicate that ActiveMatrix Administrator server will identify itself to clientswith a certificate imported into ActiveMatrix Administrator server. Whenselected, the Keystore fields and Fetch Keystore button are enabled.

KeystoreLocation



Default: Autodetect (The actual keystore type is displayed when you click FetchKeystore.)

KeystorePassword




180





Administrator Server Notification and Messaging Bus ServerThe Administrator Server Notification and Messaging Bus Server screen displays the same TIBCOEnterprise Message Service server details that are used by the primary Administrator server. Youcannot edit the configuration.

● Click Test Connection to verify that TIBCO Configuration Tool can connect to the server using theinformation supplied on this page.

Administrator Server Database DetailsThe Administrator Server Database Details screen displays the same database details that are used bythe primary Administrator server. You cannot edit the configuration.

1. Enter the Password for the Administrator server database.

2. Click Test Connection to verify that TIBCO Configuration Tool can connect to the server using theinformation supplied on this page.

Administrator Server Database Authentication Realm DetailsThe Administrator Server Database Authentication Realm Details screen displays the same databasedetails that are used by the primary Administrator server. You cannot edit the configuration.

This screen is only displayed if you selected Database as the Realm Type on the Administrator ServerConfiguration: Authentication Realm screen when configuring the primary Administrator server.

1. Enter the Password for the external database.

2. Click Test Connection to verify that TIBCO Configuration Tool can connect to the server using theinformation supplied on this page.

Administrator Server Configuration LDAP Authentication RealmThe Administrator Server Configuration LDAP Authentication Realm screen displays the same LDAPconfiguration details that are used by the primary Administrator server. You cannot edit theconfiguration.

This screen is only displayed if you selected LDAP as the Realm Type on the Administrator ServerConfiguration: Authentication Realm screen when configuring the primary Administrator server.

● Click Test Connection to verify that TIBCO Configuration Tool can connect to the server using theinformation supplied on this page.

Administrator Server Configuration Summary

The Replicate TIBCO ActiveMatrix Administrator Server wizard does not show the configurationdetails for Monitoring, Logging and Payload services. If those services are configured and deployed onthe primary ActiveMatrix Administrator server, they are automatically deployed on the replica serveras part of the replication process.

181


Field Description



Default: CONFIG_HOME\tct\admin.replicate\timestamp



where:


● port is the External HTTP Port number specified in the Administrator Server Configuration: Connection Settings screen.


Replicate TIBCOActiveMatrixAdministrator server

Whether to replicate the primary ActiveMatrix Administrator server.

Default: Selected

If you subsequently wish to delete a replica ActiveMatrix Administrator server, see Deleting a ReplicaActiveMatrix Administrator Server.

Edit TIBCO ActiveMatrix BPM Instance WizardThis section provides reference information about the TIBCO Configuration Tool Edit TIBCOActiveMatrix BPM Instance wizard.

Welcome

Field Description

AMX-BPMEnvironment Name

Name of the ActiveMatrix environment that hosts the BPM system to beedited.


AMX-BPMApplication Name

Name of the BPM application that identifies the BPM system to be edited.


182


Field Description

Edit Action to bePerformed

The type of edit you want to perform. Select one of the following:

● Edit AMX-BPM Application: configure the application that is specifiedon this screen

● Start AMX-BPM Product Application: start the application that isspecified on this screen

● Stop AMX-BPM Product Application: stop the application that isspecified on this screen

● Move AMX Host: move an ActiveMatrix host from, or to, this machine

If you want to perform multiple edit actions, you must run this wizardmultiple times.

Default: Edit AMX-BPM Application

ActiveMatrix BPM Edit: Administrator Server Configuration


Machine Name Name of the machine that hosts the ActiveMatrix Administrator server (thatmanages the BPM system being edited).



Default: 8120

Username ID of the ActiveMatrix Administrator server superuser.

Default: root

Password Password of the ActiveMatrix Administrator server superuser.

Default: t


Whether the port used to access the ActiveMatrix Administrator server isenabled for SSL. When selected, the SSL Keystore Configuration fields areenabled.

Default: Follows the value selected for Configure to Secure AllCommunication with SSL on the Welcome screen.

Test Connection Verifies that TIBCO Configuration Tool can connect to the ActiveMatrixAdministrator server using the information supplied on this page.


183



Create a Trust Store Obtains certificates from the specified ActiveMatrix Administrator server andcreates a new trust store, which will be used to establish the trust relationshipwith the ActiveMatrix Administrator server:


2. Specify a password to protect the keystore and click Next. The SSL setupwizard displays the certificates imported from the ActiveMatrixAdministrator server.


If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship withthe ActiveMatrix Administrator server.

Trust StoreLocation

Either:



Trust KeystoreType


Default: JKS

Trust StorePassword

Either:



ActiveMatrix BPM Edit: Select Edit Configurations

This screen is only displayed if you chose Edit AMX-BPM Application as the Edit Action to bePerformed on the Welcome screen.

Field Description

Edit the database used by theAMX-BPM system

Change the configuration of the runtime database.

Default: Cleared

Edit the version of SOAP usedby AMX-BPM

Specify the version of the SOAP specification that will be appliedto all SOAP bindings on services exposed by this BPM system.

Default: Cleared

Edit the CMIS server used byAMX-BPM

Configure the CMIS server that is to be used by this BPM system.

Default: Cleared

184


Field Description

Edit the type of authenticationused by AMX-BPM

Specify the type of authentication that is used by ActiveMatrixBPM clients and other applications that make use of ActiveMatrixBPM services.

Default: Cleared

Edit the Purge Process CLIconfiguration

Configure the Purge Process CLI on this BPM system. (The PurgeProcess CLI can be used from an SSH client to remotely purgeprocess instances.)

Default: Cleared

ActiveMatrix BPM: Runtime Database Configuration

This screen is displayed only if you selected Edit the database used by the AMX-BPM system on theSelect Edit Configurations screen.


Database Driver Database driver used to connect to the database server that hosts theActiveMatrix BPM database to be used by this BPM system. The driversavailable are those that have been previously installed using the TIBCOConfiguration Tool Configure Third-Party Driver Wizard. However, you mustchoose a driver for the same database type (DB2, Oracle, or SQL Server).

URL JDBC connection string that identifies this ActiveMatrix BPM database.

ActiveMatrix BPM will use this string to connect to this ActiveMatrix BPMdatabase.

For the format to use, see "JDBC Connection String Formats" in the TIBCOActiveMatrix BPM Administration Guide.

Username Database server user account that ActiveMatrix BPM should use to connect tothis ActiveMatrix BPM database. TIBCO Configuration Tool automaticallycreates the specified account if it does not already exist.

The specified Username must be unique to this BPM system; you cannot usean existing user account that is used by a different BPM database on thisserver.


Default: bpmuser

Password Password for the specified Username.

185



Test Connection Verifies that TIBCO Configuration Tool can connect to the specifiedActiveMatrix BPM database using the information supplied on this page.

Connection will be possible only when:

1. You have generated the database creation scripts (by clicking GenerateScripts).

2. The database administrator has run the database creation scripts.

The database administrator must run the database creationscripts before you click Configure in the Summary screen at theend of this wizard.

Generate Scripts Generates the SQL scripts needed to create the specified ActiveMatrix BPMdatabase.

You must generate the database creation scripts if you chose to manuallycreate the database in the ActiveMatrix BPM: Database Administratorscreen.See Manually Running BPM Database Creation Scripts for more informationabout how to manually create the database.

JDBC Connection String Formats

The JDBC connection string that you specify in the Create TIBCO ActiveMatrix BPM Server wizard orthe Edit TIBCO ActiveMatrix BPM Instance wizard must have a specific format depending on thedatabase type.

DB2

jdbc:db2://host:port/dbName

Microsoft SQL Server

jdbc:sqlserver://host:port;DatabaseName=dbName

You cannot use a literal IPV6 address for host.

Oracle 12c

You must use one of the following formats:

● jdbc:oracle:thin:@host:port/serviceName

● jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST="host")(PORT="port")))(CONNECT_DATA=(SERVICE_NAME="serviceName")(SERVER = DEDICATED)))

where serviceName is the service name of the pluggable database that ActiveMatrix BPM is using.

ActiveMatrix BPM: BDS Database Configuration

This screen is displayed only if you selected Edit the database used by the AMX-BPM system on theSelect Edit Configurations screen.

186



Use differentdatabase to otherAMX-BPMcomponents

Whether ActiveMatrix BPM should host the BDS case data store in theActiveMatrix BPM database or in a separate database.

● When selected, the BDS case data store will be hosted in a separatedatabase. The remaining fields in this table are available. The databasetype of both BDS case data store and the ActiveMatrix BPM databaseshould be the same. You must select Generate Scripts to generate the SQLscripts needed to create the specified ActiveMatrix BPM database.

● When cleared, the BDS case data store will be hosted in the ActiveMatrixBPM database, as specified on the ActiveMatrix BPM: Runtime DatabaseConfiguration screen.

Default: Cleared

URL JDBC connection string that identifies the database to be used to host the BDScase data store.

In the case of DB2, this database must have been created previously. For otherdatabases, the specified string will be used to automatically create thedatabase.

ActiveMatrix BPM will use this string to connect to the BDS case data store.

For the format to use, see "JDBC Connection String Formats" in the TIBCOActiveMatrix BPM Administration Guide.

BDS Username Database server (or for DB2, operating system) user account that ActiveMatrixBPM should use to connect to the specified database URL.


Default: bpmuser

BDS Password Password for the specified BDS Username.

Test Connection Verifies that TIBCO Configuration Tool can connect to the specified databaseusing the information supplied on this page.

ActiveMatrix BPM: SOAP Version Configuration

This screen is displayed only if you chose Edit the version of SOAP used by AMX-BPM on the SelectEdit Configurations screen.

187


Field Description

SOAP BindingVersion

Version of the SOAP specification that will be applied to all SOAP bindings onservices exposed by this BPM system. (These are the services provided by theActiveMatrix BPM public API - see the TIBCO ActiveMatrix BPM Developer’sGuide.)

SOAP versions 1.1 and 1.2 are supported.

If you change the SOAP version used by the BPM system, the followingapplications will no longer work, and must be modified to use the newSOAP version:● any custom client application that uses the existing SOAP version of

the BPM public web service API.

● any custom client application that uses the Java Service ConnectorAPI.

Default: 1.1

Also updateSOAP BindingVersion forchild userapplications

Whether to update process applications that are already deployed to this BPMsystem to use the same SOAP Binding Version specified above.

If you clear this option, the following applications will no longer work:

● any deployed process application that calls a BPM system service.

● any deployed process application that calls another BPM system-hostedprocess application using a SOAP binding. For example, where an applicationneeds to enforce a security policy to call the internal service.

If you select this option you will also need to update the applicationproject in TIBCO Business Studio to use the new SOAP version beforeupgrading any of the affected process applications.

Default: Selected

ActiveMatrix BPM: CMIS Configuration

This screen is displayed only if you chose Edit the CMIS server used by AMX-BPM on the Select EditConfigurations screen.


Use CMISRepository

Whether Business Data Services (BDS) will use a content management system(CMS) to provide case folders. This can be either the internal TIBCODocumentStore, or an external CMS.

When selected, the User Details for CMIS Server (Internal or External) fieldsare displayed.

Default: Cleared

build.properties entry: bpm.cmis.enabled

User Details for CMIS Server (Internal or External)

188



Admin User Name of the CMS administrator user. If you are using the TIBCODocumentStore, specify whatever name you want to use for the administratoruser. If you are using an external CMS, you must supply the correct name asdefined on the external CMS.

Default: Admin

The value is stored in the ECMCredentialsKeystore shared resource and usedwhen authenticating against the CMS server.

build.properties entry: bpm.cmis.adminuser

Admin UserPassword

Password for the CMS administrator user. If you are using the TIBCODocumentStore, specify whatever value you want to use for the administratoruser password. If you are using an external CMS, you must supply the correctpassword as defined on the external CMS.

Default: admin

The value is stored in the ECMCredentialsKeystore shared resource and usedwhen authenticating against the CMS server.

build.properties entry: bpm.cmis.adminpassword

External CMIS Whether BDS will use the internal TIBCO DocumentStore or an external CMS toprovide case folders:

● When cleared (the default option), BDS uses the internal TIBCODocumentStore as its CMS.

● When selected, the External CMIS Server Details fields are displayed.

Default: Cleared

build.properties entry: bpm.cmis.useinternal

External CMIS Server Details:

URL URL that is used to connect to the CMS's CMIS interface.

Default: http://localhost:9090/alfresco/api/-default-/public/cmis/versions/1.0/atom

build.properties entry: bpm.cmis.url

CMIS BindingType

Type of binding that is used against the CMIS URL. Currently, only atompub issupported.

Default: atompub

build.properties entry: bpm.cmis.bindingtype

Repository ID ID of the main repository within the CMS that is to be connected to.

Default: -default-

build.properties entry: bpm.cmis.repositoryid

189



AMX BPM FolderPath

Path of an existing folder in the main repository that is used to store case folderdata. You must either specify a folder that already exists or create a new foldermanually and specify that folder.

Default: /Sites/amxbpm/documentLibrary

build.properties entry: bpm.cmis.amxbpmfolderid

CMIS Server isSSL Enabled

Whether the external CMS server is enabled for SSL. When selected, the SSLTrust Store Configuration fields are displayed.

SSL Trust Store Configuration

Create a TrustStore

Obtains certificates from the specified CMS server and creates a new trust store,which will be used to establish the trust relationship with the external CMSserver:


2. Specify a password to protect the keystore and click Next . The SSL setupwizard displays the certificates imported from the external CMS server.

3. In the Trust Selected Certifications area, select the certificates to trust andclick Finish. The wizard fills in the Trust Store Location, Trust KeystoreType, and Trust Store Password fields.

If you do not click Create a Trust Store, you must specify the details of anexisting trust store that can be used to establish the trust relationship withthe external CMS server.

Trust StoreLocation

Either:



build.properties entry: bpm.cmis.keystorelocation

Trust KeystoreType


Default: JKS.

build.properties entry: bpm.cmis.keystoretype

Trust StorePassword

Either:



build.properties entry: bpm.cmis.keystorepassword

Test Connection Verifies that TIBCO Configuration Tool can connect to the external CMS serverusing the information supplied on this page.

The defaults on this wizard screen are based on Alfresco Community Edition 5.0a. You may need toenter different values depending on your CMS.

190


ActiveMatrix BPM: Authentication Configuration

This screen is displayed only if you chose Edit the type of authentication used by AMX-BPM on theSelect Edit Configurations screen.

Field Description

SelectAuthenticationType

LDAP, SiteMinder, Kerberos, Open ID, or SAML SSO Web Profile.

The SiteMinder option is only provided if you set up SiteMinder device driverinstallation (see Configure Third-Party Driver Wizard) and Shared Resourceinstallation for SiteMinder (see Create TIBCO ActiveMatrix BPM Server Wizard).

Default: LDAP

Allow also basicusernameauthentication

Default: Cleared

build.properties entry: bpm.edit.auth.allowUsername

Setting this option causes the authAllowUsername substitution variable to be setto true. The authAllowUsername substitution variable is used to configure theOpenspace and Workspace applications (including custom WCC applications)for dual authentication:

● true - causes applications to concurrently support both direct and SSOauthentication.

● false - only SSO authentication is supported.

For information, see "Dual Authentication" in ActiveMatrix BPM Single Sign-On.

ActiveMatrix BPM: SiteMinder Configuration

This screen is only displayed if you selected SiteMinder as the Authentication Type on theAuthentication Configuration screen. The name of the Shared Resource Instance must beamx.bpm.auth.siteminder.

Field Description

Agent Name The name of the SiteMinder Wb-Agent (configured on the SiteMinderinstallation) that will filter authentication requests.

Client IPAddress

The IP address of the machine on which the Shared Resource will be installed.This is the client that will contact the SiteMinder service.


191


Field Description


Identifies the location of the SiteMinder generated, host configuration file, fromwhich the remaining configuration properties will be taken. Choose between:


If the SiteMinder installation is on the same machine as the Shared Resourceinstallation.



● Generated


The following properties assume Generated has been selected. These values will be available from yourSiteMinder installation.



Trusted HostName

A trusted host is a client that is registered with the Policy Server and is,therefore, allowed to connect to the Policy Server. A unique name that representsthe host to the Policy Server.

HostConfigurationObject

The name of the Host Configuration Object specified in the Policy Server. Namesthe object that holds parameters for a Trusted Host.

Shared Secret An automatically generated encryption key used for encrypting traffic betweenthe trusted host and the Policy Server.

Policy Server The server IP address and port numbers for the Policy Server that the TrustedHost accesses.


ActiveMatrix BPM: Kerberos Configuration

This screen is only displayed if you selected Kerberos as the Authentication Type on theAuthentication Configuration screen. The name of the Shared Resource Instance must beamx.bpm.auth.kerberos.


Kerberos Realm The name of the domain where the Kerberos configuration applies. For example,XYZCOMPANY.COM.

Key DistributionCenter

The name or IP address of the host running the Kerberos KDC for the Kerberosrealm.

192





Identifies the location of the Kerberos generated, host configuration file, fromwhich the remaining configuration properties will be taken. Choose between:


If the Kerberos installation is on the same machine as the Shared Resourceinstallation.



● Generated


The following properties assume Generated has been selected. These values will be available from yourKerberos installation.



Default DNSDomain

The domain used to expand hostnames when translating Kerberos 4 serviceprincipals to Kerberos 5 principals. Domain names should be in lower-case.

Service PrincipalName (SPN)

The principal name of the service that is to be protected. When a service ticket isreceived, it is verified, using the KDC, against the SPN specified here.

Key Tab FileName:

The path to the key tab file containing the credentials of the service to be verifiedagainst the incoming request.


ActiveMatrix BPM: OpenID Connect Configuration

This screen is only displayed if you selected Open ID as the Authentication Type on theAuthentication Configuration screen.

Microsoft Active Directory Federation Services (ADFS) is the only Identity Provider (IdP) that issupported by, and has been tested with, ActiveMatrix BPM.


Client ID The ID that identifies the client at the Identify Provider. This, and the ClientSecret (see below), are obtained from the IdP when the client registers anapplication with the IdP for the purpose of providing authentication for users.

For information, see "Registering an Application at an Identity Provider" in theTIBCO ActiveMatrix Single Sign-On guide.

193



Client Secret The password for the Client ID account. See the description above.

Redirect URI The URI to which the IdP will redirect the user after authenticating the user andgenerating an ID Token. For all ActiveMatrix BPM applications, this must be thefollowing:http://host:port/openspace/sso/bpmssoapp.html


Also note that this URI must match exactly the Redirect URI that was specifiedwhen registering the application with the IdP.

For more information, see "Registering an Application at an Identity Provider" inthe TIBCO ActiveMatrix Single Sign-On guide.

AuthorizationInfo URI

The REST Open ID user claims/information service URI, which is used to obtainuser profile information.


For Microsoft ADFS, this must be:https://host:port/adfs/oauth2/authorize


Access TokenURI

The REST OpenID token service URI, which is used to obtain an ID Token for theauthenticated user.

Using the OpenID Access Token is not currently supported inActiveMatrix BPM. The OpenID ID Token is used to identify the user.


For Microsoft ADFS, this must be:https://host:port/adfs/oauth2/token


JSON Web KeySet URI

The URI to the JSON Web Key Set (JWKS), which is a JSON data structure thatrepresents a set of public keys used to verify the signature of the JSON WebToken (JWT) ID Token issued by the IdP.


For Microsoft ADFS, this must be:https://host:port/adfs/discovery/keys


194



Auth ScopeOptional)

Defines the claims to be returned by the IdP when the IdP authenticates the userand issues an ID Token. These claims are user attributes and are intended toprovide the application with user details.

The openid scope is included by default (even though it does not appear in theAuth Scope field by default). (The openid scope causes the sub claim to bereturned, which uniquely identifies the user.) However, if any scope is entered inthe Auth Scope field, it overrides the default value of openid. Because of that,for ActiveMatrix BPM applications, you MUST include openid, and possiblyanother scope, depending on your IdP.

For Microsoft ADFS, this must be:openid,upn

Multiple scopes can be either comma- or space-separated in the Auth Scopefield.

User Key(optional)

From the list of claims that are returned from the IdP (based on the Auth Scope),this specifies the claim that is used to identify the user.

For Microsoft ADFS, this must be:upn

The upn claim contains the user's email address, which is used in the finalauthentication step to verify that the user is a valid ActiveMatrix BPM user.

Logout Path When a user logs out of an ActiveMatrix BPM application, the browser sendsthis value to the ActiveMatrix BPM server. This property must be set to:

/bpm/logout

This value indicates to the server that it needs to send a request to the IdP to logthe user out, using the value specified in the SignOutURL property (see below).

If you are using Openspace, Workspace, or a custom WCC application, you mustalso specify this same logout path in the respective configuration file for thoseapplications. For Openspace, see "Configuring What Happens on OpenspaceLogout" in the TIBCO Openspace Customization Guide. For Workspace and customWCC applications, see "Logout Path" in the TIBCO Workspace Configuration andCustomization Guide.

195



Signout URL Upon receiving "/bpm/logout" in the LogOutPath property, the server uses thisURL to send the IdP a request to log the user out of the IdP.

The signout URL is specific to the IdP.

For Microsoft ADFS, this must be:https://host:port/adfs/ls/?wa=wsignout1.0


Redirecting to the application landing page

Depending on the IdP, you may be able to append an additional URL to theSignout URL to cause the IdP to redirect the user to the ActiveMatrix BPMapplication's landing page after logging out the user. Not all IdPs support thisfeature; they may just display a standard logout page stating that the user hasbeen successfully logged out. Also, the parameter name appended to the SignoutURL used to specify user redirect varies between IdPs.

For Microsoft ADFS, this must be:https://host:port/adfs/ls/?wa=wsignout1.0&wreply=http://host:port/appPath

where host is the DNS name or IP address of the server that hosts theActiveMatrix BPM runtime, port is the port used by the application, and appPathis the path to the application's landing page.

For additional information about using OpenID Connect for authentication, see the TIBCO ActiveMatrixBPM Single Sign-On guide.

ActiveMatrix BPM: SAML Web Profile ConfigurationUse the fields on this screen to configure ActiveMatrix BPM to use SAML Web Profile to authenticateusers of ActiveMatrix BPM applications.

This screen is only displayed if you selected SAML SSO Web Profile as the Authentication Type onthe Authentication Configuration screen.

This screen contains a subset of the available SAML Web Profile configuration parameters. All otherSAML Web Profile configuration parameters contain default values, and can be modified postinstallation using TIBCO ActiveMatrix Administrator. For information about all of the availableparameters, see "Using ActiveMatrix Administrator to Create a SAML Web Profile Shared Resource" inTIBCO ActiveMatrix BPM Single Sign-On.


Entity ID A unique ID that identifies the service provider and application that has beenregistered with an IdP.

This must match the ID that was configured at the IdP.

IDP MetadataURL

The HTTP URL of the metadata file that was returned by the IdP when yourapplication was registered with the IdP. (You cannot specify a file path, nor a"file://xx/xx" URL. This can only be specified as an HTTP URL.)

196



AuthenticationSuccessful URL

The URL to which the user is redirected after being authenticated by the IdP.This must be:http://host:port/openspace/sso/bpmssoapp.html


Although the Authentication Successful URL is used for all ActiveMatrix BPMapplications, the response from the IdP is routed to the appropriateActiveMatrix BPM application based on an interceptor script (bpm-sso-interceptor.min.js) that is included in the application that submitted therequest to the IdP (for more information about the interceptor script, see "UsingSAML Web Profile Authentication with Custom Applications" in TIBCOActiveMatrix BPM Single Sign-On).

ActiveMatrix BPM: Package / unpack AMX Host for moving

You can use this wizard for moving only an ActiveMatrix host that meets the following requirements:● The host does not contain an ActiveMatrix Administrator node.

● All nodes that are managed by the host must be running on ActiveMatrix version 3.3 hotfix 3 orlater.

Field Description

Package Host to be moved Prepare an ActiveMatrix host on this machinefor moving to another machine. This involvescreating a movedhost.properties file in thecorresponding TIBCO Host instance directoryand, optionally, creating a .zip file of thedirectory.

The option is selected if the wizard finds anyActiveMatrix BPM hosts on this machine.

Select AMX Host to move fields (enabled only if Package Host to be moved is selected)

TIBCO Host Instance The TIBCO Host instance directory on thismachine that you want to move. The listincludes all the TIBCO Host instance directoriesin the CONFIG_HOME\tibcohost directory.

Use zip to package host for move Whether to create a .zip file of the TIBCO Hostinstance directory. You may want to clear thischeck box if you have problems with .zip fileson your platform. In this case, you must movethe directory yourself to the CONFIG_HOME\tibcohost directory on the other machine afteryou have prepared it using this wizard.

Default: Selected

197


Field Description

Packaged Host Location (displayed only if theUse zip to package host for move check box isselected)

The machine and directory to which you want tomove the .zip file. As long as you specify thetarget machine, it does not matter if you do notspecify the target CONFIG_HOME\tibcohostdirectory correctly because the contents ofthe .zip file are automatically unpacked to thecorrect directory.

Unpack Host Unpack to this machine an ActiveMatrix hostthat has been moved from another machine. Thehost will have the same directory paths on thismachine as it did on the other machine.

The option is selected if the wizard cannot findany ActiveMatrix hosts on this machine.

Select Packaged AMX Host fields (enabled only if Unpack Host is selected)

Packaged Host File The path and name of one of the following, asapplicable:

● The .zip file that you created using thiswizard

● The movedhost.properties file in theTIBCO Host instance directory that youmoved to this machine

JMX URL The management URL that TIBCO Host uses tocommunicate with the node. It is usually thesame as the JMX URL on the source machine butwith the machine name changed to this machine.

ActiveMatrix BPM Edit: Purge Process CLI Configuration

This screen is displayed only if you chose Edit the Purge Process CLI configuration on the Select EditConfigurations screen.

The Purge Process CLI (Command-Line Interface) is a utility that can be used, either interactively or viascripting, to remotely purge completed, cancelled or failed process instances that have not beenautomatically purged. For more information, see "Using the Purge Process CLI" in TIBCO ActiveMatrixBPM Administration.


Enable PurgeProcess CLI

Whether the Purge Process CLI is enabled on this node.

When selected, the remaining fields on this screen are enabled.

Default: Cleared (The Purge Process CLI is disabled.)

After an upgrade, the Purge Process CLI is disabled, even if it wasenabled on the previous version of the ActiveMatrix BPM system. Ifyou want to use the Purge Process CLI on the upgraded system, youmust manually enable it.

198



Target Node: Node name of the BPM node that hosts the Purge Process CLI.

Default: BPMNode

Port Number: Port number on which the Purge Process CLI is listening.

Default: 0

IP Address: IP address of the machine on which the specified Target Node is running.

Default: 127.0.0.1

With the default value, the Purge Process CLI is not exposed to aremote SSH client.

On a distributed ActiveMatrix BPM system:● You enable the Purge Process CLI on a per-node basis. For example, if the ActiveMatrix BPM system

contains 4 nodes, to enable the Purge Process CLI on each one you must run this wizard and selectthe Enable Purge Process CLI option on each node. You can enable the Purge Process CLI on all,some or none of the nodes as you require.

● If you subsequently run this wizard on a any node and disable the Purge Process CLI, it is disabledon every node on which it has been previously enabled. (You do not need to run the wizard andselect this option on each node.)

ActiveMatrix BPM Edit: Summary

Field Description



Default: CONFIG_HOME\tct\bpmedit\timestamp

Click Configure to execute the following upgrade actions:

Editing AMX-BPMapplicationapplication_name inenvironmentenvironment_name

Configure the specified application using the new settings that you havespecified.

Default: Selected

Starting AMX-BPMapplicationapplication_name inenvironmentenvironment_name

Start the specified application.

Default: Selected

Stopping AMX-BPMapplicationapplication_name inenvironmentenvironment_name

Stop the specified application.

Default: Selected

199


Field Description

Packaging Host Stop the specified ActiveMatrix host and its nodes, and prepare the host formoving to another machine, using a .zip file if specified.

Default: Selected

Unpacking Host Unpack the specified ActiveMatrix host to this machine using the file thatyou specified, and start the host.

Default: Selected

Upgrade TIBCO ActiveMatrix BPM Instance WizardThis section provides reference information about the TIBCO Configuration Tool Upgrade TIBCOActiveMatrix BPM Instance wizard.

Welcome

Field Description




Default: Cleared

ActiveMatrix BPM Upgrade: Administrator Server Configuration


Machine Name Name of the machine that hosts the ActiveMatrix Administrator server (thatmanages the BPM system being upgraded).



● bpm.upgrade.admin.host

● bpm.upgrade.admin.url


Default: 8120


● bpm.upgrade.admin.portnumber

● bpm.upgrade.admin.url

200




Default: root

build.properties entry: bpm.upgrade.admin.username


Default: t

build.properties entry: bpm.upgrade.admin.password




build.properties entry: bpm.upgrade.adminserver.enablessl





2. Specify a password to protect the keystore and click Next. The SSL setupwizard displays the certificates imported from the ActiveMatrixAdministrator server.



Trust StoreLocation

Either:



build.properties entry: bpm.upgrade.javax.net.ssl.trustStore

Trust KeystoreType


Default: JKS

build.properties entry: bpm.upgrade.javax.net.ssl.trustStoreType

201



Trust StorePassword

Either:



build.properties entry:bpm.upgrade.javax.net.ssl.trustStorePassword

ActiveMatrix BPM Upgrade: Upgrade Configuration

Field Description

ActiveMatrix BPM Upgrade Details:

This section is only displayed when you are running this wizard on a machine that hostsan ActiveMatrix Administrator server (that is, a primary or second primary machine).

build.properties entry bpm.upgrade.host.only must be "true" on a machine that hosts anActiveMatrix Administrator server, and "false" otherwise.

ApplicationName

Name of the BPM application that identifies the BPM system to be upgraded.


build.properties entry: bpm.upgrade.app.name

EnvironmentName

Name of the ActiveMatrix environment that hosts the BPM system to beupgraded.


build.properties entry: bpm.upgrade.environment

Automaticallyupgrade BPMDatabaseSchema

Whether TIBCO Configuration Tool should automatically upgrade theActiveMatrix BPM database.

TIBCO strongly recommend that you select this option.

See Manually Upgrading the BPM Database for more information about how todecide if you need to manually upgrade the database.

Clearing this field enables Generate Scripts.

Default: Selected

build.properties entry: bpm.upgrade.schema

GenerateScripts

Generates the SQL scripts needed to manually upgrade the ActiveMatrix BPMdatabase. See Manually Running BPM Database Upgrade Scripts for moreinformation about how to use these scripts.

ActiveMatrix BPM Shared Configuration Folder:

202


Field Description

ConfigurationFolder

This is a folder under CONFIG_HOME that stores configuration data generatedby the BPM system. This must be set to the same folder that was specified duringthe original installation.

If this BPM system is distributed across different machines (to providehigh availability and/or scalability), this must be a location on a suitableshared network drive. For example, SHARED_DIR\bpm_config - see Shared File System.


build.properties entry: bpm.config.home.root

ActiveMatrix BPM Upgrade: Summary

Field Description

Session Scriptsand Log Folder

The location where scripts and logs generated by this TIBCO Configuration Toolsession are stored.

Default: CONFIG_HOME\tct\bpmupgrade\timestamp


UpgradeActiveMatrixBPM InstanceApplication

Whether to upgrade the specified BPM application to the ActiveMatrix BPMversion installed earlier.

Other BPM applications (systems) will not be affected.

The message [Not Upgrading Database] is displayed if you chose not toupgrade the ActiveMatrix BPM database in the ActiveMatrix BPM Upgrade:Upgrade Configuration screen (by clearing Automatically upgrade BPMDatabase Schema).

In this case, TIBCO Configuration Tool will not automatically upgrade theActiveMatrix BPM database, and you must manually upgrade it instead - see Manually Upgrading the BPM Database for more information.

Default: Selected

If you are upgrading from a pre-4.0 version BPM system that includesBPM nodes of node type Web Components, Process Manager or WorkManager, these node types will automatically be converted as part ofthe upgrade process to version 4.0 node types. (Web Componentsnodes are converted to Client node type. Process Manager and WorkManager nodes are converted to Server node type.) The upgradeprocess could potentially take a significant amount of time because ofthe work involved in this conversion.

203


Delete TIBCO ActiveMatrix BPM Instance WizardThis section provides reference information about the TIBCO Configuration Tool Delete TIBCOActiveMatrix BPM Instance wizard.



Using the Delete TIBCO ActiveMatrix BPM Instance WizardThe Delete TIBCO ActiveMatrix BPM Instance wizard removes a specific instance of the BPMapplication and its shared resources.

Before you run the Delete TIBCO ActiveMatrix BPM Instance wizard:● you must undeploy any user applications that are running against this BPM application instance.

● you must delete user applications before deleting a BPM application instance.

The wizard checks for application dependencies before deleting the specified BPM application instance.If the wizard detects any dependent applications other than the system organization model application(for example, amx.bpm.app.sysorgmodel), it exits with a failure message, having made no changes tothe system.

The wizard does not remove any of the following, as they may be in use by other applications:

● any shared system applications (such as LDAP server applications)

● the nodes on which the BPM application instance was deployed.

● the environment containing the BPM application instance.

● the database used by the BPM application instance.

If you want to remove any of these entities, you should do so separately, after you have run the wizard.

Welcome

Field Description



Select this to pre-select all SSL enabled check boxes in subsequent pages ofthis wizard. (You will be able to override this choice and select or clearthose check boxes on their individual pages.)

Default: Cleared

204


ActiveMatrix BPM Deletion: Administrator Server Configuration


Machine Name Name of the machine that hosts the ActiveMatrix Administrator server (thatmanages the BPM system being deleted).



● bpm.delete.admin.host

● bpm.delete.admin.url


Default: 8120


● bpm.delete.admin.portnumber

● bpm.delete.admin.url


Default: root

build.properties entry: bpm.delete.admin.username


Default: t

build.properties entry: bpm.delete.admin.password




build.properties entry: bpm.delete.adminserver.enablessl



205





2. Specify a password to protect the keystore and click Next . The SSL setupwizard displays the certificates imported from the ActiveMatrixAdministrator server.



Trust StoreLocation

Either:



build.properties entry: bpm.delete.javax.net.ssl.trustStore

Trust KeystoreType


Default: JKS

build.properties entry: bpm.delete.javax.net.ssl.trustStoreType

Trust StorePassword

Either:



build.properties entry:bpm.delete.javax.net.ssl.trustStorePassword

ActiveMatrix BPM Deletion: Instance Configuration

Field Description

ActiveMatrix BPM Deletion Details:

ApplicationName

Name of the BPM application that identifies the BPM system to be deleted.


build.properties entry: bpm.delete.app.name

206


Field Description

EnvironmentName

Name of the ActiveMatrix environment that hosts the BPM system to be deleted.


build.properties entry: bpm.delete.environment

ActiveMatrix BPM Deletion: Summary

Field Description



Default: CONFIG_HOME\tct\bpmdelete\timestamp


Delete ActiveMatrixBPM Instance

Whether to delete the specified BPM system.

Default: Selected

Make sure that you have undeployed any user applications that are running against this BPMapplication instance before you click Configure.

The wizard checks for application dependencies before deleting the specified BPM application instance.If the wizard detects any dependent applications other than the system organization model application(for example, amx.bpm.app.sysorgmodel), it exits with a failure message, having made no changes tothe system.

Deleting the BPM system removes the specified instance of the BPM application and its sharedresources. It does not remove any of the following, as they may be in use by other applications:● any shared system applications (such as LDAP server applications)

● the nodes on which the BPM application instance was deployed.

● the environment containing the BPM application instance.

● the database used by the BPM application instance.

If you want to remove any of these entities, you should do so separately.

Edit TIBCO ActiveMatrix Administrator Server Configuration WizardThis section provides reference information about the TIBCO Configuration Tool Edit TIBCOActiveMatrix Administrator Server wizard.



207


Edit ActiveMatrix Administrator Server Configuration: Administrator Server Selection

Field Description

Server Name Lists the available Administrator servers.

Default: AMX BPM - AMX BPM Server

Edit ActiveMatrix Administrator Server Configuration

Field Description

Edit HTTPConnectionSettings

Whether to edit the connection settings for the ActiveMatrix Administrator server.

Default: Cleared

Edit DatabaseSettings

Whether to edit the configuration settings for the ActiveMatrix Administratorserver database.

Default: Cleared

EditAuthenticationRealm Settings

Whether to edit the configuration settings for the ActiveMatrix Administratorserver authentication realm.

Default: Cleared

Administrator Server Configuration: Edit HTTP Connection Settings

This screen is only displayed if you selected Edit HTTP Connection Settings on the Edit ActiveMatrixAdministrator Server Configuration screen.

The default value for each field shows the current configuration setting.

Field Description

Network Adapter The address of the network adapter on the machine on which the ActiveMatrixAdministrator server runs. The default is set to 0.0.0.0 so that ActiveMatrixAdministrator will listen on all network adapters (including http://localhost andhttp://hostname) so that clients can connect to the ActiveMatrix Administratorserver using any of the conventions (localhost, IP address, hostname). The valueof this property must either be a hostname resolvable through DNS or 0.0.0.0; itcannot be an IP address.

External HTTPPort

Port on which the Administrator clients access ActiveMatrix Administrator.



208


Field Description




ImportedCertificate

Indicate that ActiveMatrix Administrator server will identify itself to clientswith a certificate imported into ActiveMatrix Administrator server. Whenselected, the Keystore fields and Fetch Keystore button are enabled.

KeystoreLocation



KeystorePassword


Fetch Keystore Retrieves the aliases from the specified keystore. The Key Alias field, KeyPassword field and Verify Keystore button are displayed.




Administrator Server Configuration: Edit Database Settings

This screen is only displayed if you selected Edit Database Settings on the Edit ActiveMatrixAdministrator Server Configuration screen.

The default value for each field shows the current configuration setting.

Changing Database Details

To change the database details, perform the following steps:

1. From the TIBCO Administrator user interface, stop the following applications from the Systemenvironment:

● com.tibco.amx.commonlogging.logservice.app● com.tibco.amx.commonlogging.payloadservice.app

2. Perform the following steps to uninstall the resource instances:

a. Make sure that you uninstall Log Service and Payload Service first. (TIBCO ActiveMatrixPayload Service Teneo Resource, TIBCO ActiveMatrix Log Service Teneo Resource).

b. Uninstall the Teneo resource instances from the system node (TIBCO ActiveMatrix GovernanceTeneo Resource).

c. Uninstall the Hibernate Resource Instance from the system node (TIBCO ActiveMatrixGovernance Hibernate Resource).

209


d. Uninstall in the following order : Log Service or Payload Service in any order followed by theGovernance JDBC shared resource instances from the system node. Ensure that the GovernanceJDBC shared resource instance must be the last to be uninstalled. It is recommended to use theForce Uninstall option for JDBC Resource Instance.

If you skip steps 3 to 7, please restart TIBCO Host manually.

3. If required, change the configuration of the user or database.

4. Start TIBCO Configuration Tool and select Edit TIBCO ActiveMatrix Administrator ServerConfiguration - V3.4.

5. Select the enterprise name and server name from the Server Configuration drop down menu, andselect Edit Database settings.

6. Edit the database configuration, and click Configure.

When update is complete, TIBCO Configuration Tool restarts the SystemNode node.

7. When the SystemNode node becomes available, log in to the TIBCO Administrator GUI and updatethe Governance JDBC resource with the new database configuration information. Cancel the pop-upto automatically synchronize the resource instances and applications.

8. Install the following:

a. JDBC Resource Instance for Governance JDBC Resource Instance. Make sure that GovernanceService is installed before installing Log Service and Payload Service.

b. Install the Hibernate Resource Instance (TIBCO ActiveMatrix Governance Hibernate Resource).

c. Install the Teneo Resource Instances. Make sure Governance Service is done before installationof Log Service and Payload Service.

If the data base URL is changed to point to a different database, make sure you migrate all the datafrom the old database location to the new database location. Editing the configuration alone does notmigrate the data.


Use Default In-Process Database

Indicate that the ActiveMatrix Administrator server database is an embeddedin-process database. TCT does not support editing the in-process databasedetails. If cleared, the external database configuration fields display.








Test Connection Verifies that TIBCO Configuration Tool can connect to the database server usingthe information supplied on this page.

210


Field Description

Create a TrustStore...

Invokes a wizard to import certificates from a server and create the trust store.

Browse Invokes a dialog to navigate to a keystore file.

KeystoreLocation

Location of the keystore.

Keystore Type Type of the keystore: JKS or JCEKS.

KeystorePassword

Password that protects the keystore.

Administrator Server Configuration: Edit Authentication Realm SettingsAdministrator stores information about users and groups in an authentication realm. When you editthe Authentication realm, you can change the settings of the current realm, switch from a database toLDAP, or switch from LDAP to a database. TIBCO Configuration Tool will then prompt you for moreinformation about the authentication realm.

This screen is only displayed if you selected Edit Authentication Realm Settings on the EditActiveMatrix Administrator Server Configuration screen.

Changing from a Database Realm to LDAP

Before you can change from a database realm to the LDAP realm, you have to add a new user in thecurrent DB realm and assign the user as superuser. This new user must already be a user in the LDAPrealm you want to use. See the Administration document for more information.

If you are changing from a Database realm to an LDAP realm, super user credentials are displayed. Youneed to enter the super user credentials you just created.

Enter the information about the authentication realm in the wizard screen.

Changing from LDAP to a Database Realm

What happens when you change from LDAP to a database realm depends on whether the databaserealm is empty or not.

● If the new database realm is empty that is if it does not have any users in it, Administrator creates anew user called tibco_user with a password 't'.

For this case, use the tibco_user superuser to log in to TIBCO Administrator after you havechanged to a database realm and change the password. Consider creating a new superuser anddeleting the default tibco_user user.

● If the new DB realm is not empty and does not contain any of the current superuser, a new usercalled tibco_user with password 't' is created.

For this case, use the tibco_user superuser to log in to TIBCO Administrator after you have changedto a database realm and change the password. Consider creating a new superuser and deleting thedefault tibco_user user.

● If the new DB realm already contains a superuser that is also a superuser in LDAP, you can use thatsuperuser. Administrator does not create a new user.

Enter the information about the authentication realm in the wizard screen.

211


Field Description

Authentication Realm

Realm Type The type of the authentication realm: Database or LDAP. If Database, the Administrator Server Configuration: Database Authentication Realm screendisplays. If LDAP, the Administrator Server Configuration: LDAPAuthentication Realm screens display.

Superuser Credentials


Default: root.


Default: t.

In the properties file, this value is obfuscated.

Administrator Server Configuration: Edit LDAP Authentication Realm

Field Description

Bind DN Name The superuser's distinguished name or superuser's name to be used to connectto the server.

Default: uid=Manager,ou=people,dc=example,dc=com

Password LDAP server password.

Default: None

Context Factory The factory object that provides the starting point for resolution of nameswithin the LDAP server.

Default: com.sun.jndi.ldap.LdapCtxFactory


Comma-separated list of URLs for an LDAP server. To achieve fault tolerance,you can specify multiple URLs. For example:

ldap://server1.example.com:686,ldap://server2.example.com:1686

Default: machineName:389, where machinename is the machine on which TIBCOConfiguration Tool is being executed.

Fetch DN Retrieves the base DN of the LDAP server.

User Search Configuration

User Search BaseDN

Base distinguished name from which the search starts.

Default: ou=people,ou=na,dc=example,dc=org

212


Field Description

User SearchExpression

The expression used for searching a user. For example: (CN=%U). "%U" isreplaced by the username being searched for. You can define any complex filtersuch as (&(cn=%U)(objectClass=account)).

Default: (&(uid={0})(objectclass=person))

User Attributewith User Name

The name of the attribute in the user object that contains the user's name.

Default: uid

Search Timeout(ms)

The time to wait for a response from the LDAP directory server.

Default: 30000

Follow Referrals Whether to follow LDAP referrals. When selected, requests to LDAP can beredirected to another server.

Select this field to indicate that the LDAP information might be available atanother location, or possibly at another server or servers.

Ask your LDAP administrator whether LDAP referrals are used inyour domain.

Field Description

Group Indication(optional)

Specifies how a user’s group memberships are found. Administrator uses groupinformation when a user, once authenticated, performs other activities in thesystem. Options:

● Group has users - List of users that belong to the group. When selected, theGroup Attribute with User Names field is enabled.

● User has groups - List of groups to which the user belongs. When selected,the User Attribute with Group Names field is enabled.

Default: Group has users.

Group SearchBase DN(optional)

Base distinguished name from which the search for the group starts.

Default: ou=groups,ou=na,dc=example,dc=org.

Group SearchExpression(optional)

Search by matching this expression against potential groups.

Default: (&(cn={0})(objectClass=groupofuniquenames)).

Group Attributewith User Names(optional)




Group Attributewith GroupName (optional)

Name of the attribute in the group object that contains the name of the group.


Default: cn.

213


Field Description

Group AttributeSubgroup Names(optional)

Name of the attribute in the group object that contains its subgroups.



User Attributewith GroupNames

Name of the attribute in the user object that lists the groups to which the userbelongs.

Default: None.

Group SearchScope Subtree

When searching the group, indicate whether to traverse into the subtree or tosearch only under the group base distinguished name.

Default: Selected.

Field Description

LDAP Realm


Select to have the search include the entire subtree starting at the base DN.Otherwise, search only the nodes one level below the base DN.

Default: Selected.


Value of Simple Authentication and Security Layer (SASL) authenticationprotocol to use. Values are implementation-dependent. Some possible valuesare simple, none, strong.

Default: simple.

LDAP Authentication

User DNTemplate(optional)

Template by which the User DN, used to connect to the LDAP server, isgenerated. Because the full DN is always supplied, the template should alwaysbe 0 (zero).

Default: uid={0},ou=people,ou=na,dc=org.

User AttributesExtra (optional)

List of user attributes to retrieve from the LDAP directory duringauthentication.

Default: Empty (no additional attributes will be retrieved for the user).


Select to enable the LDAP server for SSL. When selected, the SSL KeystoreConfiguration fields are enabled.

Default: Cleared.

Test Connection Click the Test Connection button to ensure that you can connect to the LDAPdatabase.

Field Description


214


Field Description

Create a TrustStore







Either:




The following description applies to this screen only when it is displayed from the Edit TIBCOActiveMatrix Administrator Server Configuration Wizard.

Field Description



Default: CONFIG_HOME\tct\admin.editor\timestamp



where:


● port is the External HTTP Port number specified in the Administrator Server Configuration: Connection Settings screen.


Edit TIBCO ActiveMatrixAdministrator server

Whether to apply the configuration changes to the ActiveMatrixAdministrator server.

Default: Selected

215


Upgrade or Downgrade TIBCO ActiveMatrix WizardThis section provides reference information about the TIBCO Configuration Tool Upgrade orDowngrade TIBCO ActiveMatrix wizard, as used with ActiveMatrix BPM.

See the TIBCO ActiveMatrix Service Grid Installation Guide for full information about this wizard.

TIBCO ActiveMatrix Upgrade Manager: Upgrade or Downgrade


Upgrade Select this to upgrade the current TIBCO ActiveMatrix version.

Default: Selected

Downgrade Select this to downgrade the current TIBCO ActiveMatrix version.

Default: Cleared

TIBCO ActiveMatrix Upgrade Manager: Upgrade Options

Field Description

Upgrade All TIBCOHosts Upgrade all TIBCO Hosts in the specified CONFIG_HOME.

Default: Cleared

Select TIBCOHosts to beupgraded

Upgrade selected TIBCO Hosts in the specified CONFIG_HOME.

Default: Selected

Skip diagnostic tests (notrecommended)

Skip the validation of the specified CONFIG_HOME.

Default: Cleared

TIBCO ActiveMatrix Upgrade Manager: Upgrade Selection

Field Description

Select TIBCOHosts to beupgraded

Upgrades selected TIBCO Hosts in the specified CONFIG_HOME.


Skips the validation of the specified CONFIG_HOME.

TIBCO ActiveMatrix Upgrade Manager: ValidateTIBCO Configuration Tool runs diagnostic tests to find out if there are any issues with the specifiedCONFIG_HOME that might prevent a successful upgrade or downgrade process.

Field Description

Results of diagnostic tests Results of the diagnostic tests are displayed in this area.

216


Field Description

Eligibility ofCONFIG_HOME ● ELIGIBLE: Indicates that the diagnostic tests were successful

and that the specified CONFIG_HOME is eligible for theupgrade or downgrade process.

● NOT ELIGIBLE: Indicates that some of the diagnostic testsfailed and that the specified CONFIG_HOME is not eligible forthe upgrade or downgrade process.

Rerun tests Runs the diagnostic tests again.

Diagnostic report Opens a text version of the complete diagnostic report.

TIBCO ActiveMatrix Upgrade Manager: Upgrade Summary

Field Description


Folder where the scripts and logs for the current session are stored.

Stop All or Selected TIBCOHosts

Stops all or selected Hosts and Nodes managed by the Hosts(including manual Nodes) before proceeding with the Upgrade.

Nodes are stopped irrespective of the startup mode.

Upgrade All or SelectedTIBCO Hosts

Upgrades all or selected Hosts.

All Nodes managed by the TIBCO Hosts are upgradedautomatically.

Perform post-upgrade tasks Performs the post-upgrade task after a successful Upgrade.

This task is recommended when upgrading a SystemHost (TIBCO ActiveMatrix Administrator Nodes).

Start All or Selected TIBCOHosts

Re-starts all or selected Hosts after a successful Upgrade.


217


Field Description

Upgrade Depending on the check boxes selected, clicking on Upgrade,performs the tasks in the following order:

1. Stops all or selected Hosts.

2. Upgrades all or selected Hosts.

3. Performs a post-upgrade task.

4. Re-starts all or selected Hosts.

If an action is completed and it was successful, (c) is displayedbeside it.

If an action is completed but with an error, (f) is displayed beside it.

If an action was aborted because one of the previous actions failed,(a) is displayed beside it.

Details As Upgrade might take time, if you want to see the current status oftasks, click Details to see more information.

TIBCO ActiveMatrix Upgrade Manager: Downgrade OptionsThe following table lists the options available while downgrading hosts using the Upgrade orDowngrade TIBCO ActiveMatrix wizard.

Field Description

Downgrade All TIBCOHosts Downgrades all the hosts in the specified CONFIG_HOME.

Select TIBCOHosts to bedowngraded

Downgrades selected hosts in the specified CONFIG_HOME.



TIBCO ActiveMatrix Upgrade Manager: Downgrade SelectionIf you choose to downgrade only selected hosts, the following table lists the options that are availableduring the selection of the hosts.

Field Description

Select TIBCOHosts to bedowngraded

Downgrades selected hosts in the specified CONFIG_HOME.



TIBCO ActiveMatrix Upgrade Manager: ActiveMatrix Administrator ServerThe following table lists the ActiveMatrix Administrator server details that need to be specified whileupgrading or downgrading an ActiveMatrix Administrator server using the wizard.

218


Field Description

Machine name The machine on which the ActiveMatrix Administrator Server exists.

Port Port used to connect to the server.

Username User name for the server.

Password Password for the user.

Admin server is SSL enabled Select this check box if the server is SSL-enabled.

When checked, the SSL Keystore configuration fields are enabled.

Default: Unchecked.

TIBCO ActiveMatrix Upgrade Manager: Downgrade SummaryThe Downgrade Summary provides a summary of selections and actions that will be performed duringthe downgrade. The following table lists the options available on the Downgrade Summary screen.

Field Description


Folder where the scripts and logs for the current session are stored.

Stop All or Selected TIBCOHosts

Stops all or selected hosts and nodes managed by the hosts(including manual nodes) before proceeding with the downgrade.


Downgrade All or SelectedTIBCO Hosts

Downgrades all or selected hosts.

All nodes managed by the hosts are downgradedautomatically.

Start All or Selected TIBCOHosts

Re-starts all or selected hosts after a successful downgrade.

Downgrade Depending on the check boxes selected, clicking on Downgrade,performs tasks in the following order:

1. Stops all or selected hosts.

2. Downgrades all or selected hosts.

3. Re-starts all or selected hosts.

If an action is completed and it was successful, (c) is displayedbeside it.

If an action is completed but with an error, (f) is displayed beside it.

If an action was aborted because one of the previous actions failed,(a) is displayed beside it.

219


Field Description

Details As downgrade might take some time, if you want to see the currentstatus of tasks, click Details to see more information.

220


IV - ADDITIONAL INFORMATION

The following sections provide additional information that you may need when installing or upgradingActiveMatrix BPM.

Troubleshooting InstallationIf you encounter problems with installation, there are a few things that you should do to try to find outwhy and to clean up the environment.

Procedure

1. Make sure that your system meets all prerequisites.

See System Requirements.

2. Check the installer log file for potential problems.

See Installer Log File.

3. Clean up the environment.

See Sanitizing After a Failed Installation.

Installer Log FileThe installer log file contains information about the installation that was performed. Separate log filescontain information about scripts that the installer ran.

The installer log file, tibco_universal_installer.username_install.log, is written to the .TIBCO/install_timestamp directory of the user’s home directory. To change the location of the installer logfile, specify the option -V logFile="myLogFile" when you run the installer.

The installer log file captures the following information:

● Installation environment details such as user that invoked the installer, operating system details,installer mode, host name, JAVA_HOME and the Java version available in that environment, and soon.

● List of assemblies installed.

Information related to the Ant scripts that are executed by the installer is logged in separate log files:

antTask_log_scriptname_timestamp

under the directory:

install_timestamp

Sanitizing After a Failed InstallationAn installation process can fail at various stages and the installer may not be able to clean up theenvironment before exiting. It is recommended that you clean up the environment manually beforetrying to re-install the product.

Consider a simple environment with a single node (BPMNode) on a single host. To sanitize thisenvironment after a failed installation, perform the following steps in the specified order.

The following steps are applicable for a single node environment. Similar steps may be applied to cleanup an active-active or a distributed environment. The actual steps however will have to be customizedto the environment that needs to be cleaned.

221


Procedure

1. Shutdown TIBCO Configuration Tool.

2. Stop any processes running from CONFIG_HOME.For example, tibcohost, tibamx_SystemNode, and tibamx_BPMNode.

3. Delete the BPM configuration directory specified during the installation.For example, if you chose to use the default configuration directory when installing on Windows,delete the folder C:\ProgramData\amx-bpm\tibco\data.

Uninstalling an ActiveMatrix BPM SystemTo uninstall an ActiveMatrix BPM system, stop the TIBCO processes, run the TIBCO UniversalUninstaller, and delete ActiveMatrix BPM directories.

Procedure

1. Stop the TIBCO Host instance, node processes, and TIBCO Business Studio.

2. Log in to the system from which you want to uninstall software.

● On Windows, log in as a user with Administrator privileges. You must have Administratorprivileges to uninstall this software.

● On UNIX/Linux, you should uninstall as the same user who did the installation. If more thanone product installation has been made to the same environment and you want to uninstallthem all, you should uninstall using the root user.

3. Do one of the following:

● On Windows, go to Start > All Programs > TIBCO > env_name and click on Uninstall.Alternately, you can navigate to the installation_environment\tools\universal_installer folder and run TIBCOUniversalInstaller.exe.

● On UNIX/Linux, navigate to the installation_environment/tools/universal_installerdirectory and run ./TIBCOUniversalInstaller-platform_id.extension.

You can choose to uninstall the product in either GUI or console mode. Uninstalling theproduct in silent mode is not supported.

4. At the TIBCO Installation Manager screen, choose the option Uninstall Products from SelectedTIBCO Home Location and then choose the location of TIBCO Home from the drop-down. ClickNext.

5. When the TIBCO Universal Uninstaller is launched and the Welcome screen is displayed, clickNext.

6. Select either Custom Uninstall (to select the products in this environment to be uninstalled) orTypical Uninstall (to uninstall all products in this environment).

● If you select Typical Uninstall, continue with Step 8.● If you select Custom Uninstall, continue with the next step.

7. At the Product Uninstall Selection screen, select the products (for example, TIBCO ActiveMatrixBPM Version) you want to uninstall and click Next.

8. At the Pre-Uninstall Summary screen, if you want to change any of your choices, click Back to stepback through the screens to the appropriate point. You can then restart the uninstallation processfrom that point.

9. When you are satisfied with your choices, click Uninstall.The uninstaller removes the software product you specified.

222


10. The Running ANT Tasks screen is displayed while the selected components are uninstalled. Whenasked about the cleanup of the /tools directory, click Yes, clean it up.

11. At the Post Uninstall Summary screen, review the information and then click Finish.The uninstaller exits and cleans up any temporary files.

On Windows, the TIBCO ActiveMatrix BPM entries in the Start menus may remain afterthe uninstallation. To correct this, log out, then log in again.

On UNIX/Linux, if an error message similar to the following is displayed afteruninstallation, log out and log in again for the uninstaller changes to take effect:

The wizard requires that you logout and log back in

12. Manually delete the TIBCO ActiveMatrix BPM directories under TIBCO_HOME.

13. Manually delete the TIBCO ActiveMatrix BPM directories under CONFIG_HOME.

14. If the ActiveMatrix BPM database is using Oracle, and there are no other ActiveMatrix BPMinstances using the database, do as follows:a) Delete the database server user account that ActiveMatrix BPM uses to connect to the database.

By default, the account name is bpmuser.b) Delete the tablespaces that contain that user's objects. By default, this means the files

bpm_tablespace and bpm_tablespace_temp.

15. If you registered the TIBCO Host instance as a Windows service when you created or upgraded theActiveMatrix BPM instance, delete the service using Windows Control Panel.

Disaster Recovery Using Data-Level ReplicationYou can use file-based and database-based data replication solutions to provide a disaster recoverycapability for a TIBCO ActiveMatrix BPM system.

Data-Level ReplicationThe data-level replication approach requires only file-based and database-based replication software. Itensures that data on the Disaster Recovery (DR) site will be in a consistent state across the variousTIBCO ActiveMatrix BPM datastores and will therefore start-up when required.

If the primary site fails, there may be some data loss or lost state changes within executing businessprocesses. The extent of this loss is determined by the latency of the replication of changes on theprimary site to the DR site.

TIBCO ActiveMatrix BPM maintains key system configuration and transaction data both on the filesystem and within relational databases. This data must be reliably replicated to the DR site.

The following figure provides an example of how this can be done, showing the data that needs to bereplicated between the primary and DR site and the replication methods employed.

223


Example configuration for data-level replication disaster recovery

There are two types of data:

● non-operational - data that changes only as a result of management actions being performed upon thesystem (items 1 and 2 in the diagram).

● operational - data that changes continuously during the operation of the system (items 3 to 6 in thediagram). This data must be consistent between the primary and DR sites. Synchronous replicationof operational data is not a requirement, but asynchronous replication may cause loss of data.

The case data store (item 4) can be held as part of the main TIBCO ActiveMatrix BPMdatabase (item 3). See ActiveMatrix BPM: BDS Database Configuration.

224


Configuring TIBCO ActiveMatrix BPM for Disaster RecoveryYou must perform various tasks to configure TIBCO ActiveMatrix BPM for disaster recovery.

This section provides a high-level overview of the steps involved in implementing a data-levelreplication solution for TIBCO ActiveMatrix BPM. Familiarity with the following topics is assumed:● underlying disaster recovery concepts, techniques and technologies

● file-based and database-based replication software

● TIBCO ActiveMatrix BPM architecture, installation and operation

● TIBCO Enterprise Message Service

Examples used assume the use of the UNIX operating system, Oracle databases and Oracle Data Guardreplication technology.

Contact TIBCO if you require further information about how the solution described would apply toyour specific TIBCO ActiveMatrix BPM implementation.

Creating Host Aliases for TIBCO ActiveMatrix BPM System Components

You must create host aliases because you will identify each component by its alias when you configureBPM.

● On both the primary site and the DR site, create matching aliases for the hosts of the followingTIBCO ActiveMatrix BPM system components:

● TIBCO ActiveMatrix BPM

● TIBCO ActiveMatrix BPM database server

● TIBCO ActiveMatrix BPM case data store server (if the case data store is hosted in a separatedatabase from the BPM database itself)

● TIBCO ActiveMatrix Administrator

● TIBCO ActiveMatrix Administrator database server

● Enterprise Message Service server

● LDAP server

● SMTP server (if used)

● Public load balancer

Use a method that resolves host name aliases at the network level, such as a local in-datacenterDNS solution or a matching set of entries in the hosts files on both the primary site and the DR site.For example:# TIBCO ActiveMatrix BPM - server: ip hostname aliasxx.xxx.xx.xx BPM_server_hostname amx-bpm-host# TIBCO ActiveMatrix BPM - Database Server: ip hostname aliasxx.xxx.xx.xx Oracle_server_hostname amx-bpm-db-host# TIBCO ActiveMatrix BPM - BDS Case data store Server: ip hostname aliasxx.xxx.xx.xx Oracle_server_hostname amx-bpm-bds-host# TIBCO ActiveMatrix Administrator - server: ip hostname aliasxx.xxx.xx.xx Administrator_server_hostname amx-bpm-admin-host# TIBCO ActiveMatrix Administrator - Database Server: ip hostname aliasxx.xxx.xx.xx Oracle_server_hostname amx-bpm-admin-db-host# TIBCO ActiveMatrix Enterprise Message Service server: ip hostname aliasxx.xxx.xx.xx EMS_server_hostname amx-bpm-ems-host# TIBCO ActiveMatrix BPM - LDAP Server: ip hostname aliasxx.xxx.xx.xx LDAP_server_hostname amx-bpm-ldap-host# TIBCO ActiveMatrix BPM - SMTP Server: ip hostname aliasxx.xxx.xx.xx SMTP_server_hostname amx-bpm-smtp-host

225


# Public load balancer machine: ip hostname aliasxx.xxx.xx.xx Public_load_balancer_hostname amx-bpm-public-load-balancer

Creating Service Name Aliases for TIBCO ActiveMatrix BPM Databases

On both the primary site and the DR site, create a service name alias that TIBCO ActiveMatrix BPM canuse to identify the database to which it connects.

TIBCO ActiveMatrix BPM uses a JDBC connect string to identify the Oracle database to which itconnects. The connect string identifies the database by its service name which, by default, is the same asits SID.

Because the databases on the primary and DR site have different SIDs, you must define an Oracleservice name that TIBCO ActiveMatrix BPM can use as an alias, allowing it to connect to the databasewhether it is currently running on the primary system or the DR system.

The use of an alias means that the physical location of the DBMS makes no difference to the recoveryscenario.

Procedure

1. On the primary system database, define a service name alias.For example, to define a service name alias of amxbpmdb on the primary system database (whichhas a SID of main):a) Verify that the SERVICE_NAMES parameter only contains a single name, which is the SID:

SHOW PARAMETER SERVICE_NAMES ;

b) Modify the SERVICE_NAMES parameter to add the amxbpmdb alias:ALTER SYSTEM SET SERVICE_NAMES = 'main,amxbpmdb' ;

2. On the DR system database, define the same service name alias.For example, to define a service name alias of amxbpmdb on the DR system database (which has aSID of second), run the following commands:

SHOW PARAMETER SERVICE_NAMES ;

ALTER SYSTEM SET SERVICE_NAMES = 'second,amxbpmdb' ;

Result

When you configure the EMS server and TIBCO ActiveMatrix BPM, you can specify the JDBC connectstring as:

jdbc:oracle:thin:@db-host-name:db-port-num/alias-service-name

instead of the default:

jdbc:oracle:thin:@db-host-name:db-port-num:service-name

For example:

jdbc:oracle:thin:@db-host-name:db-port-num/amxbpmdb

The service-name is preceded by a forward-slash character (’/’) not a colon (’:’).

Storing EMS Queues in the Oracle Database

EMS messages used by BPM are written to queues in the EMS server’s $sys.nonfailsafe default store.You must ensure that these messages are replicated.

By default, $sys.nonfailsafe is a file-based store on the EMS server. If you are using Windows ratherthan UNIX, installation of EMS creates services, which are not automatically replicated. To ensure that

226


messages written to these queues are replicated, change the EMS server configuration so that$sys.nonfailsafe is defined as a database store in the same Oracle database used by BPM.

This procedure assumes that EMS is either installed on both the primary and DR sites, or else installedon the primary site and replicated on the DR site.

● Edit the $sys.nonfailsafe entry in the EMS server’s stores.conf file. Set the following fields:

● type - must be dbstore.

● dbstore_driver_url - must be the aliased JDBC connect string that identifies the Oracledatabase used by BPM (see Creating Service Name Aliases for TIBCO ActiveMatrix BPMDatabases).

For example:[$sys.nonfailsafe] type = dbstoredbstore_driver_url = jdbc:oracle:thin:@db-host-name:db-port-num/amxbpmdbdbstore_driver_username = usernamedbstore_driver_password = password

See the TIBCO Enterprise Message Service User’s Guide for more information.

The $sys.nonfailsafe default store is not used exclusively by BPM, so this configurationmay also result in non-BPM related messages being stored in the database.

Configuring TIBCO ActiveMatrix BPM to Use Hostname and Aliases

Configure TIBCO ActiveMatrix BPM to use the created hostname and DB aliases, by running theTIBCO Configuration Tool.

If all of the TIBCO ActiveMatrix BPM components are installed on the same server, localhost can bespecified as the hostname in all the fields defined below, with the exception of HTTP WorkPresentation Host, which must use the defined alias. (This is because the hostname is embedded in theURL in work item notification emails for remote access from clients, so the URL must be the publicaddress that clients use to access TIBCO ActiveMatrix BPM.)

Procedure

1. In the Create TIBCO ActiveMatrix BPM Server wizard, use the indicated aliases in the followingscreens and fields.

Screen Field Enter Example

DatabaseAdministrator

URL Aliased JDBC connectstring that identifiesthe Oracle databaseused by BPM

jdbc:oracle:thin:@amx-bpm-

db-host:db-port-num/

amxbpmdb

Runtime DatabaseConfiguration

URL Aliased JDBC connectstring that identifiesthe Oracle databaseused by BPM



amxbpmdb

227



BDS DatabaseConfiguration

URL Aliased JDBC connectstring that identifiesthe Oracle databaseused to host the BDScase data store



amxbpmdb

ClientConfiguration

HTTP WorkPresentationHost

Hostname alias thatidentifies the publicload balancer

amx-bpm-public-load-

balancer

SMTP Host Hostname alias thatidentifies the SMTPserver

amx-bpm-smtp-host

LDAPConfiguration

URL Hostname alias thatidentifies the LDAPserver

amx-bpm-ldap-host

2. In the Create TIBCO ActiveMatrix Administrator Server wizard, use the indicated aliases in thefollowing screens and fields.


TIBCO HostInstance

Machine Name Hostname aliasthat identifies theTIBCOActiveMatrixAdministratorserver

amx-bpm-amx-host

Internal HTTPPort

Load BalancerURL

(If required)Hostname aliasthat identifies theload balancer

amx-bpm-int-load-balancer

Notification andMessaging BusServer


Hostname alias(and port) thatidentifies the EMSserver used byTIBCOActiveMatrixAdministrator

amx-bpm-ems-host:7222

Database Details Database URL Aliased JDBCconnect string thatidentifies theOracle databaseused by BPM



amxbpmdb

228


Enabling Halt on Error Behavior

Enable TIBCO ActiveMatrix BPM’s haltOnError behavior so that, if the primary site fails, ProcessManager halts any process instances that throw a Java exception as a result of the system error. You willthen be able to resume the halted process instances when you restart TIBCO ActiveMatrix BPM on theDR site.See "Configuring Error Handling Behavior for Process Instances" in TIBCO ActiveMatrix BPMAdministration for more information.

Replicating TIBCO ActiveMatrix BPM File-Based Data

Copy files to the Disaster Recovery site.

Procedure

● Using your chosen file-based replication solution, replicate the contents of the following directoriesfrom the primary site to the DR site. The entire contents of each directory, including all childdirectories, must be replicated.

Directory Contents Replication requirements

TIBCO_HOME TIBCOActiveMatrixBPM systemsoftware

Replicate this directory whenever there has been achange to the deployed TIBCO runtime software.For example, when:

● software has been installed.

● a hotfix, service pack or upgrade to an existingsoftware component has been added.

CONFIG_HOME deployedapplicationdata(definitions andconfigurations)

Replicate this directory whenever there has been achange to any deployed applications or theirconfiguration. For example, when:

● a change is made using ActiveMatrixAdministrator (UI or CLI).

● an application is deployed or undeployed fromTIBCO Business Studio.

TIBCO ActiveMatrix BPM TransactionManager state log files should not bereplicated - see Transaction Manager LogFiles.

EMS_CONFIG_HOME configurationfor TIBCO EMS

Replicate this directory whenever there has been achange to the EMS application or its configuration.

EMS_HOME TIBCO EMSsoftware

Optional: you can either install EMS on the DR site,or else replicate this directory. See Storing EMSQueues in the Oracle Database for further details.

Replicate this directory when there has been achange to the EMS runtime software.

229


TIBCO recommends the use of a real-time replication solution so that any update to eitherthe TIBCO_HOME or CONFIG_HOME directory structure is automatically and immediatelyreplicated. This removes any risk of administration changes performed on the primary sitenot being moved to the DR site within a suitable time.

If you chose to use a scheduled (e.g. nightly) rather than real-time solution, you should:● initiate on-demand replication as the result of any administrative changes made on the

primary site during the working day

● be willing to accept the risk of changes made between scheduled replications not beingpresent on the DR site, along with any potential system corruption risks in the eventthat the DR site needs to be activated.

Transaction Manager Log Files

TIBCO recommend that you do not replicate the transaction data that is logged by Transaction Manageron each node.

Each BPM node (for example, BPMNode), and the System node (SystemNode), has an embeddedTransaction Manager (TxM), which logs its transaction state to files in the following directories:

CONFIG_HOME/tibcohost/Admin-enterpriseName-adminServerName/nodes/nodeName/work/

HowlLogs


GeronimoTMID

Although transaction state data is stored in the file system, it changes as rapidly as other operationaldata. Consequently, if the primary site fails, some in-progress transactions may be lost.

To ensure data consistency between the primary and DR sites, TIBCO recommend that you do notreplicate the HowlLogs and TxM GeronimoTMID log directories to the DR site.

If you do replicate the HowlLogs and TxM GeronimoTMID log directories to the DR site, you mustremove any files from the HowlLogs and TxM GeronimoTMID log directories on the DR site beforestarting TIBCO ActiveMatrix BPM. See Before Starting TIBCO ActiveMatrix BPM on the Secondary Site.

Replicating TIBCO ActiveMatrix BPM Database-Based Data

Copy databases to the Disaster Recovery site.

Procedure

● Using your chosen database replication software, replicate the following databases from theprimary site to the DR site:

Database Description

TIBCO ActiveMatrixBPM

Stores the runtime state of the TIBCO ActiveMatrix BPM system. Its rateof change is entirely dependent on flow of transactions (end user activity)through the BPM system.

BDS case data store Stores case data.

The case data store can be held as part of the main TIBCOActiveMatrix BPM database. See ActiveMatrix BPM: BDSDatabase Configuration.

230


Database Description

TIBCO ActiveMatrixAdministrator

Stores information pertaining to your TIBCO ActiveMatrix enterprise -for example, deployed applications.

EMS datastore Stores the EMS Server messages. See Storing EMS Queues in the OracleDatabase.

Custom database(s) Any custom databases required by the customer application.

Recovering TIBCO ActiveMatrix BPM if the Primary Site FailsIf the primary site fails, you can recover the system by starting TIBCO ActiveMatrix BPM on thesecondary site.

There are a number of tasks that you must perform:

● Before Starting TIBCO ActiveMatrix BPM on the Secondary Site

● After Starting TIBCO ActiveMatrix BPM on the Secondary Site

Before Starting TIBCO ActiveMatrix BPM on the Secondary Site

Procedure

1. Promote your Oracle Data Guard DBMS on the secondary site to online status, and start all requiredsupport software (such as EMS) on the secondary site.

2. Roll back and purge any outstanding global transactions in the Oracle database associated withTIBCO ActiveMatrix BPM:a) Using a text editor, open the following script:

TIBCO_HOME\bpm\n.n\samples\DRscripts\clean-ora-tran.sh

b) In the following line, replace the example value bpmuser with the name of the operating systemaccount that runs TIBCO ActiveMatrix BPM.SQL_OS_USER=bpmuser

c) Save the file.d) Using the Oracle system DBA account, run the clean-ora-tran.sh script.

This script identifies any outstanding global transaction records associated with TIBCOActiveMatrix BPM, and generates a bpm-tx-rollback.sql script that contains a set of SQLcommands to purge them.

e) Review the generated bpm-tx-rollback.sql script to ensure that you are happy with thechanges it will make to the database.For example, depending on what applications use the BPM database in your particularenvironment, there might be non-BPM transactions in the database: if so, do these need to berolled back or not?

f) Using the Oracle SQLPlus utility, run the bpm-tx-rollback.sql script to purge the outstandingglobal transactions.

3. Purge all pending transactions in EMS. To do this:a) As the EMS admin user, run the following script:

TIBCO_HOME\bpm\n.n\samples\DRscripts\clean-ems-tran.sh

(Make sure that the EMS server’s bin directory is in the PATH.) This script identifies any pendedtransactions, and generates anemsrollback.sh file that contains a set of tibemsadmincommands to purge them.

231


b) Review the generated emsrollback.sh script to ensure that you are happy with the changes itwill make to the EMS datastore.

c) Use the following command to run the script and purge all pending transactions:tibemsadmin -script emsrollback.sh

See the TIBCO Enterprise Message Service User’s Guide for more information.

4. Remove any TIBCO ActiveMatrix BPM nodename TxM log files from the following locations (if theyexist):CONFIG_HOME/tibcohost/Admin-enterpriseName-adminServerName/nodes/nodeName/work/

HowlLogs


GeronimoTMID

where nodeName is the name of each node on the system - for example, BPMNode and SystemNode.See Transaction Manager Log Files for more information.

5. Remove the following lock file (it may or may not exist, depending on the file replication systembeing used):CONFIG_HOME/tibcohost/Admin-enterpriseName-adminServerName/nodes/nodeName/bin/

node.lck

where nodeName is the name of each node on the system - for example, BPMNode and SystemNode.

After Starting TIBCO ActiveMatrix BPM on the Secondary Site

Procedure

1. In TIBCO ActiveMatrix Administrator, check that BPM has started correctly and that all otherrequired applications are running.

2. Using Workspace or Openspace, resume any process instances that are now suspended because theprimary site failed (see Enabling Halt on Error Behavior).

You can resume a suspended process instance by selecting it and clicking Resume - see the TIBCOOpenspace User’s Guide or TIBCO Workspace User’s Guide for more information.

Disaster Recovery Using Device-Level ReplicationThe device-level replication approach requires dedicated device-level replication hardware andsoftware (with commensurate higher costs). It ensures that state information held in the file system ordatabase remains synchronized after replication to the DR site.

The data from the following parts of a TIBCO ActiveMatrix BPM system must be replicated on aseparate system such that all data sources are consistent.

● TIBCO_HOME and CONFIG_HOME directories for the TIBCO ActiveMatrix BPM installation. If the BPMconfiguration files are in a different location, you must replicate them as well.

● TIBCO ActiveMatrix BPM database

● TIBCO ActiveMatrix Administrator database

● TIBCO Enterprise Message Service server

● Corporate LDAP system.

The method for replicating this data depends on your specific company practices and policies.

The following diagram shows an example of this type of configuration.

232


Example configuration for device-level replication disaster recovery

Deleting a Replica ActiveMatrix Administrator ServerDo not run the deletion script on the machine that is running the ActiveMatrix Administrator instancethat you want to delete.

For example, assume your cluster consists of ActiveMatrix Administrator instance A running onmachine X and ActiveMatrix Administrator instance B running on machine Y. To delete instance B, runthe script from machine X.

233


Procedure

1. On the machine that is running the ActiveMatrix Administrator server instance that you do notwant to delete:a) Make sure that the super user specified in the following file has force_delete permission:

CONFIG_HOME\admin\enterpriseName\samples\remote_props.properties

Only users with explicit force_delete and super user permission are allowed to delete anActiveMatrix Administrator server instance.

b) Edit the following file to update the node and host name properties:CONFIG_HOME\admin\enterpriseName\samples\deleteAdminInstance_data.xml

c) Open a command window in the following folder:CONFIG_HOME\admin\enterpriseName\samples

d) Run the following command:ant -f deleteAdminInstance_build.xml

The replica node is deleted from the environment and the replica host is unregistered. However,if the replica host has any runtime nodes, the replica host is not unregistered.

2. If the replica host is unregistered, go to the machine on which the deleted ActiveMatrixAdministrator instance was running and terminate the TIBCO Host process.

Securing Communication ChannelsBy default, the communication channels between the ActiveMatrix BPM components and third-partyapplications are not secure. However, you can secure them using the SSL protocol.

The TIBCO ActiveMatrix BPM platform is partitioned across many components. These componentscommunicate with each other and with third-party applications over various communication protocols.The components and communication channels are illustrated in the following figure.

ActiveMatrix communication channels

By default, these communication channels are not secure. However, they can be secured by configuringthe channels to use the Secure Sockets Layer (SSL) protocol. SSL is a cryptographic protocol that

234


provides security and data integrity for communications over TCP/IP networks. SSL encrypts thesegments of point-to-point connections at the Transport Layer.

An SSL client and server negotiate a stateful connection by using a handshaking procedure. During thishandshake, the client and server agree on various parameters to establish the connection's security. Thehandshake begins when a client connects to an SSL-enabled server requesting a secure connection. Theserver sends back its identification in the form of a digital certificate. The certificate usually contains theserver name, the trusted certificate authority (CA), and the server's public encryption key.

You can specify the SSL configuration of the communication channels at various times in the life cycleof a TIBCO ActiveMatrix BPM enterprise. The following table lists how to perform the initial SSLconfiguration and how to upgrade, downgrade, and change the configuration of each channel. Detailedsteps for each procedure are provided in Configuring ActiveMatrix BPM Runtime Objects (TIBCOConfiguration Tool) and TIBCO ActiveMatrix BPM - SOA Administration.

Key Channel Initial ConfigurationUpgrade, Downgrade orChange Configuration

1 TIBCO ActiveMatrixAdministrator server(external HTTP port) -web and CLI clients

When creating ActiveMatrixAdministrator server inTIBCO Configuration Tool.

Upgrade or downgrade:ActiveMatrix Administrator CLI

Change SSL configuration:ActiveMatrix Administrator CLI

2 TIBCO ActiveMatrixAdministrator server(internal HTTP port) -hosts and nodes


Upgrade or downgrade:ActiveMatrix Administrator webUI or CLI

Change SSL configuration:ActiveMatrix Administrator webUI or CLI

3 TIBCO ActiveMatrixAdministrator server -TIBCO EnterpriseMessage Serviceserver


Upgrade or downgrade:ActiveMatrix Administrator webUI or CLI

Change SSL configuration:ActiveMatrix Administrator webUI or CLI

4 TIBCO Host instance -TIBCO EnterpriseMessage Serviceserver

When creating ActiveMatrixAdministrator server orTIBCO Host instance inTIBCO Configuration Tool.

Upgrade or downgrade:ActiveMatrix Administrator CLI


5 TIBCO ActiveMatrixAdministrator server -external database andLDAP servers



6 TIBCO ActiveMatrixAdministrator server -hosts and nodes(management)


Upgrade: ActiveMatrixAdministrator web UI


235


Key Channel Initial ConfigurationUpgrade, Downgrade orChange Configuration

7 TIBCO ActiveMatrixAdministrator server -UDDI server

1. Manually import the UDDIserver certificate into theActiveMatrixAdministrator server truststore using keytool.

2. Enable securecommunication inActiveMatrixAdministrator web UI orCLI.

Same procedure as initialconfiguration

8 TIBCO ActiveMatrixAdministrator server(external HTTP port) -TIBCO BusinessStudio

ActiveMatrix Administrator -When creating ActiveMatrixAdministrator server inTIBCO Configuration Tool.

TIBCO Business Studio -When you connect toActiveMatrix Administrator.

ActiveMatrix AdministratorUpgrade or downgrade:ActiveMatrix Administrator CLI


9 Resource instances(JMS, SMTP, LDAP,JDBC, HTTP) -external servers

ActiveMatrix Administratorweb UI or CLI

ActiveMatrix Administrator webUI or CLI

Configuring TIBCO Enterprise Message Service ServersIf your TIBCO ActiveMatrix BPM infrastructure connects to its TIBCO Enterprise Message Serviceservers with users who do not have administrator privileges, you must configure the servers to grantthe minimum level of privileges to the users that will enable them to perform their tasks.

TIBCO Configuration Tool needs to have permission to view factories so that you can select one. Togrant this permission, use the following command:

grant admin user=amxbpm view-factory

Procedure

1. In the Enterprise Message Service server console, set permissions for the Administrator servers.

In the following commands, replace username and password with the username and passwordvalues appropriate for each bus.

● Messaging Bus

delete queue >

delete topic >

create user username "Description of the user" password=password

create queue AMX_SV.>

grant queue AMX_SV.> user=username create, delete, modify, send, receive

236


● Notification Bus, which propagates status messages between Administrator, hosts, and nodes

delete queue >

delete topic >


create topic EMSGMS.>

grant topic EMSGMS.> user=username create, modify, subscribe, publish

grant topic $sys.monitor.connection.* user=username subscribe

grant admin user=username view-connection, view server

create topic AMX_MGMT.>

grant topic AMX_MGMT.> user=username create, modify, subscribe, publish

create queue AMX_MGMT.>

grant queue AMX_MGMT.> user=username create, delete, modify, send, receive

● Management Bus, which handles the internal Administrator queues, currently grouped with theNotification Bus

delete queue >

delete topic >


create queue com.tibco.amf.admin.deploymentServerQueue.>

grant queue com.tibco.amf.admin.deploymentServerQueue.> user=username create,

delete, send, receive

● Common Logging and Payload Bus

delete queue >

delete topic >


create queue cl_logservice_queue.physical

create queue cl_payload_queue.physical

grant queue cl_logservice_queue.physical user=username send, receive

grant queue cl_payload_queue.physical user=username send, receive

create jndiname cl_logservice_queue queue cl_logservice_queue.physical

create jndiname cl_payload_queue queue cl_payload_queue.physical

● Monitoring Bus

delete queue >

delete topic >


create queue amx.governance.stats

grant queue amx.governance.stats user=username send, receive

create queue amx.governance.internal.stats

grant queue amx.governance.internal.stats user=username send, receive

237


2. The Notification, Management, and Messaging Buses are initially grouped together, as are theMonitoring, Common Logging, and Payload Buses. So, their constraints need to be grouped beforethey are manually separated, if required.

● Messaging, Notification, and Management Buses

delete queue >

delete topic >






grant topic $sys.monitor.connection.* user=username subscribe

create queue com.tibco.amf.admin.deploymentServerQueue.>

grant admin user=username view-connection, view-server

grant queue com.tibco.amf.admin.deploymentServerQueue.> user=username create,

delete, send, receive

create topic AMX_MGMT.>

grant topic AMX_MGMT.> user=username create, modify, subscribe, publish

create queue AMX_MGMT.>

grant queue AMX_MGMT.> user=username create, delete, modify, send, receive

● Monitoring, Common Logging, and Payload Buses

delete queue >

delete topic >


create queue cl_logservice_queue.physical

create queue cl_payload_queue.physical

create queue amx.governance.stats

create queue amx.governance.internal.stats

grant queue cl_logservice_queue.physical user=username send, receive

grant queue cl_payload_queue.physical user=username send, receive

grant queue amx.governance.stats user=username send, receive

grant queue amx.governance.internal.stats user=username send, receive

create jndiname cl_logservice_queue queue cl_logservice_queue.physical

create jndiname cl_payload_queue queue cl_payload_queue.physical





238


3. Create the Administrator server and TIBCO Host instance using TIBCO Configuration Tool. (See Configuring ActiveMatrix BPM Runtime Objects (TIBCO Configuration Tool).)

Using Third-Party Solutions to Configure a High Availability, Fault TolerantActiveMatrix BPM System

In the event of a hardware failure resulting in the failure of TIBCO ActiveMatrix BPM, a highlyavailable, fault tolerant system can start TIBCO ActiveMatrix BPM on another machine, thus ensuringlimited service interruption and no loss of data or messages.

The following figure illustrates the use of third-party solutions to provide highly available, faulttolerant capabilities to your BPM runtime.

High availability ActiveMatrix BPM system using third-party solutions

The setup requires at least three machines, say M1, M2, and M3, where:

● TIBCO ActiveMatrix BPM (or at least the data folder) is on the shared file system which is onlyavailable to the machine that has a fully operational TIBCO ActiveMatrix BPM node installed andrunning.

● TIBCO ActiveMatrix BPM and TIBCO ActiveMatrix Administrator are installed and running on onemachine (M1).

● The other machines (M2 and M3) are:

— connected to a shared file system

— part of an active-passive clustering setup. At any given time, one of the machines will haveaccess to the shared file system on which the TIBCO ActiveMatrix BPM Node is installed/running.

In case of any catastrophic event such as power loss, hardware failure, network disruption, oroperating system crash, the cluster software detects it and fails over to the next available server.

— One of these two machines should have a fully operational TIBCO ActiveMatrix BPM nodeinstalled and running.

239


TIBCO ActiveMatrix® BPM Installation and Configuration

Documents

Transcript of TIBCO ActiveMatrix® BPM Installation and Configuration