TIBCO iProcess Engine (Oracle) for Windows Installation
Transcription
TIBCO iProcess Engine (Oracle) for Windows Installation
TIBCO iProcess™ Engine (Oracle) for Windows Installation Software Release 11.1.3 May 2011 Important Information TIBCO Software Inc. Confidential Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO iProcess, TIBCO iProcess Suite and TIBCO Enterprise Message Service are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE 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 OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright © 2001-2011 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information |i Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v Product Re-branding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii How to Contact TIBCO Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 Overview of the Installation Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Determining Your Installation Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Who Needs to be Involved in the Installation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Which Windows Accounts Do You Need? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 iProcess Engine Architecture - Single-Server or Node-Cluster? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Should You Support UTF-8?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Do You Need to Use the TIBCO iProcess™ COM Server Plug-in? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Interactive or Scripted Installation?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 How Long Will an Upgrade Take?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Basic System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Operating System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Additional System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Oracle Database Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Upgrade Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Additional Considerations If You Are Upgrading from a Version 9.0-o Process Engine. . . . . . . . . . . . . . . . . . . . . 28 Sizing the iProcess Engine Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Multi-noded Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Case Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 WIS Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Chapter 2 Pre-Installation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 Pre-Installation Tasks Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Check For Any Late Breaking Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Backup the iProcess Engine File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Backup the iProcess Engine Database Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Upgrade the Operating System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 TIBCO iProcess Engine (Oracle) for Windows Installation ii | Contents Upgrade Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Check LDAP Directory Attribute to iProcess Engine Property Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . Stop Any Other iProcess Engines on the Same Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set up DCOM Permissions for the iProcess Objects Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set up DCOM Permissions for a Node Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Record Changes to Tomcat Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Oracle Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Set up Oracle Transparent Application Failover (TAF) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure Oracle OPEN_CURSORS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disable Oracle Authentication Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure Oracle Character Set Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disable Oracle Flashback Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create an Oracle UNDO Tablespace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remove All User-Defined Triggers, Indexes and Statistics From the iProcess Engine Schema Tables . . . . Turn Off User Account Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Microsoft Windows Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 46 47 48 53 54 55 61 63 64 65 67 68 69 70 71 Chapter 3 Running the Setup Installation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Using Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Upgrade Performance and Timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Upgrading from a Version 9.0-o (Oracle) Process Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Running Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 The Setup Type Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 The Upgrade or New Install Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 The Choose Destination Location Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 The Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 The Operating System Users Location Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 The Group & User Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 The Database Details Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 The Select Components to Configure Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 The SMTP Server Parameters Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 The SMTP Backup Servers Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 The TIBCO iProcess Web Server Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 The Default Java Message Service Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Completing the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Performing the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Chapter 4 Carrying Out Post-Installation Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Post-Installation Tasks Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Replace Procedures that Contain Automatic Steps and Migrate All Outstanding Cases . . . . . . . . . . . . . . Re-implement Changes to Upgraded Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure Firewall Port Ranges on Slave Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the iProcess Objects Server and iProcess Objects Director . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO iProcess Engine (Oracle) for Windows Installation 114 117 121 122 123 Contents iii | Enable COM+ Network Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Microsoft Windows Cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enable Oracle Function-Based Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Grant Resource Privileges to the iProcess Engine Database Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Re-implement Changes to Tomcat Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Install the IBM Client for JMS on J2SE with IBM WebSphere Application Server . . . . . . . . . . . . . . . . . . . Configure IAPJMS Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the Default iProcess Engine Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reset LDAP Directory Attribute to iProcess Engine Property Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . Recreate Prediction Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remove Files That are no Longer Needed. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recreate All User-Defined Triggers, Indexes and Statistics on the iProcess Engine Schema Tables . . . . Update the Domain Group Policy for the "Log on as a Service" Right . . . . . . . . . . . . . . . . . . . . . . . . . . . . Disable or Re-enable Write Access to WebDav . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure JMX Ports to Run Through a Firewall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Start the iProcess Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 126 130 131 132 133 135 136 137 139 140 142 143 144 145 146 Chapter 5 Removing the iProcess Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149 Pre-Removal Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Remove the iProcess Engine From a Windows Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Remove the iProcess Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Remove the Staffware Events COM+ Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Remove the iProcess Engine Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Appendix A Usage Profiles for Tablesizes Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155 tablesizes.med File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 tablesizes.large File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Appendix B Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159 Setup Fails with an “Unable to open the file” Warning Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Setup Exits Because You are Not a Local Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Setup Cannot Continue Because Another iProcess Engine is Running . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Setup Encounters an Error Trying to Locate pthread.dll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Setup Cannot Run an Upgrade from Version 9 Because Procedures Contain Attachments or Open Client Steps . 165 Setup Failed to Connect to the Oracle Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Installing Against an Unsupported Database Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Setup Cannot Locate an Oracle UNDO Tablespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Oracle TAF is Not Enabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Oracle Advanced Queuing is Not Enabled. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 TIBCO iProcess Engine (Oracle) for Windows Installation iv | Contents Oracle Client and Database NLS_LANG Settings Do Not Match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Oracle OPEN_CURSORS Value Is Less Than 200 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172 Setup Cannot Initialize the iProcess Engine Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Setup Cannot Run One or More Database Upgrade Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Errors Occur on Validating the Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 License File Cannot Be Found . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Errors are Reported in the upgrFromtoTo.log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Upgrade Fails Because It Cannot Create the Process Sentinels Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Recovering the iProcess Engine/Process Engine if an Upgrade Fails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 mscluster Command Reports Error in \etc\services File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Process Sentinels Do Not Start Due to Logon Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 iProcess Engine Processes Do Not Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Distributed Transaction Errors Occur When You Start the iProcess Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Appendix C Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193 sw_error, sw_warn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 init2Kora_tok.sql_UserName_TimeStamp.log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 ScriptName.sql_UserName_TimeStamp.log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 upgrFromtoTo.log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197 PostChecks_UserName_TimeStamp.log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Appendix D Scripted Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Performing a Scripted Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Creating the Control File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Performing a Scripted Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 Appendix E Upgrading TIBCO EMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Updating EMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IAPJMS Specific Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO iProcess Web Services Plug-in Specific Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO iProcess Technology Plug-in Specific Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO iProcess Engine (Oracle) for Windows Installation 204 204 204 205 |v Preface This software may be available on multiple operating systems. However, not all operating system platforms for a specific software version are released at the same time. Please see the readme.txt file for the availability of this software version on a specific operating system platform. This guide explains how to install, upgrade and remove the TIBCO iProcess Engine Version 11.1.3 (Oracle) for Windows. Topics • Product Re-branding, page vi • Related Documentation, page vii • How to Contact TIBCO Support, page viii • Documentation Conventions, page ix TIBCO iProcess Engine (Oracle) for Windows Installation vi | Preface Product Re-branding Further product re-branding has been carried out in this release, as follows: • TIBCO Staffware Process Suite™ has been renamed TIBCO iProcess Suite™ • TIBCO iProcess™ Client (Windows) has been renamed TIBCO iProcess™ Workspace (Windows) • TIBCO iProcess™ Client (Browser) has been renamed TIBCO iProcess™ Workspace (Browser) • The term "Staffware" has been replaced by "iProcess". Until this work is complete you may still see references to Staffware and to the old product names within the software and in some documentation. TIBCO iProcess Engine (Oracle) for Windows Installation Related Documentation vii | Related Documentation This section lists documentation resources you may find useful. You can find more information about the TIBCO iProcess Engine from the following sources: • TIBCO iProcess Engine Release Notes Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release. This document is available in the \docs directory on the iProcess Engine distribution set. • TIBCO iProcess Suite Documentation Library This library contains all the guides for the iProcess Engine and other TIBCO products in the TIBCO iProcess Suite. • power.tibco.com There is also a useful resource, http://power.tibco.com, that delivers technical content to the TIBCO user community. This site has been developed to foster an open forum where users of TIBCO products can find valuable information, example projects and resources for those projects, and exchange ideas with other users. Entry to this site requires a username and password. If you do not have a username, you can request one. TIBCO iProcess Engine (Oracle) for Windows Installation viii | Preface How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows. • For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: http://www.tibco.com/services/support • If you already have a valid maintenance or support contract, visit this site: http://support.tibco.com Entry to this site requires a username and password. If you do not have a username, you can request one. TIBCO iProcess Engine (Oracle) for Windows Installation Documentation Conventions ix | Documentation Conventions The following conventions are used throughout this guide: Convention Description SWDIR Indicates the iProcess Engine system directory where the iProcess Engine software is installed. IPEINSTALL user Indicates the Windows account that is used to run the Setup installation program (see page 5). IPEADMIN user Indicates the Windows account that is used to administer the iProcess Engine (see page 6). IPESERVICE user Indicates the Windows account that is used to run the iProcess Engine (see page 6). italics Indicates emphasis, variables and manual titles. monospace text Indicates commands and their options, and example output. monospace italic Indicates variables in commands. green Indicates text in example output that can vary from installation to installation (version numbers, script names, user names and similar). text monospace text monospace bold text Indicates text that you must enter from the keyboard. { } Indicates a set of choices in a syntax line. The braces should not be entered. [ ] Indicates optional items in a syntax line. The brackets should not be entered. Example: SHOW_ALL_ATTRIBUTES [attribute] | Indicates mutually exclusive choices in a syntax line i.e. you enter only one of the given choices. You should not enter the symbol itself. TIBCO iProcess Engine (Oracle) for Windows Installation x | Preface TIBCO iProcess Engine (Oracle) for Windows Installation |1 Chapter 1 Introduction This chapter provides important information that you should read before attempting to install or upgrade the iProcess? Engine. Topics • Overview of the Installation Process, page 2 • Determining Your Installation Scenario, page 3 • System Requirements, page 12 • Upgrade Requirements, page 27 • Additional Considerations If You Are Upgrading from a Version 9.0-o Process Engine, page 28 TIBCO iProcess Engine (Oracle) for Windows Installation 2 | Chapter 1 Introduction Overview of the Installation Process To install or upgrade the iProcess Engine you must perform the following steps: 1. Determine your installation scenario and gather the necessary information. See page 3. 2. Carry out all required pre-installation tasks. See Chapter 2 on page 35. 3. Run the Setup installation program. See Chapter 3 on page 73. 4. Carry out all required post-installation tasks. See Chapter 4 on page 113. To avoid unnecessary repetition throughout this guide, the terms "install" and "installation" also mean "upgrade" or "upgrading", unless there is a specific difference. For example, the section Running Setup on page 76 describes how you use Setup to install or upgrade the iProcess Engine. Where there are specific differences between installation and upgrade, these are noted in the text. TIBCO iProcess Engine (Oracle) for Windows Installation Determining Your Installation Scenario 3 | Determining Your Installation Scenario The exact steps you need to follow when installing the iProcess Engine depend on your installation scenario. The following sections explain how to determine your scenario: • Who Needs to be Involved in the Installation? on page 4 • Which Windows Accounts Do You Need? on page 5 • iProcess Engine Architecture - Single-Server or Node-Cluster? on page 7 • Should You Support UTF-8? on page 8 • Do You Need to Use the TIBCO iProcess™ COM Server Plug-in? on page 9 • Interactive or Scripted Installation? on page 10 • How Long Will an Upgrade Take? on page 10 TIBCO iProcess Engine (Oracle) for Windows Installation 4 | Chapter 1 Introduction Who Needs to be Involved in the Installation? To install the iProcess Engine you will need to perform a number of pre-installation tasks, then run the Setup installation program, and finally perform a number of post-installation tasks. Each of these stages requires the involvement of one or both of the organizational roles described in the following table. Role Knowledge required ... Permissions required ... iProcess installer iProcess Engine configuration (including all optional iProcess Engine components) To install and configure iProcess Engine files and directories DBA Database configuration To create or upgrade the iProcess Engine database schema and users Depending on your operational and security environment, these roles can be performed either by the same person or by different departments or individuals. When you run Setup, you must have access to an Oracle DBA account which has the necessary permissions to create tables and users i.e. either with the DBA role assigned or with access to the Oracle Data Dictionary. (See page 91.) If you do not have DBA-level access, Setup will not be able to create the iProcess Engine schema and users in the Oracle database. TIBCO iProcess Engine (Oracle) for Windows Installation Determining Your Installation Scenario 5 | Which Windows Accounts Do You Need? Before you run the Setup installation program, you need to decide which Windows accounts you want to use as the different users shown in the following table. User Description swpro The default background user for Process Engine 9.0 systems. You must use this account to run Setup for an upgrade from Process Engine 9.0. IPEINSTALL The Windows account that is used to run Setup. IPEADMIN The Windows account that is used to administer the iProcess Engine. IPEADMIN permissions are required to perform tasks such as: IPESERVICE • starting, stopping and configuring the iProcess Engine. • running various utilities such as SWDIR\bin\swutil or SWDIR\util\LDAPCONF. The Windows account that is used to run the iProcess Engine - specifically: • the iProcess NodeName Process Sentinels service, which runs all the iProcess Engine processes. • the Staffware Events COM+ application, which provides the publish/subscribe event mechanism used for inter-process communication by the iProcess Engine processes. Choosing the IPEINSTALL User The Windows account that you use as the IPEINSTALL user has a number of implications for the way the iProcess Engine is installed, as follows: • The IPEINSTALL user account must be a member of the Administrators group on the computer where you are installing the iProcess Engine. If you use an account that does not meet this requirement Setup will immediately exit with an error (see page 162). TIBCO iProcess Engine (Oracle) for Windows Installation 6 | Chapter 1 Introduction • The IPEINSTALL user account also determines which Windows accounts you will be able to use as the IPEADMIN and IPESERVICE users: — If you perform a Basic installation (see page 77), the IPEINSTALL user account will also be used as the IPEADMIN and IPESERVICE users. You cannot choose a different account for these users. — If you perform a Custom installation (see page 77), the location of the IPEINSTALL user account will determine the accounts that are available for you to choose as the IPEADMIN and IPESERVICE users (see page 87 and page 88). You will only be able to choose accounts for these users from the same location (local machine, domain or trusted domain) as the IPEINSTALL user. • The location of the IPEINSTALL user account also determines the default value of the OS_USER_LOCATIONS process attribute, which defines where the iProcess Engine should obtain the list of users when it populates the O/S User List in the User Manager tool of the TIBCO iProcess Administrator. See the TIBCO iProcess Engine Administrator’s Guide for more information about this attribute. Choosing the IPEADMIN and IPESERVICE Users By default, the Windows account that is used as the IPEADMIN user will also be used as the IPESERVICE user. However, depending on your site’s operational policies, this may not be acceptable. For example, if a user mistypes the IPEADMIN user account password the account may be locked out. If this also locks out the IPESERVICE account you will not be able to start the iProcess NodeName Process Sentinels service and the Staffware Events COM+ application. In this example you may want these users to be separate accounts. When you run Setup, you can choose to use separate Windows accounts for the IPEADMIN and IPESERVICE users, but to do so you must perform a Custom installation rather than a Basic one (see page 77). TIBCO iProcess Engine (Oracle) for Windows Installation Determining Your Installation Scenario 7 | iProcess Engine Architecture - Single-Server or Node-Cluster? The iProcess Engine can be installed using either of the following architectures: • single-server. The iProcess Engine node is installed on and runs on a single server. • node cluster. The iProcess Engine node is distributed across multiple servers, each of which runs iProcess Engine processes. One server acts as the master server; all other servers in the cluster are slave servers. If you decide to use a node cluster architecture, note that: — the computers hosting the iProcess Engine master and slave servers must all be members of the same domain. — the IPEADMIN and IPESERVICE users must be domain accounts. The master server and all slave servers use the same iProcess Engine database schema. The schema can be hosted on an Oracle instance that is either local (to one of the servers in the iProcess node cluster) or remote. The iProcess Engine architecture is scalable. You can convert from a single-server to a node cluster at any time simply by adding another server to the installation. Refer to the TIBCO iProcess Engine Architecture guide for more information about the iProcess Engine architecture. Installing on a Node Cluster If you want to install a new iProcess Engine using a node cluster architecture, you must: 1. Install the iProcess Engine on the master server (to create the iProcess Engine database schema). 2. Install the iProcess Engine on each slave server (to add the server to the node cluster, using the same database schema). Each slave server must use the same installation parameters as the master server (for example, nodename, database name, RPC numbers and Windows account names). Any specific differences in the installation process for a slave server are noted at the appropriate points in the rest of this guide. TIBCO iProcess Engine (Oracle) for Windows Installation 8 | Chapter 1 Introduction Upgrading on a Node Cluster If you want to upgrade an existing version i10 or 10 iProcess Engine, either from or to a node cluster architecture, follow the appropriate instructions shown in the table below. To upgrade... From To single-server single-server node cluster node cluster Do this... Upgrade the iProcess Engine on the single (master) server, using the instructions in this guide. 1. Upgrade the iProcess Engine on the master server, using the instructions in this guide. 2. Upgrade the iProcess Engine on each slave server, using the instructions in this guide. single-server node cluster 1. Upgrade the iProcess Engine on the single (master) server, using the instructions in this guide. 2. Install the iProcess Engine on each slave server that you want to add to the node, using the instructions in this guide. node cluster single-server 1. Remove the iProcess Engine on each slave server, using the instructions in the Installation guide for that version. 2. Upgrade the iProcess Engine on the master server, using the instructions in this guide. The iProcess Engine does not support the multi-node architecture used by the Version 9 Process Engine. If you want to upgrade an existing version 9.0-o Process Engine, either from a multi-noded architecture, or to a node cluster architecture, see Multi-noded Systems on page 30 Should You Support UTF-8? From version 11.1, the TIBCO iProcess Suite supports Unicode (UTF-8) character encoding natively within its component products.When you install TIBCO iProcess Engine, you have the option to specify whether or not you want your iProcess database to support UTF-8 - see the option Support unicode encoding on page 93. TIBCO iProcess Engine (Oracle) for Windows Installation Determining Your Installation Scenario 9 | Determining whether or not to support UTF-8 is a major decision. Before you start the installation process, TIBCO recommends that you consult the chapter “Using the TIBCO iProcess Suite in a Multilingual Environment” in the TIBCO iProcess Engine: Architecture Guide. This sets out the advantages and costs of using UTF-8 both in new installations and when upgrading existing iProcess installations. Do You Need to Use the TIBCO iProcess™ COM Server Plug-in? The iProcess™ COM Server Plug-in is a component of the iProcess Engine that you can optionally choose to register when you run Setup (see page 95). You need to register this plug-in if the iProcess Engine will handle procedures that use EAI COM steps to call external COM applications. The iProcess COM Server Plug-in can have a significant impact on iProcess Engine performance. TIBCO recommend that you register it only if you need to use EAI COM steps. The iProcess COM Server Plug-in uses the transaction infrastructure provided by the Microsoft Distributed Transaction Coordinator service (MSDTC). This infrastructure imposes security and authentication requirements which can cause permissions problems if the iProcess environment is not set up correctly to support distributed transactions. If such problems occur, the iProcess COM Server Plug-in will not work - see page 191. Consequently, TIBCO recommend that if you intend to use the iProcess COM Server Plug-in, you make sure that you adhere to the following requirements when installing the iProcess Engine: • The following entities must all be located either on the same machine or in the same domain: — the iProcess Engine — the Windows iProcess Engine administrator account (see page 89), which runs the iProcess NodeName Process Sentinels service — the Oracle database — the Windows account that is running the Oracle database — the Windows account that is running the Distributed Transaction Coordinator service. • In a domain, the Distributed Transaction Coordinator service must be running on every machine that is running an iProcess Engine master or slave server, or the Oracle database. See the TIBCO iProcess COM Plug-in User’s Guide for more information. TIBCO iProcess Engine (Oracle) for Windows Installation 10 | Chapter 1 Introduction Interactive or Scripted Installation? You can choose to run the setup.exe installation script in two modes: • Interactive. In interactive mode setup.exe prompts you for any information that it requires and displays messages indicating its progress. See Chapter 3, Running the Setup Installation Program, on page 73 for more information about running setup.exe interactively. • Scripted. You can perform a scripted (non-interactive) installation by using a control file, which provides all the information that setup.exe would obtain by prompting. When you run setup.exe interactively all the configuration information that you supply can be written to a control file. You can use this file to provide the information that setup.exe needs and so run a similar installation silently. You may want to do this if, for example, you are installing a master server and multiple slave servers. See Appendix D, Scripted Installation, on page 199 for more information about running setup.exe with a script. How Long Will an Upgrade Take? Upgrading to Version 11.1.3 can involve significant changes to iProcess Engine data and data structures - particularly if you are upgrading from a Version 9 Process Engine. The upgrade process is therefore complex, and can take a significant amount of time to complete if the system being upgraded has a large amount of case data. TIBCO cannot provide an estimate of how long the upgrade will take because of the number of customer-specific factors that could have an impact, and the complexity of their interaction - for example, the amount of data in your system, the configuration of your Oracle system and the hardware setup you are running. TIBCO iProcess Engine (Oracle) for Windows Installation Determining Your Installation Scenario 11 | One factor that can significantly impact the duration of an upgrade is enabling case data normalization. Case data normalization is a feature that is used to make case data searching more efficient and therefore faster, by enabling the database to do simple string comparisons instead of type conversions. If you are upgrading from a Version 9 Process Engine, or from an iProcess Engine version that does not already have case data normalization enabled, you can choose to enable case data normalization when you run Setup (see page 85). If you choose to enable case data normalization, the upgrade process has to create a value for the field_value_N column for every row in the case_data table. (This column holds a “normalized” value of the field_value contents.) Because the upgrade process has to perform this operation on every case of every procedure in the database, this operation can take a significant period of time if there are large numbers of cases on the system. TIBCO therefore strongly recommend that you test the upgrade before performing it on your target system, either on a representative production environment, or using a copy of your production system. This will allow you to determine how long the upgrade is likely to take, and to identify any specific factors that may affect the success or duration of the upgrade. If you require further advice or assistance on this, contact TIBCO Support. TIBCO iProcess Engine (Oracle) for Windows Installation 12 | Chapter 1 Introduction System Requirements To be able to install and run this version of the iProcess Engine, your system must meet the following requirements. See: • Basic System Requirements below • Operating System Requirements on page 13 • Additional System Requirements on page 14 • Oracle Database Requirements on page 23 Basic System Requirements . Component Requirement Processor Minimum: single x86-based, 800Mhz. Recommended: x86-based, Dual or Quad 2.5 GHz Memory Minimum: 512 MB. Recommended: 2 GB This value does not include Oracle memory requirements if the database is installed on the same computer as the iProcess Engine. Disc space File system At least: • 310 MB for the iProcess Engine distribution set during installation. • 250 MB for the contents of the SWDIR directory structure after installation. • the amount of Oracle tablespace needed for iProcess Engine data. See page 55 for more information about how to calculate this figure. NTFS FAT partitions are not supported by the iProcess Engine. TIBCO iProcess Engine (Oracle) for Windows Installation System Requirements 13 | Operating System Requirements Make sure that one of the operating systems listed in the table below is installed on the computer where you intend to install the iProcess Engine. Also, ensure that you have all Critical Updates and Service Packs installed. Use Windows Update to determine what updates you need, and to install them. Microsoft has discontinued standard support for Windows XP. (Extended support is still available, but must be purchased from Microsoft.) TIBCO will continue to support iProcess Engine on Windows XP. However, if a problem with iProcess Engine is reported to TIBCO Support, and the problem is traced to the Windows XP operating system, TIBCO Support will be unable to assist further with the resolution of that problem. TIBCO therefore recommends that you use Windows Server 2008 or Windows Vista instead of Windows XP on any system that runs iProcess Engine. Operating System... with Service Pack Level... Additional Requirements Windows Vista 1 or later None Windows Vista 64-bit 1 or later None Windows Server 2008 None required None Windows Server 2008 x64 None required None Windows Server 2003 2 or later None Windows Server 2003 x64 R2 None required None Windows XP Professional 2 or later None If you are using an operating system release (including the stated Service Packs and additional requirements) that is: • earlier than the releases explicitly mentioned in the table above, you must upgrade to one of the specified releases. • later than the releases explicitly mentioned in the table above, please contact TIBCO Support to confirm whether or not that release is supported by your iProcess Engine version. TIBCO iProcess Engine (Oracle) for Windows Installation 14 | Chapter 1 Introduction Additional System Requirements POSIX Threads (pthreads) for Win32 On a 32-bit Windows system, version 2.7.0 of the POSIX Threads (pthreads) for Win32 library must be available on the system PATH of the computer where you intend to install the iProcess Engine, before installation begins. TIBCO have validated Version 2.7.0 against the iProcess Engine. If you want to use a later version of the library please contact TIBCO Support to confirm whether or not that version is supported by your iProcess Engine version. If you do not already have this library, you can obtain the POSIX Threads (pthreads) for Win32 distribution set from TIBCO Software Inc.by downloading it as follows: 1. Go to the TIBCO Software Inc. Product Download Site (http://download.tibco.com/tibco/Index.jsp) website. Entry to this site requires a username and password. If you do not have a username, you can request one. 2. Navigate to Products Home >> TIBCO iProcess Engine-Version 11.1.3 >>TIBCO iProcess Engine Software Version 11.1.3. From the list of files displayed, select the pthreads entry. 3. Copy the pthread.dll file from the POSIX Threads (pthreads) for Win32 distribution set to the %systemroot%\system32 folder on the computer where you intend to install iProcess Engine. 4. Make sure that the computer’s PATH system environment variable includes the %systemroot%\system32 folder. If a supported version of the pthread.dll library is not available on the system PATH when you run Setup, Setup immediately exits with an error message (see page 164). TIBCO iProcess Engine (Oracle) for Windows Installation System Requirements 15 | Additional pthread Requirements for the SAL SDK If you intend to build any applications using the iProcess Engine’s SAL SDK (installed in SWDIR\sdks\swsalsdk), those applications must include the following files from the POSIX Threads (pthreads) for Win32 distribution set: • include\pthread.h • include\sched.h • include\semaphore.h • lib\pthreadVC2.lib Errors will occur if you build applications without including these files. POSIX Threads (pthreads) for Win64 On a 64-bit Windows system, version 2.7.0 of the POSIX Threads (pthreads) for Win32 library must be available on the system PATH of the computer where you intend to install the iProcess Engine, before installation begins. TIBCO have validated Version 2.7.0 against the iProcess Engine. If you want to use a later version of the library please contact TIBCO Support to confirm whether or not that version is supported by your iProcess Engine version. If you do not already have this library, you can obtain the POSIX Threads (pthreads) for Win32 distribution set from TIBCO Software Inc.by downloading it as follows: 1. Go to the TIBCO Software Inc. Product Download Site (http://download.tibco.com/tibco/Index.jsp) website. Entry to this site requires a username and password. If you do not have a username, you can request one. 2. Navigate to Products Home >> TIBCO iProcess Engine-Version 11.1.3 >>TIBCO iProcess Engine Software Version 11.1.3. From the list of files displayed, select the pthreads entry. 3. Copy the pthread.dll file from the POSIX Threads (pthreads) for Win32 distribution set to the C:\WINDOWS\SysWOW64 folder on the computer where you intend to install iProcess Engine. 4. Make sure that the computer’s PATH system environment variable includes the C:\WINDOWS\SysWOW64 folder. If a supported version of the pthread.dll library is not available on the system PATH when you run Setup, Setup immediately exits with an error message (see page 164). TIBCO iProcess Engine (Oracle) for Windows Installation 16 | Chapter 1 Introduction Additional pthread Requirements for the SAL SDK If you intend to build any applications using the iProcess Engine’s SAL SDK (installed in SWDIR\sdks\swsalsdk), those applications must include the following files from the POSIX Threads (pthreads) for Win32 distribution set: • include\pthread.h • include\sched.h • include\semaphore.h • lib\pthreadVC2.lib Errors will occur if you build applications without including these files. Windows Clustering If you intend to install the iProcess Engine on a Microsoft Windows cluster, make sure that the necessary cluster management software (listed in the following table) is installed on each machine in the cluster. Operating System Requirement Windows Server 2003, Windows Server 2008 Supplied as part of the basic operating system. Windows XP Windows Vista Not supported. TIBCO iProcess Objects The iProcess Objects Server receives requests for services or data from TIBCO iProcess Objects (COM, Java, or C++) or TIBCO iProcess Server Objects (Java or .NET). The iProcess Objects Server processes the request, then makes the appropriate call to an iProcess Engine to initiate the desired service or obtain the desired information. The iProcess Objects Director is a standalone program that maintains a list of iProcess Objects Servers that are configured in a node cluster. When a client needs access to an iProcess Objects Server, it first establishes a connection to the iProcess Objects Director. The iProcess Objects Director then decides, based on a “pick method”, which iProcess Objects Server the client should connect to. TIBCO iProcess Engine (Oracle) for Windows Installation System Requirements 17 | If you intend to enable the iProcess Objects Server and/or iProcess™ Objects Director (see page 95), you will need to take account of the following additional runtime disk space requirements. Component Runtime Disk Space Requirement iProcess Objects Server 5 MB + Log file The iProcess Objects Server log file defaults to a maximum size of 15 MB. This can be configured after installation. See the TIBCO iProcess Objects Server Administrator’s Guide for more information. The log file is not created during installation; it is created the first time the iProcess Objects Server is used. iProcess Objects Director 500 KB + Log file The iProcess Objects Director log file defaults to a maximum size of 15 MB. This can be configured after installation using the LOG_FILE_MAX_SIZE process attribute. (See the TIBCO iProcess Objects Director Administrator’s Guide for more information.) The log file is not created during installation; it is created the first time the iProcess Objects Director is used. iProcess Server Manager The iProcess Server Manager is a JSP web client application that you can use to start, stop, restart and pause iProcess Engine server processes. It utilizes the iProcess ’Web Server’ service and TIBCO Hawk to provide a graphical view of the iProcess Engine server processes on a machine or a node cluster. If you are planning to use the iProcess Server Manager, you must have: • TIBCO Hawk Version 4.9.0 installed on the machine where you intend to install the iProcess Engine. TIBCO iProcess Engine (Oracle) for Windows Installation 18 | Chapter 1 Introduction • TIBCO Rendezvous® Version 8.1.1 installed on the machine where you intend to install the iProcess Engine. (This is the minimum version required to run TIBCO Hawk Version 4.9.0.) If you have a version of TIBCO Rendezvous earlier than 8.1.1 already installed, you should either remove TIBCO Rendezvous or upgrade it to Version 8.1.1 before installing the iProcess Engine. This is because Setup cannot upgrade an earlier version of TIBCO Rendezvous. • TIBCO Hawk Version 4.9.0 installed on the machines on which you want to administer iProcess Engine processes. Activity Publishing and Work Queue Delta Publication If activity publishing is enabled, activity information about auditable objects (for example, procedures and steps) can be published to an external application. (The BG process publishes monitored activities to the IAPJMS process.) This enables real-time monitoring of auditable objects so that mission critical or important business events can be easily monitored. Enabling activity publishing also enables Work Queue Delta publication via JMS. This allows an external application to monitor a work queue and to retrieve only those work items in a given work queue that have changed. In this case the WIS process publishes messages about the monitored queue to the IAPJMS process, and IAPJMS in turn publishes messages to a JMS topic which can be monitored by the external application. See the iProcess Engine System Administration guide for configuring activity publishing and work queue delta publication once they are enabled. If you plan to enable activity publishing (see page 95), you must ensure that the computer hosting the iProcess Engine has access to the Java Message Service (JMS) provider that you want to use. This must be one of the following. JMS provider TIBCO Enterprise Message Service (EMS) Minimum Supported Versions Additional Requirements 4.4.3 None. TIBCO iProcess Engine has also been tested against Version 5.1.2, which is delivered with iProcess Suite Version 11.1.3. TIBCO iProcess Engine (Oracle) for Windows Installation System Requirements 19 | JMS provider Minimum Supported Versions IBM® WebSphere® 6.1 The IBM® Client for JMS on J2SE with WebSphere Application Server must be installed on the machine hosting the iProcess Engine (see page 106). 5.1 None JBoss 4.0.0 None JBoss Messaging 1.0.1 SP2 BEA WebLogic Server® 8 There are no additional requirements if you use WebLogic Server Version 8. Oracle WebLogic Server® 9.2 However, if you use Oracle (formerly BEA) WebLogic Server Version 9.2 instead of Version 8, the following additional requirements apply. Additional Requirements If the WebLogic Server is hosted remotely, one of the following WebLogic client types must be installed on the machine hosting the iProcess Engine: • WebLogic T3 client (weblogic.jar), or • WebLogic JMS Thin Client (wljmsclient.jar and wlclient.jar) These .jar files are located in the WL_HOME\server\lib subdirectory of the WebLogic Server installation directory, where WL_HOME is the top-level installation directory for the entire WebLogic Platform (for example, c:\bea\weblogic90\server\lib). Note also that if you do use WebLogic Server Version 9.2, you must select Other (not BEA WebLogic Server) in the Default Java Message Service dialog. See The Default Java Message Service Dialog on page 105. Oracle WebLogic was previously known as BEA WebLogic. References to BEA WebLogic may still appear in the software and documentation. Other See the notes below. Note that: TIBCO iProcess Engine (Oracle) for Windows Installation 20 | Chapter 1 Introduction • The JMS provider can be hosted either on the local machine or on a remote machine. If the JMS provider is hosted remotely, appropriate client application .jar files must be installed on the machine hosting the iProcess Engine. (Refer to your JMS provider documentation for more information about required client .jar files.) You specify the location of these .jar files when you run Setup (see page 106). • The JMS provider must support Java Virtual Machine (JVM) 1.5.0_11 or 1.6. JVM 1.6 is distributed with this version of the iProcess Engine, and installed into the SWDIR\java directory. If you are upgrading iProcess Engine and you are using EMS, you must ensure that your version of EMS is updated. See Appendix E, Upgrading TIBCO EMS, on page 203. Java Runtime Environment (JRE) The following table lists: • the iProcess Engine components and other dependant iProcess products that use Java and so need access to a Java Virtual Machine (JVM) or other JRE libraries on the computer hosting the iProcess Engine. • the default JRE that each component or product uses to locate the libraries that it needs. • the configuration tool provided to allow you to configure the location of the JRE used by each component/product (if applicable). Component/Product Default JRE Location Configuration Tool IAPJMS process SWDIR\java SWLIB_PATH process attribute value See "Administering Process Attributes" in the TIBCO iProcess Engine Administrator’s Guide for more information. iProcess Server Manager SWDIR\java None JMX engine SWDIR\java None TIBCO EMS SWDIR None TIBCO Hawk SWDIR None TIBCO iProcess Engine (Oracle) for Windows Installation System Requirements 21 | Component/Product Default JRE Location Configuration Tool TIBCO iProcess BusinessWorks™ Connector Server Plug-in Selectable when you install the plug-in TIBCO iProcess™ Technology Plug-ins installer TIBCO iProcess™ Java Server Plug-in Selectable when you install the plug-in See the TIBCO iProcess Technology Plug-ins Installation guide for more information. TIBCO iProcess Technology Plug-ins installer See the TIBCO iProcess Technology Plug-ins Installation guide for more information. Note: On some platforms, if you are installing iProcess Java Server Plug-in to use with this version of iProcess Engine, you cannot run the installer with Java 1.6, you must use an earlier version such as Java 1.5. However, you can use Java 1.6 at run-time. TIBCO iProcess Engine Web Service Server Plug-in Selectable when you install the plug-in TIBCO iProcess Engine Web Services Plug-in installer See the TIBCO iProcess Engine Web Services Plug-in Installation guide for more information. TIBCO strongly recommend that you use the following JRE to provide the necessary Java functionality when using the components and products listed in the table above: • JRE 1.6.0_12, which is distributed with this version of the iProcess Engine and installed into the SWDIR\java directory. You can identify this JRE by running the SWDIR\java\bin\java -version command, which will display output similar to the following: TIBCO iProcess Engine (Oracle) for Windows Installation 22 | Chapter 1 Introduction If you need to use a different version of the JRE for any reason, TIBCO strongly recommend that you contact TIBCO Support before doing so, to determine if the JRE you want to use is fully compatible with this version of the iProcess Engine. TIBCO iProcess Engine (Oracle) for Windows Installation System Requirements 23 | Oracle Database Requirements This version of the iProcess Engine requires one of: • Oracle Database 10g Release 2 • Oracle 11g Release 1 Note that: • You will need access to an Oracle Metalink account to be able to access the required patches and patch sets. • The iProcess Engine uses Oracle Call Interface (OCI) to access data in the Oracle database. For reasons of stability, the iProcess Engine is statically linked with the Oracle client libraries that provide the required OCI routines. Oracle state that they only support products that run against the same set of libraries they were built with. This means you must use particular Oracle Client versions, depending on the method you use to connect to the database. • If you are using Oracle Real Application Clusters (RAC), TIBCO recommend that you install the iProcess Engine on a machine that is not part of the RAC, and use a TNS connection to connect to the remote database. The exact Oracle version requirements depend on the type of database connection you intend to use: • a direct connection to the default database hosted on the computer where you will install or upgrade the iProcess Engine. See Direct Connection Requirements for Oracle on page 24. • a Transparent Network Substrate (TNS) connection, either to: — the default database hosted on the computer where you will install or upgrade the iProcess Engine, or — a remote database - meaning a database that is either hosted on a remote computer, or a non-default database on the computer where you will install or upgrade the iProcess Engine See TNS Connection Requirements for Oracle on page 25. TIBCO iProcess Engine (Oracle) for Windows Installation 24 | Chapter 1 Introduction Direct Connection Requirements for Oracle The following diagram illustrates an example of a direct connection from the iProcess Engine to the default database: The following table shows the required Oracle database versions when you use a direct connection to the default database: Database Release Additional Requirements 10.2.0.4 Oracle Services for Microsoft Transaction Server (ORAMTS) To see if ORAMTS is installed on your system, run the Oracle Universal Installer and click Installed Products. If you need to install this component, perform a Custom installation and select the product from the list. TIBCO iProcess Engine (Oracle) for Windows Installation System Requirements 25 | TNS Connection Requirements for Oracle When using a TNS connection, you must: • ensure that the remote Oracle database uses one of the Oracle Database releases specified in the following table. • ensure that the correct Oracle Client release is installed on the computer where you will install or upgrade the iProcess Engine, as described in the following table. The following diagram illustrates an example of a TNS connection from the iProcess Engine to the default database: • have the indicated Oracle Client release (and any specified additional patches or components) installed on: — the computer where you will install or upgrade the iProcess Engine, and — if you are using a Windows cluster, on each machine in the cluster. Each Oracle Client must be pointing to the same Oracle Database. • use the TNS name to connect the iProcess Engine to the Oracle Database (see page 91). TIBCO iProcess Engine (Oracle) for Windows Installation 26 | Chapter 1 Introduction The following table shows the required Oracle database and client versions when you use a TNS connection to the default database or to a remote database. Certified Database Release Compatible Database Release 10.2.0.4 n/a Oracle Services for Microsoft Transaction Server (ORAMTS) 11.1.0.6 11.1.0.x where x is 6 or higher Oracle Services for Microsoft Transaction Server (ORAMTS) Additional Requirements Client Release Additional Requirements with 10.2.0.4 Oracle Services for Microsoft Transaction Server (ORAMTS) with 10.2.0.4 Oracle Services for Microsoft Transaction Server (ORAMTS) To see if ORAMTS is installed on your system, run the Oracle Universal Installer and click Installed Products. If you need to install this component, perform a Custom installation and select the product from the list. If you are using an Oracle version (Database or Client) that is: • earlier than the releases explicitly mentioned in the table above, you must upgrade to one of the specified releases. • later than the releases explicitly mentioned in the table above, please contact TIBCO Support to confirm whether or not that release is supported by your iProcess Engine version. TIBCO iProcess Engine (Oracle) for Windows Installation Upgrade Requirements 27 | Upgrade Requirements You can upgrade directly to the Version 11.1.3 iProcess Engine (Oracle) from the following iProcess Engine/Process Engine versions:. iProcess Engine (Oracle) (Oracle) Process Engine • Version 11.n.n • Version 9.0-o(0.27) • Version 10.n.n • Version 9.0-o(0.25) • Version i10.0-o(4.0) • Version 9.0-o(0.24) • Version i10.0-o(3.4) • Version 9.0-o(0.22) • Version 9.0-o(0.18) • Version 9.0-o(0.15.1) Note that: • If you want to upgrade to Version 11.1.3 from an earlier i9.0-o, i9.2-o or 9.0-o version, you cannot do so directly. You must first upgrade to one of the versions listed above, and then upgrade to Version 11.1.3. • Direct upgrade is not possible from a DB2, SQL Server or Classic variant of the iProcess Engine or Process Engine, or from a Version 8 or earlier Staffware server. If you wish to upgrade from such a system to Version 11.1.3, please contact TIBCO Support for further advice and assistance. • The Version 11.1.3 iProcess Engine requires specific operating system and Oracle versions - see System Requirements on page 12 for more information. If your current iProcess Engine/Process Engine is running against an operating system and/or Oracle version that does not meet these requirements, you will need to upgrade your operating system and/or Oracle database to a supported version before you can upgrade the iProcess Engine see Chapter 2 on page 35. TIBCO iProcess Engine (Oracle) for Windows Installation 28 | Chapter 1 Introduction Additional Considerations If You Are Upgrading from a Version 9.0-o Process Engine The iProcess Engine uses a significantly different system architecture to the Version 9.0-o Process Engine (allowing it to deliver significantly improved functionality and performance). As a result, there are a number of additional issues that you need to consider and plan before attempting to upgrade. These are: • Sizing the iProcess Engine Database • Multi-noded Systems • Procedures • Case Data • WIS Processes The following sections discuss these issues in more detail. Sizing the iProcess Engine Database You will need a considerable amount of extra disk space when you upgrade the iProcess Engine Version 9.0-o Oracle database to Version 11.1.3. See: • staffo and Packfile Data on page 28 • case_data Table Modifications on page 30 • Multi-noded Systems on page 30 staffo and Packfile Data The Version 11.1.3 iProcess Engine stores almost all iProcess Engine data in the database, whereas the Version 9.0-o Process Engine stores some data in the database and some data in the SWDIR file structure. For most data areas, this will not have any significant impact on the size of the database. For example, in Version 9.0-o CDQP and procedure definition data is held partly in files and partly in the database. In Version 11.1.3 this data is moved entirely to the database, but because of the way it is now stored, it does not require any significant additional space. However, there are two data areas that are held in files in Version 9.0-o but moved to the database in Version 11.1.3, that will require significant additional database space. These are: TIBCO iProcess Engine (Oracle) for Windows Installation Additional Considerations If You Are Upgrading from a Version 9.0-o Process Engine 29 | • staffo files, held in the SWDIR\queues\queuename directory. Each staffo file contains one record for each item in the associated queue. staffo file data is moved to the staffo database table in Version 11.1.3. The table contains one row for every outstanding step on the system. • Pack files, held in the SWDIR\queues\queuename\nodename.n directory. There is a pack file for every outstanding item in the associated staffo file. Each pack file contains a snapshot of the case data for that item. Pack file data is moved to the pack_data and pack_memo database tables in Version 11.1.3: — The pack_data table contains one row for every assigned field that contains data (i.e. that has a value other than SW_NA) in every outstanding step on the system. — The pack_memo table contains one or more rows for every assigned memo field that contains data (i.e. that has a value other than SW_NA) in every outstanding step on the system. For more information about these tables, see the TIBCO iProcess Engine: Oracle Administrator’s Guide. You should therefore consider the following when planning the upgrade: • The iProcess Engine database needs sufficient additional space to hold all staffo and packfile data. You can estimate how much additional space will be required. In Windows Explorer, right-click the SWDIR\queues directory and click Properties. The Size entry on the General tab shows the size, in kilobytes, of all files under the SWDIR\queues directory. On a standard iProcess installation, most of this space is taken up by staffo and pack files. • The Oracle undo tablespace(s) needs to be large enough to be able to handle the rollback of the largest staffo file and all the packfiles referenced by that staffo file. For example, this could be 1000 staffo records plus 1000 pack_file and numerous pack_memo records. • If a large amount of data is held in staffo files and packfiles, the upgrade may take a significant amount of time because of the work involved in moving the data from these files into the database. TIBCO iProcess Engine (Oracle) for Windows Installation 30 | Chapter 1 Introduction case_data Table Modifications If you choose to enable case data normalization when you run Setup (see page 85), the upgrade process: • adds the field_value_N column to the case_data table. This is likely to increase the size of the upgraded table by 100%. • adds an idx_case_data_cnum index to the case_data table. This index uses the field_value_N column, and so is likely to be extremely large. Consequently, you should expect the upgraded case_data table and its idx_case_data_cnum index to take up to four times as much disk space as the case_data table on your Version 9.0-o system. Multi-noded Systems Multi-noding is not supported in the iProcess Engine Version 11.1.3. If you want to upgrade either from a multi-noded Version 9.0-o Process Engine, or to a Version 11.1.3 iProcess Engine that uses a node cluster architecture (see page 5), follow the appropriate instructions shown in the following table. To upgrade... From Version 9.0-o To Version 11.1.3.x Do this... single-node single-server Upgrade the Process Engine using the instructions in this chapter. single-node node cluster 1. Upgrade the Process Engine using the instructions in this chapter. 2. Install the iProcess Engine on each slave server that you want to add to the node. multi-noded single-server or node cluster Convert the Version 9.0-o Process Engine to a single-node system before upgrading to Version 11.1.3. The upgrade will fail with an error if you attempt to upgrade a system that is still multi-noded. Contact TIBCO Support for specific advice on how best to upgrade a multi-noded Version 9.0-o system. TIBCO iProcess Engine (Oracle) for Windows Installation Additional Considerations If You Are Upgrading from a Version 9.0-o Process Engine 31 | Procedures Attachment fields, Open Client Steps and Automatic steps are not supported by the Version 11.1.3 iProcess Engine. The following sections describe what you need to do if your Version 9.0-o system uses any of these items. Attachment Fields Attachments are not currently supported in Version 11.1.3. You must remove all fields of type attachment from all procedures on your Version 9.0-o system before attempting to upgrade it to Version 11.1.3. The upgrade will fail with an error if you attempt to upgrade a system in which any procedure still has a field of type attachment (see page 165). Open Client Steps Open Client Steps are not currently supported in Version 11.1.3. You must remove all Open Client Steps from all procedures on your Version 9.0-o system before attempting to upgrade it to Version 11.1.3. The upgrade will fail with an error if you attempt to upgrade a system in which any procedure still contains an Open Client Step. You should therefore purge all cases of, withdraw and then delete any such procedure before upgrading. Automatic Steps Automatic steps are not currently supported in Version 11.1.3. You can upgrade a Version 9.0-o system which contains procedures that still contain Automatic steps. However, each procedure that still contains an Automatic step: • is marked as Incomplete by the upgrade process, even if it was Unreleased, Released or Withdrawn on the Version 9.0-o system. • cannot be used on the Version 11.1.3 system. If you want to continue to use the procedure on the Version 11.1.3 system, you must develop an alternative version of it before you upgrade your system. The alternative version must replace the Automatic step(s) with a suitable solution for example, using EAI steps (if there is a suitable EAI plug-in available), brokers or some other solution. To do this: 1. Export the Version 9.0-o procedure containing the Automatic step(s). 2. Import the procedure to a Version 11.1.3 development system. TIBCO iProcess Engine (Oracle) for Windows Installation 32 | Chapter 1 Introduction 3. Open the procedure in the TIBCO iProcess™ Modeler and replace each Automatic step with your preferred solution. 4. Test the procedure until you are happy that the replacement mechanism is working correctly. 5. Release the procedure, then export it to an XFR file. (The procedure must be Released when you export it.) After you have upgraded your Version 9.0-o system, you will need to import the replacement procedure (that uses, for example, EAI steps), overwrite the original procedure (that uses Automatic steps) and migrate any outstanding cases. See page 117 for more information about how to do this. If a procedure containing Automatic steps is Released and has live cases on the Version 9.0-o system, you MUST NOT start the Version 11.1.3 system until you have migrated all cases of the procedure to use the replacement (EAI/brokers) procedure. If you start the Version 11.1.3 system before you have done this, cases will attempt to run against the original (Automatic steps) procedure, which is Incomplete. This may result in corruption of the case data for all affected cases. Case Data Case numbers and case references are preserved unchanged when you upgrade from Version 9.0-o to Version 11.1.3. By contrast, every new case that is started on Version 11.1.3 has a unique case number. This means that a system upgraded from Version 9.0-o will have duplicate case numbers across procedures, whereas a newly installed Version 11.1.3 system will have unique case numbers across all systems. Consequently, you should always use the full case reference (procedure_number-case_number) as an identifier for a particular case, as this is guaranteed to provide an identifier that is unique for one case only. TIBCO iProcess Engine (Oracle) for Windows Installation Additional Considerations If You Are Upgrading from a Version 9.0-o Process Engine 33 | WIS Processes The WQS_WIS_COUNT parameter in the Version 9.0-o SWDIR\etc\staffcfg file is no longer used in Version 11.1.3. In Version 9.0-o, the WQS_WIS_COUNT parameter value defines the number of WIS processes on the system. This value is ignored when you upgrade. Instead, two WIS processes are set up by default by the upgrade process. The WIS processes in Version 11.1.3 are multi-threaded and operate more efficiently than the Version 9.0-o WIS processes. As a result, you may find that you need less of them. You should check your system performance once the upgrade is complete and re-run any WIS performance tuning process that you used to calculate the correct number of processes for your existing system (see page 136). TIBCO iProcess Engine (Oracle) for Windows Installation 34 | Chapter 1 Introduction TIBCO iProcess Engine (Oracle) for Windows Installation | 35 Chapter 2 Pre-Installation Tasks This chapter describes the tasks that you may need to perform before you run Setup to install the iProcess Engine. Make sure that you have read the information in Chapter 1 on page 1 before starting on these tasks! Topics • Pre-Installation Tasks Checklist, page 36 TIBCO iProcess Engine (Oracle) for Windows Installation 36 | Chapter 2 Pre-Installation Tasks Pre-Installation Tasks Checklist The table on the next page provides a checklist of the different tasks that you may need to do before running the Setup installation program. The table shows: • whether the iProcess installer or DBA user needs to perform the task (see page 4). • the task’s status, depending on whether you are installing a new iProcess Engine or upgrading an existing one. This is either: — Required - You must perform this task before running Setup. — Check - You may need to perform this task before running Setup, depending on your installation scenario. — Optional - You may wish to perform this task before running Setup, but it is not essential. — n/a - You can run Setup without performing this task. Consult the indicated section for more detailed information about a particular task. You may want to print this table as a useful quick reference when carrying out the pre-installation tasks. The Done? column in the table provides a place for you to tick off tasks that have been done. TIBCO iProcess Engine (Oracle) for Windows Installation Pre-Installation Tasks Checklist 37 | To be done by Install Status Upgrade Status See iPE installer, DBA Required Required page 39 2. Backup the iProcess Engine File System iPE installer n/a Required page 40 3. Backup the iProcess Engine Database Schema DBA n/a Required page 43 4. Upgrade the Operating System iPE installer Check Check page 44 5. Upgrade Oracle DBA Check Check page 45 6. Check LDAP Directory Attribute to iProcess Engine Property Mappings iPE installer n/a Check page 46 7. Stop Any Other iProcess Engines on the Same Machine iPE installer Check Check page 47 8. Set up DCOM Permissions for the iProcess Objects Server iPE installer Check n/a page 48 9. Set up DCOM Permissions for a Node Cluster iPE installer Check n/a page 53 10. Record Changes to Tomcat Configuration Files iPE installer Check n/a page 54 11. Configure the Oracle Schema DBA Optional n/a page 55 12. Set up Oracle Transparent Application Failover (TAF) DBA Check Check page 61 13. Configure Oracle OPEN_CURSORS DBA Required Check page 63 14. Disable Oracle Authentication Services DBA Check Check page 64 Task 1. Check For Any Late Breaking Information Done? TIBCO iProcess Engine (Oracle) for Windows Installation 38 | Chapter 2 Pre-Installation Tasks Task To be done by Install Status Upgrade Status See 15. Configure Oracle Character Set Support DBA Check Check page 65 16. Disable Oracle Flashback Query DBA n/a Check page 67 17. Create an Oracle UNDO Tablespace DBA Required Required page 68 18. Remove All User-Defined Triggers, Indexes and Statistics From the iProcess Engine Schema Tables DBA n/a Check page 69 19. Turn Off User Account Control iPE installer Optional Check page 70 20. Configure the Microsoft Windows Cluster iPE installer Check Check page 71 TIBCO iProcess Engine (Oracle) for Windows Installation Done? Check For Any Late Breaking Information 39 | Check For Any Late Breaking Information Status Description Procedure If you are... This task is... Installing a new iProcess Engine Required Upgrading from any Version i10, 10 or 11 iProcess Engine Required Upgrading from any Version 9 Process Engine Required Before you install the iProcess Engine you should check if there any restrictions, known issues or other late-breaking information that may affect your installation, but that was not known about when this Installation guide was published. To check for late-breaking information: 1. Read the Release Notes and Readme documents that are supplied with the iProcess Engine software. If you are installing from the physical media, you can find these files in the docs directory on the physical media. If you are installing from a network server, you should ask your network administrator where these files are stored. 2. Consult the "Late Breaking News" section of the TIBCO Support Web, at (http://www.tibco.com/services/support/supportweb.jsp). TIBCO iProcess Engine (Oracle) for Windows Installation 40 | Chapter 2 Pre-Installation Tasks Backup the iProcess Engine File System Status If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Required Upgrading from any Version 9 Process Engine Required Description You must backup your iProcess Engine system before an upgrade! Make sure that you backup the entire SWDIR directory structure, and any other files you would want to restore if a failure occurs during upgrade. The upgrade process has no undo capability. If it fails for any reason, you will require a full backup of your SWDIR filesystem to be able to restore your original iProcess Engine system. You must also back up your database schema - see page 43. Procedure The procedure you use to backup the system depends on whether you are upgrading from an iProcess Engine (version 11, 10 or i10) or from a Process Engine (version 9). To backup an existing Version i10 , 10 or 11 iProcess Engine: 1. Get all users to log out of the iProcess Engine. 2. Stop the iProcess Engine. To do this, stop the iProcess nodename Process Sentinels service from the Windows Control Panel. 3. Using your operating system backup utility, make a secure off-line copy of the entire SWDIR directory structure and any other files you would want to restore if a failure occurs during upgrade. Note that if you have made any changes to the following files since they were installed, you will need to manually re-implement those changes after you have upgraded: — SWDIR\etc\language.lng\staffico — $SWDIR\etc\language.lng\auditusr.mes TIBCO iProcess Engine (Oracle) for Windows Installation Backup the iProcess Engine File System 41 | This is because the files are overwritten during the upgrade and any changes to the original files are not automatically merged into the new files. See Re-implement Changes to Upgraded Configuration Files on page 121.) To backup an existing Version 9 Process Engine: 1. Get all users to log out of the Process Engine that you intend to upgrade. 2. Use the following command to check if there are any Automatic steps (process invocations) currently queued: SWDIR\util\plist -q Wait until all outstanding Automatic steps have been processed. 3. Stop the Process Engine. To do this, stop the Staffware nodename Background service from the Windows Control Panel. 4. Make sure that all the server processes have stopped. 5. Check that the SWDIR directory structure does not contain any ibox or mbox mailbox files. If any of these files are present, the Process Engine still has outstanding work to process, and Setup will not run the upgrade. In this case you should: a. Restart the Process Engine - do not allow any users to log in. b. Wait until all ibox and mbox files have been processed and deleted. If a SWDIR\queues\sw_event\mbox file exists it does not get automatically processed and deleted by the Process Engine. If this file does exist you should delete it manually, as it is not required. c. Stop the Process Engine. 6. Using your operating system backup utility, make a secure off-line copy of the entire SWDIR directory structure and any other files you would want to restore if a failure occurs during upgrade. Note that if you have made any changes to the following files since they were installed, you will need to manually re-implement those changes after you have upgraded. (This is because the files are overwritten during the upgrade and any changes to the original files are not automatically merged into the new files. See page 121.): — SWDIR\etc\language.lng\staffico — $SWDIR\etc\language.lng\auditusr.mes TIBCO iProcess Engine (Oracle) for Windows Installation 42 | Chapter 2 Pre-Installation Tasks 7. If this installation used the TIBCO Process Objects Server, its audit log, auto-forward information, and view-only queue information will be lost when you upgrade. If you want to retain this log/information, you must back it up. The audit log is stored in the SWDIR\logs\SWEntObjUaXX.log file; auto-forward and view-only queue information is stored in the SWDIR\ServerName.n\SWEntObjDB.mdb file. See Also See the TIBCO iProcess Engine Administrator's Guide and your operating system documentation for more information about the procedures described in this section. TIBCO iProcess Engine (Oracle) for Windows Installation Backup the iProcess Engine Database Schema 43 | Backup the iProcess Engine Database Schema Status If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Required Upgrading from any Version 9 Process Engine Required Description You must backup your iProcess Engine database schema before an upgrade! In some circumstances, it is possible that an upgrade may fail and leave the iProcess Engine in an unusable condition. If this happens, you will need your schema backup to restore the system to its previous condition before you can either use it or attempt to upgrade it again. Procedure Refer to your Oracle documentation for more information about how to backup the iProcess Engine database schema. TIBCO iProcess Engine (Oracle) for Windows Installation 44 | Chapter 2 Pre-Installation Tasks Upgrade the Operating System Status Description Node-Cluster Procedure See Also If you are... This task is... Installing a new iProcess Engine Possibly required Upgrading from any Version i10, 10 or 11 iProcess Engine Required Upgrading from any Version 9 Process Engine Required This version of the iProcess Engine requires a specific operating system versionsee Basic System Requirements on page 12 for more information. The operating system version used must be the same on the master server and on each slave server. If you are using an operating system version that does not meet the specified requirements, you must upgrade it now. Refer to your operating system documentation for more information about how to perform the upgrade. TIBCO iProcess Engine (Oracle) for Windows Installation Upgrade Oracle 45 | Upgrade Oracle Status Description If you are... This task is... Installing a new iProcess Engine Possibly required Upgrading from any Version i10, 10 or 11 iProcess Engine Possibly required Upgrading from any Version 9 Process Engine Possibly required This version of the iProcess Engine requires a specific release level of the Oracle Database and/or Client, depending on whether you are using a local or remote database - see Oracle Database Requirements on page 23 for more information. Node-Cluster The Oracle version used must be the same on the master server and on each slave server. Procedure If you are using a version of Oracle that does not meet the specified requirements, you must upgrade it now. See Also Refer to your Oracle documentation for more information about how to upgrade Oracle. TIBCO iProcess Engine (Oracle) for Windows Installation 46 | Chapter 2 Pre-Installation Tasks Check LDAP Directory Attribute to iProcess Engine Property Mappings Status Description If you are... This task is... Installing a new iProcess Engine Not applicable. Upgrading from any Version 10.2 or later iProcess Engine Not applicable. Upgrading from any pre-Version 10.2 iProcess Engine Required if you use LDAP Upgrading from any Version 9 Process Engine Required if you use LDAP The iProcess Engine allows you to manage iProcess Engine user, group, role and attribute data via any LDAP 3.3-compliant directory service, such as X.500 or Oracle Internet Directory. LDAPCONF (SWDIR\util\ldapconf) is a utility that allows you to manage the connection between the LDAP server and the iProcess Engine, including the mapping of LDAP directory attributes to iProcess Engine properties. When you upgrade to Version 11.1.3 from a pre-10.2 version of the iProcess Engine or Process Engine, a new Group Membership LDAP directory attribute is added. The introduction of this new attribute can cause existing LDAP directory attribute to iProcess Engine property mappings to become misaligned. Procedure To resolve this, you need to perform the following steps: 1. Check your LDAPCONF configuration and note which LDAP directory attributes are mapped to which iProcess Engine properties. Use the LDAPCONF View Connection Information menu option to do this. (You will need to verify that these mappings have been preserved after upgrading - see page 137). 2. Delete any custom LDAP directory attribute mappings that you have added to your LDAPCONF configuration - for example, users’ email addresses or telephone numbers. Use the LDAPCONF Set Attribute Mappings menu option to do this. (You can add these mappings back to the configuration after upgrading if you wish - see page 137.) See Also For more information about LDAPCONF commands and procedures, see Chapter 3, “Configuring the Interface to the LDAP Server” and Chapter 4, “Testing the LDAP Interface”, in the LDAPCONF Utility User's Guide. TIBCO iProcess Engine (Oracle) for Windows Installation Stop Any Other iProcess Engines on the Same Machine 47 | Stop Any Other iProcess Engines on the Same Machine Status Description If you are... This task is... Installing a new iProcess Engine Required for the first installation Upgrading from any Version i10, 10 or 11 iProcess Engine Required for the first upgrade Upgrading from any Version 9 Process Engine Required for the first upgrade You may need to stop any other iProcess Engines running on the same machine where you intend to install the iProcess Engine before you run Setup. If you do not do this when it is required, Setup will display an error dialog and fail when you run it (see page 163). This is so that Setup can stop and replace components (such as the Staffware Events COM+ application) that are also used by other iProcess Engine installations. Setup checks whether the latest versions of these components are currently installed, and only replaces them where the version delivered with this iProcess Engine is more recent than the installed version of the component. Therefore, it is only necessary to stop other iProcess Engines for the first installation of iProcess 11.1 on a given machine. When you install a second or subsequent instance of iProcess, these components will already be at the latest versions and so will not need to be replaced. Procedure To stop any other iProcess Engines running on the same machine: 1. Click Start > Settings> Control Panel. 2. Double-click Administrative Tools. 3. Double-click Services. 4. Search for any running services with the following names: — iProcess NodeName Process Sentinels — iProcess NodeName Web Server 5. If there are any, right-click each service and choose Stop. See Also See "Stopping the TIBCO iProcess Engine" in the TIBCO iProcess Engine Administrator’s Guide for more information about how to stop an iProcess Engine. TIBCO iProcess Engine (Oracle) for Windows Installation 48 | Chapter 2 Pre-Installation Tasks Set up DCOM Permissions for the iProcess Objects Server Status Description If you are... This task is... Installing a new iProcess Engine Required Upgrading from any Version i10, 10 or 11 iProcess Engine Required Upgrading from any Version 9 Process Engine Required If the Windows Distributed Component Object Model (DCOM) is enabled on this machine and you intend to enable the iProcess Objects Server (see page 95), you must ensure that the IPEADMIN user has DCOM Access Permissions and Launch Permissions. If you have chosen to use separate accounts for the IPEADMIN and IPESERVICE users (see page 6), you must give the IPESERVICE user the same DCOM permissions as the IPEADMIN user. You may have DCOM enabled without having explicitly set it. For example, Microsoft Web Server enables it as part of its setup. Procedure To set up DCOM permissions: 1. Log on to Windows as an administrator. 2. Click the Start button, then select Run. 3. Enter dcomcnfg and press OK. This runs the DCOM Configuration Utility. 4. Follow the steps in the table below for your version of Windows: If you are running Windows Server 2003 or Windows XP... i. From the Component Services icon, drill down to the My Computer icon. ii. Right click on My Computer, then select Properties. The My Computer Properties dialog is displayed. iii. Click the Default Properties tab. 5. If the Enable Distributed COM on this computer check box is selected, you must set the necessary permissions for the IPEADMIN user. The way in which TIBCO iProcess Engine (Oracle) for Windows Installation Set up DCOM Permissions for the iProcess Objects Server 49 | you do this depends on which operating system you are using. See the following subsections: — Setting Permissions on Windows Server 2003 and Windows Server 2008 — Setting Permissions on Windows XP and Windows Vista If the Enable Distributed COM on this computer check box is cleared, DCOM is not enabled and you can proceed with other pre-installation tasks. 6. If you have chosen to use separate accounts for the IPEADMIN and IPESERVICE users (see page 6), repeat the procedure for the IPESERVICE user. Setting Permissions on Windows Server 2003 and Windows Server 2008 Perform the following steps to give the IPEADMIN user access and launch permissions when using Windows Server 2003 and Windows Server 2008: 1. From the My Computer Properties dialog, click the Default COM Security tab. 2. Set up Access Permissions. To do this: a. In the Access Permissions frame, click Edit Default, then click Add. b. On the Select Users or Groups dialog, click the Locations button. c. On the Locations dialog, choose the appropriate computer or domain name where the iProcess Engine is installed, then click OK. d. Click the Advanced button. e. Click the Find Now button. f. From the list of search results, select the IPEADMIN user, then click OK. g. From the Select Users or Groups dialog, click OK. The IPEADMIN user will now appear in the list of users with access permissions. h. Click the IPEADMIN user and ensure the Allow check box is checked. If it is not checked, click in the Allow check box. i. Click OK to return to the My Computer Properties dialog. TIBCO iProcess Engine (Oracle) for Windows Installation 50 | Chapter 2 Pre-Installation Tasks 3. Set up Launch Permissions. To do this: a. In the Launch Permissions frame, click Edit Default, then click Add. b. On the Select Users or Groups dialog, click the Locations button. c. On the Locations dialog, choose the appropriate computer or domain name where the iProcess Engine is installed, then click OK. d. Click the Advanced button. e. Click the Find Now button. f. From the list of search results, select the IPEADMIN user, then click OK. g. From the Select Users or Groups dialog, click OK. The IPEADMIN user will now appear in the list of users with launch permissions. h. Click the IPEADMIN user and ensure the Allow check box is checked. If it is not checked, click in the Allow check box. i. Click OK to return to the My Computer Properties dialog. j. Click OK to return to the Component Services dialog. k. Exit Component Services. Setting Permissions on Windows XP and Windows Vista Perform the following steps to give the IPEADMIN user access and launch permissions when using Windows XP or Windows Vista: 1. From the My Computer Properties dialog, click the COM Security tab. TIBCO iProcess Engine (Oracle) for Windows Installation Set up DCOM Permissions for the iProcess Objects Server 51 | 2. Set up Access Permissions. To do this: a. In the Access Permissions frame, click Edit Default. b. On the Access Permissions dialog, click Add. c. On the Select Users, Computers, or Groups dialog, click the Locations button. d. On the Locations dialog, choose the appropriate computer or domain name where the iProcess Engine is installed, then click OK. e. Click the Advanced button. f. Click the Find Now button. g. From the list of search results, select the IPEADMIN user, then click OK. h. From the Select Users, Computers, or Groups dialog, click OK. The IPEADMIN user will now appear in the list of users with access permissions. i. Click the IPEADMIN user’s name and ensure the Allow Access check boxes are checked. If they are not checked, click in the Allow check boxes. j. Click OK to return to the My Computer Properties dialog. TIBCO iProcess Engine (Oracle) for Windows Installation 52 | Chapter 2 Pre-Installation Tasks 3. Set up Launch Permissions. To do this: a. In the Launch and Activation Permissions frame, click Edit Default. b. On the Launch Permission dialog, click Add. c. On the Select Users, Computers, or Groups dialog, click the Locations button. d. On the Locations dialog, choose the appropriate computer or domain name where the iProcess Engine is installed, then click OK. e. Click the Advanced button. f. Click the Find Now button. g. From the list of search results, select the IPEADMIN user, then click OK. h. From the Select Users or Groups dialog, click OK. The IPEADMIN user’s name will now appear in the list of users with launch permissions. i. Click the IPEADMIN user’s name and ensure the Allow check boxes for launch permissions are checked. If they are not checked, click in the Allow Launch check boxes. j. Click OK to return to the My Computer Properties dialog. k. Click OK to return to the Component Services dialog. l. Exit Component Services. TIBCO iProcess Engine (Oracle) for Windows Installation Set up DCOM Permissions for a Node Cluster 53 | Set up DCOM Permissions for a Node Cluster This only applies to Windows XP, Windows Server 2003and Windows Vista. Status Description Procedure If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional In a node cluster, iProcess Engine machines communicate by publishing and subscribing to events using the iProcess Engine event mechanism. This means that all machines in a node cluster must have permission to instantiate events. To allow this, you must configure the Windows Distributed Component Module (DCOM) to allow ANONYMOUS LOGIN permissions on each machine. To set up DCOM permissions: 1. Log on to Windows as an administrator. 2. Click the Start button, then select Run. 3. Enter dcomcnfg and press OK. This runs the DCOM Configuration Utility. 4. From the Component Services icon, drill down to the My Computer icon. 5. Right click on My Computer, then select Properties. The My Computer Properties dialog is displayed. 6. From the My Computer Properties dialog, click the COM Security tab. 7. Set up Access Permissions. To do this: a. In the Access Permissions frame, click Edit Limits. b. In the Access Permissions dialog, click ANONYMOUS LOGIN. c. Ensure the Allow check box for remote access is checked. d. Click OK to return to the My Computer Properties dialog. e. Click OK to return to the Component Services dialog. f. Exit Component Services. TIBCO iProcess Engine (Oracle) for Windows Installation 54 | Chapter 2 Pre-Installation Tasks Record Changes to Tomcat Configuration Files Status Description If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Required if upgrading from a pre-10.6 version Upgrading from any Version 9 Process Engine Not applicable When you run Setup, the Apache Tomcat application server is installed into the SWDIR\tomcat directory. (Tomcat is used by the iProcess Server Manager.) Version 11.1.3 of the iProcess Engine installs Tomcat version 5.5.31. Pre-10.6 versions of the iProcess Engine installed Tomcat version 4.1 (or earlier). The format of Tomcat’s .xml configuration files has changed in version 5.5.31. As a result, any changes you have made to existing Tomcat configuration files will be lost when you upgrade from a pre-10.6 version of the iProcess Engine. If you want to keep those changes, you need to record what they are and then manually re-implement them after you have upgraded. Procedure Record any changes (either directly, or by making backup copies) that you have made to .xml configuration files under the SWDIR\tomcat directory. If you want to keep these configuration changes after you have upgraded the iProcess Engine you will need to manually re-implement them in the Tomcat version 5.5.31 configuration files. TIBCO iProcess Engine (Oracle) for Windows Installation Configure the Oracle Schema 55 | Configure the Oracle Schema Status Description If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Not applicable Upgrading from any Version 9 Process Engine Not applicable When you run Setup, by default it creates a small database (approximately 50Mb) that is suitable for benchmarking or development purposes). You can modify this default database configuration if you wish to optimize it for your Oracle environment, taking into account factors specific to your installation such as the number of cases, the amount of case data, the life of cases and so on. The following sections describe: The Default iProcess Engine Schema Configuration • the default configuration (see below). • how Setup creates the default configuration (see page 56). • how you can modify the default configuration - for example, to alter the size of or tablespaces used by iProcess Engine tables and indexes (see page 59). By default, Setup performs the following operations when it creates the iProcess Engine schema: 1. It creates the following tablespaces (with a default location of ORACLE_HOME\database) for the Oracle instance: — a data tablespace (with a default name of staffwar). By default, all iProcess Engine tables, indexes and Oracle AQ queues are stored in this tablespace. — a temporary tablespace (with a default name of temp), which is used for sorting. 2. It creates the following Oracle users: — iProcess Engine DB Schema Owner user (with a default name of swpro). — iProcess Engine DB User (with a default name of swuser). The staffwar and temp tablespaces are allocated to these users as their default tablespaces. 3. It creates the iProcess Engine schema tables, indexes and Oracle AQ queues in the default staffwar tablespace. TIBCO iProcess Engine (Oracle) for Windows Installation 56 | Chapter 2 Pre-Installation Tasks The use of the staffwar tablespace is defined in the tablesizes file - see the following section for details. How Setup Sets Up the Default Configuration Setup uses two template files to create the iProcess Engine schema: • the init2Kora_tok.sql file • the tablesizes file The init2Kora_tok.sql File The init2Kora_tok.sql file defines the following configuration macros for each iProcess Engine table and index that is to be created: • SIZETABLESIZE - the initial size (in extents) of a table. • SIZETABLEPCTINCREASE - the percentage increase to be applied when growing a table. • SIZETABLESPACE - the tablespace to be used by a table. • SIZEINDEXSPACE - the tablespace to be used by an index. where SIZE is one of seven different categories, as shown in the following table. Category Used for... Example TINY Small tables that don’t grow. flag_table procedure_lock SMALL Generally static tables that contain small amounts of data. list_names dbs_names MEDIUM Generally static tables that contain more data. user_names user_values BIG Slightly larger tables that typically hold values for references held in SMALL and MEDIUM tables. user_values db_str_values LARGE Most of the tables that contain case related information, typically ones that only have 1 or 2 rows per case. case_information outstanding_addr staffo HUGE Tables that hold multiple rows per case, but not for all cases. pack_data pack_memo MASSIVE Tables that hold multiple rows per case for all cases. audit_trail case_data TIBCO iProcess Engine (Oracle) for Windows Installation Configure the Oracle Schema 57 | Refer to the TIBCO iProcess Engine (Oracle) Administrator? Guide to see which macros are defined for each table and index in the iProcess Engine database. The tablesizes File The tablesizes file defines a real value for each configuration macro in the init2Kora_tok.sql file. For example, the default values for the different TABLESIZE macros are shown below. # # Initial size (in extents) for each # category of table. # TINYTABLESIZE=1K SMALLTABLESIZE=2K MEDIUMTABLESIZE=40K BIGTABLESIZE=200K LARGETABLESIZE=500K HUGETABLESIZE=500K MASSIVETABLESIZE=1M How the Setup Script Uses These Template Files When you run Setup to install the iProcess Engine: 1. Setup copies the following files to the installing user’s temporary folder (as defined by the %TEMP% user environment variable): — init2Kora_tok.sql — the tablesizes file specified in the Select Tablesizes Profile dialog. 2. Setup updates the init2Kora_tok.sql script to: a. replace the configuration macros with the actual values from the tablesizes file. b. replace occurrences of the default data tablespace name (staffwar) with the name specified in the Confirm Tablespace dialog. 3. Setup runs the init2Kora_tok.sql script to create the iProcess database schema. The following diagram illustrates this process. TIBCO iProcess Engine (Oracle) for Windows Installation 58 | Chapter 2 Pre-Installation Tasks Default init2Kora_tok.sql file create table TABLE_OWNER.nodes( ... CONSTRAINT pk_nodes PRIMARY KEY (node_id) using index tablespace TINYINDEXSPACE) STORAGE (initial TINYTABLESIZE pctincrease TINYTABLEPCTINCREASE) tablespace TINYTABLESPACE; tablesizes file # TABLE SIZES # TINYTABLESIZE=1K ... # TABLE PCT INCREASES # TINYTABLEPCTINCREASE=0 ... # TABLE TABLESPACES # TINYTABLESPACE=staffwar ... # INDEX TABLESPACES # TINYINDEXSPACE=staffwar Setup Pre-processed init2Kora.sql file create table swpro.nodes( ... CONSTRAINT pk_nodes PRIMARY KEY (node_id) using index tablespace staffwar) STORAGE (initial 1K pctincrease 0) tablespace staffwar; "staffwar" tablespace TIBCO iProcess Engine (Oracle) for Windows Installation Configure the Oracle Schema 59 | How to Change the Default Configuration You can change the default configuration of the iProcess Engine schema to match your particular requirements. Depending on the level of configuration control you need, you can use any combination of the following methods: • use different or additional tablespaces (see the following section). • use a different template tablesizes file (see page 59). • customize the tablesizes file (see page 60). • customize the init2Kora_tok.sql file (see page 60). Change the Default Data Tablespace There are two ways in which you can change the default data tablespace to be used: • Setup can automatically create the default data tablespace for you, using the name you specify in the Database Details dialog (see page 91). • Alternatively, you can create the default data tablespace manually before running Setup. You may want to do this if, for example, you want to spread the larger iProcess tables across multiple tablespaces. If you are using Oracle Real Application Clusters (RAC) you must create all required tablespaces on the RAC shared storage device(s) before running Setup. If you do not do this, Setup creates the data file(s) for the tablespace in the ORACLE_HOME\database directory. To do this: a. Manually create the tablespace(s) you want to use as the default data tablespace(s). If you have created multiple tablespaces, simply specify the name of one of these tablespaces. b. When you run Setup, specify that you want to use this tablespace in the Database Details dialog (see page 91), then specify that all database objects should be created in this tablespace in the Confirm Tablespace dialog. Use an Alternative tablesizes File When you run Setup, you can use the Select Tablesizes Profile dialog to choose one of the following alternative tablesizes file: • tablesizes.med. Using this file will create a medium-sized database, requiring at least 2.5Gb of disk space. TIBCO iProcess Engine (Oracle) for Windows Installation 60 | Chapter 2 Pre-Installation Tasks • tablesizes.large. Using this file will create a large-sized database, requiring at least 65Gb of disk space. See Appendix A on page 155 for more information about the intended usage profiles of these files. Customize Specific Configuration Macros in the tablesizes File If you require more specific configuration control, you can edit the tablesizes file to change the values assigned to specific configuration macros. For example, you may want to: • increase the initial size of tables that use the LARGETABLESIZE macro. • spread the larger iProcess tables across multiple tablespaces/filesystems (to aid i/o performance and reduce contention), by modifying individual SIZETABLESPACE or SIZEINDEXSPACE entries. Remember to create any additional tablespaces before you run Setup. You can edit the tablesizes file when you run Setup. Customize the init2Kora_tok.sql File to Assign Different Configuration Macros or Values to Specific Tables or Indexes Finally, you can edit the init2Kora_tok.sql file to assign different configuration macros (or hard code specific values) to specific tables and indexes. You can do this when you run Setup. By default, the predict and predict_lock tables use the SMALL macro values. If you intend to enable background case prediction on your system (using the ENABLE_CASE_PREDICTION process attribute), TIBCO recommend that you change these tables to use a larger value in line with the level of background prediction activity you expect. See “Administering Process Attributes” in the TIBCO iProcess Engine Administrator’s Guide for more information. See Also For more information about how to estimate the size and layout requirements of your iProcess Engine schema, consult the following sources: • the TIBCO iProcess Engine (Oracle) Administrator? Guide. This guide defines the structure of each table, and provides guidance on the number of records a table should contain depending on the iProcess data. • your TIBCO representative, who can work with you to prepare a detailed sizing/configuration estimate. TIBCO iProcess Engine (Oracle) for Windows Installation Set up Oracle Transparent Application Failover (TAF) 61 | Set up Oracle Transparent Application Failover (TAF) Status Description If you are... This task is... Installing a new iProcess Engine Optional or Required (see below) Upgrading from any Version i10, 10 or 11 iProcess Engine Optional or Required (see below) Upgrading from any Version 9 Process Engine Optional or Required (see below) Oracle TAF enables an application user (such as the iProcess Engine) to automatically reconnect to a database if the connection fails. If you are running parallel servers, using TAF can allow the iProcess Engine to switch to an alternative instance if the one that it is using fails. Even if you are not using parallel servers, using TAF still means that although the iProcess Engine will not function while the database is down, it can recover immediately and automatically when the database is recovered. TIBCO strongly recommends the use of Oracle TAF with the iProcess Engine to provide 24*7 resilient operation. If you are deploying the iProcess Engine for user acceptance testing (UAT) or to a production environment, you must enable TAF. For more information about how the iProcess Engine supports database failover, see the TIBCO iProcess Engine Architecture guide. Note that: • You should not use TAF to protect the iProcess Engine from a scheduled Oracle shutdown. • The standard Oracle client connection is not protected by TAF. Therefore, if a failover occurs iProcess Engine Workspace users may need to log back in. To enable the use of TAF with the iProcess Engine, you need to configure TAF support for the service name that you intend to use to connect to the Oracle database (see page 91). Procedure The procedure you use to set up TAF depends on whether you are using Oracle RAC: • If you are not using Oracle RAC, you must manually configure a net service name that includes the FAILOVER_MODE parameter included in the CONNECT_DATA section of the connect descriptor. TIBCO iProcess Engine (Oracle) for Windows Installation 62 | Chapter 2 Pre-Installation Tasks You must specify at least the TYPE and METHOD sub-parameters for the FAILOVER_MODE parameter. • See Also If you are installing the iProcess Engine on one of the nodes of an Oracle RAC, you can use Oracle's Database Configuration Assistant (DBCA) to create a new service that will use TAF. DBCA will update all the tnsnames.ora files for the instances you choose to be in the Oracle RAC. If your iProcess Engine is connected via an Oracle client to the Oracle RAC, you can copy the changes that DBCA makes to the Oracle database tnsnames.ora file to the client's tnsnames.ora file. For more information about how to set up TAF, please see the following documents in your Oracle documentation set: • Oracle Net Services Administrator’s Guide • Oracle Clusterware and Oracle Real Application Clusters Administration and Deployment Guide (if you are using Oracle RAC) TIBCO iProcess Engine (Oracle) for Windows Installation Configure Oracle OPEN_CURSORS 63 | Configure Oracle OPEN_CURSORS Status If you are... This task is... Installing a new iProcess Engine Required Upgrading from any Version i10, 10 or 11 iProcess Engine Not applicable Upgrading from any Version 9 Process Engine Required Description The Oracle OPEN_CURSORS parameter is defined in the initialization parameter file for the Oracle instance. It defines the limit on the maximum number of cursors (active SQL statements) for each session on this Oracle instance. Procedure Make sure that the Oracle OPEN_CURSORS parameter is set to a value of at least 200. See Also See your Oracle documentation for more information about the initialization parameter file and the OPEN_CURSORS parameter. TIBCO iProcess Engine (Oracle) for Windows Installation 64 | Chapter 2 Pre-Installation Tasks Disable Oracle Authentication Services Status Description If you are... This task ... Installing a new iProcess Engine May be required Upgrading from any Version i10, 10 or 11 iProcess Engine May be required Upgrading from any Version 9 Process Engine May be required If you are installing the iProcess Engine in an Active Directory environment you must disable Oracle authentication services. If you do not do this, Setup will return the following error when it attempts to connect to the Oracle database: TNS-12638 Credential retrieval failed If you are not using Active Directory you do not need to do this. Procedure To disable authentication services, set the following parameter in the Oracle sqlnet.ora configuration file: SQLNET.AUTHENTICATION_SERVICES=none By default, the sqlnet.ora file is located in the ORACLE_HOME\network\admin directory, or in the directory specified by the TNS_ADMIN environment variable. TIBCO iProcess Engine (Oracle) for Windows Installation Configure Oracle Character Set Support 65 | Configure Oracle Character Set Support Status Description If you are... This task is... Installing a new iProcess Engine May be required Upgrading from any Version i10, 10 or 11 iProcess Engine May be required Upgrading from any Version 9 Process Engine May be required Oracle’s NLS_LANG parameter sets the language, territory and character set that the iProcess Engine uses to communicate with the Oracle database. The iProcess Engine requires that NLS_LANG uses an 8-bit character set. NLS_LANG is defined in the following Windows registry subkey: Oracle Version Oracle10g or Oracle 11g Key RegistryLocation\ORACLE\KEY_ORAHOME where ORAHOME is the Oracle home name. where RegistryLocation is either \HKEY_LOCAL_MACHINE\Software, if you are running the iProcess Engine on a 32-bit machine, or \HKEY_LOCAL_MACHINE\Software\Wow6432Node, if you are using a 64-bit machine. You can also set NLS_LANG as a System or User environment variable (using System in Control Panel). However, if you do this the environment variable setting is used for ALL Oracle homes and takes precedence over any parameters set in the Windows registry. Oracle recommend that you use the Windows registry to set NLS_LANG unless you have a specific requirement to use an environment variable. Node-Cluster Procedure NLS_LANG must be set to the same value on the master server and on each slave server. To set NLS_LANG: 1. Set the NLS_LANG value to use an 8-bit character set component (charset). TIBCO iProcess Engine (Oracle) for Windows Installation 66 | Chapter 2 Pre-Installation Tasks 2. If you are using a TNS connection, make sure that the character set component (charset) of the NLS_LANG value for the Oracle client matches the character set component of the NLS_LANG setting on the Oracle database. The format of the NLS_LANG string is: NLS_LANG = language_territory.charset Example NLS_LANG=American_America.WE8ISO8859P1 See Also For more information about using NLS_LANG, please see the Oracle Database Globalization Support Guide. TIBCO iProcess Engine (Oracle) for Windows Installation Disable Oracle Flashback Query 67 | Disable Oracle Flashback Query Status Description If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine May be required Upgrading from any Version 9 Process Engine May be required Oracle has a flashback query feature, which lets you view and repair historical data. (The initialization parameter, UNDO_RETENTION, provides a means of explicitly specifying the amount of undo information to retain.) If flashback query is enabled, the amount of undo tablespace required while you are upgrading (see page 68) will increase significantly. You may therefore want to disable this feature while you are upgrading the iProcess Engine or Process Engine. However, this may not be possible if there are other applications that use the same database and that may require a flashback query while the upgrade is taking place. If that is the case, you must leave the feature enabled and make sure you have sufficient undo tablespace available. Note that: Procedure • It is possible for undo to reach 100% as the flashback query undo will still be allocated. This will make it difficult to monitor the undo tablespace. • If undo is set to autoextend, it may grow extremely large as all undo transactions for the entire upgrade will be stored. To disable flashback query, use the Oracle command: alter system set UNDO_RETENTION=0 See Also See your Oracle documentation for more information about flashback query. TIBCO iProcess Engine (Oracle) for Windows Installation 68 | Chapter 2 Pre-Installation Tasks Create an Oracle UNDO Tablespace Status Description Procedure See Also If you are... This task is... Installing a new iProcess Engine Required Upgrading from any Version i10, 10 or 11 iProcess Engine Required Upgrading from any Version 9 Process Engine Required Beginning with Oracle9i, Oracle uses UNDO tablespaces to rollback transactions. Previous versions of Oracle used rollback segments. Create an Oracle UNDO tablespace for the iProcess Engine database. See: • your Oracle documentation, for more information on how to create and manage UNDO tablespaces. • Disable Oracle Flashback Query on page 67, for more information about Oracle’s flashback query feature and its impact on the amount of UNDO tablespace you require. TIBCO iProcess Engine (Oracle) for Windows Installation Remove All User-Defined Triggers, Indexes and Statistics From the iProcess Engine Schema Tables 69 | Remove All User-Defined Triggers, Indexes and Statistics From the iProcess Engine Schema Tables Status Description If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine May be required Upgrading from any Version 9 Process Engine May be required As part of the upgrade process Setup needs to modify certain columns in the iProcess Engine schema tables. To do this it has to remove all triggers, indexes and statistics from the tables. It recreates these triggers, indexes and statistics later in the upgrade process, after it has changed the necessary columns. However, Setup cannot remove any user-defined triggers, indexes or statistics that you have added to iProcess Engine schema tables. You will need to remove these yourself, and then manually recreate them after the upgrade has finished. Procedure Using an appropriate SQL utility, remove all user-defined triggers, indexes or statistics that you have added to iProcess Engine schema tables. You can manually recreate them after the upgrade has finished - see page 142. TIBCO iProcess Engine (Oracle) for Windows Installation 70 | Chapter 2 Pre-Installation Tasks Turn Off User Account Control Status Description If you are... This task is... Installing a new iProcess Engine Optional if you are installing on Windows Vista Upgrading from any Version 10.5 or later iProcess Engine Optional if you are installing on Windows Vista Upgrading from any pre-Version 10.5 iProcess Engine, or from any Version 9 Process Engine Optional if you are installing on Windows Vista If you are installing the iProcess Engine on Windows Vista, you may choose to turn User Account Control (UAC) off. If you choose not to turn UAC off, you will need to elevate certain tasks - that is, run them as an Administrator. See: — Running Setup on page 76 — Process Sentinels service startup on page 83 — Configure iProcess Objects Server on page 99 — Configure the iProcess Objects Server and iProcess Objects Director on page 123 — Start the iProcess Engine on page 146 See the Windows Vista documentation for information on how to elevate tasks. Procedure To turn off UAC, perform the following steps: 1. Go to Control Panel and then to User Accounts. 2. Click on Turn User Account Control on or off. 3. Uncheck the Use User Account Control (UAC) to help protect your computer checkbox. 4. Click OK. TIBCO iProcess Engine (Oracle) for Windows Installation Configure the Microsoft Windows Cluster 71 | Configure the Microsoft Windows Cluster Status Description If you are... This task is... Installing a new iProcess Engine Required if you use a Windows Cluster Upgrading from any Version 10.5 or later iProcess Engine Required if you use a Windows Cluster Upgrading from any pre-Version 10.5 iProcess Engine, or from any Version 9 Process Engine n/a If you are installing the iProcess Engine into a Microsoft Windows Cluster, you must perform some preliminary tasks to enable the iProcess Engine to operate in the Microsoft Windows Cluster environment. Microsoft Windows Clustering is not supported on Windows XPor Windows Vista. Procedure Perform the following steps: 1. If you are upgrading an iProcess Engine that is part of a Windows cluster, run the following command on each secondary machine in the cluster: SWDIR\mscluster\mscluster -r Do not run this command on the machine where the iProcess Engine is installed! If you do so you will not be able to start or upgrade the iProcess Engine. This command removes the iProcess Engine shared resources and services, and the port numbers used by the iProcess Engine watcher and worker process sentinels in the %systemroot%\system32\drivers\etc\services file. You will need to create the shared resources and services used by the upgraded iProcess Engine after you have run Setup - see page 126. 2. Enable network DTC access on the cluster. If network DTC access is not enabled, database transactions are limited to the local server. TIBCO iProcess Engine (Oracle) for Windows Installation 72 | Chapter 2 Pre-Installation Tasks For more information about how to enable network DTC access, please see article 817064 in Microsoft’s Knowledge Base at http://support.microsoft.com. 3. Using Cluster Administrator, install a Distributed Transaction Coordinator resource. If this resource is not available, Setup will not be able to add the Staffware Events and (optional) iProcess COM+ Bridge COM+ applications to Component Services during installation. For more information about how to do this, refer to the "Installing a Distributed Transaction Coordinator resource" topic in the Microsoft Cluster Administrator help. See Also See the Microsoft documentation and/or Help for more information about the Cluster Administrator tool.. TIBCO iProcess Engine (Oracle) for Windows Installation | 73 Chapter 3 Running the Setup Installation Program This chapter describes how to use the Setup installation program to install the iProcess Engine. Topics • Using Setup, page 74 • Running Setup, page 76 TIBCO iProcess Engine (Oracle) for Windows Installation 74 | Chapter 3 Running the Setup Installation Program Using Setup Setup performs the installation process in two phases: 1. Configuration information collection. In this phase Setup displays a series of dialogs that allow you to specify the information Setup needs to install the iProcess Engine. TIBCO recommend that you read the Running Setup section (on page 76) and collect the necessary information to enter into the dialogs before you actually run Setup. 2. Installation. In this phase Setup performs the required installation tasks, using the configuration information supplied in the previous phase. See page 109 for more information about this phase. Upgrade Performance and Timing Upgrading to Version 11.1.3 can involve significant changes to iProcess data and data structures. The upgrade process is therefore complex, and can take a significant amount of time to complete if the system being upgraded has a large amount of case data. TIBCO cannot provide an estimate of how long the upgrade will take because of the number of customer-specific factors that could have an impact, and the complexity of their interaction - for example, the amount of data in your existing system, the configuration of your Oracle system and the hardware setup you are running. TIBCO therefore strongly recommend that you test the upgrade before performing it on your target system, either on a representative production environment, or using a copy of your production system. This will allow you to determine how long the upgrade is likely to take, and to identify any specific factors that may affect the success or duration of the upgrade. TIBCO iProcess Engine (Oracle) for Windows Installation Using Setup 75 | Upgrading from a Version 9.0-o (Oracle) Process Engine If you are upgrading from a Version 9.0-o (Oracle) Process Engine, you should note that Setup performs the upgrade in two stages: 1. from Version 9.0-o to an interim Version i9.2-o stage. The Version i9.2-o stage is a slightly modified version developed specifically for the purpose of this upgrade. It is not intended for use as a Version i9.2-o system. 2. from Version i9.2-o to Version 11.1.3. In both stages changes are made to the iProcess Engine database schema, and to the location, content and permissions on iProcess Engine system files. TIBCO iProcess Engine (Oracle) for Windows Installation 76 | Chapter 3 Running the Setup Installation Program Running Setup To run the Setup installation program: 1. Log in to Windows using the account that you have chosen to use to run Setup (the IPEINSTALL user - see page 5). 2. Run the iProcess Engine Setup program. If you’re installing from: — physical media: Run Setup from the root directory on the physical media. — a network server: Run Setup from the appropriate network share folder If you are installing on Windows Vista and User Account Control is turned on, you must right-click the Setup file and select Run as Administrator. The Welcome dialog is displayed. 3. Review the information in the Welcome dialog and click Next. The Software License Agreement dialog is displayed. 4. Review the terms of the license agreement and, if you agree to them, click Yes to continue with the installation. If you do not agree to the terms of the license agreement, click No to exit from the installation process. You must scroll through the entire license agreement to enable the Yes option. The Setup Type dialog is displayed. See page 77. TIBCO iProcess Engine (Oracle) for Windows Installation The Setup Type Dialog 77 | The Setup Type Dialog The Setup Type dialog allows you to choose whether to run a Basic or Custom installation. To complete this dialog: 1. Choose one of the following options: If you want to... choose... install a new iProcess Engine using default configuration options whenever possible. Basic See page 78 for more information about what defaults will be set. install a new iProcess Engine, making your own choice for all available configuration options. Custom install a new slave server (in a node-cluster iProcess Engine). Custom A slave server must use the same nodename as the master server, but you cannot choose the nodename when you do a Basic installation - Setup assigns it automatically. upgrade an existing iProcess Engine installation Custom 2. Click Next. 3. If you have chosen a Basic installation: a. If you do not currently have the NobleNet Portmapper service installed on this computer, a dialog is displayed, prompting you to enter an installation directory in which to install the NobleNet Portmapper service. b. Enter the directory where you want to install the NobleNet Portmapper, then click Yes to continue. The Choose Destination Location dialog is displayed. See page 81. 4. If you have chosen a Custom installation, the Upgrade or New Install dialog is displayed. See page 79. TIBCO iProcess Engine (Oracle) for Windows Installation 78 | Chapter 3 Running the Setup Installation Program Default Configuration Options for a Basic Installation If you choose a Basic installation, Setup will use default values for a number of configuration options, shown in the table below. You will not be able to change the default values for these options. If you do not want to use the indicated default values for any of these options, you should choose a Custom installation instead of a Basic one. Configuration option Default Value See Nodename staffw_nodx page 79 Licensee TIBCO SOFTWARE page 82 Client-Server RPC port number 391875 page 82 Process Sentinels service startup Automatic page 82 Auto start processes on service startup Selected page 82 Enable Case Prediction Selected page 82 Enable Case data normalization Selected page 82 iPE Administrators group Staffware Administrators page 88 iPE Users group Staffware Users page 88 iPE Administrator account name The Windows account you are using to run Setup (i.e. the IPEINSTALL user). page 88 Use separate account for iPE Services Cleared page 88 iPE Services account name The Windows account you are using to run Setup (i.e. the IPEINSTALL user). page 88 Users are required to login with a password Selected page 88 TIBCO iProcess Engine (Oracle) for Windows Installation The Upgrade or New Install Dialog 79 | The Upgrade or New Install Dialog The Upgrade or New Install dialog allows you to choose whether to install a new iProcess Engine or upgrade an existing one. To complete this dialog: 1. Select one of the following options: If you want to... do this... install a new iProcess Engine i. Select New installation. ii. Specify the iProcess nodename to use for the new installation. You can accept the default entry or type in a new name. If you want to install a master server, the nodename must be 24 characters or less using letters or digits, which can be separated by an underscore character (_). If you want to install a slave server, the nodename must be exactly the same as the one used on the master server. upgrade an existing iProcess Engine installation i. Select Upgrading existing installation. ii. From the list of nodenames, select the iProcess Engine/Process Engine that you want to upgrade. When you select a nodename in the list, the Version, Language and Client-Server RPC port number of that iProcess Engine/Process Engine are displayed in the Details pane. An error message is displayed if you cannot (directly) upgrade the chosen nodename to this version (see page 27). 2. Click Next. 3. If you selected New installation: a. If you do not currently have the NobleNet Portmapper service installed on this computer, a dialog is displayed, prompting you to enter an installation directory in which to install the NobleNet Portmapper service. Enter the directory where you want to install the NobleNet Portmapper, then click Yes to continue. b. The Choose Destination Location dialog is displayed. See page 81. 4. If you selected Upgrading existing installation: a. Setup checks that the procedure data on the system can be upgraded successfully. (If upgrade cannot continue, Setup exits with an error - see page 165). TIBCO iProcess Engine (Oracle) for Windows Installation 80 | Chapter 3 Running the Setup Installation Program b. A Question dialog is displayed, informing you that Setup needs to delete the contents of the SWDIR\tsys and SWDIR\sysinfo folders before continuing. It also reminds you that you must have removed any user-defined triggers, indexes or statistics that you have added to iProcess Engine schema tables before continuing (see page 69). Click Yes when you are ready to continue with the upgrade. c. The Configuration dialog is displayed. See page 82. TIBCO iProcess Engine (Oracle) for Windows Installation The Choose Destination Location Dialog 81 | The Choose Destination Location Dialog The Choose Destination Location dialog allows you to select the directory where you want to install the iProcess Engine. To complete this dialog: 1. Specify the Destination Folder where you want to install the iProcess Engine files. (This folder is referred to as the iProcess system directory or SWDIR.) Make sure that the SWDIR full pathname does not exceed 64 characters, otherwise the installation will fail with an error. See page 178. If you are installing the iProcess Engine on a computer that is part of a Windows cluster, SWDIR must be located on a cluster storage device that is accessible to all nodes in the cluster. Click Next. 2. If you are doing: — a Basic installation, the Group and User Configuration dialog is displayed. See page 88. — a Custom installation, the Configuration dialog is displayed. See page 82. TIBCO iProcess Engine (Oracle) for Windows Installation 82 | Chapter 3 Running the Setup Installation Program The Configuration Dialog The Configuration dialog allows you to define a number of basic iProcess Engine configuration options. To complete this dialog: 1. Complete the following items as required. Item Description Licensee Specify the descriptive name used to identify this iProcess Engine. The name must be between 4 and 32 characters long. JMX port number The iProcess Engine includes a Java Management Extensions (JMX) engine that enables TIBCO Business Studio™ to deploy procedures to the iProcess Engine. Specify the port number on which the JMX engine should run. The port number must be: • an integer value between 0 and 65535. • unique across all iProcess Engine installations on this computer. If you do not specify a number, the default port 10025 will be used. In Business Studio, a Deployment Server can use this port number to deploy processes to this iProcess Engine (using the JMX Remote Method Invocation (RMI) interface). See the TIBCO Business Studio Implementation guide for more information. The port number will be written to the SWJMXConfig.port entry in the SWDIR\etc\swjmx.properties file, and can be changed after installation if desired. See the TIBCO iProcess Engine Administrator’s Guide for more information. TIBCO iProcess Engine (Oracle) for Windows Installation The Configuration Dialog 83 | Item Description Client-Server RPC port number Specify the RPC service number that iProcess Workspace (Windows) clients use to communicate with this iProcess Engine. If you want to change the default RPC port number, either select a new value from the drop-down list or click the browse button ( ). A dialog is displayed in which you can enter specific RPC port numbers. Note that: Process Sentinels service startup • You cannot change this value if you are upgrading. • 391875 to 391879 is the reserved iProcess Engine client-server RPC program number range. Using a number in this range should prevent any clash with other applications using the same number, provided that other applications also use legitimate RPC numbers. • The RPC service number must be unique across all iProcess Engine installations on this computer. Select the startup option you want to use for the iProcess NodeName Process Sentinels service: • Automatic - The Process Sentinels service starts automatically when the computer starts up. • Manual - You must manually start the Process Sentinels service, using either Control Panel > Services or the SWDIR\bin\swstart command. Note: If you are installing on Windows Vista and User Account Control is turned on, you must elevate the window issuing this swstart command to run it as an Administrator. • Disabled - You cannot start the Process Sentinels service. You can change this setting after installation by using the Services Console in Windows. TIBCO iProcess Engine (Oracle) for Windows Installation 84 | Chapter 3 Running the Setup Installation Program Item Description Auto start processes on service startup Select this check box if you want the iProcess Engine processes to automatically start after the Process Sentinels have started. Clear this check box to disable automatic process startup. If you do this, you will need to manually start the iProcess Engine processes after the Process Sentinels have started. Note that: Enable Case Prediction • You must select this check-box if you are installing to a Microsoft Windows Cluster. • Selecting this check box sets the value of the iProcess Engine PM_AUTO_BOOT process attribute to 1 (enabled). Clearing it sets it to 0 (disabled). See the TIBCO iProcess Engine Administrator’s Guide for more information about this process attribute. • If you are upgrading, and automatic process startup is currently enabled (PM_AUTO_BOOT=1), you cannot disable it. The check box is disabled. Select this check box to enable the case prediction server process (BGPREDICT). Clear it to disable the process. Note that: • Selecting this check box sets the value of the iProcess Engine ENABLE_CASE_PREDICTION process attribute to 1 (enabled). Clearing it sets it to 0 (disabled). See the TIBCO iProcess Engine Administrator’s Guide for more information about this attribute. • The case prediction server process only affects background case prediction. It has no effect on live case prediction or case simulation. • If you are upgrading, and case prediction is currently enabled (ENABLE_CASE_PREDICTION=1), you cannot disable it. The check box is disabled. For more information about the use of case prediction, see “Using Case Prediction to Forecast Outstanding Work Items” in the TIBCO iProcess Modeler - Advanced Design guide. TIBCO iProcess Engine (Oracle) for Windows Installation The Configuration Dialog 85 | Item Description Enable Case data normalization Select this check box to enable case data normalization. Clear it to disable case data normalization. (If you are upgrading, and case data normalization is currently enabled, you cannot disable it. The check box is disabled.) Case data normalization is a feature used to make case data searching more efficient and therefore faster. It uses the field_value_N column in the case_data table in the iProcess Engine database. This column provides a “normalized” value of the value in the field_value column, allowing the database to do simple string comparisons, instead of having to do type conversions. Note that: • If you intend to use iProcess Objects to perform case data searches, TIBCO strongly recommends that you enable case data normalization. If you do not do this, you will be able to view and start procedures, but you will not be able to view the cases until you normalize the data. • Selecting this check box sets the value of the iProcess Engine NORMALISE_CASE_DATA process attribute to 1 (enabled). Clearing it sets it to 0 (disabled). See the TIBCO iProcess Engine Administrator’s Guide for more information about this attribute. • You can enable or disable case data normalization after installation by using the Case Data Normalization Utility. See "Administering Case Data Normalization" in the TIBCO iProcess Engine Administrator's Guide for more information about this utility. If you are upgrading, you should also note the following before choosing to enable case data normalization: • Setup will need to populate the field_value_N column for every row in the case_data table, using the values from the field_value column. This can significantly impact the duration of the upgrade process if there are large numbers of cases on the system. See page 10 for more information. • If you are upgrading from a Version 9 Process Engine, the size of the case_data table will increase significantly. See page 30 for more information. TIBCO iProcess Engine (Oracle) for Windows Installation 86 | Chapter 3 Running the Setup Installation Program 2. Click Next. If you are installing the iProcess Engine on a computer which is: — a member of a domain, the Operating System Users Location dialog is displayed - see page 87. — a stand-alone machine, the Group and User Configuration dialog is displayed - see page 88. TIBCO iProcess Engine (Oracle) for Windows Installation The Operating System Users Location Dialog 87 | The Operating System Users Location Dialog The Operating System Users Location dialog allows you to specify the location of the Windows user account that you want to use to administer the iProcess Engine (the IPEADMIN user - see page 6). You will choose the actual account to use from this location in the next dialog. The account must already exist - Setup cannot create it. If you need to create the Windows user account that you want to use, you should do so now. To complete this dialog: 1. Choose the location of the IPEADMIN user account from the following options: Option IPEADMIN account must already exist on... Local machine accounts the computer where you are installing the iProcess Engine. Domain accounts the domain where you are installing the iProcess Engine. Trusted domain accounts the domain where the IPEINSTALL user’s account is located (see page 5). 2. Click Next. The Group & User Configuration Dialog is displayed (see page 88). TIBCO do not recommend installing the iProcess Engine on a domain controller. TIBCO iProcess Engine (Oracle) for Windows Installation 88 | Chapter 3 Running the Setup Installation Program The Group & User Configuration Dialog The Group & User Configuration dialog allows you to specify iProcess Engine group names, the IPEADMIN and IPESERVICE user names and passwords, and whether iProcess Workspace users need a password to log in. To complete this dialog: 1. Complete the following items: Item Description iPE Administrators group Specify the local Windows group (i.e. a group on the computer where you are installing the iProcess Engine) that will be used to contain iProcess Engine administrators. You can either select an existing group from the drop-down list or type in a new group name. Setup will create this group for you. You cannot change this value if you are upgrading or performing a Basic installation. iPE Users group Specify the local Windows group (i.e. a group on the computer where you are installing the iProcess Engine) that will be used to contain iProcess Engine users. You can either select an existing group from the drop-down list or type in a new group name. Setup will create this group for you. You cannot change this value if you are upgrading or performing a Basic installation. TIBCO iProcess Engine (Oracle) for Windows Installation The Group & User Configuration Dialog 89 | Item Description iPE Administrator account name Select the Windows account that you want to use to administer the iProcess Engine (the IPEADMIN user - see page 6). The default account shown is: • if you are installing a new iProcess Engine - the account you are using to run Setup (i.e. the IPEINSTALL user). • if you are upgrading an existing installation - the existing IPEADMIN account (as defined on line 3 of the SWDIR\swdefs file). If you are performing: • a Basic installation, you cannot change the default account shown. If you do not want to use this account as the IPEADMIN account, you must Cancel the installation and re-run Setup using the account that you do want to use as the IPEADMIN account. • a Custom installation, you can either: — type in the name of the Windows account you want to use directly. — select the Select account from list box to populate the field with a drop-down list of user accounts that are available from the location you specified in the Operating System Users Location dialog. Note: If you have a large number of Windows operating system users across a domain and trusted domain(s), this can take a long time. To avoid this, type in the name of the Windows account you want to use directly. If the user account you want to use is not listed, click Back to return to the Operating System Users Location dialog, and either select a different location or create the user account. iPE Administrator account password Enter the password for the selected IPEADMIN user. Redirect work items from old Administrator queue This check box is only displayed if you are upgrading, and is only enabled if you have selected a different IPEADMIN user. Select this check box if you want any outstanding work items in the work queue belonging to the original IPEADMIN user to be redirected to the work queue of the new IPEADMIN user. Clear this check box if you want any outstanding work items belonging to the original IPEADMIN user to be left in their work queue. TIBCO iProcess Engine (Oracle) for Windows Installation 90 | Chapter 3 Running the Setup Installation Program Item Description Use separate account for iPE Services This check box is only enabled if you are performing a Custom installation. Select this check box if you want to use different Windows accounts for the IPESERVICE and IPEADMIN users (see page 6). Clear this check box if you want to use the same Windows account for the IPESERVICE user and the IPEADMIN user. This is the default option (which will also be used if you are performing a Basic installation). iPE Services account name This field is only enabled if you are performing a Custom installation. Select the account that you want to use as the IPESERVICE user (see page 6). This user runs the iProcess NodeName Process Sentinels service and the Staffware Events COM+ application. The default account shown is: • if you are installing a new iProcess Engine - the account you are using to run Setup (i.e. the IPEINSTALL user). • if you are upgrading an existing installation - the existing IPEADMIN account (as defined on line 3 of the SWDIR\swdefs file). The drop-down list is populated with the list of user accounts that are available from the location you specified in the Operating System Users Location dialog. If the user account you want to use is not listed, click Back to return to the Operating System Users Location dialog, and either select a different location or create the user account. iPE Services account password Users are required to login with a password This field is only enabled if you are performing a Custom installation. Enter the password for the selected iPE Services account name. Select this check box if you require iProcess Workspace users to supply a password to log in to this iProcess Engine. Clear this check box if you want to allow iProcess Workspace users to be able to log in to this iProcess Engine without a password. You cannot change this value if you are performing a Basic installation. — Click Next. The Database Details dialog is displayed - see page 91. TIBCO iProcess Engine (Oracle) for Windows Installation The Database Details Dialog 91 | The Database Details Dialog The Database Details dialog allows you to define the details of the Oracle database that the iProcess Engine will connect to . To complete this dialog: 1. Complete the following items: Item Description Oracle database service (TNS) name Specify the service name of the Oracle database in which you want to create the iProcess Engine schema. This name must be 32 characters or less. If you are using a direct connection (to the default database hosted on the computer where you are installing the iProcess Engine - see page 24), you can leave this field blank. TIBCO strongly recommends the use of an Oracle TAF-enabled service name to provide 24*7 resilient operation. If you are deploying the iProcess Engine for user acceptance testing (UAT) or to a production environment, you must enable TAF (see page 61). You cannot change this value if you are upgrading. TIBCO iProcess Engine (Oracle) for Windows Installation 92 | Chapter 3 Running the Setup Installation Program Item Description You have DBA privileges This check box is only displayed if you are upgrading. When you click Next from this dialog, Setup will perform a number of checks on your Oracle configuration. It automatically checks the following: • NLS_LANG value (see page 65). • UNDO tablespace (see page 68). However, it requires DBA-level access to be able to check the following items: • TAF (see page 61) • OPEN_CURSORS value (see page 63) • Advanced Queuing configuration. Select this check box if you have the name and password of an Oracle DBA. Clear this check box if you do not have the name and password of an Oracle DBA. Setup will not be able to check the TAF, OPEN_CURSORS and Advance Queuing configuration, so you should check these items manually before proceeding. Database Admin Username Specify the name of the Oracle user that the iProcess Engine should use when it needs to connect to the database as a database administrator (DBA). This must be an account which has the necessary permissions to create tables and users i.e. either with the DBA role assigned or with access to the Oracle Data Dictionary. Database Admin Password Specify the password for the Oracle DBA user. Current Background user Specify the name of the Oracle user that will own the iProcess Engine schema. (Setup will create this user for you if it does not already exist.) This name will also be used as the name of the iProcess Engine schema. Click Change if you want to use a different user to the one shown (see below). You cannot change this value if you are upgrading. TIBCO iProcess Engine (Oracle) for Windows Installation The Database Details Dialog 93 | Item Description Current Foreground user Specify the name of the Oracle user that the iProcess Engine should use for REFERENCES, SELECT, DELETE, and Update accesses to the iProcess Engine schema. (Setup will create this user for you if it does not already exist.) Click Change if you want to use a different user to the one shown (see below). You cannot change this value if you are upgrading. Current Tablespace Specify the name of the Oracle data tablespace that the iProcess Engine schema will be created in. (Setup will create this tablespace for you if it does not already exist.) Click Change if you want to use a different tablespace to the one shown (see below). You cannot change this value if you are upgrading. Support unicode encoding Leave this checkbox selected if you want the iProcess database to support unicode (UTF-8) encoding. Click to deselect it if you do not want the database to support unicode encoding. If you are installing a slave server make sure that you enter exactly the same information in this dialog as you did for the master server. 2. If you want to change the current Background user, Foreground user or Tablespace, click Change. The Database Users dialog is displayed. a.If you want to change the name of the Oracle Background user or Foreground user, enter the desired Username and the associated Password and Password Confirmation. b.If you want to change the name of the data tablespace, enter the desired Tablespace name (up to the Oracle limit of 30 characters). c.Click OK to return to the Database Details dialog. 3. Click Next. TIBCO iProcess Engine (Oracle) for Windows Installation 94 | Chapter 3 Running the Setup Installation Program 4. If you are installing a slave server, a dialog is displayed warning you that the database tables already exist, and asking you to confirm that you want to install a slave server: — If you want to install a slave server, click Yes. The Select Components to Configure dialog is displayed - see page 95. — If you do not want to install a slave server, click No to return to the Database Details dialog. 5. Setup now tries to connect to the Oracle database using your specified settings, performs a number of checks against your Oracle configuration (see page 92), and creates the Oracle Foreground user and Background user if they do not already exist. 6. The Select TableSizes Profile dialog is displayed. Database ’staffw_nod3’ does not exist. Do you want to create it? User ’swpro3’ does not exist. Do you want to create it? 7. The TIBCO Software Installation and Configuration dialog is displayed. TIBCO iProcess Engine (Oracle) for Windows Installation The Select Components to Configure Dialog 95 | The Select Components to Configure Dialog The Select Components to Configure dialog allows you to choose whether you wish to install, enable or configure various optional iProcess Engine components. To complete this dialog: 1. Complete the following items: Item Description Upgrade NobleNet Portmapper This check box is only enabled if Setup detects that the NobleNet Portmapper service is installed on your system: • Select this check box if you want to upgrade this service. The upgrade will replace the existing service with a new version with the name NobleNet Portmapper for TCP. TIBCO advise you to perform this upgrade, unless you have other services on your computer which have a hardcoded dependency on the NobleNet Portmapper service. • Register EAICOM Server Plug-in Clear this check box if you do not want to upgrade the NobleNet Portmapper service. Select this check box to enable the TIBCO iProcess COM Server Plug-in. TIBCO recommend that you do this only if you need to use this plug-in, and if you have ensured that your iProcess environment fully supports distributed transactions. See page 9 for more information. Clear the check box to disable this plug-in. TIBCO iProcess Engine (Oracle) for Windows Installation 96 | Chapter 3 Running the Setup Installation Program Item Description Configure iProcess Email Server Plug-in Select this check box if you want to configure SMTP server parameters for the TIBCO iProcess EMail Server Plug-in as part of the installation. You will be able to configure these parameters in a later installation dialog - see page 101. You cannot change this setting if you are upgrading from Version 10.5 or later, or from an earlier version that already has the TIBCO iProcess EMail Server Plug-in installed. The check box is disabled. Alternatively, you can configure SMTP server parameters after you have installed the iProcess Engine. (See the TIBCO iProcess Email Plug-in User’s Guide for more information.) Clear this check box if you want to do this. Install iProcess ‘Web Server’ Service Select this check box if you want to install the iProcess nodename Web Server service. You should install this service if you want to use the iProcess Server Manager. The iProcess Server Manager is a JSP web client application that you can use to start, stop, restart and pause iProcess Engine server processes. It utilizes TIBCO Hawk and TIBCO Rendezvous (see page 17) to provide a graphical view of the iProcess Engine server processes on a machine or a node cluster. You will need to specify the location of the TIBCO Hawk and TIBCO Rendezvous applications in a later dialog - see page 103. Alternatively, you can use the SWDIR\bin\smstart.bat file to install this service after you have installed the iProcess Engine. (See "Using the iProcess Server Manager to Administer Server Processes" in the TIBCO iProcess Engine Administrator’s Guide for more information.) Clear this check box if you want to do this, or if you do not want to install this service. TIBCO iProcess Engine (Oracle) for Windows Installation The Select Components to Configure Dialog 97 | Item Description Enable IAP Select this check box to enable activity publishing (both IAPJMS and Work Queue Delta publishing). Clear this check box to disable it. If you are upgrading from Version 10.3 or later you cannot change this setting. The check box is disabled. If activity publishing is enabled, activity information about auditable objects (for example, procedures and steps) can be published to an external application. (The BG process publishes monitored activities to the IAPJMS process.) This enables real-time monitoring of auditable objects so that mission critical or important business events can be easily monitored. Similarly, details of a work item are provided whenever the work item changes on a queue that the subscribing application is subscribed to. Note that: • If you enable activity publishing on the master server, you must also enable it on each slave server. • Selecting this check box sets the value of the iProcess Engine IAPJMS_PUBLISH process attribute to 1 (enabled). Clearing it sets it to 0 (disabled). See the TIBCO iProcess Engine Administrator’s Guide for more information about this process attribute. Enabling activity publishing does not result in activities being automatically published by the iProcess Engine. To get the iProcess Engine to actually monitor and publish events, you must also: • configure the activities and events that you want to monitor and publish. See "Configuring Activity Monitoring" in the TIBCO iProcess Modeler - Integration Techniques guide for more information about how to do this. • configure how the iProcess Engine will handle and publish monitored events. See "Administering Activity Monitoring" in the TIBCO iProcess Engine Administrator’s Guide for more information about how to do this. TIBCO iProcess Engine (Oracle) for Windows Installation 98 | Chapter 3 Running the Setup Installation Program Item Description Use Cluster Network Name Select this check box if you want to install the iProcess Engine to a virtual server in a Microsoft Windows cluster. (The indicated Microsoft Windows cluster Network Name will be written to the iProcess Engine database node_cluster table at the end of the installation process.) You must do this if you wish to run the iProcess Engine in an interference-free failover configuration on a Microsoft Windows cluster. Clear this check box if you want to install the iProcess Engine on the physical computer instead. Note that: Enable iProcess Objects Server • This check box is only displayed if a Microsoft Windows cluster Network Name can be found for the machine on which the installation is being performed. The Cluster Network Name is also displayed for information. • If you are upgrading from Version 10.5 or later you cannot change this setting. The check box is disabled. • You can update the node_cluster table with a Microsoft Windows cluster Network Name after installation if you prefer - see page 126 for more information. • You will need to perform some additional post-installation tasks to configure the iProcess Engine to run in a cluster. See page 126 for more information. Select this check box if you want to enable the iProcess Objects Server process (SPO). Clear it to disable the process. The iProcess Objects Server receives requests for services or data from TIBCO iProcess Objects (COM, Java, or C++) or TIBCO iProcess Server Objects (Java or .NET). The iProcess Objects Server processes the request, then makes the appropriate call to an iProcess Engine to initiate the desired service or obtain the desired information. For more information, see the TIBCO iProcess Objects Server Administrator’s Guide. TIBCO iProcess Engine (Oracle) for Windows Installation The Select Components to Configure Dialog 99 | Item Description Configure iProcess Objects Server Select this check box if you want to run the iProcess Objects Server Configuration Utility later in the installation process (see page 110). This utility allows you to set configuration parameters for the iProcess Objects Server. Clear this check box if you do not want to run the configuration utility. For information about the parameters available in this utility, see the TIBCO iProcess Objects Programmer’s Guide or TIBCO iProcess Objects Server Administrator’s Guide Note: If you are installing on Windows Vista and User Account Control is turned on, you cannot run the iProcess Objects Server Configuration Utility during installation. In that case, clear this check box and run the configuration utility separately after installation. You must then run the configuration utility from the bin directory and elevate the command to run it as an Administrator. (You cannot elevate the utility if you try to run it from Control Panel.) See Configure the iProcess Objects Server and iProcess Objects Director on page 123 Enable iProcess Objects Director Select this check box if you want to enable the iProcess Objects Director process (DIRECTOR). The iProcess Objects Director is a standalone program that maintains a list of iProcess Objects Servers that are configured in a node cluster. When a client needs access to an iProcess Objects Server, it first establishes a connection to the iProcess Objects Director. The iProcess Objects Director then decides, based on a “pick method”, which iProcess Objects Server the client should connect to. For more information, see the TIBCO iProcess Objects Director Administrator’s Guide. TIBCO iProcess Engine (Oracle) for Windows Installation 100 | Chapter 3 Running the Setup Installation Program 2. Click Next. The next dialog that is displayed depends on the options you have chosen in this dialog. If you selected: — Configure iProcess Email Server Plug-in, the SMTP Server Parameters dialog is displayed - see page 101. — Install iProcess ‘Web Server’ Service, the TIBCO iProcess Web Server Configuration dialog is displayed - see page 103. — Enable IAP, the Default Java Message Service dialog is displayed - see page 105. Otherwise, the Start Copying Files dialog is displayed - see page 108. TIBCO iProcess Engine (Oracle) for Windows Installation The SMTP Server Parameters Dialog 101 | The SMTP Server Parameters Dialog The SMTP Server Parameters dialog allows you to define the parameters that the iProcess EMail Server Plug-in will use to connect to an SMTP server. The values you specify in this dialog are written as parameters to the SWDIR\libs\eai_mail.cfg file. For more information about these parameters, see the TIBCO iProcess Email Plug-in User’s Guide. If you are upgrading a system that already has the iProcess EMail Server Plug-in installed, the default values shown in this dialog are taken from the existing SWDIR\libs\eai_mail.cfg file. To complete this dialog: 1. Complete the following items: Item Description Mail From Specify the default email address that you want to use to send EAI Mail messages from. Host Specify the name or IP address of the machine hosting the SMTP server that you want to use. Port Specify the TCP port number on which the SMTP server is running. Test Connection Click this button if you want to test the connection to the SMTP server using the specified Host and Port parameters. Specify Mail Message Headers Select this check box if you want to specify header information to be used with all EAI Mail messages. (You will be able to enter this information in the next dialog.) 2. Click Next. If you selected Specify Mail Message Headers, a second part of the SMTP Server Parameters dialog is displayed, in which you can enter the information you want to use as a mail message header. Click Next when you have finished. 3. Click Next. The SMTP Backup Servers dialog is displayed - see The SMTP Backup Servers Dialog on page 102. TIBCO iProcess Engine (Oracle) for Windows Installation 102 | Chapter 3 Running the Setup Installation Program The SMTP Backup Servers Dialog The SMTP Backup Servers dialog allows you to define parameters that the iProcess EMail Server Plug-in will use to locate backup servers in case of a failure in the primary SMTP server. See the TIBCO iProcess Email Plug-in User’s Guide for more information on backup servers. The values you specify in this dialog are written as parameters to the SWDIR\libs\eai_mail.cfg file. For more information about these parameters, see the TIBCO iProcess Email Plug-in User’s Guide. To complete this dialog: 1. Complete the following items: Item Description Backup Host For each backup server in turn, you can specify the machine name or the IP address of the machine hosting the backup SMTP server. There can be as many Backup Host entries as there are SMTP servers available for failover. Backup Port The port number on which the preceding Backup Host is running. There must be one Backup Port entry for each Backup Host server. Retry Count Specify how many times the plug-in should use a backup server before retrying the primary host. Enter a non-zero numeric value. The default is 50. Note that: • If a negative value is entered, it is interpreted as 50. • If zero or a non-numeric value is entered, the configuration of backup servers has no effect and the plug-in reverts to the primary host. If a successful connection is made on retrying the primary host, the plug-in reverts to using that host. If not, the plug-in continues with the backup server that is currently in use. 2. Click Next. The next dialog that is displayed depends on the options that you chose in the Select Components to Configure dialog. If you selected: — Install iProcess ‘Web Server’ Service, the TIBCO iProcess Web Server Configuration dialog is displayed - see page 103. — Enable IAP, the Default Java Message Service dialog is displayed - see page 105. Otherwise, the Start Copying Files dialog is displayed - see page 108. TIBCO iProcess Engine (Oracle) for Windows Installation The TIBCO iProcess Web Server Configuration Dialog 103 | The TIBCO iProcess Web Server Configuration Dialog The TIBCO iProcess Web Server Configuration dialog allows you to specify the location of the TIBCO Hawk and TIBCO Rendezvous applications, which are used by the iProcess nodename Web Server service. To complete this dialog: 1. Complete the following items: Item Description TIBCO Hawk directory Enter the full pathname of the directory where the TIBCO Hawk software is installed, or click the browse button ( ). The Locate TIBCO Hawk dialog is displayed, which allows you to browse for the software. Select the appropriate directory, then click OK. TIBCO Rendezvous directory Enter the full pathname of the directory where the TIBCO Rendezvous software is installed, or click the browse button ( ). The Locate TIBCO Rendezvous dialog is displayed, which allows you to browse for the software. Select the appropriate directory, then click OK. Enable the Webdav server for write access Select this check box if you want write access to WebDav enabled on the Apache Tomcat application server that is installed with the iProcess Engine. Selecting this option enables you to easily deploy your TIBCO Forms using TIBCO Business Studio. If you want to use TIBCO Forms and do not want to enable this option, then you must install the forms manually on this or your own web server. There are security issues around enabling WebDav and if you select this option, the following warning message is displayed: You have enabled write access to WebDAV, which allows you to make your own deployed forms for the browser client. This may cause your server potential security issues and/or cause your deployed forms for the browser client to fail. TIBCO Software Inc. is not responsible for these or any other consequences caused by your use of the write access to WebDAV. If you do not want to use TIBCO Forms then TIBCO recommend that you do not enable write access to WebDav. See the documentation supplied with the Apache Tomcat Application Server for more information about security. 2. Click Next. The next dialog that is displayed depends on the options that you chose in the Select Components to Configure dialog. TIBCO iProcess Engine (Oracle) for Windows Installation 104 | Chapter 3 Running the Setup Installation Program If you selected Enable IAP, the Default Java Message Service dialog is displayed - see page 105. Otherwise, the Start Copying Files dialog is displayed - see page 108. TIBCO iProcess Engine (Oracle) for Windows Installation The Default Java Message Service Dialog 105 | The Default Java Message Service Dialog The Default Java Message Service dialog, along with two subsequent dialogs, allows you to configure the necessary Java Message Service (JMS) parameters to enable Activity Monitoring and Work Queue Delta publication on the iProcess Engine. For more information about the use of these parameters, see "Administering Activity Monitoring" in the TIBCO iProcess Engine Administrator’s Guide. To complete this sequence of dialogs: 1. Select the JMS provider that the iProcess Engine should publish messages to. If you want to use JBoss 4.0.0 you should select JBoss. If you want to use any other version of JBoss or JBoss Messaging you should select Other instead. Similarly, if you want to use BEA WebLogic Server Version 8 you should select BEA WebLogic Server. If you want to use any other version of WebLogic Server you should select Other instead. 2. 3. Click Next. The Jar Files for JMS Connectivity dialog is displayed, with appropriate default entries for the selected JMS provider. TIBCO iProcess Engine (Oracle) for Windows Installation 106 | Chapter 3 Running the Setup Installation Program 4. Complete the following items on this dialog: Item Description Base If your chosen JMS provider is: • IBM Websphere 6.x: Specify the full path of the directory containing the IBM Client for JMS on J2SE with WebSphere Application Server. (The iProcess Engine IAPJMS process must use this client to communicate with the WebSphere 6.x Application Server.) If you do not already have this client installed on this computer, TIBCO recommend that you use the default location (SWDIR\jmsclient). You must then install this client into the specified directory after you have installed the iProcess Engine. See page 133 for more information about how to do this. • anything else: Specify the full path (or comma-separated paths) of the .jar files required by this JMS provider. When specifying the path, make sure that you use the forward slash character (’/’) as the path separator rather than the backslash character (’\’). For example, specify "e:/tibco/ems/clients/java/jms.jar" not "e:\tibco\ems\clients\java\jms.jar". Setup writes this value to the IAPJMS configuration file SWDIR\etc\iapjms_classpath.properties. Additional Specify the full path (or comma-separated paths) of any additional .jar files that are required for your JMS configuration. When specifying the path, make sure that you use the forward slash character (’/’) as the path separator rather than the backslash character (’\’). Setup writes this value to the IAPJMS configuration file SWDIR\etc\iapjms_classpath.properties. If you are using a Microsoft Windows Cluster, the Base and Additional paths must be accessible to every physical machine in the cluster. 5. Click Next. The IAPJMS Properties dialog is displayed, with appropriate default entries for the selected JMS provider. TIBCO iProcess Engine (Oracle) for Windows Installation The Default Java Message Service Dialog 107 | 6. Complete the following items on this dialog: Item Description Context Specify the name of the context factory that produces context instances for this JMS Provider. Setup writes this value to the IAPJMSConnect.InitialContextFactory property in the IAPJMS configuration file SWDIR\etc\iapjms.properties. URL Specify the URL that the iProcess Engine uses to connect to this JMS Provider. Setup writes this value to the IAPJMSConnect.InitialURL property in the IAPJMS configuration file SWDIR\etc\iapjms.properties. Connection Specify the name of the object that the iProcess Engine uses to create a connection to this JMS Provider. Setup writes this value to the IAPJMSConnect.TopicConnectionFactory property in the IAPJMS configuration file SWDIR\etc\iapjms.properties. 7. Click Next. The Start Copying Files dialog is displayed - see page 108. TIBCO iProcess Engine (Oracle) for Windows Installation 108 | Chapter 3 Running the Setup Installation Program Completing the Installation To finish the installation process, complete the following steps: 1. Setup now checks if you are installing a master server or a slave server. If you are installing a slave server (that is, you have chosen a nodename that already exists as an entry in the node_cluster table in your specified database), a dialog containing the following message is displayed: Do you want to add this node as another machine in this cluster? a. Click Yes if you want to install this iProcess Engine as a slave server on the NodeName node. The Start Copying Files dialog is displayed - see step 2 below. Click No if you do not want to do this. The following warning is displayed: WARNING - The iProcess tables already exist in the database. Do you wish to re-create the iProcess database tables? (Note: This will result in any existing data held in the database tables being deleted.) Click: — Yes if you want to install this iProcess Engine as the master server on the NodeName node. Selecting this option overwrites all the tables in the database. — No if you do not want to do this. Step Back through Setup’s dialogs and either choose a different nodename (see page 81) that does not already exist in the specified database, or choose a different database (see page 91). 2. The Start Copying Files dialog is displayed, from which you can review your installation options. If you want to change any of your choices, click Back to step back through the dialogs to the appropriate point. When you are satisfied with your choices, click Next. TIBCO iProcess Engine (Oracle) for Windows Installation Performing the Installation 109 | Performing the Installation Setup now performs the following tasks to install the iProcess Engine using your specified options: 1. If you are installing or upgrading a master server, Setup runs one or more SQL scripts to initialize or upgrade the iProcess Engine database tables. The Running Database Scripts dialog is displayed, which shows the progress of this operation. Setup logs the progress of each installation script to the following file: SWDIR\logs\ScriptName.sql_UserName_TimeStamp.log where: — ScriptName is the name of the installation or upgrade script. — UserName is the name of the account being used to run Setup (i.e. the IPEINSTALL user). — TimeStamp is the time that the log file was created, in the form DDMMYYYY_HHMM. If Setup encounters an error when running a script, it displays the details of the error in the Script Results section of the dialog, and also displays an error message dialog. If you are: — installing a new iProcess Engine, you cannot continue with the installation until this error is corrected. See page 173 for more information. — upgrading an existing version i10, 10 or 11 iProcess Engine, you can choose to either continue with or exit from the upgrade. See page 174 for more information. — upgrading an existing version 9 Process Engine, you can choose to either continue with or exit from the upgrade. However, TIBCO strongly recommend that you contact TIBCO Support for further assistance before continuing. See page 174 for more information. 2. Setup displays a number of progress meters while it performs the necessary installation tasks. As one of these tasks, Setup registers the following iProcess Engine server plug-ins: — TIBCO iProcess COM Server Plug-in — TIBCO iProcess Database Server Plug-in (provides functionality previously provided by the TIBCO iProcess™ Oracle Server Plug-in) — TIBCO iProcess EMail Server Plug-in TIBCO iProcess Engine (Oracle) for Windows Installation 110 | Chapter 3 Running the Setup Installation Program — TIBCO iProcess Script Server Plug-in Setup also writes the port numbers used by the iProcess Engine watcher and worker process sentinels to the %systemroot%\system32\drivers\etc\services file. The entries are: nodename_worker nnn/tcp nodename_watcher mmm/tcp where: — node_name is the nodename of this iProcess Engine. — nnn and mmm are unique numbers in the services file depending on what port numbers are already being used on the server. For example: staffw_nod1_watcher 1500/tcp staffw_nod1_worker 1501/tcp 3. When Setup has completed its installation tasks, the Finished dialog is displayed. Click OK. 4. If you checked the Configure iProcess Objects Server box in the Select Components to Configure dialog (see page 95), the iProcess Objects Server Configuration Utility is displayed: This utility is not displayed if you are installing on Windows Vista and User Account Control is turned on (see Configure iProcess Objects Server on page 99). This is because if User Account Control is turned on the settings are not saved in the registry. a. Set your desired configuration parameters for the iProcess Objects Server. See the TIBCO iProcess Objects Programmer’s Guide or TIBCO iProcess Objects Server Administrator’s Guide for more information about the available parameters. b. If you are installing to a Microsoft Windows Cluster, you must specify that the iProcess Objects Server uses a static port (using the TCP tab). 5. Click OK to close the Server Configuration Utility. Setup performs a number of checks to validate that the installation has succeeded. If it encounters an error it displays a suitable error message (see page 177). TIBCO iProcess Engine (Oracle) for Windows Installation Performing the Installation 111 | The Setup Complete dialog is displayed. Depending on the tasks that Setup has had to perform, you may now be prompted to reboot your computer. You can choose to reboot immediately or later, but you must reboot your computer before running the iProcess Engine for the first time. 6. Click Finish. The iProcess Engine is now installed. 7. Finally, if you were upgrading an existing iProcess Engine, you should now check the upgrade log files (SWDIR\logs\upgrFromtoTo.log) to confirm that no errors have occurred. If any errors are reported in these log files, you may need to take action to ensure the system is fully functional. For example, a missing packfile is not considered to be a fatal error, but unless the work item is resent, it will not appear in the upgraded system. See page 179 for more information. TIBCO iProcess Engine (Oracle) for Windows Installation 112 | Chapter 3 Running the Setup Installation Program TIBCO iProcess Engine (Oracle) for Windows Installation | 113 Chapter 4 Carrying Out Post-Installation Tasks This chapter describes the tasks you need to carry out after you have installed the iProcess Engine using the instructions in Chapter 3 on page 73. Topics • Post-Installation Tasks Checklist, page 114 TIBCO iProcess Engine (Oracle) for Windows Installation 114 | Chapter 4 Carrying Out Post-Installation Tasks Post-Installation Tasks Checklist The following table provides a checklist of the different tasks that you must or may need to do before starting the iProcess Engine. The table shows: • whether the iProcess installer or DBA user needs to perform the task (see page 4). • the task’s status according to whether you are installing a new iProcess Engine or upgrading an existing one. This is either: — Required - You must perform this task before you start the iProcess Engine. — Check - You may need to perform this task before you start the iProcess Engine, depending on your installation scenario. — Optional - You may wish to perform this task before you start the iProcess Engine, but it is not essential. Consult the indicated section for more detailed information about a particular task. You may want to print this table as a useful quick reference when carrying out the post-installation tasks. The Done? column in the table provides a place for you to tick off tasks that have been done. TIBCO iProcess Engine (Oracle) for Windows Installation Post-Installation Tasks Checklist 115 | To be done by Install Status Upgrade Status See iProcess installer n/a Required (from V9 only) page 121 2. Re-implement Changes to Upgraded Configuration Files iProcess installer n/a Optional page 121 3. Configure Firewall Port Ranges on Slave Servers iProcess installer Check Check page 122 4. Configure the iProcess Objects Server and iProcess Objects Director iProcess installer Optional Optional page 123 5. Enable COM+ Network Access iProcess installer Check Check page 125 6. Configure the Microsoft Windows Cluster iProcess installer Check Check page 126 7. Enable Oracle Function-Based Indexes DBA Check Check page 130 8. Grant Resource Privileges to the iProcess Engine Database Users DBA n/a Required (from V9 only) page 130 9. Re-implement Changes to Tomcat Configuration Files iProcess installer n/a Check page 132 10. Install the IBM Client for JMS on J2SE with IBM WebSphere Application Server iProcess installer Check Check page 133 11. Configure IAPJMS Security Settings iProcess installer Optional Optional page 135 12. Configure the Default iProcess Engine Setup iProcess installer Optional Optional page 136 Task 1. Replace Procedures that Contain Automatic Steps and Migrate All Outstanding Cases Done? TIBCO iProcess Engine (Oracle) for Windows Installation 116 | Chapter 4 Carrying Out Post-Installation Tasks Task To be done by Install Status Upgrade Status See 13. Reset LDAP Directory Attribute to iProcess Engine Property Mappings iProcess installer n/a Check page 137 14. Recreate Prediction Data iProcess installer n/a Optional page 139 15. Remove Files That are no Longer Needed iProcess installer n/a Optional page 140 16. Recreate All User-Defined Triggers, Indexes and Statistics on the iProcess Engine Schema Tables DBA n/a Check page 142 17. Update the Domain Group Policy for the "Log on as a Service" Right iProcess installer Check Check page 143 18. Disable or Re-enable Write Access to WebDav iProcess installer Optional Optional page 144 19. Configure JMX Ports to Run Through a Firewall iProcess installer Optional Optional page 145 20. Start the iProcess Engine iProcess installer Optional Optional page 146 TIBCO iProcess Engine (Oracle) for Windows Installation Done? Replace Procedures that Contain Automatic Steps and Migrate All Outstanding Cases 117 | Replace Procedures that Contain Automatic Steps and Migrate All Outstanding Cases Status Description If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Not applicable Upgrading from any Version 9 Process Engine Required Automatic steps are not currently supported in this version of the iProcess Engine. When you upgrade, each procedure on the Version 9.0-o system that contains an Automatic step is given a release status of Incomplete. You must now: 1. replace the procedure with the alternative version that you have developed (as described in Automatic Steps on page 31). 2. migrate all outstanding cases of the procedure (if there are any) to use the new version of the procedure. If a procedure containing Automatic steps is Released and has live cases on the Version 9.0-o system, you MUST NOT start the Version 11.1.3 system until you have migrated all cases of the procedure to use the replacement (EAI/brokers) version. If you start the Version 11.1.3 system before you have done this, any outstanding cases will attempt to run against the original (Automatic steps) version, which is Incomplete. This may result in corruption of the case data for all affected cases. Procedure To replace procedures and migrate cases: 1. Log in as the IPEADMIN user (see page 88). 2. Use the following command to check the version and release status of the upgraded procedure: SWDIR\util\plist -P procname where procname is the procedure name. The release status should be Incomplete. TIBCO iProcess Engine (Oracle) for Windows Installation 118 | Chapter 4 Carrying Out Post-Installation Tasks For example: c:\swserver\staffw_nod1\util>plist -P hiring Procedure:HIRING Version User Status Comment --------------------------------------------------1.1 swadmin INCOMPLETE uorai100_10 3. Use the following command to import your (previously developed) replacement procedure: SWDIR\bin\swutil IMPORT procname where procname is the procedure name, which must be the same as the upgraded procedure. When prompted to do so, choose to import the procedure as a New version, with release status Model. For example: c:\swserver\staffw_nod1\bin>swutil IMPORT hiring Importing a Procedure Checking Procedure 'HIRING': Procedure name HIRING already exists. 'R'ename, 'N'ew version or 'A'lways new version ? n Procedure 'HIRING' currently released Enter new status, 'M'odel ('A' for all) or 'W'ithdrawn ('S' for all) : m Importing Procedure 'HIRING' : Do you want to import another xfr file ? n TIBCO iProcess Engine (Oracle) for Windows Installation Replace Procedures that Contain Automatic Steps and Migrate All Outstanding Cases 119 | 4. Use the SWDIR\util\plist -P command to check the version and release status of the procedure again. There are now two versions. The original (upgraded) version should have release status Withdrawn. The replacement (imported) version should have release status Model, with its minor version number incremented by 1. For example: c:\swserver\staffw_nod1\bin>plist -P hiring Procedure:HIRING Version User Status Comment --------------------------------------------------1.1 swadmin WITHDRAWN uorai100_10 1.2 swadmin MODEL New Version of Procedure Imported 5. Use the following command to release the Model version of the procedure and migrate all existing cases to use it: SWDIR\bin\swutil PROC RELEASE procname version "comment" -M ALL where: — procname is the procedure name. — version is the version number to release. — comment is a descriptive comment. — M specifies that cases are to be migrated immediately by the command, without any interaction with the background process (BG). This parameter is case sensitive. Do NOT use -m, which migrates cases by posting a message to the background process and so requires the iProcess Engine to be running. — ALL specifies that all cases of the procedure are to be migrated. (This parameter is also case sensitive.) For example: c:\swserver\staffw_nod1\bin>swutil PROC RELEASE hiring 1.2 "Migrate Autostep" -M ALL 6. Use the SWDIR\util\plist -P command to check that the release operation succeeded. TIBCO iProcess Engine (Oracle) for Windows Installation 120 | Chapter 4 Carrying Out Post-Installation Tasks The replacement (imported) procedure should now have release status Released, with whatever comment you supplied in the command. For example: c:\swserver\staffw_nod1\util>plist -P hiring Procedure:HIRING Version User Status Comment --------------------------------------------------1.1 swadmin WITHDRAWN uorai100_10 1.2 swadmin RELEASED Migrate Autostep 7. Use the SWDIR\util\plist -cvvv command to check that all cases of the procedure have successfully migrated to the new Released version. For example: c:\swserver\staffw_nod1\util>plist -cvvv hiring CNum CID Sts Case Description Starter yyyy/ddd hh:mm PVer PPrc ------------------------------------------------------------------------1 1 LIVE Case 1 swadmin@swnod001 1.2 r 2 2 LIVE Case 2 swadmin@swnod001 1.2 r 3 3 LIVE Case 3 swadmin@swnod001 1.2 r 4 4 LIVE Case 4 swadmin@swnod001 1.2 r On a production system the output from this command may be extensive as it lists each individual case for the procedure. You may therefore prefer to redirect this output to a file rather than view it on the screen. 8. Check that no entries have been added to the SWDIR\logs\sw_warn or SWDIR\logs\sw_error files. TIBCO iProcess Engine (Oracle) for Windows Installation Re-implement Changes to Upgraded Configuration Files 121 | Re-implement Changes to Upgraded Configuration Files Status Description See Also If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional If you made any changes to the default values in the following files on your original system, you should now manually re-implement any of those changes that you want to keep in the upgraded files: • SWDIR\etc\language.lng\staffico • SWDIR\etc\language.lng\auditusr.mes For more information about the default contents of these files, and how to edit them, please see the following references: For information about... See... SWDIR\etc\language.lng\staffico: “Using the iProcess Engine Configuration Files”, in the TIBCO iProcess Engine Administrator’s Guide SWDIR\etc\language.lng\auditusr.mes “Defining Audit Trail Entries”, in the TIBCO iProcess swutil and swbatch Reference Guide. TIBCO iProcess Engine (Oracle) for Windows Installation 122 | Chapter 4 Carrying Out Post-Installation Tasks Configure Firewall Port Ranges on Slave Servers Status Description If you are... This task is... Installing a new iProcess Engine Required Upgrading from any Version i10, 10 or 11 iProcess Engine Required Upgrading from any Version 9 Process Engine Required From Version 11.1.3 onwards firewall port range configuration data is stored in the port_range database tables, and can be configured by using the SWDIR\util\swadm utility. In pre-10.5.0 iProcess Engine versions, this data was stored in and managed using the SWDIR\etc\staffcfg file. If you are installing or upgrading an iProcess Engine as: Procedure • a slave server in a node-cluster (see page 5), you must now manually configure any required firewall port range data. • a master server or single server, you do not need to do anything. Setup automatically creates the necessary port range configuration data in this case, either using default values (for a new installation), or using the existing values for an upgrade (from the SWDIR\etc\staffcfg file if upgrading from a pre-10.5 version). If you are either: • installing a new slave server, or • upgrading an existing (pre-version 10.5) slave server, you should use the swadm utility to create the necessary port range configuration data for your firewall configuration. See Also See Chapter 9, “Administering Firewall Port Ranges”, in the TIBCO iProcess Engine Administrator’s Guide for more information about using the iProcess Engine with a firewall, and how to use the SWDIR\util\swadm utility to configure firewall port ranges. TIBCO iProcess Engine (Oracle) for Windows Installation Configure the iProcess Objects Server and iProcess Objects Director 123 | Configure the iProcess Objects Server and iProcess Objects Director Status Description Node Cluster Procedure If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional If you chose to enable the iProcess Objects Server and/or iProcess Objects Director during the installation process (see page 95), you can now configure them according to your requirements, should you wish to, before starting the iProcess Engine. The iProcess Objects Server and/or iProcess Objects Director must communicate using the same Client-Server RPC port number (see page 82) used by the node on which the iProcess Engine foreground processes (WIS, WQS, etc.) are running. If they do not match, errors will be written to the iProcess Objects Server and/or iProcess Objects Director log file on startup. To configure the: • iProcess Objects Server, run the iProcess Objects Server Configuration Utility. To start this utility, click Start > Settings > Control Panel > TIBCO iProcess Objects Server. You do not need to run this utility again if you choose to run the iProcess Objects Server Configuration Utility as part of the installation process (see page 95). For more information about this utility, and how to use it, see "Configuring the TIBCO iProcess Objects Server" in the TIBCO iProcess Objects Server Administrator’s Guide. If you are installing on Windows Vista and User Account Control is turned on, you must then run the configuration utility by selecting the SWEntObjSvCfg.exe program file in the SWDIR/bin directory and elevating it to run it as an Administrator. (You cannot elevate the utility if you try to run it from Control Panel.) See Configure iProcess Objects Server on page 99. TIBCO iProcess Engine (Oracle) for Windows Installation 124 | Chapter 4 Carrying Out Post-Installation Tasks • iProcess Objects Director, set the iProcess Engine process attributes that control the iProcess Objects Director to your required values. For more information about these attributes and their possible values, see "Configuring the TIBCO iProcess Objects Director" in the TIBCO iProcess Objects Director Administrator’s Guide. If the iProcess Objects Server and/or iProcess Objects Director are installed on a master or slave server (in a node cluster) which is not running any iProcess Engine foreground processes (WIS, WQS, etc.) 1. Determine the client/server RPC port being used by the node on which the foreground processes are running by looking at line 11 of the SWDIR\swdefs file on that node’s machine. 2. Compare the client/server RPC port specified in the SWDIR\swdefs file of the machine on which you are installing the iProcess Objects Server and iProcess Objects Director with the port number you determined in the previous step. If the RPC numbers match, no further action is required. If they do not match: a. Change the client/server RPC port specified in the SWDIR\swdefs file of the machine on which you are performing the installation so it is the same as on the machine running the foreground processes. b. Change the RPC number in the following registry location on the machine on which you are installing so it matches the number in the SWDIR\swdefs file: RegistryLocation\Staffware plc\Staffware Server\Nodes\MyNode\RPC_CLTSRV where RegistryLocation is either \HKEY_LOCAL_MACHINE\Software, if you are running the iProcess Engine on a 32-bit machine, or \HKEY_LOCAL_MACHINE\Software\Wow6432Node, if you are using a 64-bit machine. TIBCO iProcess Engine (Oracle) for Windows Installation Enable COM+ Network Access 125 | Enable COM+ Network Access Status Description Procedure If you are... This task is... Installing a new iProcess Engine May be required Upgrading from any Version i10, 10 or 11 iProcess Engine May be required Upgrading from any Version 9 Process Engine May be required COM+ network access is disabled by default when you install the iProcess Engine. You must enable it in either of the following circumstances: • the iProcess Engine is installed on Windows Server 2003 and uses the node cluster architecture (see page 5). You must enable COM+ network access on the master server and on each slave server. • the iProcess Engine is installed on a Microsoft Windows Cluster. You must enable COM+ network access on each machine in the cluster. To enable COM+ network access: 1. On the Start menu, point to Control Panel, then select Add or Remove Programs. 2. Click Add/Remove Windows Components. The Windows Components Wizard is displayed. 3. Select Application Server and click Details. 4. Select the check box next to Enable network COM+ access. 5. Click OK. 6. Click Next to complete the Windows Components Wizard. 7. Click Finish to close the wizard. TIBCO iProcess Engine (Oracle) for Windows Installation 126 | Chapter 4 Carrying Out Post-Installation Tasks Configure the Microsoft Windows Cluster Status Description Procedure If you are... This task is... Installing a new iProcess Engine Required if you use a Windows Cluster Upgrading from any Version 10.5 or later iProcess Engine Required if you use a Windows Cluster Upgrading from any pre-Version 10.5 iProcess Engine, or from any Version 9 Process Engine n/a If you are installing the iProcess Engine into a Microsoft Windows Cluster, you must perform some additional tasks to enable the iProcess Engine to operate in the Microsoft Windows Cluster environment. Perform the following steps: 1. If you did not select the Auto start processes on service startup check box when you ran Setup (see page 82), set the iProcess Engine PM_AUTO_BOOT process attribute value to 1 (so that iProcess Engine processes automatically start after the Process Sentinels have started). 2. If you did not select the Use Cluster Network Name check box when you ran Setup (see page 95), configure the iProcess Engine to use a virtual server in a Microsoft Windows cluster. To do this: a. Use the SWDIR\util\swadm SHOW_SERVERS command to determine the machine ID of the physical server where the iProcess Engine is currently installed (as stored in the node_cluster table). For example: C:\swserver\staffw_nod1\util>swadm show_servers -------------------------------------------------------------------------------Machine ID Machine Name Master Check Error Files Machine Comment -------------------------------------------------------------------------------1 PCANUSER00355 Y TIBCO iProcess Engine (Oracle) for Windows Installation Y PCANUSER00355 Configure the Microsoft Windows Cluster 127 | b. Use the following command to replace the machine name (in the node_cluster table) with the Microsoft Windows cluster Network Name: SWDIR\util\swadm MOVE_SERVER MachineID NetworkName where: — MachineID is the ID of the physical server where the iProcess Engine is currently installed. — NetworkName is the network name of the cluster’s Network Name resource. (This is the name that clients use to access services dependent on this resource, as defined on the Parameters tab of the resource’s Properties dialog in Cluster Administrator.) 3. If you are using EMS, you must now: a. install the same EMS Version on each secondary machine in the cluster. Refer to the TIBCO Enterprise Message Service Installation guide for more information about how to install EMS. b. configure EMS to work as part of the cluster. For more information about how to do this, see the EMS documentation and the following power.tibco.com article: http://power.tibco.com/app/kb/article.jsp?aid=107600 If you are upgrading your version of TIBCO EMS you must follow the instructions in Upgrading TIBCO EMS on page 203. Failure to do so will result in the loss of work queue data. 4. If you are using Hawk, you must now: a. install the same Hawk Version on each secondary machine in the cluster. You can find the Hawk Version distribution set and documentation in the SWDIR\hawk folder. Refer to the TIBCO Hawk® Installation and Configuration guide for more information about how to install Hawk. b. configure Hawk to work as part of the cluster. For more information about how to do this, see the Hawk documentation and the following power.tibco.com article: http://power.tibco.com/app/kb/article.jsp?aid=100034 TIBCO iProcess Engine (Oracle) for Windows Installation 128 | Chapter 4 Carrying Out Post-Installation Tasks 5. If your Microsoft Windows Cluster is not running software to ensure that services, components and shared DLLs are replicated between machines and so are identical between the machines in the cluster, run the following command on each secondary machine in the cluster: SWDIR\mscluster\mscluster This command creates the following shared resources and services that are required by the iProcess Engine: — iProcess nodename Process Sentinels service — iProcess nodename Web Server service — NobleNet Portmapper for TCP service — Staffware Events COM+ application — iProcess COM+ Bridge COM+ application where nodename is the nodename of this iProcess Engine. It also replicates the port numbers used by the iProcess Engine watcher and worker process sentinels in the %systemroot%\system32\drivers\etc\services file. 6. Open Cluster Administrator. (You can do this by clicking Start > Control Panel > Administrative Tools > Cluster Administrator.) 7. Install a new Generic Service resource for the iProcess Engine NobleNet Portmapper service. This resource must have the following properties: Property Description Resource name Any suitable descriptive name you choose. Service name NobleNet Portmapper for TCP For more information about how to install this resource, refer to the "Installing a Generic Service resource" topic in the Microsoft Cluster Administrator help. TIBCO iProcess Engine (Oracle) for Windows Installation Configure the Microsoft Windows Cluster 129 | 8. Install a new Generic Service resource for the iProcess Engine Process Sentinels service. This resource must have the following properties: Property Description Resource name Any suitable descriptive name you choose. Dependencies The NobleNet Portmapper resource you created in the previous step. Service name iProcessnodenameProcessSentinels where nodename is the nodename of this iProcess Engine. There must be no spaces either anywhere in the name or at the end of the string. Registry Replication > Root Registry Key Add both of the following entries: • RegistryLocation\Staffware plc\Staffware Server\Nodes\nodename • RegistryLocation\Staffware plc\Staffware EntObj Server\Nodes\nodename where: See Also • RegistryLocation is either SOFTWARE, if you are running the iProcess Engine on a 32-bit machine, or SOFTWARE\Wow6432Node, if you are using a 64-bit machine. • nodename is the nodename of this iProcess Engine. See the Microsoft documentation and/or Help for more information about the Cluster Administrator tool. TIBCO iProcess Engine (Oracle) for Windows Installation 130 | Chapter 4 Carrying Out Post-Installation Tasks Enable Oracle Function-Based Indexes Status If you are... This task is... Installing a new iProcess Engine Required Upgrading from any Version i10 , 10 or 11 iProcess Engine Not applicable Upgrading from any Version 9 Process Engine Required Description The case_information table contains an Oracle function-based index, idx_ci_casedesc_UC, which allows the iProcess Engine to perform case insensitive searches on the table. Procedure To enable the use of the idx_ci_casedesc_UC index in Oracle, you must: 1. Set the following Oracle initialization parameters: QUERY_REWRITE_INTEGRITY=TRUSTED; QUERY_REWRITE_ENABLED=TRUE; 2. Ensure that the following SQL command is run at regular intervals (for example, as a scheduled job in the database or as part of your maintenance activities). analyze table case_information compute statistics; On systems with large amounts of data, this command can take a long time to complete. TIBCO recommend that you run the command when there are not many users logged in - for example, overnight. This command computes the necessary statistics on the case_information table which the Oracle query optimizer uses to perform Cost-Based Optimization (CBO). If there is no cost-based information, or if CBO is disabled, searches involving the case_information table will require a full table scan, which can take a long time to complete. See Also Please see your Oracle documentation for more information about function-based indexes and CBO. TIBCO iProcess Engine (Oracle) for Windows Installation Grant Resource Privileges to the iProcess Engine Database Users 131 | Grant Resource Privileges to the iProcess Engine Database Users Status Description If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Not applicable Upgrading from any Version 9 Process Engine Required If you upgrade from a Version 9 Process Engine, Setup needs to grant resource privileges to the iProcess Engine database users when it runs certain upgrade scripts. However, Setup can only do this if you have access to an Oracle DBA account when you run it (see page 91). If you did not have access to an Oracle DBA account when you ran Setup, you must now manually perform these grants. Procedure To grant resource privileges to the iProcess Engine database users: 1. Connect to the Oracle database as a database administrator (DBA). 2. Using an appropriate SQL utility, perform the following grants: grant resource to iPE_DB_Schema_owner; grant resource to iPE_DB_user; where: • iPE_DB_Schema_owner is the name of the Oracle user that owns the iProcess Engine database schema. • iPE_DB_user is the name of the Oracle user that the iProcess Engine uses to access the iProcess Engine database schema. This user has the REFERENCES, SELECT, DELETE, and UPDATE permissions. TIBCO iProcess Engine (Oracle) for Windows Installation 132 | Chapter 4 Carrying Out Post-Installation Tasks Re-implement Changes to Tomcat Configuration Files Status Description If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Required if upgrading from a pre-10.6 version Upgrading from any Version 9 Process Engine Not applicable If you have upgraded from a pre-10.6 version of the iProcess Engine, any changes you made to the default values in the Tomcat configuration files in the SWDIR\tomcat directory on your original system have been lost (see page 54). If you want to keep any of those changes, you should now manually re-implement them in the new Tomcat version 5.5.31 .xml configuration files. Procedure Manually re-implement the desired changes in the Tomcat version 5.5.31 configuration files in the SWDIR\tomcat directory. For more information about how to re-implement the changes using the new configuration file format, please see your Tomcat version 5.5.31 documentation. TIBCO iProcess Engine (Oracle) for Windows Installation Install the IBM Client for JMS on J2SE with IBM WebSphere Application Server 133 | Install the IBM Client for JMS on J2SE with IBM WebSphere Application Server Status Description If you are... This task is... Installing a new iProcess Engine Required if you use Websphere 6.x Upgrading from any Version i10, 10 or 11 iProcess Engine Required if you use Websphere 6.x Upgrading from any Version 9 Process Engine Required if you use Websphere 6.x If you intend to use Websphere 6.x as your JMS provider for Activity Publication, and you do not already have the IBM Client for JMS on J2SE with WebSphere Application Server (referred to as the "IBM JMS Client" in the rest of this section) installed on your system, you must install it now. You must install the IBM JMS Client into the directory you specified for it when you ran Setup (see page 105). The IBM JMS Client is an embeddable technology that provides JMS V1.1 connections to a service integration bus messaging engine in WebSphere Application Server V6.0.2 (or above). It is available from the following IBM URL: http://www-1.ibm.com/support/docview.wss?uid=swg24012804 Procedure To do this: 1. Download the IBM JMS Client download file (sibc_install-<build>.jar) from the above URL. 2. Use the following command to install the IBM JMS Client: java –jar sibc_install-<build>.jar jms_jndi_sun directory where: — jms_jndi_sun is the installation option for JMS + JNDI for Sun JREs. You must use this installation option to ensure that the IBM JMS Client uses a Sun JRE, which it must do to work with the iProcess Engine IAPJMS process. TIBCO iProcess Engine (Oracle) for Windows Installation 134 | Chapter 4 Carrying Out Post-Installation Tasks — directory is the same path name that you entered in the Base field of the Default Java Message Service dialog (see page 105). You must install to this directory because that is where the iProcess Engine will look for the client .jar files. TIBCO iProcess Engine (Oracle) for Windows Installation Configure IAPJMS Security Settings 135 | Configure IAPJMS Security Settings Status Description If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional If you chose to enable Activity Publication when you ran Setup (see page 97), default values for the JNDI/JMS user name and password are written to the SecurityPrinciple and SecurityCredentials properties (respectively), in the SWDIR\etc\iapjms.properties file. (This file contains all the configuration information for the IAPJMS library.) If you want to change these values for security reasons, you should do so now. Enabling activity publishing does not result in events being automatically published by the iProcess Engine - see page 97 for more information. See Also For more information about how to change the default values for the JNDI/JMS user name and password, see "Updating the IAP Security Principle and Credentials" in the TIBCO iProcess Engine Administrator’s Guide. TIBCO iProcess Engine (Oracle) for Windows Installation 136 | Chapter 4 Carrying Out Post-Installation Tasks Configure the Default iProcess Engine Setup Status Description Node Cluster Procedure If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional Setup creates a default set of server processes, process attributes, message queues and Mbox sets for the iProcess Engine. You can, if you wish, change this default setup to suit your particular requirements. The default processes are all set up on the master server. When a slave server is added no processes are initially configured to run on it. Use the SWDIR\util\swsvrmgr and/or SWDIR\util\swadm utilities to set up server processes, process attributes, message queues and Mbox sets according to your requirements. If you have upgraded from Version 9.0-o, you may find that you need less WIS processes, because the iProcess Engine WIS processes are more efficient. You should check your system performance and re-run any WIS performance tuning process that you used to calculate the correct number of processes for your existing system before upgrading. (See WIS Processes on page 33.) See Also See the following references in the TIBCO iProcess Engine Administrator's Guide for more information. For information about configuring... See this chapter... processes Administering iProcess Engine Server Processes process attributes Administering Process Attributes message queues and Mbox sets Administering Message Queues and Mbox Sets TIBCO iProcess Engine (Oracle) for Windows Installation Reset LDAP Directory Attribute to iProcess Engine Property Mappings 137 | Reset LDAP Directory Attribute to iProcess Engine Property Mappings Status Description If you are... This task is... Installing a new iProcess Engine Not applicable. Upgrading from any Version 11 iProcess Engine Not applicable Upgrading from any Version i10 or 10 iProcess Engine Required if you use LDAP Upgrading from any Version 9 Process Engine Required if you use LDAP At Version 11, the LDAPCONF utility stores user information in the iProcess database, where previous versions used a separate file. Therefore, when you upgrade to Version 11.1.3, you must run the LDAPCONF utility to save the existing information from file to database. In addition, when you upgrade to Version 11.1.3 from a pre-10.2 version of the iProcess Engine or Process Engine, a new Group Membership LDAP directory attribute is added. The introduction of this new attribute can cause the existing LDAP directory attribute to iProcess Engine property mappings to become misaligned. Procedure To do this, you need to perform the following steps: 1. Select LDAPCONF menu option [8] Save. This reads the existing configuration information from the SWDIR\util\swldap file, saves it to the database, and deletes the file. 2. Check your LDAPCONF configuration to ensure that the correct LDAP directory attributes are still mapped to the correct iProcess Engine properties. Use the LDAPCONF View Connection Information menu option to do this, and compare the mappings to the ones that you noted before you upgraded (see page 46). 3. If any attribute mappings are not what you expect, change them to their correct values. Use LDAPCONF menu option [3] Set Attribute Mappings to do this. 4. Recreate any custom LDAP directory attribute mappings that you deleted before you upgraded (see page 46). Use the LDAPCONF Set Attribute Mappings menu option to do this. TIBCO iProcess Engine (Oracle) for Windows Installation 138 | Chapter 4 Carrying Out Post-Installation Tasks 5. Select LDAPCONF menu option [8] Save again to save any changes. See Also For more information about LDAPCONF commands and procedures, see Chapter 3, “Configuring the Interface to the LDAP Server” and Chapter 4, “Testing the LDAP Interface”, in the LDAPCONF Utility User's Guide. TIBCO iProcess Engine (Oracle) for Windows Installation Recreate Prediction Data 139 | Recreate Prediction Data Status If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Not applicable Description During the upgrade process the predict and predict_lock tables are dropped and then recreated. Accordingly, any prediction data contained in those tables is lost. Procedure You can recreate the data in these tables (for any procedures that you want to) by using the following command: SWDIR\bin\swutil PREDICT procname ALL_CASES where procname is the name of the procedure that you want to recreate prediction data for. See Also For more information about: • case prediction, see "Using Case Prediction to Forecast Outstanding Work Items" in the TIBCO iProcess Modeler Advanced Design guide. • the swutil PREDICT command, see "Updating Prediction for Cases" in the TIBCO iProcess swutil and swbatch Reference guide. TIBCO iProcess Engine (Oracle) for Windows Installation 140 | Chapter 4 Carrying Out Post-Installation Tasks Remove Files That are no Longer Needed Status Description If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine Not applicable Upgrading from any Version 9 Process Engine Optional After the upgrade has finished a number of files are left on the system that are no longer required (because the data in them has been moved into the database by the upgrade). The upgrade process renames most of these files by appending .imported to the filename. However, pack files and procedure definition files also remain, but are not renamed. These files are not used by the iProcess Engine and can be deleted at your convenience. Procedure Deleting Renamed Files To delete the renamed (.imported) files that are no longer needed: 1. In Windows Explorer or My Computer, navigate to the SWDIR\queues directory. 2. To delete renamed files, search for and delete all files in the directory that have the following suffix: — .imported 3. To delete pack files, search for and delete all files in the directory that have the following suffixes: — .v — .l?? — .m?? — .x?? where ? is any single character. 4. Navigate to the SWDIR\queues\nodename.n directory (where nodename is the Version 11.1.3 iProcess Engine node name). TIBCO iProcess Engine (Oracle) for Windows Installation Remove Files That are no Longer Needed 141 | 5. To delete procedure definition files, search for and delete all files in the directory that have the following suffix: — .p?? where ? is any single character. Do NOT delete the entire SWDIR\nodename.n directory, because USE files are still stored in the 'use' sub-directory. TIBCO iProcess Engine (Oracle) for Windows Installation 142 | Chapter 4 Carrying Out Post-Installation Tasks Recreate All User-Defined Triggers, Indexes and Statistics on the iProcess Engine Schema Tables Status Description Procedure If you are... This task is... Installing a new iProcess Engine Not applicable Upgrading from any Version i10, 10 or 11 iProcess Engine May be required Upgrading from any Version 9 Process Engine May be required After the upgrade has finished you need to recreate any user-defined triggers, indexes or statistics that you deleted before upgrading the iProcess Engine (see page 69). Using an appropriate SQL utility, recreate all user-defined triggers, indexes or statistics on iProcess Engine schema tables that you deleted before you upgraded. TIBCO iProcess Engine (Oracle) for Windows Installation Update the Domain Group Policy for the "Log on as a Service" Right 143 | Update the Domain Group Policy for the "Log on as a Service" Right Status Description If you are... This task ... Installing a new iProcess Engine May be required Upgrading from any Version i10, 10 or 11 iProcess Engine May be required Upgrading from any Version 9 Process Engine May be required When you install the iProcess Engine, Setup assigns the "Log on as a service" right to the user account you have chosen to use to run the iProcess nodename Process Sentinels service (the IPESERVICE user - see page 6 and page 90). The right is assigned on the computer where you have installed the iProcess Engine. If you have installed the iProcess Engine in a domain, using domain users, and the domain uses a group policy for the "Log on as a service" right, you must now also update that group policy to include the IPESERVICE user. If you do not do this, the IPESERVICE user’s locally-assigned right will be overwritten when the domain controller propagates the group policy to the member machines in the domain (which happens, by default, every 90 minutes). The account will therefore lose the "Log on as a service" right, and so be unable to start the iProcess nodename Process Sentinels service (see page 186). Procedure Change the group policy on the domain controller for the "Log on as a service" right to include the IPESERVICE user. You must have access to an account that has Domain Administrator privileges to be able to change the group policy. See Also There are a number of ways to change group policies, depending on how the domain is configured. Refer to your Microsoft documentation for more information about group policies and how to change them. TIBCO iProcess Engine (Oracle) for Windows Installation 144 | Chapter 4 Carrying Out Post-Installation Tasks Disable or Re-enable Write Access to WebDav Status If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional Description You may find, once you have installed or upgraded the iProcess Engine, that you want to disable or re-enable write access to WebDav on the Apache Tomcat Application Server installed with the iProcess Engine. To do this, you must edit the SWDIR\tomcat\webdav\WEB-INF\web.xml file. Procedure To disable or re-enable write access to WebDav on the Apache Tomcat Application Server installed with the iProcess Engine, do the following: 1. In a text editor, open the SWDIR\tomcat\webdav\WEB-INF\web.xml file. 2. Depending on your requirements, either uncomment or comment out the following section: <init-param> <param-name>readonly</param-name> <param-value>false</param-value> </init-param> 3. Save the file. TIBCO iProcess Engine (Oracle) for Windows Installation Configure JMX Ports to Run Through a Firewall 145 | Configure JMX Ports to Run Through a Firewall Status Description If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional JMX relies on a JAVA technology called RMI which uses dynamic ports to be able to communicate between a client and a server. Firewalls cannot handle dynamic ports as they need to know the port number. iProcess overcomes this problem by statically assigning a listening port for the RMI server. To do this you need to configure the %SWDIR%/etc/swjmx.properties file. Procedure To configure the swjmxproperties file, do the following: 1. Open %SWDIR%/etc/swjmx.properties and you will see lines similar to the following: SWJMXConfig.location=C:/swserver/staffw_nod1/etc/swjmx_config.xml SWJMXConfig.port=10025 2. The default port is 10025 but you can change this to a port of your choosing. The RMI server port number will then be automatically set to the value of SWJMXConfig.port +1. 3. Save the file. TIBCO iProcess Engine (Oracle) for Windows Installation 146 | Chapter 4 Carrying Out Post-Installation Tasks Start the iProcess Engine Status Description Node Cluster Procedure If you are... This task is... Installing a new iProcess Engine Optional Upgrading from any Version i10, 10 or 11 iProcess Engine Optional Upgrading from any Version 9 Process Engine Optional The iProcess Engine is now properly installed, configured and ready to start up. Install each node in the cluster before trying to start the iProcess Engine. To start the iProcess Engine: 1. If you were prompted to reboot your computer when Setup finished (see page 109) but you have not yet done so, you must reboot now. 2. Login as the iProcess Engine IPEADMIN user (see page 88). 3. If you have installed the iProcess Engine to a Windows cluster, use the Bring online service in the Microsoft Cluster Administrator to start the iProcess Engine. Do not attempt to start the iProcess Engine on a Windows cluster using Control Panel > Services or the SWDIR\bin\swstart command. 4. If you are not using a Windows Cluster: a. Open a command prompt window. If you have installed on Windows Vista and User Account Control is turned on, you must elevate the command prompt window. Right-click on it and select Run As Administrator. b. Enter the following command to start the iProcess Engine process sentinels: SWDIR\bin\swstart -p TIBCO iProcess Engine (Oracle) for Windows Installation Start the iProcess Engine 147 | c. If you did not select the Auto start processes on service startup check box when you ran Setup (see page 82), enter the following command to start the iProcess Engine processes: SWDIR\bin\swstart If you did select the Auto start processes on service startup check box, the process sentinels will automatically start all of the iProcess Engine processes. See Also See "Controlling the TIBCO iProcess Engine" in the TIBCO iProcess Engine Administrator's Guide for more information about how to start the iProcess Engine. TIBCO iProcess Engine (Oracle) for Windows Installation 148 | Chapter 4 Carrying Out Post-Installation Tasks TIBCO iProcess Engine (Oracle) for Windows Installation | 149 Chapter 5 Removing the iProcess Engine This chapter describes how to remove the iProcess Engine from your system if it is no longer required. Topics • Pre-Removal Considerations, page 150 • Remove the iProcess Engine From a Windows Cluster, page 151 • Remove the iProcess Engine, page 152 • Remove the Staffware Events COM+ Application, page 153 • Remove the iProcess Engine Database, page 154 TIBCO iProcess Engine (Oracle) for Windows Installation 150 | Chapter 5 Removing the iProcess Engine Pre-Removal Considerations You should note the following points before removing your iProcess Engine installation: • Do not attempt to delete iProcess Engine files directly, as some may remain on the system, causing problems if you wish to re-install the iProcess Engine later. • Perform a backup of your database schema and any other files if you want to keep your existing iProcess Engine data. Otherwise it will be lost when you remove the iProcess Engine. Configuration changes that were made prior to installation are not automatically removed. Any such changes made must be manually changed back to their original values. • If you remove an iProcess Engine that uses a node cluster architecture, you must remove things in the following sequence: a. Remove the iProcess Engine from each slave server. b. Remove the iProcess Engine from the master server. c. Remove the iProcess Engine database schema and Oracle users from the Oracle instance. When you are ready to remove the iProcess Engine, work through the instructions in the following sections in sequence. It is essential that if you have TIBCO iProcess Technology Plug-ins installed, you uninstall these before removing iProcess Engine. See TIBCO iProcess Technology Plug-ins Installation guide for information on how to do this. TIBCO iProcess Engine (Oracle) for Windows Installation Remove the iProcess Engine From a Windows Cluster 151 | Remove the iProcess Engine From a Windows Cluster If you have installed the iProcess Engine in a Windows cluster: 1. Run the following command on each secondary machine in the cluster: SWDIR\mscluster\mscluster -r Do not run this command on the machine where the iProcess Engine is installed! If you do so you will not be able to remove the iProcess Engine from that machine. This command removes the following iProcess Engine shared resources and services: — iProcess nodename Process Sentinels service — iProcess nodename Web Server service — NobleNet Portmapper for TCP service — Staffware Events COM+ application — iProcess COM+ Bridge COM+ application where nodename is the nodename of this iProcess Engine. It also removes the port numbers used by the iProcess Engine watcher and worker process sentinels in the %systemroot%\system32\drivers\etc\services file. 2. Using Cluster Administrator, remove the Generic Service resources for the NobleNet Portmapper and Process Sentinels services for this iProcess Engine (see page 128). See the Microsoft documentation and/or Help for more information about the Cluster Administrator tool. 3. Next, remove the iProcess Engine itself - see page 152. TIBCO iProcess Engine (Oracle) for Windows Installation 152 | Chapter 5 Removing the iProcess Engine Remove the iProcess Engine To remove the iProcess Engine installation from your computer: 1. Log in to Windows using the IPEADMIN user account (see page 88). 2. Make sure that all users are logged out from the iProcess Engine. 3. Stop the following services: — iProcess NodeName Process Sentinels — iProcess NodeName Web Server (if it exists) 4. Click Start > Settings> Control Panel. 5. Double-click Add or Remove Programs. The Add or Remove Programs window is displayed. On Windows Vista, double-click Programs and Features. 6. Select TIBCO iProcess Engine/nodename, where nodename is the name of the iProcess Engine installation that you want to remove, then click Remove. On Windows Vista, click Uninstall/Change. The following Warning dialog is displayed: Please note that all existing data will be lost upon un-installing the TIBCO iProcess Engine. Are you sure you wish to un-install at this time? 7. Click Yes to remove the iProcess Engine. The Remove Programs From Your Computer dialog is displayed, which shows the progress of the uninstall process. 8. When the message Uninstall successfully completed is displayed, click OK. The iProcess Engine has been removed from the system. If any other messages are displayed, follow the on-screen instructions. 9. Next, remove the Staffware Events COM+ application - see page 153. TIBCO iProcess Engine (Oracle) for Windows Installation Remove the Staffware Events COM+ Application 153 | Remove the Staffware Events COM+ Application Removing the Staffware Events COM+ application means that any other iProcess Engine installed on this computer will no longer work. Do not remove this application if there are other iProcess Engine installations on this computer. To remove the Staffware Events COM+ application: 1. Click Start > Settings> Control Panel. 2. Double-click Administrative Tools, then double-click Component Services. The Component Services console is displayed. On Windows Vista, run dcomcnfg to display the Component Services console. 3. In the left hand pane, select Component Services > Computers > My Computer > COM+ Application. 4. Right-click Staffware Events and select Delete. A Confirm Item Delete dialog is displayed asking you to confirm that you want to delete Staffware Events. 5. Click Yes to confirm. 6. Close the Component Services and Administrative Tools windows. 7. Delete the following two files from your system: — winnt\system32\SWEventClass.dll — winnt\system32\SWEventClassSubscriber.dll 8. Finally, remove the iProcess Engine database - see page 154. TIBCO iProcess Engine (Oracle) for Windows Installation 154 | Chapter 5 Removing the iProcess Engine Remove the iProcess Engine Database Do not remove the iProcess Engine schema and Oracle users until you have removed the iProcess Engine files from the master server and all slave servers (see page 150). Delete the iProcess schema and the iProcess background user and foreground user accounts from the Oracle database. Refer to your Oracle documentation for more information about how to do this. TIBCO iProcess Engine (Oracle) for Windows Installation | 155 Appendix A Usage Profiles for Tablesizes Files This appendix shows the usage profiles that have been used to calculate the values used in the alternative tablesizes files tablesizes.med and tablesizes.large. See page 59 for more information about the use of these files. In each file, the sizing of the initial extent is 10% of the maximum estimated tablesize. This means that as the table grows it will expand to fill 10 database extents. TIBCO iProcess Engine (Oracle) for Windows Installation 156 | Appendix A Usage Profiles for Tablesizes Files tablesizes.med File This file defines tablesizes for a medium-sized installation. If you use this file, you must reserve at least 2.5Gb of disk space for the database. Statistic Value Number of registered iProcess Engine users 200 Number of iProcess Engine groups 10 Number of user defined attributes 4 Average number of groups a user belongs to 5 Average number of case starts per day 2000 Average number of days before a case is purged 90 Average number of days before a case is closed 30 Average percentage of steps processed via queues 90% Average number of assigned fields per case 50 Average number of steps processed per case 10 Average number of CustAudits per case 20 Average number of sub-procedure calls per case 3 Average size of field name 10 Average size of field value 50 TIBCO iProcess Engine (Oracle) for Windows Installation tablesizes.large File 157 | tablesizes.large File This file defines tablesizes for a large-sized installation. If you use this file, you must reserve at least 65Gb of disk space for the database. Statistic Value Number of registered iProcess Engine users 9500 Number of iProcess Engine groups 500 Number of user defined attributes 12 Average number of groups a user belongs to 15 Average number of case starts per day 20000 Average number of days before a case is purged 90 Average number of days before a case is closed 30 Average percentage of steps processed via queues 90% Average number of assigned fields per case 150 Average number of steps processed per case 25 Average number of CustAudits per case 50 Average number of sub-procedure calls per case 8 Average size of field name 12 Average size of field value 50 TIBCO iProcess Engine (Oracle) for Windows Installation 158 | Appendix A Usage Profiles for Tablesizes Files TIBCO iProcess Engine (Oracle) for Windows Installation | 159 Appendix B Troubleshooting This appendix describes how to deal with errors that you may encounter when installing the iProcess Engine. If the information in this appendix does not help you to resolve the problem, or if you are in any way unsure as to how to proceed, contact TIBCO Support for further assistance. Topics • Setup Fails with an “Unable to open the file” Warning Dialog, page xlv • Setup Exits Because You are Not a Local Administrator, page xlvi • Setup Cannot Continue Because Another iProcess Engine is Running, page xlvii • Setup Encounters an Error Trying to Locate pthread.dll, page xlviii • Setup Cannot Run an Upgrade from Version 9 Because Procedures Contain Attachments or Open Client Steps, page xlix • Setup Failed to Connect to the Oracle Database, page l • Installing Against an Unsupported Database Version, page li • Setup Cannot Locate an Oracle UNDO Tablespace, page lii • Oracle TAF is Not Enabled, page liii • Oracle Advanced Queuing is Not Enabled, page liv • Oracle Client and Database NLS_LANG Settings Do Not Match, page lv • Oracle OPEN_CURSORS Value Is Less Than 200, page lvi • Setup Cannot Initialize the iProcess Engine Database, page lvii • Errors Occur on Validating the Installation, page lxi • License File Cannot Be Found, page lxii • Errors are Reported in the upgrFromtoTo.log Files, page lxiii TIBCO iProcess Engine (Oracle) for Windows Installation 160 | Appendix B Troubleshooting • Upgrade Fails Because It Cannot Create the Process Sentinels Process, page lxv • Recovering the iProcess Engine/Process Engine if an Upgrade Fails, page lxvi • mscluster Command Reports Error in \etc\services File, page lxviii • Process Sentinels Do Not Start Due to Logon Failure, page lxx • iProcess Engine Processes Do Not Start, page lxxii • Distributed Transaction Errors Occur When You Start the iProcess Engine, page lxxv TIBCO iProcess Engine (Oracle) for Windows Installation Setup Fails with an “Unable to open the file” Warning Dialog 161 | Setup Fails with an “Unable to open the file” Warning Dialog Problem Description When you run Setup a Warning dialog is displayed with the following message: Unable to open the file: fil.dll You can only click OK to this dialog, and when you do so, Setup exits. This error occurs if you do not have the correct Oracle database and/or client releases (along with any additionally required patches or components) installed on the computer where you are trying to install the iProcess Engine. The fil.dll file requires the Oracle client .dll files to be able to connect to the Oracle database. When Setup starts up, it tries to load the fil.dll file, which in turn attempts to load the required Oracle .dll files. If these files cannot be found, the error occurs. What to Do Install the required Oracle database and/or client release on the computer where you are trying to install the iProcess Engine. See page xxiii for more information. Make sure that you have also installed any additional patches or components that are required. TIBCO iProcess Engine (Oracle) for Windows Installation 162 | Appendix B Troubleshooting Setup Exits Because You are Not a Local Administrator Problem Description When you run Setup it exits immediately with the following error message: You are not a local machine Administrator. Setup cannot continue To be able to run Setup, you must be logged in as a user that is a member of the Windows Administrators group on the computer where you are trying to run Setup. What to Do To resolve this problem: 1. Either: — Log out, then log in as a user who is already a member of the local Administrators group. — Add the user you are logged in as to the local Administrators group. To access the Administrators group, open Control Panel -> Administrative Tools -> Computer Management -> System Tools -> Local Users and Groups -> Groups -> Administrators. Refer to your Windows documentation if you need more information. 2. Run Setup again. TIBCO iProcess Engine (Oracle) for Windows Installation Setup Cannot Continue Because Another iProcess Engine is Running 163 | Setup Cannot Continue Because Another iProcess Engine is Running Problem Description Setup displays an error when you click Next on the Setup Type dialog (see page v). For example: The following iPE services have been found to be running: iProcess staffw_nod1 Process Sentinels The installation process cannot continue until all installations have been shutdown. Please refer to the iPE server document for more information. Setup has detected that the indicated iProcess NodeName Process Sentinels service is running, where NodeName is the nodename of the iProcess Engine that is running the service. Setup may need to stop and replace components (such as the Staffware Events COM+ application) that are also used by other iProcess Engine installations, if those components need updating. If so, it cannot perform the installation if another iProcess Engine is running on the same machine. See Stop Any Other iProcess Engines on the Same Machine on page xiii for more details of when this is typically required. What to Do To resolve this problem: 1. Stop the indicated iProcess NodeName Process Sentinels service. To do this: a. Click Start > Settings> Control Panel. b. Double-click Administrative Tools. c. Double-click Services. d. Right-click the iProcess NodeName Process Sentinels service and choose Stop. 2. Click Next on the Setup Type dialog again. If you have chosen: — a Basic installation, the Choose Destination Location dialog is displayed. See page ix. — a Custom installation, the Upgrade or New Install dialog is displayed. See page vii. See Also See "Stopping the TIBCO iProcess Engine" in the TIBCO iProcess Engine Administrator’s Guide for more information about how to stop the iProcess Engine. TIBCO iProcess Engine (Oracle) for Windows Installation 164 | Appendix B Troubleshooting Setup Encounters an Error Trying to Locate pthread.dll Problem Description When you run Setup it exits immediately with one of the following error messages: Failed to locate the 'pthread.dll' componentThe minimum 'pthread.dll' component version required is 2.7.0. The version available on the system is 2.6.0Failed to load the 'pthread.dll' component as no version information could be found in it Failed to determine the version of the 'pthread.dll' component followed by the message: POSIX Threads (pthreads) for Win32 is required in order for the software to run correctly. Please refer to the Installation Guide for information on where to get hold of this component and how to install it. To be able to run Setup, you must have a supported version of the POSIX Threads (pthreads) for Win32 library installed and available on your system PATH. What to Do To resolve this problem: 1. Obtain the POSIX Threads (pthreads) for Win32 library from TIBCO and make it available on your system PATH. See page xiv for more information about how to do this. 2. Run Setup again. TIBCO iProcess Engine (Oracle) for Windows Installation Setup Cannot Run an Upgrade from Version 9 Because Procedures Contain Attachments or Open Client Steps 165 | Setup Cannot Run an Upgrade from Version 9 Because Procedures Contain Attachments or Open Client Steps Problem Description Setup aborts an upgrade from a Version 9.0-o system and displays the following error: Upgrade cannot continue because unsupported items were found in the existing procedures. Please see SWDIR\upgrchk.log for more information. The error occurs when you click Next after selecting Upgrading existing installation in the Upgrade or New Install dialog (see page vii). Setup has detected that one or more procedures on the Version 9.0-o system contain either attachment fields or Open Client Steps. Attachment fields and Open Client Steps are not currently supported in Version 11.1.3, and must be removed from the Version 9.0-o system before attempting to upgrade it to Version 11.1.3. What to Do To resolve this problem: 1. Examine the SWDIR\upgrchk.log file to determine which procedures are affected on your Version 9.0-o system. 2. Remove all attachment fields from all affected procedures. 3. Purge all cases of, withdraw and then delete all affected procedures that contains any Open Client Steps. 4. Run Setup again to upgrade your Version 9.0-o system to Version 11.1.3. TIBCO iProcess Engine (Oracle) for Windows Installation 166 | Appendix B Troubleshooting Setup Failed to Connect to the Oracle Database Problem Description Setup displays the following error when you click Next from the Database Details dialog: Failed to connect to database with username, password and connection supplied. Do you wish to continue with this setup? Setup cannot connect to the Oracle database. What to Do To resolve this problem: 1. Check the following: — You have specified the correct information in the Database Details dialog - see page xix. — The Oracle database is running and your computer has a network connection to it. 2. If you want to continue with the installation, click Yes. If you do not want to continue with the installation, click No. Setup exits. TIBCO iProcess Engine (Oracle) for Windows Installation Installing Against an Unsupported Database Version 167 | Installing Against an Unsupported Database Version Problem Description If you try to install or upgrade the iProcess Engine using a database version that does not meet the minimum requirements for this version of the iProcess Engine, Setup displays the following error message when you click Next from the Database Details dialog: WARNING: the version of Oracle you are using is not supported. Refer to the Installation Guide for full details of supported Oracle versions. Minimum versions required are 10g (10.2.0.4) Do you wish to continue with this installation? Although you can continue, TIBCO recommend that you only install the iProcess Engine using a supported database version - see page xxiii for details of supported versions. What To Do If you want to continue with the installation, click Yes. If you do not want to continue with the installation: 1. Click No. Setup exits. 2. Upgrade your operating system and/or database to a supported version (see page xxiii) and then re-run Setup. TIBCO iProcess Engine (Oracle) for Windows Installation 168 | Appendix B Troubleshooting Setup Cannot Locate an Oracle UNDO Tablespace Problem Description Setup displays one of the following error messages when you click Next from the Database Details dialog: Error Meaning This Oracle instance does not have an UNDO tablespace defined. Setup has connected to the Oracle database and determined that an UNDO tablespace does not exist. You cannot continue the installation without an UNDO tablespace. Failed to determine if there is an UNDO tablespace present Setup has attempted to connect to the Oracle database to determine if an UNDO tablespace exists, but has been unable to do so. Setup cannot create the iProcess Engine database schema without an UNDO tablespace. What To Do To resolve this problem: 1. Click OK. The Database Details dialog is displayed. 2. Make sure that the Oracle database is running and that your computer has a network connection to it. 3. Make sure that an Oracle UNDO tablespace exists for the iProcess Engine database. Create one if it does not. See: — your Oracle documentation, for more information on how to create and manage UNDO tablespaces. — Disable Oracle Flashback Query on page xxxiii, for more information about Oracle’s flashback query feature and its impact on the amount of UNDO tablespace you require. 4. Click Next on the Database Details dialog. TIBCO iProcess Engine (Oracle) for Windows Installation Oracle TAF is Not Enabled 169 | Oracle TAF is Not Enabled Problem Description Setup displays one of the following error messages when you click Next from the Database Details dialog: Error Meaning This Oracle connection does NOT have TAF enabled, you can still continue, but if this installation is to be used in a UAT or Production environment you MUST enable TAF (Failover). Setup has connected to the Oracle database and determined that Oracle TAF is not enabled for the specified Oracle database service (TNS) name. Continue without TAF enabled? Failed to determine whether TAF is configured for the Oracle connection. Setup has attempted to connect to the Oracle database to determine if Oracle TAF is enabled, but has been unable to do so. TIBCO strongly recommends the use of Oracle TAF with the iProcess Engine to provide 24*7 resilient operation. If you are deploying the iProcess Engine for user acceptance testing (UAT) or to a production environment, you must enable TAF. What To Do If you want to enable TAF before continuing with the installation: 1. Click No to return to the Database Details dialog. 2. Make sure that the Oracle database is running and that your computer has a network connection to it. 3. Enable Oracle TAF on your chosen service name. See page xxvii for more information about how to do this. 4. Click Next on the Database Details dialog. If you want to continue with the installation without enabling TAF, click Yes. TIBCO iProcess Engine (Oracle) for Windows Installation 170 | Appendix B Troubleshooting Oracle Advanced Queuing is Not Enabled Problem Description Setup displays one of the following error messages when you click Next from the Database Details dialog: Error Meaning This Oracle connection does NOT have Advanced Queuing installed. Setup has connected to the Oracle database and determined that Oracle Advanced Queuing is not installed for the specified Oracle database service (TNS) name. Oracle Advanced Queuing (AQ) is required for iPE. Failed to determine whether Oracle AQ is correctly installed. Setup has attempted to connect to the Oracle database to determine if Oracle TAF is installed, but has been unable to do so. Oracle Advanced Queuing provides the message queuing and event handling systems used by the iProcess Engine. The iProcess Engine will not work if Oracle Advanced Queuing is not installed What To Do To resolve this problem: 1. Click No to return to the Database Details dialog. 2. Make sure that the Oracle database is running and that your computer has a network connection to it. 3. Make sure that Oracle Advanced Queuing is installed. Refer to your Oracle documentation for more information about installing Advanced Queuing. 4. Click Next on the Database Details dialog. TIBCO iProcess Engine (Oracle) for Windows Installation Oracle Client and Database NLS_LANG Settings Do Not Match 171 | Oracle Client and Database NLS_LANG Settings Do Not Match Problem Description What To Do Setup displays one of the following error messages when you click Next from the Database Details dialog: Error Meaning The NLS_LANG environment setting doesn't match the database's setting. Setup has connected to the Oracle database and determined that its NLS_LANG setting does not match the NLS_LANG setting on the Oracle client. Failed to check the NLS environment settings with that of the database Setup has attempted to connect to the Oracle database to check its NLS_LANG setting, but has been unable to do so. To resolve this problem: 1. Click No to return to the Database Details dialog. 2. Make sure that the Oracle database is running and that your computer has a network connection to it. 3. Change the NLS_LANG setting for the Oracle client so that it matches the NLS_LANG setting on the Oracle database. See page xxxi for more information. 4. Click Next on the Database Details dialog. TIBCO iProcess Engine (Oracle) for Windows Installation 172 | Appendix B Troubleshooting Oracle OPEN_CURSORS Value Is Less Than 200 Problem Description What To Do Setup displays one of the following error messages when you click Next from the Database Details dialog: Error Meaning WARNING: This Oracle instance has the OPEN_CURSORS parameter configured to a value less than 200. It should be set to 200 or greater. Setup has connected to the Oracle database and determined that its OPEN_CURSORS parameter is configured to a value less than 200. Failed to get the current value of the Oracle OPEN_CURSORS parameter. Setup has attempted to connect to the Oracle database to check its OPEN_CURSORS parameter value, but has been unable to do so. To resolve this problem: 1. Click No to return to the Database Details dialog. 2. Make sure that the Oracle database is running and that your computer has a network connection to it. 3. Increase the OPEN_CURSORS parameter to a value of 200 or more. See page xxix for more information. 4. Click Next on the Database Details dialog. TIBCO iProcess Engine (Oracle) for Windows Installation Setup Cannot Initialize the iProcess Engine Database 173 | Setup Cannot Initialize the iProcess Engine Database Problem Description Setup displays the following error when it tries to run the SQL script to initialize the iProcess Engine database schema: The database initialization script has failed to run successfully. Setup cannot continue. What To Do To resolve this problem: 1. Click Exit to exit from Setup. 2. Examine the following log file to determine the cause of the error: SWDIR\logs\init2Kora_tok.sql_UserName_TimeStamp.log where: — UserName is the name of the account being used to run Setup (i.e. the IPEINSTALL user). — TimeStamp is the time that the log file was created, in the form DDMMYYYY_HHMM. 3. If the cause of the error is obvious, correct it and re-run Setup. If not, contact TIBCO Support for further assistance. TIBCO iProcess Engine (Oracle) for Windows Installation 174 | Appendix B Troubleshooting Setup Cannot Run One or More Database Upgrade Scripts Problem Description Setup displays the following dialog when it attempts run a database upgrade script (see page xxxvii): One of the database upgrade scripts has failed to run successfully. You may continue with this setup but the databases and data files cannot be automatically upgraded. If you continue you will need to do the following in order: - Manually edit and run the database scripts against the data source. - Run the upgrade executable (upgr.exe) to upgrade the data files. Setup also: • displays the name of the script that has failed, along with the details of the error(s), in the Script Results section of the Running Database Scripts dialog. • logs the progress of the script in the following log file: SWDIR\logs\ScriptName.sql_UserName_TimeStamp.log where: — ScriptName is the name of the upgrade script that was being run when the error occurred. — UserName is the name of the account being used to run Setup (i.e. the IPEINSTALL user). — TimeStamp is the time that the log file was created, in the form DDMMYYYY_HHMM. • What To Do gives you (in the dialog) the option to Continue with or Exit from the upgrade. The steps you need to take to resolve this problem depend on the script that has failed to run. If the failed script name begins with: • uoraPE, this indicates an error in a script upgrading a Version 9 Process Engine. See Version 9 Upgrade Script Error below. • uorai9 or uorai10, this indicates an iProcess Engine upgrade script error. See Version i9, i10 or 10 Upgrade Script Error below. TIBCO iProcess Engine (Oracle) for Windows Installation Setup Cannot Run One or More Database Upgrade Scripts 175 | Version 9 Upgrade Script Error An error has occurred during the first stage of an upgrade from Version 9, when the Version 9.0-o Process Engine is being upgraded to its interim Version i9.2-o stage (see page iii). Contact TIBCO Support Services for further assistance. If this error occurs, TIBCO strongly recommend that you do not attempt to fix the problem or back out or re-run the upgrade. This stage of the upgrade process involves significant changes to the iProcess system, and the steps required to rectify the problem will depend upon the particular configuration of your system. Version i9, i10 or 10 Upgrade Script Error An error has occurred in one of the incremental iProcess Engine database upgrade scripts. Setup runs a number of incremental scripts to upgrade the iProcess Engine database from its existing version to Version 11.1.3. The number of scripts that need to be run depends on the version number of the iProcess Engine being upgraded - older versions require more scripts. The iProcess Engine database is therefore in an intermediate state between Version 11.1.3 and the version being upgraded from, depending on which scripts (if any) have successfully completed before the error occurred. You should investigate the reported error(s) in the upgrade script using the information in the Running Database Scripts dialog and log file (see page lviii), and decide whether you wish to continue with the upgrade process (see below) or exit from it (see page lx). TIBCO recommend that you continue only if the cause of the error is clear and resolvable. If you are in any way unsure about the error and how to deal with it, you should contact TIBCO Support for further assistance on the best course of action. If you wish to continue with the upgrade: 1. Click Continue in the error message dialog. Setup continues with the remaining upgrade steps (see page xxxvii), but does not attempt to complete upgrading the iProcess Engine database. 2. When Setup has finished, take whatever actions are necessary to correct the errors reported in the upgrade script and, if necessary, edit and/or re-run it. The script is located in the SWDIR\util directory. If Setup encounters an error when it tries to run an upgrade script, it copies all of the upgrade scripts to the SWDIR\util directory. The scripts are named uoraiVersion.sql, where Version is the iProcess Engine version number that the script upgrades the iProcess Engine database schema to. Setup pre-processes each upgrade script to identify the following Oracle users at the appropriate places: — the table owner, as specified in the existing SWDIR\etc\staffpms file. — the Oracle background and foreground users. TIBCO iProcess Engine (Oracle) for Windows Installation 176 | Appendix B Troubleshooting 3. Run the remaining uoraiVersion.sql upgrade scripts in the SWDIR\util directory, starting with the next highest Version after the one that failed, and finishing with the uorai106_00.sql script for the final upgrade to Version 11.1.3. When all the upgrade scripts have successfully completed, the iProcess Engine database schema has been successfully upgraded to Version 11.1.3. Do not run any uoraiVersion.sql scripts for versions earlier than the script that failed. For example, if you were upgrading from a Version i10.0-o(3.4) iProcess Engine and an error occurred in the uorai101_10.sql script, you would need to first correct and run that script, then run the following scripts in this order: a. uorai101_10.sql b. uorai103_00.sql c. uorai105_00.sql d. uorai106_00.sql e. uorai106_10.sql f. uorai1110_00.sql You would not need to run the uorai100_40.sql script, as this had completed successfully before the error occurred in the uorai101_10.sql script. 4. Open a command prompt and run the SWDIR\util\upgr utility. This upgrades the iProcess Engine data files. 5. Open a command prompt and run the SWDIR\bin\fixperms utility. This sets the required permissions on all files and directories in and under SWDIR. If you wish to cancel the upgrade: 1. Exit to exit from Setup. 2. You must restore the iProcess Engine to its previous condition before you can either use it again or re-try the upgrade. See page lxvi for more information about how to do this. TIBCO iProcess Engine (Oracle) for Windows Installation Errors Occur on Validating the Installation 177 | Errors Occur on Validating the Installation Problem Description Setup displays one or more of the following error messages when it attempts to validate that the installation has succeeded. Error Message Failed to start the NobleNet Portmapper for TCP service or contact it once it had been started. ErrorDescription Failed to start the iPE COM+ component. ErrorDescription Some or all of the iPE registry entries haven't been created or updated correctly. ErrorDescription Failed to subscribe, publish or receive a COM+ event. ErrorDescription Failed to access the database and validate the nodename. ErrorDescription Failed to enqueue message to the BG. ErrorDescription In each case, ErrorDescription provides more detailed information about the specific error that has occurred. There may also be further information in the Windows System and/or Application event logs (which you can view using Control Panel > Administrative Tools > Event Viewer.) In the case of the COM+, database access and enqueuing message errors, the following log file also provides further information about the error. SWDIR\logs\PostChecks_UserName_TimeStamp.log where: • UserName is the name of the account being used to run Setup (i.e. the IPEINSTALL user). • TimeStamp is the time that the log file was created, in the form DDMMYYYY_HHMM. See page lxxxii for more information about the PostChecks_UserName_TimeStamp.log file. What To Do Examine the ErrorDescription and, if applicable, the log file to try and determine the cause of the error and its possible resolution. TIBCO recommend that you contact TIBCO Support for further assistance with any of these errors unless the cause and resolution are immediately obvious. TIBCO iProcess Engine (Oracle) for Windows Installation 178 | Appendix B Troubleshooting License File Cannot Be Found Problem Description When Setup attempts to generate configuration files, it displays an error message stating that the license file cannot be found. When you click OK to acknowledge this message, a Dr. Watson error is generated. When running Setup, in the Choose Destination Location dialog, the Destination Folder for the iProcess system directory (SWDIR) had a full pathname of more than 64 characters - see page ix. What to Do To resolve this problem: 1. Run Setup again. 2. In the Choose Destination Location dialog, specify a Destination Folder pathname that has a length 64 characters or less. TIBCO iProcess Engine (Oracle) for Windows Installation Errors are Reported in the upgrFromtoTo.log Files 179 | Errors are Reported in the upgrFromtoTo.log Files Problem Description Setup reports errors in one or more SWDIR\logs\upgrFromtoTo.log files, where From indicates the version being upgraded from, and To indicates the version being upgraded to. Different log files are created depending on the versions involved in the particular stage of the upgrade process when the error occurs, as shown in the following table. What to Do Log file Upgrading from... Upgrading to... upgrv9.0toi9.2.log a Version 9.0-x Process Engine an interim Version i9.2-o stage (see page iii) upgri9.2toi11.xlog a Version i9.2-o iProcess Engine (or from the interim Version i9.2-o stage of a Version 9.0-x Process Engine upgrade) the current version upgri10.xtoi11.x.log an earlier Version 10 iProcess Engine the current version If the upgrade process failed with a fatal error, examine the log files and contact TIBCO Support for further assistance. If the upgrade succeeded, but errors were reported in these log files, you may need to take action to ensure the system is fully functional. For example, a missing packfile is not considered to be a fatal error, but unless the work item is resent, it will not appear in the upgraded system. To examine these log files, use the following commands, which will display any unexpected errors but ignore any items that do not require user action: cd SWDIR\logs find "T001" upgr* | find /v "T001: process_s" | more The following example shows the type of error that may occur: 040324145520.097284:T001: No global CDQPs are defined for cdqpgrp 040324145520.097607:T001: No global CDQPs are defined for cdqpusr TIBCO iProcess Engine (Oracle) for Windows Installation 180 | Appendix B Troubleshooting These errors indicate that no global group or user CDQP entries were found on the system to be imported. If you are not using global CDQPs these errors can be ignored. TIBCO iProcess Engine (Oracle) for Windows Installation Upgrade Fails Because It Cannot Create the Process Sentinels Process 181 | Upgrade Fails Because It Cannot Create the Process Sentinels Process Problem Description Setup displays the following fatal error: InstallService(): CreateService (iProcess staffw_nod1 iProcess Sentinels) The specified service has been marked for deletion. The Services dialog was open when you ran Setup. If the Services dialog is open when Setup runs, Setup cannot upgrade the indicated iProcess Engine service. What to Do To correct this error: 1. Close the Services dialog. 2. Run Setup again - see page iv. TIBCO iProcess Engine (Oracle) for Windows Installation 182 | Appendix B Troubleshooting Recovering the iProcess Engine/Process Engine if an Upgrade Fails Problem Description In some circumstances, it is possible that an upgrade can fail and leave the iProcess Engine system in an unusable condition. If this happens: 1. You must restore your original system to its previous condition before you can either use it or attempt to upgrade it again. 2. If you suspect that: — the error was caused by an external factor (for example, a system hardware failure while the upgrade was in progress), you can, if you wish, attempt to upgrade the system again. — the error was connected with the upgrade process itself (for example, Setup crashes for unknown reasons), TIBCO recommend that you do not attempt to upgrade again. Instead, you should contact TIBCO Support for further assistance. What to Do To restore your original system: 1. Log in as the background user e.g. swpro (for a pre-Version 10.6 system) or as the IPEADMIN user (for a Version 10.6 or later system). 2. If you have upgraded from a Version 9.0-o Process Engine that was running against an Oracle8i database, and: — you intend to attempt to upgrade again, you must now do one of the following: • restore the backup of the iProcess Oracle8i database schema to your Oracle server. (Whether or not this is possible depends upon the way the backup was made.) • revert your Oracle Server from Oracle9i or Oracle10g back to Oracle8i. — you intend to revert back to the Version 9.0-o system, and not attempt to upgrade again, you must revert your Oracle Server from Oracle9i or Oracle10g back to Oracle8i. Refer to your Oracle documentation and/or Oracle DBA for more information about these options. 3. If you have reverted your Oracle Server from Oracle9i or Oracle10g back to Oracle8i, or if you have upgraded from an iProcess Engine, restore the backup of the iProcess database schema. Refer to your Oracle documentation for more information about how to do this. 4. Delete the SWDIR directory structure. TIBCO iProcess Engine (Oracle) for Windows Installation Recovering the iProcess Engine/Process Engine if an Upgrade Fails 183 | 5. Restore your backup of the SWDIR directory structure. Refer to your operating system documentation for more information about how to do this. 6. Run the SWDIR\bin\fixperms program, to grant appropriate permissions on all files in and under SWDIR. Use the command: SWDIR\bin\fixperms -r -y SWDIR The system should now be restored to the same state it was in before you attempted to upgrade it. TIBCO iProcess Engine (Oracle) for Windows Installation 184 | Appendix B Troubleshooting mscluster Command Reports Error in \etc\services File Problem Description When you install the iProcess Engine, Setup writes the port numbers used by the iProcess Engine watcher and worker process sentinels to the %systemroot%\system32\drivers\etc\services file. The SWDIR\mscluster\mscluster utility attempts to replicate these entries to the %systemroot%\system32\drivers\etc\services file on the Windows cluster node (see page xiv). If it encounters an error, the utility displays this message: Checking entries in 'etc\services' followed by one of the errors listed below. Error Meaning Error: watcher port number Number already in use by 'process' mscluster cannot create the required entry for the watcher process because the allocated port Number is already in use on this machine by the indicated process. You will need to either change the port number used by the indicated process, or use a different port number for the watcher process. Error: port mismatch for watcher entry 'nodename_watcher’ - entry currently uses CurrentNumber rather than NewNumber' mscluster cannot create the required entry for the watcher process because an entry already exists for it. The current entry uses port CurrentNumber but mscluster needs to allocate port NewNumber to it. You will need to manually update the existing entry. The error messages are shown for the watcher process. The same errors can also occur for the worker process. What to Do To resolve this problem: 1. Using a suitable text editor, open the %systemroot%\system32\drivers\etc\services file. 2. If necessary, change the port number allocated to the other process indicated in the error message. TIBCO iProcess Engine (Oracle) for Windows Installation mscluster Command Reports Error in \etc\services File 185 | 3. Add the required entry for the watcher (or worker) process, in the format: nodename_SentinelType Number/tcp [# Comment] where: — nodename is the iProcess Engine nodename. — SentinelType is either watcher or worker, as shown in the error message. — Number is the port number you want to use - either the original number that mscluster tried to use (as reported in the error message) or a different number, as required. The port number must be a unique entry in this file (i.e. not used by any other entry). There must be a blank line left at the bottom of the services file otherwise the last line is ignored. — Comment (optional) is any descriptive text you want to add. 4. Save the file. 5. If you have used a different port number to the one that mscluster tried to use, you must replicate this change to the other machines in the iProcess Engine system. Repeat steps 1 to 4 on the iProcess Engine master server, any iProcess Engine slave servers, and each other machine in the Windows cluster. TIBCO iProcess Engine (Oracle) for Windows Installation 186 | Appendix B Troubleshooting Process Sentinels Do Not Start Due to Logon Failure Problem Description When you try to start the iProcess Engine for the first time, the iProcess nodename Process Sentinels service fails to start and displays the following error message (system error 1069): The service did not start due to a logon failure. . See the TIBCO iProcess Engine Administrator’s Guide for more information about how to start the iProcess Engine. When you install the iProcess Engine, Setup assigns the "Log on as a service" right to the user account you have chosen to use to run the iProcess nodename Process Sentinels service (the IPESERVICE user - see page xviii). The right is assigned on the computer where you have installed the iProcess Engine. However, a conflict can occur if: • you have installed the iProcess Engine in a domain, using domain users, and • the domain uses a group policy for the "Log on as a service" right, but the policy does not include the IPESERVICE user. The domain controller propagates the group policy to the member machines in the domain at regular intervals (by default, every 90 minutes). When this happens, the IPESERVICE user’s locally-assigned right will be overwritten by the group policy. The account therefore loses the "Log on as a service" right, and so cannot start the iProcess nodename Process Sentinels service. What to Do To resolve this problem: 1. Change the group policy on the domain controller for the "Log on as a service" right to include the IPESERVICE user. You must have access to an account that has Domain Administrator privileges to be able to change the group policy. 2. On the computer running the iProcess Engine, either wait for the domain controller to refresh the group policy, or use the Microsoft gpupdate tool to update the policy immediately. 3. Start the iProcess Engine. The iProcess nodename Process Sentinels service should start correctly. TIBCO iProcess Engine (Oracle) for Windows Installation Process Sentinels Do Not Start Due to Logon Failure 187 | See Also Refer to your Microsoft documentation for more information about group policies, how to change them, and the gpupdate tool. TIBCO iProcess Engine (Oracle) for Windows Installation 188 | Appendix B Troubleshooting iProcess Engine Processes Do Not Start Problem Description When you try to start the iProcess Engine for the first time, the iProcess nodename Process Sentinels service starts but the remaining iProcess server processes do not appear. See the TIBCO iProcess Engine Administrator’s Guide for more information about how to start the iProcess Engine and the processes that should appear when you start it. iProcess Engine processes communicate by publishing and subscribing to events. When the iProcess Engine starts, a START event is issued. The Process Sentinels subscribe to that event, which causes them to start the necessary iProcess Engine server processes. The Staffware Events COM+ application provides event handling functionality for the iProcess Engine. If there is a problem with this application, events cannot be processed, so the Process Sentinels do not receive the START event and therefore do not start the iProcess Engine server processes. The Staffware Events application runs using the IPESERVICE Windows account (see page vi and page xviii). When the application starts up, it authenticates the IPESERVICE user, either: • on the local machine, if local accounts are being used, or • on the appropriate domain controller, if domain or trusted domain accounts are being used, or if the iProcess Engine is installed in an Active Directory environment. If authentication fails, the Staffware Events COM+ application fails to start. Possible reasons for authentication failure are: • The application cannot contact the domain controller for some reason - for example, transient network problems. • Incorrect user name - the wrong IPESERVICE user is being used. • Incorrect password for the IPESERVICE user. This can occur if the IPESERVICE user account has been deleted and recreated for any reason. An encrypted identifier is associated with each instance of a username/password combination. Although the recreated username/password are the same, this identifier is different, so authentication fails. The password must be manually re-entered. TIBCO iProcess Engine (Oracle) for Windows Installation iProcess Engine Processes Do Not Start 189 | What to Do To try and correct any problems with the Staffware Events application: 1. Click the Start button, point to Settings, click Control Panel, double-click Administrative Tools, and then double-click Component Services. The Component Services console is displayed.. On Windows Vista, run dcomcnfg to display the Component Services console. 2. In the left-hand pane, select Component Services > Computers > My Computer > COM+ Applications. 3. Right-click COM+ Applications and click View > Status View. The right-hand pane shows whether or not the Staffware Events application is currently running. On Windows Server 2003, the Staffware Events application does not run all the time. It shuts down automatically when it is idle, and restarts automatically when an event occurs. 4. Right-click Staffware Events and click Properties. 5. On the Identity tab (which specifies the account that the Staffware Events application runs under): a. Make sure that the This user radio button is selected, and that the specified User is the correct IPESERVICE user for this installation (see page xviii). b. Re-enter the password for this user in both the Password and Confirm Password fields. 6. Click OK. 7. If the Staffware Events application is currently running, right-click it and click Shut down. 8. Right-click Staffware Events and click Start. Make sure that the application is running. You should now be able to start the iProcess Engine server processes. To do this: 1. Log in as the IPEADMIN user (see page vi and page xvii). 2. Make sure that the iProcess nodename Process Sentinels service is running. TIBCO iProcess Engine (Oracle) for Windows Installation 190 | Appendix B Troubleshooting 3. Use the command: SWDIR\bin\swstart If you have installed on Windows Vista and User Account Control is turned on, you must elevate the command prompt window. Right-click on it and select Run As Administrator 4. Check that the appropriate server processes start (using either SWDIR\util\swadm or Task Manager). TIBCO iProcess Engine (Oracle) for Windows Installation Distributed Transaction Errors Occur When You Start the iProcess Engine 191 | Distributed Transaction Errors Occur When You Start the iProcess Engine Problem Description When you start the iProcess Engine for the first time, the following error message is repeatedly written to the SWDIR\logs error file. 2007/01/26 12:02:36(BG:1:6088:1:pro:idl.c:7.148:5826): 1945-Database error: idl_SQL_allocate_connection_from_pool() idl_SQL_enlist_connection() Failed This error indicates that the TIBCO iProcess COM Server Plug-in has been registered, but is unable to successfully complete a distributed transaction due to permissions problems. These problems are most likely caused by using an iProcess environment that does not properly support distributed transactions. See page ix for more information. What to Do To stop the error being written to the SWDIR\logs error file, unregister the iProcess COM Server Plug-in, using the following command: SWDIR\util\sweaireg UNREG eaicom The iProcess Engine will not be able to process any EAI COM steps after you have done this. If you need to be able to process EAI COM steps, you will need to either re-install and/or re-configure the iProcess Engine to use an environment that supports distributed transactions, or investigate the particular permissions problems to see if any workarounds are available. Contact TIBCO Support for further assistance. TIBCO iProcess Engine (Oracle) for Windows Installation 192 | Appendix B Troubleshooting TIBCO iProcess Engine (Oracle) for Windows Installation Log Files 193 | Appendix C Log Files This appendix describes the different log files that Setup may write to the SWDIR\logs directory during the course of an installation or upgrade. Topics • sw_error, sw_warn, page 194 • init2Kora_tok.sql_UserName_TimeStamp.log, page 195 • ScriptName.sql_UserName_TimeStamp.log, page 196 • upgrFromtoTo.log, page 197 • PostChecks_UserName_TimeStamp.log, page 198 Filename Description TIBCO iProcess Engine (Oracle) for Windows Installation 194 | Appendix C Log Files sw_error, sw_warn sw_error and sw_warn are system log files, used to record information, warning and error messages. Errors can be written to these files during installation or upgrade in the following circumstances: • If automatic steps are not correctly replaced after an upgrade. See page 117. For a full description of the sw_error and sw_warn files and their contents, see the TIBCO iProcess Engine System Messages guide. TIBCO iProcess Engine (Oracle) for Windows Installation init2Kora_tok.sql_UserName_TimeStamp.log 195 | init2Kora_tok.sql_UserName_TimeStamp.log This file logs the progress of the init2Kora_tok.sql SQL script used to create the iProcess Engine database schema. The log file is always created when the script is run, whether the script runs successfully or not. See: • page 109 for more information about the initialization script. • page 173 if errors are reported in this log file. TIBCO iProcess Engine (Oracle) for Windows Installation 196 | Appendix C Log Files ScriptName.sql_UserName_TimeStamp.log This file logs the progress of the ScriptName.sql SQL script used to upgrade the iProcess Engine database schema from one version to another. Multiple upgrade scripts can be run during an upgrade, depending on the version being upgraded from. A log file is always created for each upgrade script that is run, whether the script runs successfully or not. See: • page 109 for more information about the upgrade scripts. • page 174 if errors are reported in one of these log files. TIBCO iProcess Engine (Oracle) for Windows Installation upgrFromtoTo.log 197 | upgrFromtoTo.log This file logs errors that occurred during an upgrade stage, where From indicates the version being upgraded from, and To indicates the version being upgraded to. An upgrFromtoTo.log file is only created if an error occurs (whether fatal or not). Multiple upgrFromtoTo.log files may be created. See page 179 for more information. TIBCO iProcess Engine (Oracle) for Windows Installation 198 | Appendix C Log Files PostChecks_UserName_TimeStamp.log This file logs the progress of various post-installation checks that Setup runs to validate that the installation or upgrade has succeeded. This file is always created when you run Setup, and always contains some initial debug information, like the following example. 070130153435.774993:A001: fil_pattr_register_callback : Added callback(0/1) MBOXSET_MSG to attribute(19) MBSET_WRITE_BG 070130153435.820335:i001: iqlDbQueueRead : idl_select_uni failed..Returned 100 070130153435.820497:i001: iqlQueueInit(): failed to get information about DEADQUEUE: 0 070130153435.823555:i001: iqlDbQueueRead : idl_select_uni failed..Returned 100 070130153435.823658:i001: iqlQueueInit(): failed to get information about DEADQUEUE: 0 This debug information does not indicate that a validation error has occurred, and can be ignored. If Setup displays one of the following error messages when it performs its post-validation checks, this file also contains additional information about the error. See page 177 for more information. Failed to subscribe, publish or receive a COM+ event. ErrorDescription Failed to access the database and validate the nodename. TIBCO iProcess Engine (Oracle) for Windows Installation ErrorDescription | 199 Appendix D Scripted Installation This appendix describes how to use the Setup installation program to perform a scripted (non-interactive) installation of the iProcess Engine. Topics • Performing a Scripted Installation, page 200 TIBCO iProcess Engine (Oracle) for Windows Installation 200 | Appendix D Scripted Installation Performing a Scripted Installation You can run a scripted installation by using a control file, which provides all the information that setup would obtain by prompting you. The control file is created when you run setup interactively in the normal way. All the configuration information that you supply is written to a control file. You can subsequently use this control file as a script to run a similar installation automatically, without needing you to enter values at the dialogs. You may want to do this if, for example, you are installing a master server and multiple slave servers: you would run setup interactively for the master server and use the resulting control file to run scripted installations on each slave server. Creating the Control File Create the control file as follows: 1. Carry out all the necessary pre-installation tasks (see page 35). 2. Open a command window. 3. Type the following command: setupdir\setup.exe -bC:\spoinfo.reg -r -f1 file.rst If you have installed on Windows Vista and User Account Control is turned on, you must elevate the command prompt window. Right-click on it and select Run As Administrator where: — setupdir is the directory from which you run setup.exe; see Running Setup on page 76 for details. — file.rst is the full path of the control file in which you want to record your responses to the installation prompts. For example: E:\TIBCO\setup.exe -bC:\spoinfo.reg -r -f1C:\ipe107.rst 4. Run setup.exe, entering the required values to all the prompts as normal. If you have installed on Windows Vista and User Account Control is turned on, you must elevate the command prompt window. Right-click on it and select Run As Administrator 5. Carry out the post-installation tasks (see page 114). TIBCO iProcess Engine (Oracle) for Windows Installation Performing a Scripted Installation 201 | 6. Start the iProcess Engine, log in, and make sure that it has been correctly installed. Performing a Scripted Installation To perform a scripted installation: 1. Prepare a control file to use for the scripted installation, as described above. 2. On each machine where you wish to install iProcess Engine, carry out all the necessary pre-installation tasks (see page 35). 3. Log in as a user who is a member of the Administrators group - see Choosing the IPEINSTALL User on page 5. 4. Open a command window. 5. Type the following command: setupdir/setup.exe -bC:\spoinfo.reg -s -f1C: file.rst If you have installed on Windows Vista and User Account Control is turned on, you must elevate the command prompt window. Right-click on it and select Run As Administrator. where: — setupdir is the directory from which you run setup.exe; see Running Setup on page 76 for details. — file.rst is the full path of the control file which you have created 6. Setup.exe installs the iProcess Engine, automatically getting the necessary information from the control file. 7. Carry out the post-installation tasks (see page 114). 8. Start the iProcess Engine, log in, and make sure that it has been correctly installed. TIBCO iProcess Engine (Oracle) for Windows Installation 202 | Appendix D Scripted Installation TIBCO iProcess Engine (Oracle) for Windows Installation | 203 Appendix E Upgrading TIBCO EMS TIBCO iProcess Engine version 10.6.x was shipped with a version of TIBCO EMS which contains a security vulnerability (EMS 4.4.1 or earlier). See the following link for more information. http://www.tibco.com/resources/mk/ems_security_advisory_20080115.txt In order to fix the vulnerability EMS must be updated to version 4.4.2 or later. It is therefore fixed by upgrading EMS to the version required for TIBCO iProcess Engine Version 11.1.3. TIBCO iProcess Engine (Oracle) for Windows Installation 204 | Appendix E Upgrading TIBCO EMS Updating EMS The EMS installer does not currently offer an upgrade option. The install process removes any queues, topics, factories or other configuration that has been applied to the EMS server and restores a default configuration. In order to backup and restore all your existing EMS queues, factories, topics, queue messages, topic messages and configuration use the following process: 1. Stop your EMS application(s). 2. Stop tibemsd and tibemsadmin. 3. Make a copy of all .conf files and .db files found under the ems/bin directory and its sub-directories. 4. Uninstall the old EMS version. 5. Install the new EMS version. 6. Replace your .conf and .db files from step 3. For more detailed instructions on how to install and uninstall EMS, please refer to the TIBCO Enterprise Message Service Installation guide. It is important that this configuration is maintained because iProcess features such as IAPJMS, Technology Plug-ins and Web Services Plug-in rely on various EMS queues and topics to function correctly. IAPJMS Specific Procedure With a basic iProcess Engine installation, EMS can be used by the IAPJMS process for activity publication. After the upgrade IAPJMS will continue to function. IAPJMS uses client jar files found in the EMS install directory to connect to EMS. As long as the configuration is correct no other update should be needed. TIBCO iProcess Web Services Plug-in Specific Procedure The TIBCO iProcess Web Services Plug-in can be configured to use EMS as the JMS provider; in this case an additional step is required after the EMS upgrade. • Update the tibjms.jar file stored under SWDIR\jetty-6.1.1\jms\tibco to the new version supplied with the updated EMS server. TIBCO iProcess Engine (Oracle) for Windows Installation Updating EMS 205 | TIBCO iProcess Technology Plug-in Specific Procedure The TIBCO iProcess Technology Plug-in uses EMS to communicate with the BusinessWorks Engine when iProcess Engine ->BusinessWorks EAI steps are being defined. The following additional step is required after EMS has been updated. • Update the tibjms.jar file stored under SWDIR\jmslib\ems to the new version supplied with the updated EMS server. TIBCO iProcess Engine (Oracle) for Windows Installation 206 | Appendix E Upgrading TIBCO EMS TIBCO iProcess Engine (Oracle) for Windows Installation