Tib TRA Script Deploy Usr

TIBCO Runtime Agent™
Scripting Deployment User’s Guide

Software Release 5.10
August 2015
Two-Second Advantage®
Important 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, Two-Second Advantage, TIBCO Hawk, TIBCO Rendezvous, TIBCO Runtime Agent, TIBCO
ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO Designer, TIBCO ActiveMatrix Service Gateway,
TIBCO BusinessEvents, TIBCO BusinessConnect, and TIBCO BusinessConnect Trading Community
Management are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or
other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition
(J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation
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.
This Product is covered by U.S. Patent No. 6,970,981.
Copyright © 1998-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Changes from the previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
TIBCO Runtime Agent Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
Chapter 1 Scripting Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
buildear Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
AppManage Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Credential File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installed Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Starting the Scripting Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Accessing Online Help for Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Specifying Application Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Working with Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Protecting Sensitive Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
AppManage Log Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
buildear Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Simple Application Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Complex Application Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
TIBCO Runtime Agent Scripting Deployment User’s Guide

iv
| Contents
Redeploying an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Changes Made to EAR file Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Changes Made to Deployment File Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Changes Made to EAR and Deployment Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Exporting an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Other Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
-upload Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
-config Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
-undeploy Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
-delete Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
-start Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
-stop Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
-breaklock Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
–override Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
-min Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
-max Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
-template Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
-password Option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
-passwordFile Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
-moveAppData Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
-truncate Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
-serialize Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
-exportDeployed Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Monitoring Events and Rulebases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Event Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Rulebase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Setting Service Instance Runtime Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Chapter 3 Using AppManage in Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Creating the AppManage.batch File by Exporting Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Deploying Applications in Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Undeploying Applications in Batch Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Starting Applications in Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Stopping Applications in Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Deleting Applications in Batch Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Killing Applications in Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Changing the Transport for Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Appendix A Deployment Configuration File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Contents v
|
AppManage XSD Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Icons Used in the Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Application Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
NVPairs Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
RepoInstances Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
services Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
httpRepoInstance Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
rvRepoInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
bindings Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
monitor Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
product Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
setting Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
shutdown Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
NTService Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
java Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
rulebases Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
events Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
failureEvent Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
suspendProcessEvent Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
logEvent Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
alertAction Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
emailAction Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
customAction Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
bw Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
bwprocesses Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
checkpoints Element. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
faultTolerant Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
adapter Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
formFlow Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
authentications Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Requires Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
CookieAuthenticationConfiguration Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
HttpSessionAuthenticationConfiguration Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
WebServerAuthenticationConfiguration Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ExternalAuthenticationConfiguration Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Appendix B Failure Code List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

vi
| Contents

Figures vii
|
Figures
Figure 1 TIBCO Administrator GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Figure 2 Partial Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Figure 3 Application Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Figure 4 NVPairs Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Figure 5 RepoInstances Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Figure 6 services Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 7 httpRepoInstance Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Figure 8 rvRepoInstance Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Figure 9 bindings Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Figure 10 monitor Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Figure 11 product Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Figure 12 setting Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Figure 13 shutdown Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Figure 14 NTService Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Figure 15 java Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Figure 16 rulebases Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Figure 17 events Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Figure 18 failureEvent Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Figure 19 suspendProcess Event Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Figure 20 logEvent Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Figure 21 alertAction Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Figure 22 emailAction Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Figure 23 customAction Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Figure 24 bw Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Figure 25 bwprocesses Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Figure 26 checkpoints Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Figure 27 faultTolerant Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Figure 28 adapter Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

viii
| Figures
Figure 29 formFlow Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Figure 30 authentications Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Figure 31 RequiresAuthetication Element Diagram. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Figure 32 CookieAuthenticationConfiguration Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Figure 33 HttpSessionAuthenticationConfiguration Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Figure 34 WebServerAuthenticationConfiguration Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Figure 35 ExternalAuthenticationConfiguration Element Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Tables ix
|
Tables
Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Table 2 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Table 3 Application Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Table 4 NVPairs Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 5 RepoInstances Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 6 services Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 7 httpRepoInstance Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 8 rvRepoInstance Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Table 9 bindings Element Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Table 10 monitor Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Table 11 product Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Table 12 setting Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 13 shutdown Element Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Table 14 NTService Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Table 15 java Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 16 rulebases Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 17 events Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Table 18 failureEvent Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Table 19 suspendProcess Event Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Table 20 logEvent Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Table 21 alertAction Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Table 22 emailAction Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Table 23 customAction Element Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Table 24 bw Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Table 25 bwprocesses Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Table 26 checkpoints Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Table 27 faultTolerant Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Table 28 adapter Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

x
| Tables
Table 29 formFlow Element Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Table 30 authentications Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Table 31 RequiresAuthetication Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Table 32 CookieAuthenticationConfiguration Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Table 33 HttpSessionAuthenticationConfiguration Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Table 34 WebServerAuthenticationConfiguration Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Table 35 ExternalAuthenticationConfiguration Element Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Table 36 Failure Code List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

| xi
Preface
This document details the command line utility AppManage, by which you can
automate and customize application deployment tasks using shell scripts.
Topics
• Changes from the previous Release of this Guide, page xii

• Related Documentation, page xiii
• Typographical Conventions, page xv
• Connecting with TIBCO Resources, page xviii

xii
| Changes from the previous Release of this Guide
Changes from the previous Release of this Guide
All the screenshots have been updated with new TIBCO logo.

Preface xiii
|
Related Documentation
This section lists documentation resources you may find useful.
TIBCO Runtime Agent Documentation

The TIBCO Runtime Agent™ software suite is a prerequisite for other TIBCO
software products. In addition to Runtime Agent components, the software suite
includes the third-party libraries used by other TIBCO products, TIBCO
Designer™, Java Runtime Environment (JRE), TIBCO Rendezvous®, and TIBCO
Hawk®.
The following documents form the TIBCO Runtime Agent™ documentation set:
• TIBCO Runtime Agent™ Installation Read this manual for instructions on site
preparation and installation.
• TIBCO Runtime Agent™ Installing Into a Cluster Read this manual for
instructions on installing TIBCO applications into a cluster environment.
• TIBCO Runtime Agent™ Upgrading to Release 5.10.0 Read this manual for
instructions on upgrading from release 5.x to release 5.10.0.
• TIBCO Runtime Agent™ Domain Utility User’s Guide Read this manual for
instructions on using TIBCO Domain Utility to create and manage
administration domains.
• TIBCO Runtime Agent™ Scripting Deployment User’s Guide Read this manual
for instructions on using the AppManage scripting utility to deploy
applications.
• TIBCO Runtime Agent™ Authentication API User's Guide Read this manual for
instructions on using Authentication API.
• TIBCO Runtime Agent™ 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.
Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCO
products:
• TIBCO Administrator™ : TIBCO Administrator allows you to manage users,
machines and applications defined in a TIBCO administration domain. The
TIBCO Administrator graphical user interface enables users to deploy,
monitor, and start and stop TIBCO applications.

xiv
| Related Documentation
• TIBCO Designer™: This graphical user interface is used for designing and
creating integration project configurations and building an Enterprise Archive
(EAR) for the project. The EAR can then be used by TIBCO Administrator for
deploying and running the application.
• TIBCO Hawk®: This is a tool for monitoring and managing distributed
applications and operating systems.
• TIBCO Rendezvous®: Rendezvous enables programs running on many
different kinds of computers on a network to communicate seamlessly. It
includes two main components: the Rendezvous application programming
interface (API) in several languages, and the Rendezvous daemon.
• TIBCO Enterprise Message Service™: This software lets application programs
send and receive messages using the Java Message Service (JMS) protocol. It
also integrates with TIBCO Rendezvous and TIBCO SmartSockets®
messaging products.
• TIBCO ActiveMatrix BusinessWorks™: ActiveMatrix BusinessWorks is a
scalable, extensible, and easy to use integration platform that allows you to
develop integration projects. ActiveMatrix BusinessWorks includes a GUI for
defining business processes and an engine that executes the process.
• TIBCO® Adapter software: TIBCO Runtime Agent is a prerequisite for TIBCO
Adapter products. You will therefore find TIBCO Adapter product
documentation useful.

Preface xv
|
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention Use
ENV_NAME TIBCO products are installed into an installation environment. A product
installed into an installation environment does not access components in other
TIBCO_HOME
installation environments. Incompatible products and multiple instances of the
TRA_HOME same product must be installed into different installation environments.
An installation environment consists of the following properties:
• Name Identifies the installation environment. This name is referenced in
documentation as ENV_NAME. On Microsoft Windows, the name is
appended to the name of Windows services created by the installer and is a
component of the path to the product shortcut in the Windows Start > All
Programs menu.
• Path The folder into which the product is installed. This folder is referenced
in documentation as TIBCO_HOME.
TIBCO Runtume Agent installs into a directory within a TIBCO_HOME. This
directory is referenced in documentation as <ProductAcronym>_HOME. The
default value of <ProductAcronym>_HOME depends on the operating system.
For example on Windows systems, the default value is
C:\tibco\<ProductAcronym>\<ReleaseNumber>.
code font Code font identifies commands, code examples, filenames, pathnames, and
output displayed in a command window. For example:
Use MyCommand to start the foo process.
bold code Bold code font is used in the following ways:

font
• In procedures, to indicate what a user types. For example: Type admin.
• In large code samples, to indicate the parts of the sample that are of
particular interest.
• In command syntax, to indicate the default parameter for a command. For
example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]

xvi
| Typographical Conventions
Table 1 General Typographical Conventions (Cont’d)
Convention Use
italic font Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO ActiveMatrix
BusinessWorks Concepts.
• To introduce new terms For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must replace.
For example: MyCommand PathName
Key Key name separated by a plus sign indicate keys pressed simultaneously. For
combinations example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.
Table 2 Syntax Typographical Conventions
Convention Use
[ ] An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
| A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand param1 | param2 | param3

Preface xvii
|
Table 2 Syntax Typographical Conventions (Cont’d)
Convention Use
{ } A logical group of items in a command. Other syntax notations may appear
within each logical group.
For example, the following command requires two parameters, which can be
either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter
can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters.
The first parameter must be param1. You can optionally include param2 as the
second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}

xviii Connecting with TIBCO Resources
|
Connecting with TIBCO Resources
How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and
resident experts. It is a place to share and access the collective experience of the
TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety
of resources. To register, go to http://www.tibcommunity.com.
How to Access TIBCO Documentation

You can access TIBCO documentation here:
http://docs.tibco.com
How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, 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:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user
name, you can request one.

Scripting Deployment 1
|
Chapter 1 Scripting Deployment
This chapter introduces the TIBCO Runtime Agent™ scripting utilities that are
used to upload, configure and deploy applications in administration domains.
Topics
• Overview, page 2
• buildear Utility, page 3
• AppManage Utility, page 4
• Installed Files, page 6
• Starting the Scripting Utilities, page 7
• Accessing Online Help for Commands, page 8
• Working with Passwords, page 11
• Log Files, page 13

2
| Chapter 1 Scripting Deployment
Overview
The scripting tools allow you to build an EAR file for an application configured in
TIBCO Designer, then load the application into one or more TIBCO Administrator
administration domains. Deployment options can be specified in a deployment
configuration file that is created using the AppManage utility.
• If your application is not complex and needs only machine bindings defined
for each domain, you can use the AppManage utility to create the deployment
configuration file from information in the EAR file, then edit the configuration
file with the machine names where the applications will be deployed. In this
scenario, the TIBCO Administrator GUI is not used.
• If your application is complex and needs more then machine bindings
defined, you can import an EAR file into the TIBCO Administrator GUI and
specify deployment configuration options for the application. This method is
preferred if your application includes complex mappings, such as fault
tolerance, runtime variables, alerts and so on.
In this scenario, the TIBCO Administrator GUI is used to initially set the
application’s deployment configuration options. After the options are set, the
TIBCO Administrator GUI is no longer used. The AppManage utility updates
the deployment configuration file from the application configured in the
TIBCO Administrator GUI. The file is edited for each administration domain
by changing machine bindings and so on, then deployed into each
administration domain.

buildear Utility 3
|
buildear Utility
The buildear utility builds an EAR file based on the Enterprise Archive
resource that is defined in a TIBCO Designer project. The project directories and
files must be writable so that buildear can save the file. When saving, buildear
increments the archive build number and saves it to the project.
An EAR file size can be very large. You should ensure that the machine on which
the EAR file is loaded and deployed has sufficient disk space. See Enterprise
Archive File Size in TIBCO Designer User’s Guide for details.
It is recommended that you configure the components that are included in the
archive and build the archive in TIBCO Designer. After the archive is built you
can use buildear to send the archive to multiple machines.
On UNIX platform, the builder utility requires configuration of X Server Manager

(X11) or XVFB (X Virtual FrameBuffer). The builder utility fails when X server or
XVFB does not run or when the DISPLAY environment variable is not set
properly.

4
AppManage Utility
The AppManage utility creates an XML based deployment configuration file in

which deployment options can be defined. The utility also uploads the
deployment file and EAR file into a TIBCO Administrator administration domain.
The AppManage utility can be used to:
• Create a deployment configuration file based on information in an EAR file ,
or from an application already configured in the TIBCO Administrator GUI.
• Upload an EAR file to an administration domain without specifying
deployment configuration options. After the file is imported, it is ready to be
configured with deployment options and deployed using the TIBCO
Administrator GUI.
• Upload an EAR file and a deployment configuration file into an
administration domain in one operation. The application is uploaded with its
deployment options set, but is not deployed.
• Upload an EAR file and a deployment configuration file and deploy the
application in one operation. Using this method, you can quickly deploy your
applications in multiple domains.
• Export all application archives and deployment configuration files within a
domain, so they can be batch deleted, started, stopped, undeployed, or
deployed in another domain. For TIBCO Rendezvous administration
domains, you can change the transport set for application to administration
server communication, from rv (Rendezvous) to local, or the reverse.
• Undeploy a deployed application.
• Delete an application from an administration domain.
• Start a service instance of an application.
• Stop a successfully deployed service instance of an application.
Credential File
A credential file contains the administration domain user’s name and encrypted
password.
The -cred option takes the name and location of a property file containing
username and encrypted password. If the -cred option is used, the -user and-pw
options should not be used.

AppManage Utility 5
|
In some cases, message "Specify userID and password" is generated even after
providing the credential file because of incorrect credential file or it doesn't
contain the required two field in proper format : - user pw
When invoking an AppManage option, use the -cred option to specify the name
and location of the property file.
AppManage -upload -ear <ear_name> -cred <file-path\cred123.txt>
-domain <domain_name>
To Create a Sample Credential File:

1. Create a text file with the username and password entries only as shown next.
Add the prefix #! to the password.
user=admin
pw=#!ax86n0ty
2. Save the file and invoke the utility giving the file as input.
Sample Credential file:

user=username-1
pw=#!password-1
user=username-2
pw=#!password-2
.....
.....
.....
user=username-N
pw=#!password-N

6
Installed Files
The installation log file is written to the TIBCO_HOME/log directory.
AppManage Utility
The AppManage utility and the AppManage.tra file are installed in the
TIBCO_HOME/tra/version/bin directory. The AppManage.jar file is installed in
the TIBCO_HOME/tra/version/lib directory.
Buildear Utility
The buildear utility and the buildear.tra file are installed in the
TIBCO_HOME/tra/version/bin directory.

Starting the Scripting Utilities 7
|
Starting the Scripting Utilities
This section explains how to start the AppManage and buildear utilities.
Starting AppManage
To start the AppManage utility, change directory to TIBCO_HOME/tra/version/bin
and type AppManage -action. See the next section for information about using
online help for information about the actions available.
The AppManage utility must be run on a machine that is part of the administration
domain you are updating.
The user account used to run the AppManage utility must have Write permissions
set in the TIBCO Administrator GUI for the application, domain repository and
application repository that is being updated.
Starting Buildear
To start the buildear utility, change directory to TIBCO_HOME/tra/version/bin
and type buildear -options. See the next section for information about using
online help.
You should verify your project by loading it into TIBCO Designer before you use
the project with the buildear utility. If the project doesn't load correctly in TIBCO
Designer, the buildear utility doesn't support it.

8
Accessing Online Help for Commands
Online help is available for the AppManage and buildear utilities.
AppManage Help
The AppManage online help shows the command line syntax, describes each
command option and provides command line examples. For example, typing
AppManage on the command line produces the following help.
C:\tibco\tra\<version>\bin>appmanage
Usage: AppManage [options] [args...]
(to execute a task)
or AppManage -? [options]
(to print detailed message of each option)
where options include:
-export export a deployment configuration file
-upload upload an archive
-config configure an application
If -ear is specified, upload the archive first
-deploy deploy an application
If -ear is specified, upload the archive first
If -deployConfig is specified, configure the
application first
-undeploy undeploy an application
-delete delete an application
If -force is specified, undeploy the
application first.
-start start successfully deployed service instances
of an application
-stop gracefully shutdown successfully deployed
service instances of an application
-kill immediately kill successfully deployed
service instances of an application
-moveAppData Redeploy application with new location for
Application Data
-truncate Truncate the application deployment revision
-batchExport To export deployment configuration files for
all the archives under a directory
-batchUpload Uplaod all applications specified in
AppManage.batch
-batchConfig Config all applications specified in
AppManage.batch
-batchDeploy Deploy all applications specified in
AppManage.batch
-batchUndeploy Undeploy all applications specified in
AppManage.batch
-batchDelete Delete all applications specified in
AppManage.batch
-batchstart Start all applications specified in
AppManage.batch
-batchstop Stop all applications specified in
AppManage.batch
-batchkill Kill all applications specified in

Accessing Online Help for Commands 9
|
AppManage.batch
-batchMoveAppData Move Application Data to or from local for
all applications specified in AppManage.batch
To display help about a command line option, type:

AppManage -? command line option
On UNIX systems, ? has special meaning and must be enclosed within quotation
marks. To display help for a command line option on UNIX, type:
AppManage "-?" comand line option
Buildear Help
The buildear utility help can be displayed by typing:
buildear -h
The buildear utility online help does not explain that the -p and -o options
require the full path to the project and EAR file .
The buildear utility always reports success even if the operation was not
successful.
Specifying Application Names

Many AppManage commands use the -app option that specifies the application
name. The -app value must include the full path to the application as set in the
Application Management module in the TIBCO Administrator GUI. For example,
the next diagram shows two applications in the Application Management
module. The Path column lists the full path for each application. Note that the
DefaultDesktop application is at the top level and the NewHireApp is contained
in the HireApp folder.

10
Figure 1 TIBCO Administrator GUI
When running a command option such as -undeploy against the top level
DefaultDesktop application, the following syntax must be used for the -app
option:
AppManage -undeploy -app DefaultDesktop -user a -pw a -domain test
When running the same command against the NewHireApp application that is
contained in the HireApp folder, the following syntax must be used for the -app
option. A forward slash separates the folder and application name.
AppManage -undeploy -app HireApp/NewHireApp -user a -pw a -domain
test

Working with Passwords 11
|
Working with Passwords
Each action specified using the AppManage utility requires a password to access
the administration domain where the action will be executed. You can specify the
password using clear text or an encrypted key. The -pw option always takes a
clear text password. The -cred option takes the name and location of a property
file containing username and encrypted password. If the -cred option is used, the
-user and-pw options should not be used.
A credentials file contains an administration domain user’s name and encrypted

password. The obfuscate utility is used to create the encrypted password. For
example, a credentials text file containing the user name john and encrypted
password jH86n0ty is created as follows.
1. Create a text file with the username and password entries only as shown next.
Add the prefix #! to the password.
user=john
pw=#!jH86n0ty
2. Save the file and invoke the obfuscate utility giving the file as input. The
utility is in TIBCO_HOME/tra/version/bin. (Refer to TIBCO Runtime Agent
Installation for more information about Obfuscate Utility.)
3. When invoking an AppManage option, use the -cred option to specify the
name and location of the property file.
AppManage -upload -ear c:\ears\timer_wait.ear -cred
c:\ears\psswd\tp001Psw.txt -domain tp001
Passwords in the generated deployment configuration file are always encrypted.

12
Protecting Sensitive Data
When you export an application, sensitive data in the EAR file is encrypted using
either a static key or dynamically generated symmetric key, depending on
whether you choose to use dynamic symmetric key at the time of deployment.
Likewise, sensitive data in the deployment configuration file is encrypted using a
static key when it is exported. However, you can generate a custom key for better
security by specifying an encryption password. If you do so, you will also be
required to provide the same password when you upload or deploy with the
deployment configuration file.
See Other Options on page 24 for descriptions and example usage of the
-password and -passwordFile options.

Log Files 13
|
Log Files
Both the AppManage and buildear utilities write information to a log file.
AppManage Log Files

The AppManage utility writes information to a log file. The log file location
depends on whether you are accessing an administration domain or not.
• If you are not accessing an administration domain, the log is written to the
TIBCO_HOME/tra/version/logs/ApplicationManagement.log file.
• If you are accessing an administration domain, the log is written to the
TIBCO_HOME/tra/domain/domain/logs/ApplicationManagement.log file.
A comparison log file is generated if you export from an EAR file without
specifying an administration domain. This information can help you decide
whether you need to change the deployment configuration file after an EAR file
changes.
For example, using the following command line, the AppManage utility compares
the oldconfiguration.xml file with the given EAR file. If any service, global
variables, or both have been added, removed, or updated, a log file is created in
the same directory where the oldconfiguration.xml file resides, using the file
name, oldconfiguration.xml.log.
AppManage -export -ear c:\ears\timer_wait.ear -deployConfig
oldconfiguration.xml -out newconfiguration.xml
buildear Log File

The buildear utility writes information to the designer.log file. By default, on
Windows, the log is located in the C:\Documents and
Settings\user-name\.TIBCO\logs directory.
Note that the default log location can be changed in TIBCO Designer.

14

| 15
Chapter 2 Getting Started
This chapter explains how to use the AppManage utility for simple and complex
deployments.
Topics
• Simple Application Deployment, page 16

• Complex Application Deployment, page 18
• Redeploying an Application, page 20
• Exporting an Application, page 23
• Other Options, page 24
• Monitoring Events and Rulebases, page 30
• Setting Service Instance Runtime Variables, page 34

16
| Chapter 2 Getting Started
Simple Application Deployment
In this scenario, a file notification project has been modified using TIBCO
BusinessWorks. The buildear utility builds an EAR file for deployment. Based
on the EAR file, the AppManage utility creates a deployment configuration file
which includes XML tags for each deployment option. Using a text editor, the
machine binding tags are edited. The AppManage utility is then used to deploy the
application.
1. Build the EAR file.
The project is configured using TIBCO Designer. After all components in an
archive resource are configured, the buildear utility can be used to build the
EAR file.
The command line to build the EAR file is listed next. The -s option is saves
the archive as another version in the project.
You can have multiple archive resources defined in a project. The -ear option
allows you to provide the location of the archive resource that contains the
changed components. You can get the archive resource URI in TIBCO
Designer by selecting the archive and clicking Resource > Inspect Resource.
The Resource Inspector dialog shows the URI next to the icon.
The -o option identifies the location and name of the output EAR file. The
EAR file name must use the .ear suffix. If not specified, the EAR file location
for the Enterprise Archive is used.
The -p option provides the location of the TIBCO Designer project where the
archive has been created.
buildear -s -ear /filenotify.archive
-o c:\ears\deployment\filenotify.ear
-p c:\tibco\projects\filenotify
2. Create the deployment configuration file.

The deployment configuration file is created by the AppManage utility based
on information in the EAR file. The -out option provides the name and
location of the deployment configuration file. The file is created with XML
tags for all required schema and substitution variables for each machine
binding tag.
AppManage -export -ear c:\ears\deployment\filenotify.ear -out
c:\ears\deployments\filenotify.xml
3. Edit the deployment configuration file.

Before editing the file, copy it and name it based on the application and
administration domain into which the application will be deployed. Open the

Simple Application Deployment 17
|
new file and change the substitution variables defined by the AppManage
utility for the processes. In this example the <machine> XML tags are
modified with the name of the machine on which the processes run.
The generated file includes substitution variables for the machine element
value. The variables use the syntax, %%<archive-type>-machine%% (a
combination of percent symbols, archive type and computer name). During
deployment you must configure an element that uses such a variable by
replacing the substitution value with the actual value, without the percent
symbols.
<services>
<bw name="Process Archive.par">
<enabled>true</enabled>
<bindings>
<binding name="">
<machine>%%Process Archive.par-machine%%</machine>
.
.
.
<bindings>
<binding name="">
<machine>%%deuxiemeprocess.par-machine%%</machine>
.
.
.
4. Deploy the application.

The following command line uploads the EAR file and the deployment
configuration file into the tp001 domain. The -deploy action indicates that
the application is to be uploaded and deployed in one operation. The -ear
option specifies the EAR file to load and the -deployconfig option specifies
the name of the deployment configuration file. The -app option provides the
application name. The admin account is used in this example. If you are using
a normal user account, it must have the Administer permission set for the
application. Note that the application name and administration domain name
are case sensitive.
AppManage -deploy -ear c:\ears\deployment\filenotify.ear
-deployconfig c:\ears\deployment\filenotify_tp001.xml
-app filenotify -domain tp001 -user admin -pw admin

18
Complex Application Deployment
In a more complex scenario an application may require fault tolerant options,

alerts, TIBCO Hawk rulebases, and so on defined. While you could define these
options in the deployment configuration file that is generated by the AppManage
utility, it is recommended you configure the options in TIBCO Administrator and
use AppManage to generate the deployment configuration file from the application
itself.
1. Build the EAR file.
buildear -ear /dbtrigger.archive
-o c:\ears\deployment\dbtrigger.ear
-p c:\tibco\projects\dbtrigger
2. Import and configure the EAR file in TIBCO Administrator.

Start the TIBCO Administrator GUI and import the EAR file, then configure
the application with deployment options. See the TIBCO Administrator User’s
Guide for information. Exit TIBCO Administrator after the deployment
options are set.
3. Create the deployment configuration file.
The AppManage utility creates the deployment configuration file based on
information in the application you configured in the TIBCO Administrator
GUI. The -out option provides the name and location of the deployment
configuration file that will be generated by the AppManage utility. The -app
option identifies the application in the given administration domain to use.
The -template option is used so that substitution variables are created for
each machine tag.
AppManage -export -out c:\ears\deployment\dbtrigger.xml
-app dbtrigger -domain tp001 -user admin -pw admin -template
4. Edit the deployment configuration file.

Before editing the file, copy it and name it based on the application and
domain into which the application will be deployed. Open the new file and
change the <machine> XML tags to the name of the machine on which the
processes run. For example:
<services>
<bw name="Process Archive.par">
<bindings>
<binding name="">
<machine>%%Process Archive.par-machine%%</machine>
.
.
.

Complex Application Deployment 19
|
<bindings>
<binding name="">
<machine>%%deuxiemeprocess.par-machine%%</machine>
.
.
.
5. Deploy the application.

After you have set the machine bindings, you can upload and deploy the
application in one operation. The following command uploads the EAR file
and the deployment configuration file into the tp003 domain. The -deploy
option specifies that the application should be deployed. The -ear option
specifies the EAR file to load and the -deployConfig option specifies the
name and location of the deployment configuration file to use. The -app
option provides the application name. Note that the application name and
domain names are case sensitive.
AppManage -deploy -ear c:\ears\deployment\dbtrigger.ear
-deployconfig c:\ears\deployments\dbtrigger_tp003.xml
-app dbtrigger -domain tp003 -user admin -pw admin

20
Redeploying an Application
You can use the scripting utilities to redeploy an already deployed application.
The AppManage utility does not include a redeploy command; the -deploy
command is used to redeploy an application. The options to use with the -deploy
command vary depending on where changes were made. The -force option
provided for AppManage is equivalent to the Force redeployment of all services
in the TIBCO Adminitrator GUI. This section shows these options.
Changes Made to EAR file Only

If you have only changed the application’s configuration in TIBCO Designer, you
must upload the changed EAR file into the affected administration domains. For
example, you might modify a TIBCO Designer project by:
• changing an existing adapter service or form flow service
• changing an existing process within a process service by adding or deleting
new activities or changing existing activities
• adding, deleting or changing existing sub-processes
• adding, deleting or changing shared resources
In scenarios where just the application’s project has changed, build the new EAR
file using the buildear utility and use AppManage -deploy with the -ear option
to redeploy the application.
For example, the following command lines build an EAR file and redeploy the
filenotify application with the changed filenotify.ear archive file.

-app filenotify -domain tp003 -user admin -pw admim
Changes Made to Deployment File Only

If you have only changed the deployment file, you must upload the changed
deployment file. For example, you might modify the deployment file by:
• changing deployment level or service level variables
• adding or removing machines to which services are bound
• adding, deleting or changing service monitoring configurations

Redeploying an Application 21
|
• changing fault-tolerance settings for process services deployed in

fault-tolerant mode
• changing checkpoint storage from JDBC to File, or from File to JDBC ,or JDBC
to JDBC, where the new JDBC resource exists in the original shared archive
• changing process settings such as Active or Inactive State, MaxJobs, or
Activation Limit
• changing service instance configuration settings such as NT Service, Java
parameters, or log files
• changing deployment transport settings such as to Rendezvous, HTTP,
HTTPS or related parameters
In scenarios where just the deployment configuration file has changed, use
AppManage -deploy with the -deployconfig option to redeploy the application.
For example, the following command redeploys the filenotify application with
the changed filenotify_tp003.xml file.
AppManage -deploy
-deployconfig c:\ears\deployment\filenotify_tp003.xml
Changes Made to EAR and Deployment Files

If you change both the TIBCO Designer project and the deployment configuration
file, you must upload both when redeploying. For example, you may want to
make the following changes:
• add new services or delete existing services (adapter, process or form flow
archives)
• add or remove deployment level or service level variables (including Adapter
SDK properties)
• change checkpoint storage from File to JDBC or JDBC to JDBC, where the new
JDBC Shared Resource was not part of the Shared Archive in the original EAR
file
If you have changed both the TIBCO Designer project and the deployment
configuration file, complete the following steps to redeploy the changed
application:
1. Build an EAR file using the buildear utility. For example:

22
2. Generate a new deployment configuration file using the EAR file created in
the previous step, the deployment configuration file used when previously
deploying the application and specify a new deployment configuration file.
For example, when the following command is run, a log file is generated in
the same folder where the new deployment configuration file is created. The
log file lists all changes that were made to the deployment configuration file,
as a result of changes to the EAR file.
AppManage -export -ear c:\ears\deployment\filenotify.ear
-deployconfig c:\ears\deployments\filenotify.xml
-out c:\ears\deployments\filenotify-changed.xml
The new deployment configuration file may need to be further modified, for
example, by replacing machine binding substitution variables with actual
machine names for new services, modifying deployment or service level
variable values, picking up the right checkpoint repository from the list of
checkpoint repositories, and so.
3. After you have made the changes to your deployment configuration file, you
are ready to deploy the application. For example:
-deployconfig c:\ears\deployment\filenotify-changed.xml

Exporting an Application 23
|
Exporting an Application
You can use the appManage -export option to create and export an application’s
deployment configuration file and archive (EAR) file. You can also use the
appManage -batchExport option to create and export the deployment
configuration files and EAR files for all applications in an administration domain.
Exporting an EAR File and Configuring for an Application

The next command exports the deployment configuration file and creates an EAR
file for an application named myApp. The deployment configuration file and EAR
file are created in the c:\test folder. The application is embedded in
folder1/folder2/, which is relative to the Application Management root in the
TIBCO Administrator GUI. See Specifying Application Names on page 9 for more
information.
AppManage -export -out c:\test\myApp.xml -genEar -ear
c:\test\myApp.ear -app folder1/folder2/myApp -user user1 -pw user1
-domain test
Exporting EAR Files and Configuring for all Applications

You can export all applications in an administration domain using the appManage
-batchExport option. For example, the next command exports a deployment
configuration file and EAR file for each application found in the test domain.
AppManage -batchExport -user user1 -pw user1 -domain test -dir
c:\temp\test
When performing batch jobs with AppManage in a database-based domain, make

sure that your database server is configured with a sufficiently large connection
pool so that you do not run out of JDBC connections. For more information, see
Configuring Connection Pool Size for the Database Server in TIBCO Administrator
Server Configuration Guide.

24
Other Options
In addition to the -export and -deploy options, the AppManage utility allows
you to use:
• -upload to upload an application into an administration domain without
configuring the application’s deployment options.
• -config to upload an application along with its deployment configuration
file, which defines the application’s configuration options, but not deploy the
application.
• -undeploy to undeploy an application.
• -delete to remove an application from an administration domain.
• -start or -stop to start or stop a service or process configured under an
application.
• -override to use global variable values defined in the EAR file, instead of
those defined in the original deployment configuration file when redeploying.
• -min to generate only XML tags for options you have changed.
• -max to export a template deployment configuration file with every possible
setting included.
• -template to generate a deployment configuration file in template format.
• -password to prompt for a password that is used to encrypt or decrypt
sensitive data in the deployment configuration file.
• -passwordFile to use a password file to encrypt or decrypt sensitive data in
the deployment configuration file.
• -MoveAppData to change the transport setting for a given application.
• -truncate to truncate the application deployment revision.
• -desc to specify a description for the deployed application.
• -serialize to deploy service instances one at a time instead of in parallel.
• -exportDeployed to export the configuration for the last successful
deployment rather than what is currently being modified and will be used for
the next deployment.

Other Options 25
|
-upload Option
You can use the AppManage utility to upload an EAR file into an administration
domain. Specifying the -upload option is identical to importing an EAR in the
TIBCO Administrator GUI. The application is loaded, but no deployment options
are specified and the application is not deployed.
AppManage -upload -ear c:\ears\timer_wait.ear -user admin -pw admin
-domain tp002
-config Option
You can upload an EAR file and a deployment configuration file into an
administration domain and not deploy the application. The -config option
uploads the EAR file and the deployment configuration file, but does not deploy
the application. You can omit the -ear option if the EAR file is already loaded in
the domain.
AppManage -config -ear c:\ears\timer_wait.ear -deployConfig
c:\ears\deployments\timer_wait.xml -app timer_wait -user admin -pw
admin -domain tp002
-undeploy Option
You can undeploy an application using a command line similar to the following.
The application will remain in the domain, but in an undeployed state.
AppManage -undeploy -app timer_wait -domain tp001 -user admin -pw
admin
-delete Option
You can remove an application from an administration domain. If the application
is deployed, you can undeploy and delete the application in one operation using
the -force option. An error is returned if you attempt to delete a deployed
application without specifying the -force option.
AppManage -delete -app timer_wait -user admin -pw admin -domain
tp001 -force
-start Option
You can use the AppManage utility to start an application and all its associated
processes, or use the utility to start just one service. The -service tag takes the
name of a service. Each service contains a name. For example, if there is a TIBCO
BusinessWorks service element <bw name="BW Processes.par"> in a
deployment configuration file, -service takes the value "BW Processes.par".

26
AppManage -start -app myApp -user a -pw a -domain test
AppManage -start -app myApp -service "BW Processes.par" -user a -pw

a -domain test"
In the case where -binding is provided without -service, all services in the
application are started.
AppManage -start -app myApp -binding
ActiveDatabaseAdapterConfiguration -user a -pw a -domain test
-stop Option
You can use the AppManage utility to stop an application and all its associated
processes, or use the utility to stop just one service. The -binding tag takes the
name of a binding. Each binding contains a name. For example, if there is a
binding element <binding name="BW Processes"> in a deployment
configuration file, -binding takes the value "BW Processes".
AppManage -stop -app myApp -user a -pw a -domain test
AppManage -stop -app myApp -service

ActiveDatabaseAdapterConfiguration.aar -user a -pw a -domain test
AppManage -stop -app myApp -service "BW Processes.par" -binding

"BW Processes" -user a -pw a -domain test
-breaklock Option
You can use the AppManage utility to break the lock held on the application by
other users. This will result in loosing uncommited changes by the other users.
–override Option
This option is only applicable when a deployment configuration file already
exists. That is, you are redeploying with a changed archive file.
By default, a newly generated deployment configuration file preserves the value
in the original deployment config file. Use this option with the -export option to
create a deployment configuration file that uses the values defined for global
variables in the archive file, rather than the values defined for global variables in
the original deployment configuration file.
AppManage -export -ear c:\ears\deployment\filenotify.ear
-deployconfig c:\ears\deployments\filenotify.xml
-out c:\ears\deployments\filenotify-changed.xml
-override

Other Options 27
|
-min Option
Use this option with the -export and -ear options to create a small deployment
configuration file that only includes XML tags for options you have changed in
the EAR file. XML tags are not generated for default options that have values,
which have not been changed from their defaults. Options for which XML tags
are not generated will use default values.
-max Option
Use this option with the -export option to create a deployment configuration file
that includes all possible XML tags. For example:
appmanage -export -app SendMsg -domain tp041 -user admin -pw admin
-out c:\temp\sendmsg.xml -max
-template Option
Use this option with the -export option to create a deployment configuration file
that includes XML tags for all options. Certain options, such as machine tags will
include values defined within percent (%%) characters that can be searched for
and replaced. For example:
<bindings>
<binding name="">
<machine>%%demo2sub.aar-machine%%</machine>
<product>
<type>adb</type>
<version/>
<location/>
</product>
<description/>
<contact/>
</binding>
</bindings>
-password Option
Use this option with the -export option to encrypt sensitive data in the exported
deployment configuration file. You will be prompted to enter an encryption
password. For example:
AppManage -export -out c:\ears\deployments\timer_wait.xml -app
timer_wait -user admin -pw admin -domain tp002 -password
Also use this option with the -deploy or -config option to upload a deployment
configuration file whose sensitive data is encrypted with your custom password.
You will be prompted to enter the encryption password that you specified when
generating the deployment configuration file. For example:

28

admin -domain tp002 -password
-passwordFile Option
Use this option with the -export option to encrypt sensitive data in the exported
deployment configuration file using a properties file. The properties file contains
the password encrypted using the obfuscate utility (Refer to TIBCO Runtime
Agent Installation for more information about Obfuscate Utility). For example:
AppManage -export -out c:\ears\deployments\timer_wait.xml -app
timer_wait -user admin -pw admin -domain tp002 -passwordFile
c:\my_password.txt
Also use this option with the -deploy or -config option to upload a deployment
configuration file whose sensitive data is encrypted with your custom password.
To use this option, you must provide a properties file which contains the
password encrypted using the obfuscate utility when generating the
deployment configuration file. For example:
admin -domain tp002 -passwordFile c:\my_password.txt
-moveAppData Option
This option allows you to change the transport setting for a given application. It is
similar to the -batchMoveAppData option, but operates against a single
application. If the application is within a directory, use a forward slash (/) to
separate it from the application name. For an overview of this option, see ,
Changing the Transport for Applications, on page 43.
The -deployconfig option can be used to configure the application with a given
XML file.
The following example shows how to change the transport setting for an
application from rv (Rendezvous) to local.
AppManage -moveAppData -app SendMsg -user admin -pw admin -domain
tp041 -local
-truncate Option
With this option you can remove unwanted revisions of an application. Note that
this option does not change the value of Max Deployment Revision for your
application. The following example truncates the application’s revision history.

Other Options 29
|
AppManage -truncate -app <app> -domain <domain> -user <user> -pw
<password>] [-cred <cred>]
-serialize Option
If this option is used, then deployment will be done to one machine at a time.
Without this, deployment is done simultaneously to all machines with service
instances for the application being deployed.
When deployment is being done to multiple machines and there are contention
issues, the use of this flag can alleviate them and greatly speedup the overall
deployment process.
Contention issues can be identified by deployment taking many minutes, but not
using significant amounts of CPU time on the admin server or target machines.
The following example shows how to use this option in a domain.
AppManage -deploy -app myApp -user user1 -pw user1 -domain test
-serialize
-exportDeployed Option
This option is to be used with -export or -batchExport option. If -exportDeployed
is specified, the active deployed configuration is exported. If not, then the current
configuration changes that would be picked up by the next deployment are what
is exported. If the application is in undeployed status, but was deployed earlier,
the last deployed configuration is exported. If the application has never been
deployed, the current configuration is exported just as if the flag was not
specified.
When used with -export:
AppManage -export -app <app> -domain <domain> -out <uri> [-user
<user> -pw <password>] [-cred <cred>] [-template] [-min] [-genEar]
[-ear <archive>] [-exportDeployed]
When used with -batchExport:

AppManage -batchExport -domain <domain> -user <userName> -pw
<password> [-cred <cred>] -dir <dir> [-template] [-min] [-noear]
[-exportDeployed]

30
Monitoring Events and Rulebases
A deployment configuration file can contain specifications for event elements and
TIBCO Hawk rulebases. This section provides examples about how to configure
these elements. For an introduction to monitoring events and rulebases, see the
TIBCO Administrator User’s Guide.
Event Element
When defining an event in the TIBCO Administrator GUI, the Add Event panel
displays the General, Alert, Email and Command sections. The General section
defines how events defined in the alert, email and command sections are handled.
Events are defined in the deployment configuration file in a similar way. Similar
to the General section, the failureEvent element describes how an event is
handled. The Alert, Email and Command sections correspond to the alertAction,
emailAction and customAction elements.
Alert
The following XML fragment shows the definition of a monitoring alert section.
The restart element is set to true and the failure element is set to FIRST. This
means when the alert is triggered, only for the first failure occurrence, TIBCO
Administrator will attempt to restart the service instance. For all subsequent
failure occurrences, the service instance is not restarted. If the failure element was
set to Subsequent, each time a failure occurred, the TIBCO Administrator would
attempt to restart the failed service.
An alertAction is enabled and set to medium level. The alert is enabled for only
for the first failure occurrence. To generate an alert for each failure occurrence, the
performPolicy element must be set to Always.
The emailAction and customAction sections are not enabled.
<monitor>
<events>
<failureEvent>
<restart>true</restart>
<description>Restart on first failure</description>
<actions>
<alertAction>
<performPolicy>Once</performPolicy>
<level>Medium</level>
<message>Component failed!</message>
</alertAction>
<emailAction>

Monitoring Events and Rulebases 31
|
<enabled>false</enabled>
</emailAction>
<customAction>
</customAction>
</actions>
<failure>FIRST</failure>
</failureEvent>
</events>
</monitor>
Email
The following XML fragment shows the definition for a monitoring email event.
The restart element is set to true, so when an enabled action evaluates to true, the
service instance is restarted. The failure element is set to ANY, which means that
any failure will trigger the restart.
Only the emailAction element is enabled. The alertAction and customAction
elements are disabled. The performPolicy element for email is defined as Always
and the enabled element is defined as true. This means that the email alert action
will be performed each time a failure event occurs for the application.
<monitor>
<events>
<failureEvent>
<restart>true</restart>
<description>Restart service instance.</description>
<actions>
<alertAction>
<level>Low</level>
</alertAction>
<emailAction>
<performPolicy>Always</performPolicy>
<message>MyMessage</message>
<to>SentTo</to>
<cc>CCTo</cc>
<subject>MySubject</subject>
<sMTPServer>my.mail.server</sMTPServer>
</emailAction>
<customAction>
</customAction>
</actions>
<failure>ANY</failure>
</failureEvent>
</events>
</monitor>

32
Command
The following XML fragment shows the definition for a monitor command event.
The restart element is set to false, so the service instance is not restarted upon
failure. The alertAction and emailAction elements are disabled.
The customAction element is enabled such that the command is executed only
once. The command element lists the batch file to execute upon failure.
<monitor>
<events>
<suspendProcessEvent>
<restart>false</restart>
<description>Execute command upon failure.</description>
<actions>
<alertAction>
<level>Low</level>
</alertAction>
<emailAction>
</emailAction>
<customAction>
<command>c:\commands\bin\mycommand.bat</command>
</customAction>
</actions>
</suspendProcessEvent>
</events>
</monitor>
Rulebase
In a scenario where a TIBCO Hawk rulebase file is used to monitor a TIBCO
BusinessWorks process or an adapter service, when configuring deployment
options using the TIBCO Administrator GUI, the rulebase file is picked up by
browsing the file system or by specifying the full path to the file in the file system.
When the rulebase file is loaded, path information is lost and only the file name
and the contents are stored within Administrator.
If a deployment that makes use of this feature is exported into a deployment
configuration file, using the AppManage -export command, the XML file has a
section similar to:
<monitor>
<rulebases>
<rulebase>
<uri>myrulebase.hrb</uri>
<data>Hawk Rulebase file in Binary format</data>

Monitoring Events and Rulebases 33
|
</rulebase>
</rulebases>
</monitor>
When using this deployment configuration file to redeploy, you must change the
uri to the absolute uri of the new Hawk rulebase file. For example:
<monitor>
<rulebases>
<rulebase>
<uri>c:\tibco\hkrulebases\myrulebase.hrb</uri>
<data>Hawk Rulebase file in Binary format</data>
</rulebase>
</rulebases>
</monitor>
Note that:
• If the uri is a path to a valid Hawk rulebase file, it will be used in the
deployment, even if the contents of the rulebase file do not match the content
within the data tag <data></data>.
• If the uri is not a valid path to a Hawk rulebase file, the binary content within
the <data> tag will be used to create the Hawk rulebase file and the name
given to the rulebase file will be the Filename portion of the uri.
• If the uri is invalid and a Hawk rulebase cannot be created out of the content
within the data tag, an exception will be thrown.

34
Setting Service Instance Runtime Variables
You can set a service instance runtime variable by exporting an application’s

deployment configuration file and adding a runtime variable to the NVPairs
element section to the file as shown in this section. After adding the section, use
AppManage to deploy the application.
Each service instance can use the same runtime variable and assign a different
value to it. The instance runtime variable can be any runtime variable that was
defined for the service at configuration time and set to be included when the
Include all service level global variables option is selected when
building the enterprise archive file
Variable values can be set at the application level, service level and service
instance level. A variable value set at the service instance level overrides the same
variable value set at the service level. Similarly, a variable value set at the service
level overrides the same variable set at the application level.
You can use the -template and -max options to create an XML file that shows all
the service instance runtime variables defined for your application. See , -max
Option, on page 27.
The following XML fragment shows the services section for a TIBCO
BusinessWorks project that includes a sender process instance deployed on one
machine and a receiver process instance deployed on two machines. The bold
sections show that an instance runtime variable has been added to each process
instance deployment in the NVPairs section, under each service instance binding
section. This allows you to set values separately for each process instance
deployment. The NVPairs name must be "INSTANCE_RUNTIME_VARIABLES".
<?xml version="1.0" encoding="UTF-8"?>
<application
xmlns="http://www.tibco.com/xmlns/ApplicationManagement"
name="RVCM_Project">
<description></description>
<contact></contact>
<NVPairs name="Global Variables">
<NameValuePair>
<name>DirLedger</name>
<value>.</value>
</NameValuePair>
.
.
.
<NameValuePairInteger>
<name>RVCM/Worker_Tasks</name>
<value>0</value>
</NameValuePairInteger>

Setting Service Instance Runtime Variables 35
|
<name>RVCM/Scheduler_Weight</name>
<value>0</value>
<name>RVCM/Worker_Weight</name>
<value>0</value>
</NVPairs>
.
.
.
<services>
<bw name="RVCM-Sender.par">
<bindings>
<binding name="">
<machine>SENDER-MACHINE</machine>
.
.
.
<NVPairs name="INSTANCE_RUNTIME_VARIABLES">
<value>0</value>
<value>0</value>
<value>0</value>
</NVPairs>
</binding>
</bindings>
.
.
.
</bw>
<bw name="RVCMQ-Receiver.par">
<bindings>
<binding name="">
<machine>RECEIVER-MACHINE1</machine>
.
.
.
<value>0</value>
<value>0</value>

36
<value>0</value>
</NVPairs>
</binding>
<binding name="">
<machine>RECEIVER-MACHINE2</machine>
.
.
.
<value>0</value>
<value>0</value>
<value>0</value>
</NVPairs>
</binding>
</bindings>
.
.
.
</bw>
</services>
</application>

| 37
Chapter 3 Using AppManage in Batch Mode
This chapter explains the AppManage utility batch commands.
Topics
• Overview, page 38
• Creating the AppManage.batch File by Exporting Applications, page 39
• Deploying Applications in Batch Mode, page 40
• Starting Applications in Batch Mode, page 41
• Deleting Applications in Batch Mode, page 42

38
| Chapter 3 Using AppManage in Batch Mode
Overview
To use the AppManage utility in batch mode you must first create an
AppManage.batch file. The file lists the applications and their corresponding EAR
and XML files. While you can create the file manually, the easiest way is to
generate the file using the -batchExport option. In addition to creating the
AppManage.batch file, the option creates an enterprise archive file and XML file
for each application in the given domain.
If you are creating the AppManage.batch file manually, the files listed in the
AppManage.batch file must be specified using relative file paths. The base of
those relative paths is the directory specified by the –dir option that is given on
the AppManage command line. See Creating the AppManage.batch File by
Exporting Applications on page 39 for an example command line.
The following is an example AppManage.batch file.
<?xml version="1.0" encoding="UTF-8"?>
<apps>
<app name="SendMsg" ear="SendMsg.ear" xml="SendMsg.xml"/>
<app name="WriteMsg" ear="WriteMsg.ear" xml="WriteMsg.xml"/>
</apps>
After creating the AppManage.batch file, you can use the AppManage utility to do
the following operations in batch mode:
• Deploy applications
• Undeploy applications
• Start or stop applications
• Delete applications
• Kill applications
• Change the transport
When performing batch jobs with AppManage in a database-based domain, make

sure that your database server is configured with a sufficiently large connection
pool so that you do not run out of JDBC connections. For more information, see
Configuring Connection Pool Size for the Database Server in TIBCO Administrator

Creating the AppManage.batch File by Exporting Applications 39
|
Creating the AppManage.batch File by Exporting Applications
The next command shows how to automatically create the AppManage.batch file.
To use an encrypted password, do not use the -user and -pw options. Instead
create a credentials file and encrypt the password, then provide the file location
and name to the -cred option. See Working with Passwords on page 11 for
details.
The -dir option specifies the location where the AppManage.batch file will be
written. The directory specified for the option is created, if it does not exist. The
AppManage.batch file cannot be written directly under the file system root drive.
That is, specifying c:\AppManage.batch for the –dir option is not allowed.
AppManage -batchExport -domain mydomain -user admin -pw admin -dir
c:\adminbatch\mybatch\
The -batchExport option also takes these options:

• -template — export a deployment configuration file in template format.
• -min — export a deployment configuration file with default settings omitted.
• -noear — do not export enterprise archive files.

40
Deploying Applications in Batch Mode
The following command deploys all applications specified in the

AppManage.batch file that is located in the directory specified for the -dir
option. The directory must have been created earlier using the -batchExport
option. See Creating the AppManage.batch File by Exporting Applications on
page 39 for details.
Because the -nostart option is given, the applications are not started. If the
-nostart option is not given, the applications are started after deployment.
AppManage -batchDeploy -domain mydomain -user admin -pw admin -dir
c:\adminbatch\mybatch\ -nostart
Undeploying Applications in Batch Mode

The following command undeploys all applications specified in the
option.
AppManage -batchUnDeploy -domain mydomain -user admin -pw admin
-dir c:\adminbatch\mybatch\

Starting Applications in Batch Mode 41
|
Starting Applications in Batch Mode
The following command starts all applications specified in the AppManage.batch

file that is located in the directory specified for the -dir option. The directory
must have been created earlier using the -batchExport option. See Creating the
AppManage.batch File by Exporting Applications on page 39 for details.
AppManage -batchstart -domain mydomain -user admin -pw admin
Stopping Applications in Batch Mode

The following command stops all applications specified in the AppManage.batch
file that is located in the directory specified for the -dir option.
AppManage -batchstop -domain mydomain -user admin -pw admin

42
Deleting Applications in Batch Mode
The following command deletes all applications specified in the

option. The directory must have been created earlier using the -batchExport
option. See Creating the AppManage.batch File by Exporting Applications on
page 39 for details.
If the application is deployed, you can undeploy and delete the application in one
operation using the -force option. An error is returned if you attempt to delete a
deployed application without specifying the -force option.
AppManage -batchDelete -domain mydomain -user admin -pw admin
-dir c:\adminbatch\mybatch\ -force
Killing Applications in Batch Mode

This command forces an immediate shutdown of each service instance or process
engine listed in the AppManage.batch file. If checkpoints or other graceful
shutdown options are defined for a process engine, the options are ignored.
Current jobs are terminated before given a chance to complete.
The following command kills all applications specified in the AppManage.batch
file that is located in the directory specified for the -dir option.
AppManage -batchkill -domain mydomain -user admin -pw admin

Changing the Transport for Applications 43
|
Changing the Transport for Applications
When configuring an administration domain, you set the default for how the
administration server interacts with application repositories stored as files. When
TIBCO Rendezvous is configured as the transport for the administration domain,
it can be configured to use local application data or server-based application data
as the default.
While the choice you use can be changed in TIBCO Administrator by
undeploying the application, changing the transport setting, and redeploying the
application, you can use the AppManage -batchMoveAppData option to change
the transport setting in batch mode.
When using the option, AppManage redeploys the application with the changed
transport setting. You can change values and redeploy without undeploying the
application.
The -batchMoveAppData option updates all applications specified in the -dir
directory. You can also change the default transport setting for an administration
domain by including the -setDefault option, where all subsequent deployments
in the domain will use the given transport.
The user account must have write permission for the specified applications. Only
the local or rv (Rendezvous) transports can be set.
For example, the following command changes the transport from rv to local for
the applications specified in the directory given for the -dir option. The directory
must have been populated earlier using the -batchExport option. See Creating
the AppManage.batch File by Exporting Applications on page 39 for details.
C:\tibco\tra\<version>\bin>appmanage -batchMoveAppData -domain tp041
-user admin -pw admin -dir c:\adminbatch\mybatch -local
Checking if master server is responding ...
Finished checking
Initializing ...
Finished initialization
Redeploying application SendMsg with new Application data location
local ...
Loading archive ...
Finished loading archive
Configuring application ...
Finished configuring application
Deploying application ...
Instance SendMsg created succesfully
Finished deploying application
[ SendMsg ]: Finished successfully in 19 seconds

44

| 45
Appendix A Deployment Configuration File Reference
This chapter explains the values you can set for elements in the generated
deployment configuration XML file.
Topics
• Application Element, page 48

• bw Element, page 71
• adapter Element, page 77
• formFlow Element, page 79
• Requires Authentication, page 82

46
| Appendix A Deployment Configuration File Reference
Overview
This chapter explains the values you can set for elements in an XML file for an
application. The XML file is typically generated using the AppManage -export
option against an application’s EAR file. For example:
AppManage -export -out c:\test\myApp.xml -ear myApp.ear
Typically, you then edit the XML file, and then deploy the application. See Simple
Application Deployment on page 16 for details about deploying an application
after editing its deployment configuration file.
AppManage XSD Files

If you are using an XML editor such as that available in TIBCO Designer (using
Project > Import Resources from File, Folder, URL), you can load the XSD files
that are included in the AppManage.jar and the Deployment.jar files. Doing so
allows you to get more information about the elements in the deployment
configuration file. The jar files are located in the TIBCO_HOME/tra/version/lib
directory.
The main XML schema for deployment configuration is in
ApplicationManagement.xsd, which is included in the AppManage.jar. The
bw.xsd file is also in the AppManage.jar file. There are two imported schemas,
RequiresAuthentication.xsd and DeploymentDescriptorArchive.xsd
referenced. The two XSDs are in the Deployment.jar file.
To get the XSD files, use winzip or another utility to unpack the jar files. The XSD
files are located as follows in the jar files:
• AppManage.jar:
com\tibco\administrator\command\resource\ApplicationManagement.
xsd
• AppManage.jar:
com\tibco\administrator\command\resource\bw\bw.xsd
• Deployment.jar:
\com\tibco\dd\authentication\RequiresAuthentication.xsd
Icons Used in the Diagrams

Each element in this appendix is explained using the diagrams that display in
TIBCO Designer. The following shows a partial element diagram. In the diagram
below, the name attribute is mandatory and the repoInstanceName element is
optional.

Overview 47
|
Figure 2 Partial Element Diagram
"?" indicates Indicates allowed

optional data type
• The icon indicates the object is an attribute.
• The icon indicates the object is an element.
• The allowed data type is listed in the grey box.
• The icon indicates the attribute or element is optional.
• If a icon does not appear, the attribute or element is mandatory.
• The icon (not shown in the diagram) indicates a one to many relationship
exists for an element.

48
Application Element
The next diagram shows the application element. The elements included in the
application element are explained in this section.
Figure 3 Application Element Diagram

Application Element 49
|
Table 3 Application Element Description
Attribute or
Description
Element
name The name assigned to the application in TIBCO
Designer.
repoInstanceName This element corresponds to the Deployment Name field

that is displayed in the Edit Application Configuration
panel in the TIBCO Administrator GUI. The element’s
value is the <administration-domain>-<application> name.
description Information about the application that is stored in this

file.
contact Name of the person responsible for this application.
NVPairs See NVPairs Element on page 49.
repoInstances See RepoInstances Element on page 52.
services See services Element on page 53.
plugins Currently not used.
NVPairs Element
The next diagram shows the element.

50
Figure 4 NVPairs Element Diagram
Table 4 NVPairs Element Description
Attribute or Description
Element
name Name assigned to an NVPairs element.
NVPair One or more NVPair elements, each with a name, value

and optional description. An NVPair element is typically
used to define global variables.
The NVPairs element is used to display the global variables set in the enterprise
archive file for an application. The following global variables are predefined by
default:
• DirLedger — Used by the system when defining the path name of the TIBCO
Rendezvous certified messaging ledger file. The default is the root installation
directory.
• DirTrace — Used by the system to partially create the path name for log file
used by the adapter. The default is the root installation directory.
• HawkEnabled — Used by the system to indicate whether TIBCO Hawk is
used to monitor the adapter. True indicates that a Hawk microagent is defined
for the adapter. False indicates the microagent is not to be used. Default is
False.
• JmsProviderUrl — A JMS provider URL tells applications where the JMS
daemon is located. Setting this value mostly makes sense in early stages of a
project, when only one JMS daemon is used.
• JmsSslProviderUrl — Specifies where the JMS server, running in the SSL
mode, is located. Setting this value mostly makes sense in the early stages of a
project, when only one JMS server is used.
• RemoteRvDaemon — Used by the system to identify the TIBCO Rendezvous
routing daemon. See TIBCO Rendezvous Administration for details about
specifying the routing daemon name.

|
• RvDaemon — Used by the system to identify the TIBCO Rendezvous daemon

parameter. The parameter instructs the transport object about how and where
to find the Rendezvous daemon and establish communication. The default
value is 7500, which is the default value used by the Rendezvous daemon. See
TIBCO Rendezvous Concepts for details about specifying the daemon
parameter.
• RvNetwork — Used by the system to identify the TIBCO Rendezvous
network parameter. Every network transport communicates with other
transports over a single network interface. On computers with more than one
network interface, the network parameter instructs the TIBCO Rendezvous
daemon to use a particular network for all outbound messages from this
transport. See TIBCO Rendezvous Concepts for details about specifying the
network parameter.
• RvService — Used by the system to identify the TIBCO Rendezvous service
parameter. The Rendezvous daemon divides the network into logical
partitions. Each transport communicates on a single service; a transport can
communicate only with other transports on the same service. See TIBCO
Rendezvous Concepts for details about specifying the service parameter. Default
is 7500
• RvaHost — Used by the system to identify the computer on which the TIBCO
Rendezvous agent runs. See TIBCO Rendezvous Administration for details
about specifying the rva parameters.
• RvaPort — Used by the system to identify the TIBCO Rendezvous agent TCP
port where the agent listens for client connection requests. See TIBCO
Rendezvous Administration for details about specifying the rva parameters.
Default is to 7501.
• TIBHawkDaemon — Used by the system to identify the TIBCO Hawk
daemon parameter. See the TIBCO Hawk Installation and Configuration manual
for details about this parameter. Default is the value that was set during
domain creation (7474 by default).
• TIBHawkNetwork — Used by the system to identify the TIBCO Hawk
network parameter. See the TIBCO Hawk Installation and Configuration manual
for details about this parameter. Default is an empty string.
• TIBHawkService — Used by the system to identify the TIBCO service
parameter. See the TIBCO Hawk Installation and Configuration manual for
details about this parameter. Default is 7474.
• MessageEncoding — The message encoding set for the application. The
default value is ISO8859-1, which only supports English and other western
European languages that belong to ISO Latin-1 character set. After the project
is deployed in an administration domain, the messaging encoding set at
design time is overridden by the domain's encoding property. All the TIBCO

52
components working in the same domain must always use the same encoding
for intercommunication. See TIBCO Administrator Server Configuration Guide
for more information.
RepoInstances Element
Figure 5 RepoInstances Element
Table 5 RepoInstances Element Description
Attribute or
Element Description
selected Indicates the transport selected to be used by the

deployment repository instance. Can be set to rv, http,
https or local.
When set to local, the application repository will be sent
to the target machine. This allows the application to run
independently of the administration server.
When set to rv, the client application will use TIBCO
Rendezvous to communicate with the administration
server. The following fields become available:
When set to http, the client application will use HTTP to
communicate with the administration server.
Note that https can only be selected if the administration
server is configured to use SSL.
httpRepoInstance See httpRepoInstance Element on page 54.
rvRepoInstance See rvRepoInstance on page 55.

|
Table 5 RepoInstances Element Description
Attribute or
Element Description
localRepoInstance Indicates a local file (or directory of files) is used as the

deployment repository instance. Depending on the type
of services deployed to a machine, the local repository
may be a .dat file or a multi-file project (such as is used
in Designer). If there is an adapter service and a BW
service you will have both types of instances installed on
your local machine.
The localRepoInstance element contains the encoding
element. If this element is not specified, then the
encoding for the admin server is used. If the admin
server is not available, then the default for this element
is ISO8859-1.
services Element
Figure 6 services Element Diagram

54
Table 6 services Element Description
Attribute or
Description
Element
name The name assigned to the application’s service or
process. Names ending in .par indicate the application
is a TIBCO BusinessWorks process. Names ending in
.sar indicate the application is a service, such as a
TIBCO adapter.
enabled true or false. Only enabled services are deployed.

Disabling a service, effectively undeploys just that
service while letting all other services in the application
run as normal. For example, this can be useful when you
wish to deploy an application that includes a service for
which you don't have the required software.
bindings See bindings Element on page 57.
failureCount The value in this field defines how many restarts should
be attempted before resetting the error counter to 0. See
the TIBCO Administrator User’s Guide for more
information about this element.
failureInterval The value in this field defines how much time should
expire before resetting the error counter to 0.
monitor See monitor Element on page 59.
httpRepoInstance Element

|
Figure 7 httpRepoInstance Element Diagram
Table 7 httpRepoInstance Element Description
Element
server Name of the administration server under which this
application is deployed.
user User authorized for this application repository. Defaults

to the user currently logged into the AppManage utility.
password User’s password.
extraPropertyFile Currently not used.
timeout Amount of time in seconds allowed for completing a

task, such as retrieving information from the server.
Defaults to 600 seconds.
url The URL with which the client attempts to connect to the
server.
rvRepoInstance

56
Figure 8 rvRepoInstance Element Diagram
Table 8 rvRepoInstance Element Description
Attribute or
Element Description
server Name of the administration server under which this

application is deployed.
user User authorized for this application repository. Defaults

to the user currently logged into the AppManage utility.
password User’s password.
extraPropertyFile Currently not used.
timeout Amount of time in seconds allowed for completing a

task, such as retrieving information from the server.
Defaults to 600 seconds.
discoveryTimeout Amount of time in seconds allowed for the initial

connection to the administration server.

|
Table 8 rvRepoInstance Element Description
Attribute or
Element Description
daemon Instructs the transport object about how and where to

find the TIBCO Rendezvous daemon and establish
communication. The default value is 7500, which is the
default value used by the Rendezvous daemon. See
TIBCO Rendezvous Concepts for details about specifying
the daemon parameter.
service Used by the system to identify the TIBCO Rendezvous

service parameter. The Rendezvous daemon divides the
network into logical partitions. Each transport
communicates on a single service; a transport can
communicate only with other transports on the same
service. See TIBCO Rendezvous Concepts for details
about specifying the service parameter. Default is 7500.
network Used by the system to identify the TIBCO Rendezvous

network parameter. Every network transport
communicates with other transports over a single
network interface. On computers with more than one
network interface, the network parameter instructs the
TIBCO Rendezvous daemon to use a particular network
for all outbound messages from this transport. See
TIBCO Rendezvous Concepts for details about
specifying the network parameter.
regionalSubject TIBCO Rendezvous subject prefix used for regional

read-operation in the load balancing mode. For
additional information see the TIBCO Administrator
operationRetry Number of times to retry after a timeout occurs.
bindings Element

58
Figure 9 bindings Element Diagram
Table 9 bindings Element Description
Attribute or
Element Description
name Name assigned to the binding element.
machine The machine to which this application is bound.
product See product Element on page 59.
container Lists the Formflow archive name and container.
description Information about the binding, stored in this file.
contact Name of the person responsible for this application.
setting See setting Element on page 60.
ftWeight When a process joins a fault tolerance group, it specifies

its weight as a parameter. Weight represents the ability
of a member to fulfill its function—relative to other
members of the same group. See the TIBCO Rendezvous
Concepts book for information about using fault
tolerance groups.
shutdown See shutdown Element on page 60.

|
monitor Element
Figure 10 monitor Element Diagram
Table 10 monitor Element Description
Attribute or
Description
Element
rulebases See rulebases Element on page 63.
events See events Element on page 64.
product Element
Figure 11 product Element Diagram
Table 11 product Element Description
Element
type The product type. Do not change.
version The product version installed.
location The product’s directory location.

60
setting Element
Figure 12 setting Element Diagram
Table 12 setting Element Description
Attribute or
Element Description
startOnBoot Specifies that the service instance should be started

whenever its machine restarts.
enableVerbose Enables verbose tracing.
maxLogFileSize Specifies the maximum size (in Kilobytes) a log file can
reach before the engine switches to the next log file.
threadCount Number of threads assigned. Default is 8.
NTService See NTService Element on page 61.
java See java Element on page 62.
shutdown Element

|
Figure 13 shutdown Element Diagram
Table 13 shutdown Element Description
Attribute or
Element Description
checkpoint When true, the process engine waits for all jobs to finish
(up to the maximum timeout) before shutting down the
engine, rather than removing jobs at their next
checkpoint.
timeout The maximum timeout in seconds the process engine

will wait for jobs to finish before shutting down the
engine. A zero (0) value means 0 seconds, which
effectively turns the graceful shutdown into an
immediate shutdown.
NTService Element
Figure 14 NTService Element Diagram

62
Table 14 NTService Element Description
Attribute or
Description
Element
runAsNT true or false. When true, the service is run as a Microsoft
Windows Service. You can then manage the engine as
you would any other service, and you can specify that it
starts automatically when the machine reboots.
startupType Set to one of the service startup types, Automatic,

Manual, or Disabled.
loginAs The login account for the service, if any. The domain
name must be specified. If the login account is defined
on the local machine, the domain is ".". For example,
user jeff on the local machine would be specified as
.\jeff.
password Password for the login account.
java Element
Figure 15 java Element Diagram

|
Table 15 java Element Description
Attribute or
Description
Element
prepandClassPath The items you provide here are prepended to your
CLASSPATH environment variable. You can specify a Java
code editor, or the jar file from a JNDI provider if you
wish to use TIBCO BusinessWorks to receive and
process JMS messages.
appendClassPath The items you provide here are appended to your

CLASSPATH environment variable. You can specify a Java
code editor, or the jar file from a JNDI provider if you
wish to use TIBCO BusinessWorks to receive and
process JMS messages.
initHeapSize Initial size for the JVM used for the process engine.
Default is 32 MB.
maxHeapSize Maximum size for the JVM used for the process engine.
Default is 128 MB.
threadStackSize Size for the thread stack. Default is 128 KB.
rulebases Element
Figure 16 rulebases Element Diagram
Table 16 rulebases Element Description
Attribute or
Description
Element
uri Location of the rulebase file.

64
Table 16 rulebases Element Description
Attribute or
Element Description
data Rulebase content. Do not change.
events Element
Figure 17 events Element Diagram
Table 17 events Element Description
Attribute or
Description
Element
event See failureEvent Element on page 64.
failureEvent Element
Figure 18 failureEvent Element Diagram
Table 18 failureEvent Element Description
Attribute or
Description
Element
restart true or false. If true, the service instance is restarted
upon failure.

|
Table 18 failureEvent Element Description
Attribute or
Element Description
description Information that describes this operation.
actions One of the following actions defined for a failure event:

• alertAction Element on page 66
• emailAction Element on page 67
• customAction Element on page 69
failure The failure element defines when the alert action should
be enabled after a service instance failure. One of the
following can be defined:
• ANY—Any failure
• FIRST—First component failure.
• SECOND—Second component failure.
• Subsequent—Subsequent component failures.
suspendProcessEvent Element
Figure 19 suspendProcess Event Element Diagram
Table 19 suspendProcess Event Element Description
Attribute or
Description
Element
upon failure.

66
Table 19 suspendProcess Event Element Description
Attribute or
Element Description
actions The action to perform when the policy is suspended.
logEvent Element
Figure 20 logEvent Element Diagram
Table 20 logEvent Element Description
Attribute or
Element Description

upon failure.
actions The action to perform.
match The string in the log file to match.
alertAction Element

|
Figure 21 alertAction Element Diagram
Table 21 alertAction Element Description
Attribute or
Element Description
performPolicy The policy to perform:

• Once—Generate an alert only for the first
occurrence.
• Always—Generate an alert for each occurrence.
enabled true or false. If true, the action will occur when

conditions for the action are true. If false, the action is
not called.
level Set the alert level. This affects the appearance of the alert
in the TIBCO Administrator GUI.
• High
• Medium
• Low
message The message that displays when this alert is triggered.
emailAction Element

68
Figure 22 emailAction Element Diagram
Table 22 emailAction Element Description
Attribute or
Element Description

occurrence.

not called.
level Set the alert level. This affects the appearance of the alert
in the TIBCO Administrator GUI.
• High
• Medium
• Low
message The message to send.
to A comma-separated list of email addresses to which the

message will be sent.
cc A comma-separated list of email addresses to which

copies of the message will be sent.

|
Table 22 emailAction Element Description
Attribute or
Element Description
subject The subject of the email message.
sMTPServer The mail server (SMTP server) to use to send the

message. Specify the host name or the host IP address.
customAction Element
Figure 23 customAction Element Diagram
Table 23 customAction Element Description
Attribute or
Element Description

occurrence.

not called.

70
Table 23 customAction Element Description
Attribute or
Element Description
command Specify the script to execute. Script files are highly

recommended.
Commands are possible but are limited because the
command line arguments cannot accept redirection (|),
multiple command (;) or append characters(> and >>).
Redirection is allowed in a script.
On Windows:
• Use a .bat file that begins with the line @echo off to
prevent the shell from exiting prematurely.
• Always give the full path with "\" as the path
separator.
• If you use a command instead of a script, you must
prefix it with cmd \c.
On UNIX:
• Make sure the script is executable (chmod +x).
• Always give the full path with / as the path

separator.
If you purchased the full TIBCO Hawk product, see the
TIBCO Hawk Administrator’s Guide for more information.
arguments The list of arguments for the command.

bw Element 71
|
bw Element
The bw element is used by a TIBCO BusinessWorks process. The next diagram

shows the element.
Figure 24 bw Element Diagram
Table 24 bw Element Description
Attribute or
Description
Element
name Name assigned to this process instance.

72
Table 24 bw Element Description
Attribute or
Element Description

run as normal. This can be useful, for example when you
be attempted before resetting the error counter to 0.
tns3:bwprocesses Currently not used.
tns3:checkpoints Currently not used.
bwprocesses See bwprocesses Element on page 72.
checkpoints See checkpoints Element on page 73.
isFT true or false. If true, indicates that this process is part of a

fault tolerant group.
faultTolerant See faultTolerant Element on page 74.
bwprocesses Element

bw Element 73
|
Figure 25 bwprocesses Element Diagram
Table 25 bwprocesses Element Description
Attribute or
Element Description
name Name for this element.
starter Name of the process starter.
enabled true or false. Only enabled processes are deployed.

Disabling a process, effectively undeploys just that
process while letting all other processes in the
application run as normal. This can be useful, for
example when you wish to deploy an application that
includes a process for which you don't have the required
software.
maxjob Specifies the maximum number of process instances that

can concurrently be loaded into memory.
flowlimit Specifies the maximum number of currently running

process instance to start before suspending the process
starter.
checkpoints Element

74
Figure 26 checkpoints Element Diagram
Table 26 checkpoints Element Description
Element
selected The selected checkpoint (from checkpoint element).
checkpoint A list of possible checkpoints.
tablePrefix When you specify a database for TIBCO BusinessWorks

storage, tables are created in your database. The
administration domain name and deployment ID
(assigned by TIBCO BusinessWorks) are used to name
the tables to ensure uniqueness of the tables for each
domain and each deployment. This element lists the
table prefix.
faultTolerant Element
Figure 27 faultTolerant Element Diagram

bw Element 75
|
Table 27 faultTolerant Element Description
Attribute or
Description
Element
hbInterval Heartbeat Interval. The master engine of a fault-tolerant
group broadcasts heartbeat messages to inform the other
group members that it is still active. The heartbeat
interval determines the time (in milliseconds) between
heartbeat messages. In the event if one process engine
fails, another engine detects the stop in the master’s
heartbeat and resumes operation in place of the other
engine. All process starters are restarted on the
secondary, and services are restarted to the state of their
last checkpoint.
activationInterval Activation Interval (ms) — A standard TIBCO

Rendezvous fault tolerant parameter, documented in the
TIBCO Rendezvous Concepts chapter 15, Developing Fault
Tolerant Programs.
Secondary process engines track heartbeat messages
sent from the master engine. This field specifies the
amount of time to expire since the last heartbeat from the
master before the secondary restarts the process starters
and process engines.
The Heartbeat Interval should be smaller than the
Preparation Interval, which should be smaller than the
Activation interval. It is recommended that Activation
Interval be slightly over 2 heartbeats.

76
Table 27 faultTolerant Element Description
Attribute or
Element Description
preparationDelay Preparation Interval (ms) — A standard TIBCO

Rendezvous fault tolerant parameter, documented in the
TIBCO Rendezvous Concepts chapter 15 Developing Fault
Tolerant Programs).
When a master engine resumes operation, the secondary
engine shuts down and returns to standby mode. For
some situations, it may be necessary to ensure that the
secondary engine has completely shut down before the
master engine resumes operation.
This field is used to specify a delay before the master
engine restarts. When the time since the last heartbeat
from an active member exceeds this value, the ranking
inactive member will receive a "hint" so that it can
prepare for activation.

adapter Element 77
|
adapter Element
The adapter element is used by a TIBCO Adapter service. The next diagram
shows the element.
Figure 28 adapter Element Diagram
Table 28 adapter Element Description
Attribute or
Description
Element
name Name assigned to this application.


78
Table 28 adapter Element Description
Attribute or
Element Description

formFlow Element 79
|
formFlow Element
The formflow element is used by a TIBCO BusinessWorks Workflow process. The

next diagram shows the formflow element.
Figure 29 formFlow Element Diagram
Table 29 formFlow Element Description
Attribute or
Description
Element
name Name assigned to this application.

80
Table 29 formFlow Element Description
Attribute or
Element Description

tns3:bwprocesses Currently not used.
tns3:checkpoints Currently not used.
bwprocesses See bwprocesses Element on page 72.
checkpoints See checkpoints Element on page 73.
isFT true or false. If true, indicates that this process is part of a

fault tolerant group.
faultTolerant See faultTolerant Element on page 74.
authentications See authentications Element on page 80.
authentications Element

formFlow Element 81
|
Figure 30 authentications Element Diagram
Table 30 authentications Element Description
Element
selected Name of the selected authentication configuration. Can
be Http Session, Cookie, or Web Server.
configName Name assigned to this configuration.
configDescription Description about the configuration.
idleTimeout Determines when the session is terminated if idle.

82
Requires Authentication
The requires authentication elements are explained in this section. The next
diagram shows a high-level view of the elements in the section.
Figure 31 RequiresAuthetication Element Diagram
Table 31 RequiresAuthetication Element Description
Attribute or
Description
Element
name Name assigned to this configuration.
description Description about the configuration.
AuthenticationCon For internal use.

figuration
selectedAuthentica For internal use.

tionConfiguration
Name
requestContextImp For internal use.

lementationClassN
ame
CookieAuthenticationConfiguration Element
The next diagram shows the element. The element represents the configuration
for cookie based authentication.

Requires Authentication 83
|
Figure 32 CookieAuthenticationConfiguration Element Diagram
Table 32 CookieAuthenticationConfiguration Element Description
Element
requiresPasswordI For internal use.

nCleartext
cookieDomain The domain to which the tracking cookie applies. The

domain string must begin with a dot and must include
at least one embedded dot.
cookieKeepExpire Number of days that the cookie is kept, after which the
cookie will expire.
signaturePassword Password used to protect the logged in identity from

being changed in a client’s cookie file.
HttpSessionAuthenticationConfiguration Element

84
Figure 33 HttpSessionAuthenticationConfiguration Element Diagram
Table 33 HttpSessionAuthenticationConfiguration Element Description
Element

nCleartext
WebServerAuthenticationConfiguration Element

Requires Authentication 85
|
Figure 34 WebServerAuthenticationConfiguration Element Diagram
Table 34 WebServerAuthenticationConfiguration Element Description
Element

nCleartext
cookieDomain The domain to which the tracking cookie applies. The

domain string must begin with a dot and must include
at least one embedded dot.
cookiePath Path where the cookie will be stored.
requireNewSession Allows users to specify that a new browser session is

ForVerify required for login.
ExternalAuthenticationConfiguration Element

86
Figure 35 ExternalAuthenticationConfiguration Element Diagram
Table 35 ExternalAuthenticationConfiguration Element Description
Element
className Authentication Handler Class Name. Class name in

servlet path or in the enterprise archive file.

| 87
Appendix B Failure Code List
The following table lists and explains failure codes.
Table 36 Failure Code List
Numeric
Exit Code Description Action
Value
FAILURE_USAGE_ER A command line arguments Usage error. Correct the usage -1
ROR
parsing error occurred. error.
FAILURE_APPLICAT The specified application does Usage error. Correct the usage -2
ION_NOT_EXIST
not exist in the administration error.
domain.
FAILURE_SERVICE The specified service does not Usage error. Correct the usage -5
_NOT_EXIST exist in the administration error.
domain.
FAILURE_UNEXPECT An unexpected application Runtime error. Check the log, -3

ED_EXCEPTION
level or Java exception correct the error and retry.
occurred, such as a locking
exception or a JDBC connection
exception.
FAILURE_UNEXPECT An abnormal Java error The error is not revocable. -4

ED_THROWABLE
occurred, such as a thread error Retry the action.
or out of memory error.
FAILURE_BINDING_ The specified service container Usage error. Correct the usage -6
NOT_EXIST
binding does not exist in the error.
administration domain.
FAILURE_HAWK_MIC The TIBCO Hawk microagent is Runtime error. Check if the -7

ROAGENT
not running or a Hawk server is running.
microagent exception has been
thrown.
FAILURE_HAWK_CON A TIBCO Hawk console Runtime error. Check the -8

SOLE
exception occurred. TIBCO Hawk console for
errors.

88
| Appendix B Failure Code List
Numeric
Exit Code Description Action Value
FAILURE_NO_MACHI The deployed service container The application is in a bad -9
NE_ASSOCIATED_WI
binding has no machine state. A retry may not fix the
TH_PROCESS
associated with it. The service error.
instance is in an abnormal state.
An end user normally would
not see this error.
FAILURE_PARSING_ A parsing error was Contact TIBCO support. -10

XSD
encountered in the XML
schema files. An end user
normally would not see this
error.
FAILURE_PARSING_ An error was encountered Configuration error. Check -11

XML
when parsing the deployment the configuration file.
configuration file during the
validation phase. The
configuration file is not a
well-formatted XML file. An
end user may see this error.
FAILURE_VALIDATI An XML validation error in the Configuration error. Check -12

ON
deployment configuration file the configuration file.
occurred. The configuration file
is well-formatted, but has
elements that are not
conforming to XML schema.
FAILURE_NOT_AUTH The specified user name has no Make sure user has -13
ORIZED
permission to perform the Administer permission set for
intended action. the action.
FAILURE_NOT_AUTH The supplied password does Make sure user name and -14
ENTICATED
not match the password stored password is correct.
in the administration domain.
FAILURE_DOMAIN_N The specified administration Usage error. You must supply -15
OT_INSTALLED
domain does not exist. a valid domain name.

Failure Code List 89
|
Numeric
FAILURE_DOMAIN_M The master server is down or Make sure master server is -16
ASTER_SERVER_DOW
not responding within the running.
N
discovery timeout limit as
specified in the administration
domain's property file,
AdministrationDomain.prop
erties.
FAILURE_GET_ARCH Failed to retrieve the enterprise Make sure the enterprise -17
IVE
archive file from the archive file exists in the file
administration domain or from system.
the file system URI.
FAILURE_BATCH One or more exceptions Runtime error. Check the log -18
occurred during batch mode file, make corrections and
operations. retry.
FAILURE_UPLOAD_G Various unexpected exceptions Runtime error. Check the log -20
ENRAL
occurred during archive file, make corrections and
uploading, but not the retry.
following:
FAILURE_UPLOAD_COMMIT
FAILURE_UPLOAD_APPLICATIO
N_ARCHIVE
FAILURE_UPLOAD_APPLICATIO
N_ARCHIVE
FAILURE_UPLOAD_C A commit exception occurred Runtime error. Check the log -21
OMMIT
when uploading the archive. file, make corrections and
retry.
FAILURE_UPLOAD_A An exception occurred when Runtime error. Check the log -22
PPLICATION_ARCHI
adding archive into application file, make corrections and
VE
deployment configuration retry.
object.
FAILURE_ERROR_EX An exception occurred when Runtime error. Check log file, -24
ECUTING_EAR_PLUG
supplying default deployment Retry
IN
settings.

90
Numeric
FAILURE_CONFIG_E Various other unexpected Runtime error. Check the log -30
RROR_GENERAL
exceptions occurred when file, make corrections and
configuring the application, but retry.
not the following:
FAILURE_CONFIG_COMMIT
FAILURE_CONFIG_FILE_PARSE
_ERROR
FAILURE_CONFIG_FILE_READ_
ERROR
FAILURE_CONFIG_FILE_NOT_E
XIST
FAILURE_NO_UPLOADED_ARCHI
VE
FAILURE_INVALID_REPO_INST
ANCE
FAILURE_CONFIG_C A commit exception occurred Runtime error. Check the log -31
OMMIT
when configuring the file, make corrections and
application. retry.
FAILURE_CONFIG_F An error occurred when Configuration error. -32

ILE_PARSE_ERROR
parsing the configuration file.
This is only reported when the
configuration file is not
validated. Usually, if the
configuration file is not
well-formatted, the validation
phase would have exited with
FAILURE_PARSING_XML code
before this step is reached.
FAILURE_CONFIG_F An IO error occurred when Make sure file has read -33
ILE_READ_ERROR
reading the configuration file. permission
FAILURE_CONFIG_F A file not found exception Make sure file exists. -34
ILE_NOT_EXIST
occurred when reading
configuration file.

|
Numeric
FAILURE_NO_UPLOA No archive is associated with Runtime error. The -35
DED_ARCHIVE
the application to be application is in a bad state.
configured. If this happens, it Retry may not fix the error.
means the application is in an
abnormal state. An end user
normally would not see this
error.
FAILURE_INVALID_ The repository instance name in Configuration error. Make -36

REPO_INSTANCE
the configuration file is not sure the instance name is
valid. A legal repository correct in the configuration
instance must start with <domain file.
name>- or %%DOMAIN%%-.
FAILURE_DEPLOY_G Various other unexpected Runtime error. Check the log -40
ENERAL
deploying the application, but retry.
not the following:
FAILURE_DEPLOY_COMMIT
FAILURE_NOT_DEPLOYABLE_ST
ATE
FAILURE_DEPLOYMENT_STATUS
FAILURE_DEPLOY_C A commit exception occurred Runtime error. Check the log -41
OMMIT
when deploying the file, make corrections and
application. retry.
FAILURE_NOT_DEPL The application is not in a Action error. No need to -42

OYABLE_STATE
deployable state. For example, deploy.
if an application is in
synchronized state, and a user
tries to deploy again without
uploading the archive file again
or changing any setting, this
exit code is posted. In TIBCO
Administrator, the deploy
button would be grayed if an
application is in this state.
FAILURE_DEPLOYME The deployment was Check the log file, make -43
NT_STATUS
unsuccessful. corrections and retry.

92
Numeric
FAILURE_UNDEPLOY Various other unexpected Runtime error. Check the log -50
_GENERAL
undeploying the application, retry.
but not including the following:
FAILURE_UNDEPLOY_COMMIT
FAILURE_UNDEPLOY A commit exception occurred Runtime error. Check the log -51
_COMMIT
when undeploying the file, make corrections and
application. retry.
FAILURE_DELETE_G Various other unexpected Runtime error. Check the log -60
ENERAL
exception occurred when file, make corrections and
deleting the application, but not retry.
including the following:
FAILURE_DELETE_COMMIT
FAILURE_DEPLOYED_STATE
FAILURE_DELETE_C A commit exception occurred Runtime error. Check the log -61
OMMIT
when deleting the application. file, make corrections and
retry.
FAILURE_DEPLOYED The application cannot be Action error. Undeploy the -62

_STATE
deleted as it is not yet application first or use the
undeployed. -force option.
FAILURE_EXPORT_G Various other unexpected Runtime error. Check the log -70
ENERAL
exception occurred when file, make corrections and
exporting the application retry.
configuration, but not
including the following:
FAILURE_XML_SERIALIZE
FAILURE_EXPORT_FILE_NAME_
ERROR
FAILURE_MERGE_ERROR
FAILURE_XML_SERI An IO error occurred when Make sure the file or directory -71
ALIZE
writing the configuration file. is writable.

|
Numeric
FAILURE_EXPORT_F The given export file name is Usage error. Correct the file -72
ILE_NAME_ERROR
invalid. A valid export file name.
name must end with a dot
suffix.
FAILURE_MERGE_ER An error occurred when Runtime error. Check the log -73
ROR
merging an old configuration file, make corrections and
with a new archive. retry.
FAILURE_START_GE Various other unexpected Runtime error. Check the log -80
NERAL
starting the application, but not retry.
the following:
FAILURE_BINDING_NOT_EXIST
FAILURE_HAWK_MICROAGENT
FAILURE_HAWK_CONSOLE
FAILURE_STOP_GEN Various other unexpected Runtime error. Check the log -90
ERAL
stopping the application, but retry.
not the following:
FAILURE_STOP_NOT The application is not in Action error. Make sure the -91
_IN_STOPPABLE_ST
stoppable state. service instance is in a
ATE
stoppable state.
FAILURE_KILL_GEN Various other unexpected Runtime error. Check the log -100
ERAL
killing application, but not the retry.
following:

94

| 95
Index
A D
activationInterval 75 daemon 57
appendClassPath 63 Delete Applications, Batch Mode 42
Application Deployment -delete Option 25
Complex 18 Deploy Applications, Batch Mode 40
Simple 16 DirLedger 50
AppManage Log Files 13 DirTrace 50
AppManage Utility 4 discoveryTimeout 56
AppManage.batch 38
arguments 70
B enabled 54, 67, 72, 73, 77, 80

enableVerbose 60
buildear Log File 13 Encrypted Password 11
buildear options 16 ENV_NAME xv
buildear Utility 3 Export Applications, Batch Mode 39
C F
Changes failure 65
Deployment File Only 20 Failure Code List 87
EAR and Deployment Files 21 FAILURE_APPLICATION_NOT_EXIST 87
EAR file Only 20 FAILURE_BATCH 89
checkpoint 61 FAILURE_BINDING_NOT_EXIST 87
className 86 FAILURE_CONFIG_COMMIT 90
command 70 FAILURE_CONFIG_ERROR_GENERAL 90
-config option 25 FAILURE_CONFIG_FILE_NOT_EXIST 90
container 58 FAILURE_CONFIG_FILE_PARSE_ERROR 90
cookieDomain 83, 85 FAILURE_CONFIG_FILE_READ_ERROR 90
cookieKeepExpire 83 FAILURE_DELETE_COMMIT 92
cookiePath 85 FAILURE_DELETE_GENERAL 92
Credentials File 11 FAILURE_DEPLOY_COMMIT 91
customer support xviii FAILURE_DEPLOY_GENERAL 91
FAILURE_DEPLOYED_STATE 92
96
| Index
FAILURE_DEPLOYMENT_STATUS 91 Help 8
FAILURE_DOMAIN_MASTER_SERVER_DOWN 89
FAILURE_DOMAIN_NOT_INSTALLED 88
FAILURE_ERROR_EXECUTING_EAR_PLUGIN 89
FAILURE_EXPORT_FILE_NAME_ERROR 93 I
FAILURE_EXPORT_GENERAL 92
FAILURE_GET_ARCHIVE 89 idleTimeout 86
FAILURE_HAWK_CONSOLE 87 initHeapSize 63
FAILURE_HAWK_MICROAGENT 87
FAILURE_INVALID_REPO_INSTANCE 91
FAILURE_KILL_GENERAL 93
FAILURE_MERGE_ERROR 93 J
FAILURE_NO_MACHINE_ASSOCIATED_WITH_PR
OCESS 88 JmsProviderUrl 50
FAILURE_NO_UPLOADED_ARCHIVE 91 JmsSslProviderUrl 50
FAILURE_NOT_AUTHENTICATED 88
FAILURE_NOT_AUTHORIZED 88
FAILURE_NOT_DEPLOYABLE_STATE 91
FAILURE_PARSING_XML 88 L
FAILURE_PARSING_XSD 88
FAILURE_SERVICE_NOT_EXIST 87 level 67
FAILURE_START_GENERAL 93 localRepoInstance 53
FAILURE_STOP_GENERAL 93 location 59
FAILURE_STOP_NOT_IN_STOPPABLE_STATE 93 Log Files, AppManage 13
FAILURE_UNDEPLOY_COMMIT 92 loginAs 62
FAILURE_UNDEPLOY_GENERAL 92
FAILURE_UNEXPECTED_EXCEPTION 87
FAILURE_UNEXPECTED_THROWABLE 87
FAILURE_UPLOAD_APPLICATION_ARCHIVE 89 M
FAILURE_UPLOAD_COMMIT 89
FAILURE_UPLOAD_GENRAL 89 machine 58
FAILURE_USAGE_ERROR 87 maxHeapSize 63
FAILURE_VALIDATION 88 maxjob 73
FAILURE_XML_SERIALIZE 92 maxLogFileSize 60
failureCount 54, 72, 77, 80 MessageEncoding 51
failureInterval 54, 72, 77, 80 -min Option 27
flowlimit 73 -moveAppData Option 28
ftWeight 58
N
H
network 57
HawkEnabled 50 NVPair 50
hbInterval 75
Index 97
|
O service 57
signaturePassword 83
obfuscate utility 11 sMTPServer 69
Online Help 8 -start Option 25
operationRetry 57 startOnBoot 60
options, buildear 16 startupType 62
-stop Option 26
support, contacting xviii
P
-passwordfile Option 28 T
Passwords 11
performPolicy 67, 68 tablePrefix 74
prepandClassPath 63 technical support xviii
preparationDelay 76 -template Option 27
-prompt Option 27 threadCount 60
Protecting Sensitive Data 12 threadStackSize 63
TIBCO_HOME xv
TIBHawkDaemon 51
TIBHawkNetwork 51
R TIBHawkService 51
timeout 55, 56, 61
Redeploying -truncate Option 28
an Application 20 type 59
regionalSubject 57
relative file paths 38
RemoteRvDaemon 50
repoInstanceName 49 U
requireNewSessionForVerify 85
restart 64, 65, 66 Undeploy Applications, Batch Mode 40
runAsNT 62 -undeploy Option 25
Running Scripting Utilities 7 -upload option 25
RvaHost 51 url 55
RvaPort 51 Using Online Help 8
RvDaemon 51
RvNetwork 51
RvService 51
W
Working with Passwords 11
S
selected 52
server 55, 56
98
| Index
X
XSD files 46
Z
?verride Option 26

Tib TRA Script Deploy Usr

Uploaded by

Copyright:

Available Formats

Tib TRA Script Deploy Usr

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Tib TRA Script Deploy Usr

Uploaded by

Copyright:

Available Formats

TIBCO Runtime Agent™

Scripting Deployment User’s Guide

Chapter 1 Scripting Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

TIBCO Runtime Agent Scripting Deployment User’s Guide

Chapter 3 Using AppManage in Batch Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Appendix A Deployment Configuration File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

TIBCO Runtime Agent Scripting Deployment User’s Guide

Appendix B Failure Code List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

TIBCO Runtime Agent Scripting Deployment User’s Guide

TIBCO Runtime Agent Scripting Deployment User’s Guide

Figure 1 TIBCO Administrator GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

TIBCO Runtime Agent Scripting Deployment User’s Guide

TIBCO Runtime Agent Scripting Deployment User’s Guide

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

TIBCO Runtime Agent Scripting Deployment User’s Guide

TIBCO Runtime Agent Scripting Deployment User’s Guide

• Changes from the previous Release of this Guide, page xii

TIBCO Runtime Agent Scripting Deployment User’s Guide

Changes from the previous Release of this Guide

TIBCO Runtime Agent Scripting Deployment User’s Guide

This section lists documentation resources you may find useful.

TIBCO Runtime Agent Documentation

Other TIBCO Product Documentation

TIBCO Runtime Agent Scripting Deployment User’s Guide

TIBCO Runtime Agent Scripting Deployment User’s Guide

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

bold code Bold code font is used in the following ways:

TIBCO Runtime Agent Scripting Deployment User’s Guide

Table 1 General Typographical Conventions (Cont’d)

Table 2 Syntax Typographical Conventions

TIBCO Runtime Agent Scripting Deployment User’s Guide

Table 2 Syntax Typographical Conventions (Cont’d)

TIBCO Runtime Agent Scripting Deployment User’s Guide

Connecting with TIBCO Resources

How to Join TIBCOmmunity

How to Access TIBCO Documentation

How to Contact TIBCO Support

TIBCO Runtime Agent Scripting Deployment User’s Guide

Chapter 1 Scripting Deployment

TIBCO Runtime Agent Scripting Deployment User’s Guide

TIBCO Runtime Agent Scripting Deployment User’s Guide

On UNIX platform, the builder utility requires configuration of X Server Manager

TIBCO Runtime Agent Scripting Deployment User’s Guide

The AppManage utility creates an XML based deployment configuration file in

TIBCO Runtime Agent Scripting Deployment User’s Guide

To Create a Sample Credential File:

Sample Credential file:

TIBCO Runtime Agent Scripting Deployment User’s Guide

The installation log file is written to the TIBCO_HOME/log directory.

TIBCO Runtime Agent Scripting Deployment User’s Guide

Starting the Scripting Utilities

TIBCO Runtime Agent Scripting Deployment User’s Guide

Accessing Online Help for Commands

Online help is available for the AppManage and buildear utilities.

TIBCO Runtime Agent Scripting Deployment User’s Guide

To display help about a command line option, type:

Specifying Application Names

TIBCO Runtime Agent Scripting Deployment User’s Guide