TIBCO BusinessConnect Scripting Deployment User S Guide

TIBCO BusinessConnect™
Scripting Deployment
User’s Guide
Software Release 6.2
August 2014
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, and TIBCO Designer 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.
Copyright © 1999-2014 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
TIBCO BusinessConnect Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Chapter 1 Scripting Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
TIBCO BusinessConnect Scripting Deployment Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
TIBCO BusinessConnect Scripting Deployment’s Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Preparation for Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Deploying and Managing TIBCO BusinessConnect Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Starting bcappmanage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Managing Applications Using bcappmanage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Task A: Preparing for Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Task B: Deploying and Managing TIBCO BusinessConnect Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Task C: Preparing and Managing Gateway Server Tokens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Other Management Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 3 Parameters for commonConfig.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
JDBC Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Binding Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Cluster/FT Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Appendix A Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

-activateProtocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
TIBCO BusinessConnect Scripting Deployment User’s Guide

iv
| Contents
-createApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
-createGatewayToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
-assignService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
-startTransports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
-stopTransports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
-createInstallation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
-createTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
-configFTClusterMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
-deleteApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
-deployApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
-exportConfigRepo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
-exportDeployConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
-importConfigRepo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
-importDeployConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
-killApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
-listGatewayToken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
-startApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
-stopApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
-undeployApp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Appendix B Configuration Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

commonConfig.properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

|v
Preface
TIBCO BusinessConnect™ software is a B2B (business-to-business) gateway that

allows your company to engage in electronic commerce with your business
partners.
Topics
• Related Documentation, page vi

• Typographical Conventions, page viii
• Connecting with TIBCO Resources, page xi

vi
| Related Documentation
Related Documentation
This section lists documentation resources you may find useful.
TIBCO BusinessConnect Documentation

The following documents form the TIBCO BusinessConnect documentation set:
• TIBCO BusinessConnect™ Installation and Configuration Read this guide to
learn how to install and configure TIBCO BusinessConnect.
• TIBCO BusinessConnect™ Concepts Read this guide to learn about TIBCO
BusinessConnect architecture, deployment modes, protocols, and security.
• TIBCO BusinessConnect Interior Server™ Administration Read this guide in
order to administer, operate, and manage TIBCO BusinessConnect Interior
Server.
• TIBCO BusinessConnect Gateway Server™ Administration Read this guide in
order to administer, operate, and manage TIBCO BusinessConnect Gateway
Server.
• TIBCO BusinessConnect™ Trading Partner Administration Read this guide to
configure and manage trading partners.
• TIBCO BusinessConnect™ Scripting Deployment User’s Guide Read this guide to
configure and manage TIBCO BusinessConnect using the command line
interface.
• TIBCO BusinessConnect™ 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™: The software 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.
• TIBCO ActiveMatrix BusinessWorks™: This software is a scalable, extensible,
and easy to use integration platform that allows you to develop integration
projects. TIBCO ActiveMatrix BusinessWorks includes a graphical user

Preface vii
|
interface (GUI) for defining business processes and an engine that executes
the process.
• 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 Runtime Agent™: This software suite is a prerequisite for other TIBCO
software products. In addition to TIBCO Runtime Agent components, the
software suite includes the third-party libraries used by other TIBCO products
such as TIBCO Designer, Java Runtime Environment (JRE), TIBCO Hawk®,
and TIBCO Rendezvous®.
• TIBCO Rendezvous®: This software enables programs running on many
different kinds of computers on a network to communicate seamlessly. It
includes two main components: the Rendezvous programming language
interface (API) in several languages, and the Rendezvous daemon.
• TIBCO Enterprise Message Service™: This software provides a message
service that enables integration of applications within an enterprise based on
the Java Message Service (JMS) specifications.
• TIBCO BusinessEvents®: This software helps companies identify and quantify
the impact of events; it notifies people and systems about meaningful events
so processes can be adapted on-the-fly. TIBCO BusinessEvents uses a unique
model-driven approach to collect, filter, and correlate events and deliver
real-time operational insight.
• TIBCO Hawk®: This software is a tool for monitoring and managing
distributed applications and operating systems. The software is designed
specifically for monitoring distributed systems, so there is no centralized
console or frequent polling across the network.
• tibbr®, tibbr Service, tibbr Community, and tibbr Community Service: This
software is the first workplace communication tool with which you can follow
subjects that relate to your work and interests besides following people as you
do in typical social networking applications. That way, you have much more
flexibility in obtaining the right information at the right time in the right
context. In fact, the information will find you.
• TIBCO BusinessConnect™ Palette: This software is about the resources
available in the TIBCO BusinessConnect Palette for TIBCO ActiveMatrix
BusinessWorks.

viii
| Typographical Conventions
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
BC_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 BusinessConnect installs into a directory within a TIBCO_HOME. This
directory is referenced in documentation as BC_HOME. The default value of
BC_HOME depends on the operating system. For example, on Windows systems,
the default value is C:\tibco\bc\version.
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]

Preface ix
|
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 BusinessConnect
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 names 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 para1 | param2 | param3

x
| Typographical Conventions
Table 2 Syntax Typographical Conventions
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}

Preface xi
|
Connecting with TIBCO Resources
How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and
resident experts; 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.

xii
| Connecting with TIBCO Resources

Scripting Deployment 1
|
Chapter 1 Scripting Deployment
This chapter introduces the TIBCO BusinessConnect Scripting Deployment tool,

which is used to configure and deploy TIBCO BusinessConnect applications in
the administration domain using the command line interface.
Topics
• Overview, page 2
• TIBCO BusinessConnect Scripting Deployment Architecture, page 3
• TIBCO BusinessConnect Scripting Deployment’s Tasks, page 6
• Online Help, page 9

2
| Chapter 1 Scripting Deployment
Overview
TIBCO BusinessConnect Scripting Deployment enables the configuration and

deployment of a TIBCO BusinessConnect application in a non-GUI mode. This
includes deployment related tasks, such as creating and deploying TIBCO
BusinessConnect in TIBCO Administrator, as well as configuring the TIBCO
BusinessConnect configuration store (creating TIBCO BusinessConnect
installation, activating protocols, and importing CSX files).
Scripted deployment itself does not support certain deployment related aspects of
the TIBCO BusinessConnect application, such as public and private process
transports, file poller configurations, and intercomponent settings. Therefore,
these configuration settings need to be extracted from an existing TIBCO
BusinessConnect deployment, where they have been already configured using
the TIBCO BusinessConnect GUI.
This allows the entire TIBCO BusinessConnect repository and deployment
configurations on a TIBCO Administrator domain to be archived and
reconstructed on the same or another TIBCO Administrator domain. This archive
can be source-controlled for later deployment or redeployment; it can have
different service bindings, on different machines, with different clustering, and
different load balancing layout.
TIBCO BusinessConnect Scripting Deployment also facilitates the following:
• Automation for moving the TIBCO BusinessConnect application from one
environment to another, such as development to QA, or user acceptance to
production.
• Deploying of new participants or new operations between environments with
the ability to incrementally export the TIBCO BusinessConnect repository,
such as participants and operations, and without using the TIBCO
BusinessConnect Administrator console.
TIBCO BusinessConnect Scripting Deployment uses various commands to
perform configuration and deployment tasks.
Most of the configuration and deployment tasks use the configuration file
commonConfig.properties. This file is located in the directory
BC_HOME/tools/bcappmanage. For more details, see Chapter 3, Parameters for
commonConfig.properties.

TIBCO BusinessConnect Scripting Deployment Architecture 3
|
TIBCO BusinessConnect Scripting Deployment Architecture
TIBCO BusinessConnect Scripting Deployment (bcappmanage) combines the

underlying TIBCO BusinessConnect configuration repository management API in
the TIBCO Administrator console and the TIBCO Runtime Agent application
management utility into a single suite of command line utilities. These utilities
create a complete scripting deployment environment for managing of the TIBCO
BusinessConnect application.
TIBCO BusinessConnect Scripting Deployment uses four data files to persist all
configurations as archives for later deployment:
• Configuration Repository CSX Export It contains all configurations in the
TIBCO BusinessConnect configuration repository:
— System settings
— Trading partner profiles and business agreement settings
— Operation definitions
— Public transport and private process Smart Routing rules
— Private key and certificate credentials
• Deployment Configuration XML It contains all configurations in the TIBCO
BusinessConnect application archive for a TIBCO Administrator domain:
— Process definitions that drives the TIBCO BusinessConnect runtime engine
— Public transport settings
— Private process and inter-component communication settings
— Other miscellaneous settings that control the TIBCO BusinessConnect
runtime engine
• Service Instances Binding It contains all configurations for dynamic binding
of machines as the application service containers that execute the TIBCO
BusinessConnect runtime engine:
— Service instances to machines managed by the destination TIBCO
Administrator domain
— Other miscellaneous settings that control each binding service instances
• FT Cluster Mappings It contains all configurations for dynamic assignments
of service instance bindings to fault-tolerant groups and assignments of
fault-tolerant groups to public Smart Routing clusters.

4
Figure 1 illustrates a typical usage scenario for the TIBCO BusinessConnect

Scripting Deployment’s two major tasks: preparation for deployment, and
deployment and management of the TIBCO BusinessConnect application. See
TIBCO BusinessConnect Scripting Deployment’s Tasks for more information.

TIBCO BusinessConnect Scripting Deployment Architecture 5
|
Figure 1 TIBCO BusinessConnect Scripting Deployment Architecture
BusinessConnect BusinessConnect
Source Administration Domain
Target Administration Domain

Administration Console Scripting Deployment
Configuration and
Deployment
Administrator Login Command Line Terminal
Configuring BC
Application and Create Installation
Deployments
Activate Protocols
Export Configuration
Configuration Repository
Repository CSX Export
Import Configuration
Repository
Export
Deployment Deployment
Configuration Configuration Create Application
XML
Import Deployment
Administrator Logoff Configuration
Service
Instance Optional
Bindings
Configure FT Cluster
Mappings
Fault Tolerant Deploy Application

Cluster
Mappings
Start Application

6
TIBCO BusinessConnect Scripting Deployment’s Tasks
The two major tasks performed by the TIBCO BusinessConnect Scripting

Deployment consist of the following:
• Preparation for Deployment
• Deploying and Managing TIBCO BusinessConnect Application
Preparation for Deployment
For more details, see Task A: Preparing for Deployment on page 13.
This task exports the TIBCO BusinessConnect configuration repository CSX

export and the deployment configuration XML after completing all the
configurations necessary for deployment. It serves as the basis for deploying the
TIBCO BusinessConnect application on an TIBCO Administrator domain without
the application service containers. Repeat this task when there are any changes in
the configurations.
For all TIBCO BusinessConnect configuration related tasks, the JDBC connection
parameters for the TIBCO BusinessConnect configuration store need to be
specified. These connection parameters are picked up by default from the file
commonConfig.properties, a regular Java properties file located in the current
working directory BC_HOME/tools/bcappmanage. The location of this file can
also be specified with the argument -configRepoURL.
Manage Configuration Repository Commands

The following commands are used to prepare for deployment:
• -createInstallation Create configuration repository for object models, base
metadata, and schemas.
• -createTables Create the audit, non-repudiation, and runtime database
tables.
• -activateProtocol Activate the installed protocol plugins, by performing
protocol metadata activation and by creating schemas and supporting
runtime tables.
• -exportConfigRepo Export the TIBCO BusinessConnect configuration
repository into a CSX file with options to allow full installation export or by
certificates, operations or participants only.

TIBCO BusinessConnect Scripting Deployment’s Tasks 7
|
• -importConfigRepo Import the previously exported configuration repository

saved as a CSX file.
Argument
The connection parameters are picked up by default from the file
comonConfig.properties, a regular Java properties file located in the current
working directory BC_HOME/tools/bcappmanage. The location of this file can
also be specified with the argument -configRepoURL.
• -configRepoURL The URL of the configuration repository. This argument
follows the syntax file://file path.
Deploying and Managing TIBCO BusinessConnect Application
For more details, see Task B: Deploying and Managing TIBCO BusinessConnect
Applications.
This task uses the service instance binding map file to bind service instances
dynamically as application service containers for machines managed by a TIBCO
Administrator domain at deployment time. Optionally, dynamic assignments of
the fault tolerant groups and the public Smart Routing clusters are allowed using
the fault tolerant cluster map file.
Deployment tasks require that the administrative domain and authentication
credentials are specified. In addition to the listed commands, the command line
arguments are also needed. See Deployment Arguments.
Manage Deployment Configuration Commands

• -exportDeployConfig Export deployment configuration in XML format.
• -importDeployConfig Import deployment configuration in XML format with
machine bindings. To learn more, see Binding Maps.
• -configFTClusterMap Fault-tolerant and load-balanced mapping for Public
Smart Routing.
Manage Application Service Deployment Commands

• -createApp Create a TIBCO BusinessConnect application service.
• -deleteApp Delete a TIBCO BusinessConnect application service.
• -deployApp Deploy a TIBCO BusinessConnect application service.
• -undeployApp Undeploy a TIBCO BusinessConnect application service.

8
Manage Application Service Instances Commands

• -startApp Start TIBCO BusinessConnect service instances.
• -stopApp Stop TIBCO BusinessConnect service instances.
• -killApp Kill TIBCO BusinessConnect service instances.
Deployment Arguments
The mandatory arguments (parameters) for all deployment tasks are as follows:
• -user Administrative domain user name
• -pw Administrative domain password for the machine
• -cred Credentials file. See Credentials File.
• -domain Administrative domain
These arguments are not contained in the file commonConfig.properties.

Online Help 9
|
Online Help
To invoke the online help for TIBCO BusinessConnect, go to the directory

BC_HOME/tools/bcappmanage and type
bcappmanage
The following list of online help commands appears:
BCAppManage Usage:
Manage Configuration Repository:
-createInstallation : create Configuration Repository

-createTables : create Audit / NR / Runtime database tables
-activateProtocol : activate installed Protocol Plugin
-exportConfigRepo : export Configuration Repository (csx)
-importConfigRepo : import Configuration Repository (csx)
-createGatewayToken : create gateway tokens
-listGatewayToken : list a gateway token's properties
Manage Deployment Configuration:
-exportDeployConfig : export Deployment Configuration template

-importDeployConfig : import Deployment Configuration with machine
bindings
-configFTClusterMap : create Fault Tolerance / Load Balance Clustering
for Public Smart Routing
Manage Application Service Deployment:
-createApp : create Application Service

-deleteApp : delete Application Service
-deployApp : deploy Application Service
-undeployApp : undeploy Application Service
Manage Application Service Instances:
-startApp : start Service Instances

-stopApp : stop Service Instances
-killApp : kill Service Instances
Manage Gateway Server Instances:
-assignService : assign service to gateway server

-startTransports : start gateway server transports
-stopTransports : stop gateway server transports

10

| 11
Chapter 2 Getting Started
This chapter shows the sequence for configuring and deploying TIBCO
BusinessConnect application using TIBCO BusinessConnect.
Topics
• Starting bcappmanage, page 12

• Managing Applications Using bcappmanage, page 13

12
| Chapter 2 Getting Started
Starting bcappmanage
To start the bcappmanage utility, change to the directory

BC_HOME/tools/bcappmanage, and type the following
bcappmanage
See the section Online Help for information about using online help.
Once the TIBCO BusinessConnect application has been configured and deployed,
you can quickly export the existing configuration and deployment repositories.
After these preparation tasks are done, continue by re-installing the application,
importing the previously exported configuration, creating tables (if needed), and
deploying and managing the application using the command line interface.
To configure and deploy the TIBCO BusinessConnect application with TIBCO

BusinessConnect Scripting Deployment, the sequence explained in Managing
Applications Using bcappmanage must be followed.
Users who are planning to use the Oracle OCI drivers must specify the Oracle
Client Library path in the environment variable
tibco.env.ORACLE_CLIENT_PATH of the file bcappmanage.tra located under
BC_HOME/tools/bcappmanage.
The value should point to the Oracle native client libraries directory.
• On Windows, this is typically ORACLE_CLIENT_HOME/BIN directory; for
example C:\oracle\product\10.2.0\client\BIN.
• On UNIX systems, this is typically the ORACLE_CLIENT_HOME/lib or
ORACLE_CLIENT_HOME/lib32 directory.

Managing Applications Using bcappmanage 13
|
Managing Applications Using bcappmanage
TIBCO BusinessConnect Scripting Deployment cannot be used for the initial

TIBCO BusinessConnect application installation and configuration, which must
be performed in the TIBCO BusinessConnect GUI using TIBCO Administrator.
After you have used the GUI interface to install and configure the application,
you can use either the same GUI or the command line interface to perform
management and deployment tasks. Before performing any of the listed tasks,
make sure to first provide information for the file commonConfig.properties.
More details about this configuration file are available in Chapter 3, Parameters
for commonConfig.properties.
All parameters in the file commonConfig.properties will be validated by TIBCO
Runtime Agent. If any of the required parameters are missing or have been
entered in a format that is not acceptable, TIBCO Runtime Agent will throw an
error or insert default values, where appropriate.
To see the completed file commonConfig.properties with added parameters, see
Appendix B, Configuration Properties File.
Task A: Preparing for Deployment

To prepare for configuration of a TIBCO BusinessConnect application using
TIBCO BusinessConnect Scripting Deployment, the deployment configuration
and configuration repository need to be exported. Both tasks are required and can
be done in any order.
1. Export Deployment Configuration
bcappmanage -exportDeployConfig
The generated XML file will be used during the task invoked by the command
-importDeployConfig. Repeat the command -exportDeployConfig if any
of the configured deployment parameters have changed.
The complete command reference is available in -exportDeployConfig.
2. Export Configuration Repository
bcappmanage -exportConfigRepo
This task is used for generating CSX configuration export files from the
TIBCO BusinessConnect configuration repository. It supports four main
categories: participants, operations, certificates, and entire installation.
The complete command reference is available in -exportConfigRepo.

14
Task B: Deploying and Managing TIBCO BusinessConnect Applications

Once the configuration repository and the deployment configuration are exported
for the selected application categories, you can install, deploy, and manage the
TIBCO BusinessConnect application.
1. Create Installation
bcappmanage -createInstallation
Same as the Create Installation task in the TIBCO BusinessConnect GUI, this
task creates the TIBCO BusinessConnect installation. The complete command
reference is available in -createInstallation.
2. Activate Protocol
bcappmanage -activateProtocol
This task allows activation in one pass for all available protocol plugins
installed on the machine where bcappmanage is running. The complete
command reference is available in -activateProtocol.
3. Create Tables (optional)
bcappmanage -createTables
This task is optional and is not needed when the audit, non-repudiation, and
runtime data will be stored in the database account that is the same as the
account of the configuration store. The complete command reference is
available in -createTables.
4. Import Configuration Repository
bcappmanage -importConfigRepo
Imports the previously exported configuration repository saved as a CSX file.

The complete command reference is available in -importConfigRepo.
5. Create Application
bcappmanage -createApp
Creates deployment configuration for a TIBCO BusinessConnect application

service. The complete command reference is available in -createApp.
6. Import Deployment Configuration
bcappmanage -importDeployConfig
Imports the previously exported deployment configuration in XML format

and also does machine assignments. Names of the Interior hosts in the
commonConfig.properties file must be specified exactly as they are shown
on the screen Resource Management > Machines in TIBCO Administrator.
Same needs to be ensured for all property settings that use the machine names

Managing Applications Using bcappmanage 15
|
in their key. To learn more about machine bindings, see Binding Maps. The
complete command reference is available in -importDeployConfig.
7. Configure FT Cluster Map (optional)
bcappmanage -configFTClusterMap
This command is optional. It configures mappings of machines to

fault-tolerant groups and mappings of fault-tolerant groups to Public Smart
Routing clusters.
Configuration of fault-tolerant clusters for Public Smart Routing with TIBCO
BusinessConnect Scripting Deployment requires the machine bindings of
service instances be configured during the –importDeployConfig task. This
tool does not recognize machine bindings that are configured using the
TIBCO BusinessConnect administration console GUI. The complete command
reference is available in -configFTClusterMap.
8. Deploy Application
bcappmanage -deployApp
This command corresponds to the Deploy task in the TIBCO BusinessConnect

GUI and deploys the TIBCO BusinessConnect application service with an
option to suspend starting of all service instances on deploy. The complete
command reference is available in -deployApp.
9. Start Application
bcappmanage -startApp
This task can be used for starting the TIBCO BusinessConnect engines
deployed in scripted mode. The options define whether an individual engine
or all engines will be started, and also whether these engines are on the
Interior server. The complete command reference is available in -startApp.
Task C: Preparing and Managing Gateway Server Tokens

Once the Interior Server is deployed and running, you can create the Gateway
Server token and use it to start and deploy the Gateway Server. Two commands
for managing these tokens have been supplied:
• -createGatewayToken.
• -listGatewayToken.
Other Management Tasks

These tasks are dedicated to managing configured and deployed applications:

16
• Undeploy Application, which is presented in -undeployApp.

• Delete Application, which is presented in -deleteApp.
• Stop Application, which is presented in -stopApp.
• Kill Application, which is presented in -killApp.

| 17
Chapter 3 Parameters for commonConfig.properties
This chapter explains the parameters that are contained in the file
Topics
• Overview, page 18
• JDBC Maps, page 19
• Binding Maps, page 20
• Cluster/FT Map, page 24

18
| Chapter 3 Parameters for commonConfig.properties
Overview
When you install TIBCO BusinessConnect, the installation will create the file
commonConfig.properties in the directory BC_HOME/tools/bcappmanage.
This file has not been configured for your site and the configuration values such
as host names and passwords are missing. If you try to deploy a TIBCO
BusinessConnect application with the initially generated configuration properties
file, you will get error prompts asking you to enter the missing values.
To enter the values (parameters or keys) in the file commonConfig.properties,
either use the values that were available for the TIBCO BusinessConnect
application configured and deployed using the TIBCO BusinessConnect GUI, or
supply new values.
The values that you need to enter belong to three categories and have to be
mapped to the installed parameters as explained in the following sections:
• JDBC Maps
• Binding Maps
• Cluster/FT Map
A sample file commonConfig.properties that contains the values needed for
deployment is shown in Appendix B, Configuration Properties File.

JDBC Maps 19
|
JDBC Maps
The section JDBC Maps of the file commonConfig.properties contains the JDBC
connection parameters needed for configuration of repositories and of the audit,
non-repudiation, and runtime tables.
Configuration Repository Connection Parameters
Instead of posting your JDBC user ID and password in different files, it is

preferred to have them specified as the command line arguments with commands
-configRepoUser and -configRepoPw, respectively.
• bc.repo.db.driver = value
• bc.repo.db.url = value
• bc.repo.db.userID = value
This parameter is optional if the command -configRepoUser is used.
• bc.repo.db.password = value
This parameter is optional if the command -configRepoPw is used .
• bc.repo.db.connectionPool.size = value
Audit, Non-Repudiation, and Runtime Connection Parameters

The audit, non-repudiation, and runtime connection parameters are used by the
task -createTables.
• bc.[audit | nr | runtime].db.driver = value
• bc.[audit | nr | runtime].db.url = value
• bc.[audit | nr | runtime].db.userID = value
This parameter is optional if overwritten by the line parameter for the
command -jdbcUser (see -createTables).
• bc.[audit | nr | runtime].db.password = value
This parameter is optional if overwritten by the line parameter for the
command -jdbcPw (see -createTables).
• bc.[audit | nr | runtime].db.connectionPool.size = value

20
Binding Maps
The section Bindings Maps of the file commonConfig.properties contains the

values needed to configure Interior server bindings, fault-tolerant parameters,
heap sizes, thread stack sizes, and NT service startup parameters.
The binding maps properties are used by the task -importDeployConfig.
Machine Mapping to Interior Server Bindings

bc.appmanage.[interior].hosts = [<host>, ]
[interior]
The parameter interior is used for mapping engines that need to be

deployed on the Interior Server.
[<host>, ]
List of hosts where the Interior servers need to be deployed. Repeat the same
host for multiple service instances per host.
Examples:
bc.appmanage.interior.hosts = myHostA, myHostA, myHostA
Optional General and Java Server Settings Parameters
For more details about server settings parameters, see TIBCO Administrator User's
Guide, Setting Deployment Options, section Server Settings Tab.
Subsequent configuration properties use the following convention to refer to a

unique service instance for each host.
bc.appmanage.[interior].<host>.<index>.[ startonboot |
enableverbose | maxlogfilesize | maxlogfilecount | threadcount |
prependclasspath | appendclasspath | minHeap | maxHeap |
threadStack ] = <value>
[interior]
interior is used for mapping engines that need to be deployed on the

Interior Server.<host>
List of host names where the Interior server needs to be deployed.
<index>

Binding Maps 21
|
The parameter <host> is the name of the machine binding and <index> refers
to the instance on the same host. If there is only one instance on a machine, an
<index> of 1 is required.
myHostA.1, myHostA.2, myHostA.3
startonboot
Boolean value which denotes Start when the machine on which the service
instance is installed restarts.
enableverbose
Boolean value which denotes the enable verbose tracing

maxlogfilesize
Maximum Log File Size in KB

maxlogfilecount
Maximum number of log files to use

threadcount
Number of threads to use to execute the process instances

prependclasspath
Prepend to the CLASSPATH environment variable

appendclasspath:
Append to the CLASSPATH environment variable

minHeap
Initial Heap Size (MB)

maxHeap
Maximum Heap Size (MB)

threadStack:
Java Thread Stack Size (KB)
Examples:
bc.appmanage.interior.myHostA.1.minHeap=512 (Mbytes)
bc.appmanage.interior.myHostA.1.maxHeap=1024 (Mbytes)
bc.appmanage.interior.myHostA.2.minHeap=512 (Mbytes)
bc.appmanage.interior.myHostA.2.maxHeap=1024 (Mbytes)
bc.appmanage.interior.myHostA.2.startonboot=true

22
Optional Service Instance NT Service Startup Parameters

bc.appmanage.[interior].<host>.<index>.ntservice = [automatic |
manual].<user>.<pw>
[interior]
The parameter interior is used for mapping engines that need to be

deployed on the Interior Server.
<host>

<index>
A numerical value that denotes the Interior server instances occurring within
a host.
[automatic | manual]
NT Service start up type

<user>
Login user for the service

<pw>
Password for the service
Example:
bc.appmanage.interior.myHostX.1.ntservice =
automatic.myDomain\\myUserID.myPassword
Optional Interior Server Fault Tolerance Parameters
For more details about server fault tolerance parameters, see TIBCO
BusinessConnect Interior Server Administration, Fault Tolerance Tab.
bc.appmanage.ftGroupSettings.[service | network | daemonHost |

daemonPort | heartbeatInterval | activationInterval |
activationDelay]=[value]
service
Service used by the fault tolerance daemon

network
Network used by the fault tolerance daemon

daemonHost

Binding Maps 23
|
Daemon host
daemonPort
Daemon port
hearbeatInterval
Heart beat interval in seconds

activationInterval
Activation interval in seconds

activationDelay
Activation delay in seconds
Optional Oracle Client Path Parameter

bc.appmanage.interior.<host>.<index>.oracleclientpath=[value]
This property has can be updated using the TIBCO BusinessConnect Scripting
Deployment.
<host>

<index>
A numerical value that denotes the Interior server instances occurring within
a host.
Examples:
The Oracle client path for configuring interior engines with an OCI driver can be
set as shown below:
bc.appmanage.interior.host1.1.oracleclientpath=C:/Oracle1
bc.appmanage.interior.host2.1.oracleclientpath=/local/Oracle

24
Cluster/FT Map
The section Cluster/FT Map of the file commonConfig.properties contains the

parameters needed to map fault-tolerant groups to service instances and to map
Public Smart Routing clusters to fault-tolerant groups. Both parameter groups are
optional. The following properties are used with the task -configFtClusterMap
and are only applicable for Dual Firewall deployment.
Mapping Fault-Tolerant Groups to Service Instances

bc.appmanage.ft.group.<groupname> = [<host>.<index>,]
<groupname>
Fault-tolerant group name

<host>
Host machine running the service instance occurrence.

<index>
Required to denote the service instance occurrence on a host machine. Repeat

<host>.<index> to assign multiple service instance to a fault-tolerant group.
Examples:
bc.appmanage.ft.group.myFTGroupA = myHostX.1, myHostY.2
bc.appmanage.ft.group.myFTGroupB = myHostY.1, myHostX.2
bc.appmanage.ft.group.myDefaultFT = myHostZ.1
Mapping Public Smart Routing Clusters to Fault-Tolerant Groups

bc.appmanage.cluster.queue.[<queuename> | default]= [<groupname>,]
<queuename>
Public Smart Route rule name. Repeat <groupname> to assign multiple

fault-tolerant groups to a public Smart Routing cluster.
<default>
Denotes the NO MATCHING RULES rule name. If a service instance binding

exists but is not present in these properties, it will automatically be assigned to
a default fault-tolerant group named <domain>.BCFTGROUP.DEFAULT. All
unassigned fault-tolerant groups with be automatically added to the default
cluster queue when the default cluster queue property is not present.

Cluster/FT Map 25
|
Examples:
bc.appmanage.cluster.queue.myLargeEmailRule = myFTGroupA
bc.appmanage.cluster.queue.myLargeHTTPRequestRule = myFTGroupB
bc.appmanage.cluster.queue.default = myDefaultFT

26

| 27
Appendix A Command Reference
This appendix lists all configuration and deployment commands that you can
invoke using TIBCO BusinessConnect.
Topics
• -activateProtocol, page 28
• -createApp, page 29
• -createGatewayToken, page 30
• -assignService, page 32
• -startTransports, page 34
• -stopTransports, page 35
• -createInstallation, page 37
• -createTables, page 39
• -configFTClusterMap, page 41
• -deleteApp, page 42
• -deployApp, page 43
• -exportConfigRepo, page 44
• -exportDeployConfig, page 47
• -importConfigRepo, page 48
• -importDeployConfig, page 50
• -killApp, page 52
• -listGatewayToken, page 53
• -startApp, page 54
• -stopApp, page 55
• -undeployApp, page 56

28
| Appendix A Command Reference
-activateProtocol
Synopsis bcappmanage -activateProtocol
Description This command activates the specified TIBCO BusinessConnect protocol, which
involves the creation of database tables and other protocol specific initialization
steps. If ALL is specified, all installed protocols will be activated. In case of the
base EDI protocol, it checks whether it is enabled before the HIPAA protocol can
be activated. This task is equivalent to the activate protocol task under
BusinessConnect > Manage Installation in the TIBCO BusinessConnect GUI.
Options -protocol [ tibEDI | tibHIPAA | RosettaNet | SOAP | ebXML | cXML |

TCM | CMI | EZComm | FTPS | SFTP | PX | XCFI | ALL ]
Protocol plugin to activate

{ -tmpdir <temp directory> }
Temporary directory used to un-war the protocol plugin.

(default= Java system property - java.io.tmpdir)
{ -configRepoURL [<props_file_url> | <jdbc_url>] }
Optional URL to property file specifying the configuration repository

connection parameters or a standard JDBC URL.
If specifying a property file URL, the syntax is file://<file location>, ex
file://c:/temp/config.properties.
(default=file://./commonConfig.properties)
{ -configRepoUser <user> -configRepoPw <password> }
Optional configuration repository user and password. It must be specified if

the configRepoURL parameter is a JDBC URL, or if they are not specified in
the connection properties file.
Example:
• Activates all installed protocols.
bcappmanage -activateProtocol -protocol ALL -configRepoURL
file://c:/temp/config.properties
• Activates the EDI protocol.

bcappmanage -activateProtocol -protocol tibEDI -configRepoURL
Dependencies -createInstallation

-createApp 29
|
-createApp
Synopsis bcappmanage -createApp
Description This task is equivalent to the step Create Deployment Configuration invoked
from the TIBCO BusinessConnect GUI, which creates the TIBCO BusinessConnect
application that can be managed from TIBCO Administrator.
Options -domain <domain name> [-user <domain user> -pw <domain password> |
-cred <domain cred_file>]
administration domain name and credentials. Either user/password or

credential file location should be specified. See Credentials File.
Optional URL to property file specifying configuration repository connection

parameters or a standard JDBC URL
(default = file://./commonConfig.properties)

the connection properties file
Example
• Create the Single Server deployment configuration for the administrative
domain default-lt using the configuration connection parameters from a
Java properties file other than default.
bcappmanage -createApp -domain default-lt -cred
c:/temp/cred.properties -configRepoURL
Dependencies -importConfigRepo

30
-createGatewayToken
Synopsis bcappmanage -createGatewayToken
Description This command is used to create a Gateway Server token. The Gateway Server
container reads a Gateway Server token (including the RV for DMZ/MSH
communication) to start establishing a secure trusted connection with the Interior
Server.
The Gateway Server token allows for a secure configuration of a management
port and the DDTP port. It defines the communication of the Gateway Server: the
default settings given in General Settings are overwritten by the data in the
Gateway Server token. It also defines policy control and validates policies upon
startup.
Options - configRepoURL
The TIBCO BusinessConnect repository URL, mandatory

- configRepoUser
The TIBCO BusinessConnect repository user, mandatory

- configRepoPw
The TIBCO BusinessConnect repository password, mandatory

- name
Token name, optional

- desc
Optional description of the token

- managementPort
Optional management port for monitoring, defaults to 11000.

- dataPort
Optional data port used for streaming data transfer, defaults to 12000.
- publicBinding
Optional public binding address set in the token for transport listeners.
- systemBinding
Optional system binding address set in the token for internal management
and streaming data transfer.
- rvNetwork

-createGatewayToken 31
|
Optional RV Network set in the token for communication with the Interior
server. It defaults to the value specified in deployment Intercomponent
Communication > Gateway Server Settings.
- rvService
Optional RV Service set in the token for communication with the Interior
- rvDaemon
Optional RV Daemon set in the token for communication with the Interior
-exportPath
Optional export file path. The default is ./securetoken.dat.

- overwrite
Optional flag indicating to overwrite an existing token file.
Example:
Create a Gateway Token for the TIBCO BusinessConnect configuration
repository URL jdbc:oracle:thin:@host:1521:orcl and the user Joe. The
password for this URL and user is changeme, the token name is token1, and
the rest of the data is also entered for the management port (13000), data port
(14000) and for the export path of the token (c:\temp\token1.dat).
bcappmanage -createGatewayToken -configRepoURL
jdbc:oracle:thin:@10.100.100.10:1521:orcl -configRepoUser joe
-configRepoPw changeme -name token1 -managementPort 13000
-dataPort 14000 -exportPath c:/temp/token1.dat

32
-assignService
Synopsis bcappmanage -assignService
Description This command is used to delete the predefined service or to assign a service to a
Gateway Instance. This task is equivalent to perform under BusinessConnect >
Gateway > Gateway Instances in TIBCO Administrator.

credential file location should be specified.

parameters or a standard JDBC URL.

{ -instance <gateway server instance> }
Optional BC Gateway Server Instance name.

{ -transport <gateway server transport> }
Optional BC Gateway Server transport name. If you want to assign a service

to a Gateway Server Instance, you need to set the service transport name
option.
{ -service <gateway server service> }
Optional BC Gateway Server service name. If you want to assign a service to a

Gateway Server Instance, you need to set this option.
Example:
The following examples are listed when using the default settings.
• Specify credential file for administrative domain authorization and a file URL
for the configuration repository connection properties.

-assignService 33
|
bcappmanage -assignService -domain default-lt -cred

• Specify user ID/password for administrative domain authorization, and a

JDBC URL and userid/password for the configuration repository connection
properties.
bcappmanage -assignService -domain default-lt -user joe -pw
changeme
-configRepoURL jdbc:oracle:thin://host:1521;SID=bcdb
-configRepoUser joe -configRepoPw changeme

34
-startTransports
Synopsis bcappmanage -startTransports
Description This command is used to start all available transports for a Gateway Server. This
task is equivalent to perform under BusinessConnect > Gateway > Gateway
Instances in TIBCO Administrator.



Example:
bcappmanage -startTransports -domain default-lt -cred

properties.
bcappmanage -startTransports -domain default-lt -user joe -pw changeme

-stopTransports 35
|
-stopTransports
Synopsis bcappmanage -stopTransports
Description This command is used to stop all available transports for a Gateway Server. This
task is equivalent to perform under BusinessConnect > Gateway > Gateway
Instances in TIBCO Administrator.



Example:
bcappmanage -stopTransports -domain default-lt -cred

properties.
bcappmanage -stopTransports -domain default-lt -user joe -pw
changeme

36

-createInstallation 37
|
-createInstallation
Synopsis bcappmanage -createInstallation
Description The command -createInstallation creates a new TIBCO BusinessConnect

installation with option to disallow overwriting. This step initializes the TIBCO
BusinessConnect configuration store and is the functional equivalent of the step
Create Installation performed by TIBCO Administrator UI.
It creates the TIBCO BusinessConnect configuration schema in the database
account specified by the argument -configRepoURL, where the configuration
related tables are initialized with bootstrap data. This task also creates the audit,
runtime and non-repudiation schemas in the same database account, and
initializes the configuration store JDBC parameters used by TIBCO Administrator
in the BusinessConnect > Manage.
Only the TIBCO Administrator Super User and TIBCO BusinessConnect Super
User can perform the task -createInstallation.
It is required that TIBCO Administrator application is running while performing
this task.
Administration domain name and credentials. Either user/password or


If specifying a property file URL, the syntax is file://<file location>; for
example, file://c:/temp/config.properties.
Optional configuration repository user and password. Must be specified if the

configRepoURL parameter is a JDBC URL, or if they are not specified in the
connection properties file
{ -prefix <installation prefix> }
The TIBCO BusinessConnect installation prefix (default=AX.BC)

{ -overwrite }

38
Optional flag to enable overwriting if the database account has an existing

TIBCO BusinessConnect installation. By default existing TIBCO
BusinessConnect installation is not overwritten.
Examples
• Specifying credential file for admin domain authorization and a file URL for
the configuration repository connection properties.
bcappmanage -createInstallation -domain default-lt -cred
• Specifying user ID/password for administrative domain authorization and a

properties.
bcappmanage -createInstallation -domain default-lt -user joe -pw
changeme -configRepoURL jdbc:oracle:thin:@10.100.100.10:1521:orcl

-createTables 39
|
-createTables
Synopsis bcappmanage -createTables
Description This command is used to create audit, runtime, and non-repudiation schemas in
database accounts that are different from the ones in the TIBCO BusinessConnect
configuration store. This is accomplished by specifying the category
(audit/non-repudiation/runtime) as well as the JDBC connection parameters for
TIBCO BusinessConnect configuration store.
This task is optional and is not needed when the audit, non-repudiation, and
runtime data will be stored in the database account that is the same as the account
of the configuration store.
Options -category [ audit | nr | runtime ]
Table category to drop and recreate.

{ -jdbcURL [<props_file_url> | <jdbc_url>] }
Optional URL to a property file specifying database tables connection

If specifying a property file url the syntax is file://<file location>; for
example, file://c:/temp/audit.properties.
{ -jdbcUser <user> -jdbcPw <password> }
Optional database tables connection user and password. It must be specified if

the JDBC URL parameter is a JDBC URL, or if they are not specified in the
connection properties file.

parameters or a standard JDBC URL

the connection properties file
{ -overwrite }

40
Optional flag to enable overwriting if the database account has existing audit,
non-repudiation, or runtime data. By default existing data is not overwritten.
Examples
• Recreates and drops audit tables by specifying the audit connect entries via a
properties file other than default.
bcappmanage -createTables -category audit -configRepoURL
file://c:/temp/config.properties -jdbcURL
file://c:/temp/audit.properties

-configFTClusterMap 41
|
-configFTClusterMap
Synopsis bcappmanage -configFTClusterMap
Description This task is optional and is used for changing the default fault-tolerant
assignments for interior engines, as well as for mapping the Public Smart Routing
cluster queues to fault-tolerant groups.
Clusters for fault-tolerant groups and for Smart Routing are mapped as follows:
• Fault-tolerant groups to machine bindings
• Public Smart Routing cluster queues to fault-tolerant groups
The mappings are specified via a Java properties file or a
commonConfig.properties file located under BC_HOME/tools/bcappmanage.
The command configFTClusterMap can work only with the service instances
bindings that were previously configured using the command
-importDeployConfig. See step 6.
For more in formation, see Cluster/FT Map.

{-map <ft_cluster_map> }
location to properties file hosting fault tolerance and smart routing cluster
map configuration (default=./commonConfig.properties)
Example
• Perform cluster mapping using a Java properties file
C:/temp/cluster.properties other than default.
bcappmanage -configFTClusterMap -domain default-lt -cred

c:/temp/cred.properties -map C:/temp/cluster.properties
Dependencies -importDeployConfig
(service instances bindings must be previously configured using the

command -importDeployConfig)

42
-deleteApp
Synopsis bcappmanage -deleteApp
Description Deletes deployment configuration for a TIBCO BusinessConnect application

service. This task is equivalent to deleting the TIBCO BusinessConnect
application from TIBCO Administrator after undeploying the application.
Undeploy the application service before invoking this task.

Example
• Deletes the TIBCO BusinessConnect application using the credential file
C:/temp/cred.properties.
bcappmanage -deleteApp -domain default-lt -cred

c:/temp/cred.properties

-deployApp 43
|
-deployApp
Synopsis bcappmanage -deployApp
Description Deploys the configured TIBCO BusinessConnect application with an option to

suspend starting of all service instances.



{ -nostart }
Optional argument. If it is specified, do not start application service instances

on deploy.
Examples
• Deploys TIBCO BusinessConnect application service without starting the
service instances.
bcappmanage -deployApp -domain default-lt -cred
c:/temp/cred.properties -nostart
Dependencies -importDeployConfig
-configureFTClusterMap (optional)

44
-exportConfigRepo
Synopsis bcappmanage -exportConfigRepo
Description The command -exportConfigRepo is used for exporting CSX component files
from the TIBCO BusinessConnect configuration store. It supports four main
categories: participants, operations, certificates, and entire installation. It typically
exports all operations or participants, but it can be used also to export only
selected ones. For example, if you need to export a participant Company2 into
production environment, this command coupled with -importConfigRepo will
allow you to add the participant without making any changes to the GUI.
When exporting the configuration repository, target files are saved in the CSX
format, and configuration repositories are created for the following:
• Participants and agreements
• Operations and bindings
• Key and certificate credentials
• System and server settings
Exporting is performed as follows:
• For participants, operations, and certificates: a differential export is possible.
• For participants and certificates: a comma-separated list of entities to be
exported can be specified.
• For operations: the XPath of the operation tree to be exported can be specified
in addition to the protocol standard, which is mandatory for this category.
• In all these cases the exported CSX file can be optionally protected with a
password.
• For certificate export: each exported certificate is written out as a file
<cert-alias>.cert in the folder specified by the -p7b argument.
• The default export directory is the p7b_certs folder in the current working
directory.
Options -csx <config_export>
Configuration repository export (csx) file to import/export . Not applicable

for certificates export.
{ -pw <password> }
Optional password to encrypt/decrypt configuration repository

import/export (csx). Not applicable for certificates export.

-exportConfigRepo 45
|
{-overwrite}
Overwrites existing configuration repository export (csx) file if specified. Not

applicable for certificates export.
{ -category [ installation | participants | operations |
certificates] }
Export category type (default = installation)

{ -protocol [ EZComm | X12 | EDIFACT | TEXT | Gateway | Service |
RosettaNet | SOAP | ebXML | cXML ] }
Protocol standard for operation export applicable to category = operations

only
{ -op <delta_pattern> }
The operation sub-branch to be exported for category = operation, if not

specified the entire operation tree is exported; for example, -op /00401 for
protocol = X12
{ -alias <delta list> }
A comma separated list of participants for category = participants or aliases

for category = certificates, if not specified the entire set of participants or
certificates is exported
{ -tp <trading partner> }
The trading partner name for category = certificates

{ -p7b <p7b cert dir> }
The export directory for category = certificates


parameters or a standard JDBC URL. If specifying a property file URL, the
syntax is file://<file location>; for example,

the configRepoURL parameter is a JDBC URL or if they are not specified in
Examples
• Exporting two participants
bcappmanage -exportConfigRepo -category participants -alias
tantony-lt,tantony-dt -configRepoURL
file://c:/temp/config.properties -csx c:/temp/participants-1.csx

46
• Exporting all participants

bcappmanage -exportConfigRepo -category participants
-configRepoURL file://c:/temp/config.properties -csx
c:/temp/participants-1.csx
• Exporting certificate with alias cert1 for partner tantony-dt into folder
c:/temp (as file cert1.cert)
bcappmanage -exportConfigRepo -category certificates -alias cert1

-tp tantony-dt -configRepoURL file://c:/temp/config.properties
-p7b c:/temp
• Exporting the operation branch /00401 for protocol standard X12

bcappmanage -exportConfigRepo -category operations -protocol X12
-op /00401 -configRepoURL file://c:/temp/config.properties -csx
c:/temp/operations-401.csx
• Exporting the entire operation tree for protocol standard X12

bcappmanage -exportConfigRepo -category operations -protocol X12
-configRepoURL file://c:/temp/config.properties -csx
c:/temp/operations-401.csx

-exportDeployConfig 47
|
-exportDeployConfig
Synopsis bcappmanage -exportDeployConfig
Description Exports the deployment configuration into an XML file for future scripting
deployment. Any future import of this configuration will contain all public and
private process communication parameters specific to TIBCO BusinessConnect
application. By default, the output deployment configuration XML file is set as
BC-<domain>-deploy-config.xml and resides in the directory
BC_HOME/tools/bcappmanage/domain/<domain>, if not specified otherwise.

{-out <deploy_config_xml> }
File path to export the TIBCO BusinessConnect application configuration into

(default = BC-<domain>-deploy-config.xml)
{-overwrite}
Overwrites existing deployment configuration XML file if specified
In addition to an user ID and password, TIBCO BusinessConnect also supports

the TIBCO Runtime Agent credentials file, which can hold an obfuscated
(encrypted) password created by the obfuscate utility. If you do not want to use
the credentials file to store login and password, you can supply them directly on
the command line.
Credentials File
To read more about the credentials file, see TIBCO Runtime Agent Scripting
Deployment User’s Guide, section Working with Passwords.
Example
• Exports the deployment configuration for the administration domain
default-dt and the credential file located in C:\temp\cred.properties,
and saves it to the file C:\temp\config.xml.
bcappmanage -exportDeployConfig -domain default-lt -cred
c:/temp/cred.properties -out c:/temp/config.xml

48
-importConfigRepo
Synopsis bcappmanage -importConfigRepo
Description This command is used for importing CSX component files into the TIBCO
BusinessConnect configuration store by specifying the location of the CSX file and
the password, in case the file was password protected. It imports the file that was
previously exported using step 2.
Only the TIBCO BusinessConnect Super User can perform this task. To learn more
about TIBCO BusinessConnect Super Users and how they are created, see TIBCO
BusinessConnect Concepts, TIBCO BusinessConnect Super User, and TIBCO
BusinessConnect Trading Partner Administration Guide, Managing Groups with
TIBCO BusinessConnect User Management.
Only the CSX files belonging to TIBCO BusinessConnect 5.3.3 and later are
supported.
When importConfigRepo is executed, the installation name created during the

task createInstallation will be replaced with the installation name from the
imported CSX file.
It is required that TIBCO Administrator application is running while performing

this task.

-csx <config_export>
Configuration repository export (csx) file to import/export

{ -csxpw <password> }
Optional password to encrypt/decrypt the configuration repository import or

export (csx).
Optional URL to property file specifying the configuration repository

connection parameters or a standard JDBC URL. If specifying a property file
URL, the syntax is file://file location, such as

-importConfigRepo 49
|

Example
• Import the configuration repository that was previously exported into the file
C:\tempmisc\operations-x12-test.csx.
bcappmanage -importConfigRepo -domain default-lt -cred

c:/temp/cred.properties-configRepoURL
file://c:/temp/config.properties -csx
c:/temp/misc/operations-x12-test.csx
-exportConfigRepo
-activateProtocol (if any)

-createTables (optional)

50
-importDeployConfig
The task -importDeployConfig allows only import of the same type of XML
deployment configuration; for example, the XML configuration exported from a
Single Server deployment mode can be only imported on a Single Server
deployment configuration.
Synopsis bcappmanage -importDeployConfig
Description This command is used for configuring the Interior server engine instances and for
specifying the attributes of the deployed engines, such as Java heap, stack size
settings, and NT service settings.
Input the bindings using the following:
• The Java properties file commonConfig.properties, whose location is a
command line argument for this task or BC_HOME/tools/bcappmanage
• Configuration file that was exported using the command
-exportDeployConfig.By default, the input XML file for the task
-importDeployConfig is set as BC-<domain>-deploy-config.xml, which
resides under BC_HOME/tools/bcappmanage/domain/<domain>
While exporting the deployment configuration, you do not need to specify any
machines names. Therefore, the step invoked by the command
-importDeployConfig is used to define to the exact machines that will be used
for the deployment and to configure their bindings. To learn more, see Binding
Maps.
Names of the Interior hosts must be specified exactly as they are shown on the
screen Resource Management > Machines in TIBCO Administrator. Same needs
to be ensured for all property settings that use the machine names in their key. See
Binding Maps for more information.

{ -config <deploy_config_xml> }
File path to the exported TIBCO BusinessConnect application configuration

(default=BC-<domain>-deploy-config.xml)
{ -bindings <machine_binding_map> }
Location to properties file hosting the Interior server host definitions

(default=./commonConfig.properties)

-importDeployConfig 51
|
Example
• Import the deployment configuration for the administrative domain
default-lt from the file C:\temp\config.xml.
bcappmanage -importDeployConfig -domain default-lt -cred

c:/temp/cred.properties -config c:/temp/config.xml -bindings
C:/temp/bindings.properties
Dependencies -exportDeployConfig
-createApp

52
-killApp
Synopsis bcappmanage -killApp
Description Kills (forcefully stops) TIBCO BusinessConnect application service instance.

This task can be used for killing the TIBCO BusinessConnect engines deployed in
scripted mode.
The command killApp can work only with the service instances bindings that
were previously configured using the command -importDeployConfig. See
step 6.

{ -engine [interior.<host>.<index>] }
Application service instance identifier; for example, interior.host1.1.
Example
• Kills all engines.
bcappmanage -killApp -domain default-lt -cred
• Kills interior instance 1 on the host Machine_X.
bcappmanage -killApp -domain default-lt -cred

c:/temp/cred.properties -engine interior.Machine_X.1

-listGatewayToken 53
|
-listGatewayToken
Synopsis bcappmanage -listGatewayToken
Description Lists properties of a Gateway token.
Options -filename
Name of the token file (mandatory)
Example
• List properties of the Gateway Token file token1.dat.
bcappmanage -listGatewayToken -fileName c:/temp/token1.dat

54
-startApp
Synopsis bcappmanage -startApp
Description Starts a TIBCO BusinessConnect application service instance by service instance

identifier on the Interior Server service.
The command startApp can work only with the service instances bindings that
step 6.

credential file location should be specified. See Credentials File
Application service instance identifier: interior.host1.1
Example:
• Start all engines
bcappmanage -startApp -domain default-lt -cred
• Start interior instance 1 on host Machine_X

bcappmanage -startApp -domain default-lt -cred
Dependencies -deployApp (with the -nostart option)

-stopApp 55
|
-stopApp
Synopsis bcappmanage -stopApp
Description Stops a single TIBCO BusinessConnect application service instance by service

instance identifier on the Interior Server.
This task can be used for stopping the TIBCO BusinessConnect engines deployed
in scripted mode.
The command stoppApp can work only with the service instances bindings that
step 6.

Application service instance identifier; for example, interior.host1.1.
Example
• Stop all engines.
bcappmanage -stopApp -domain default-lt -cred
• Stop interior instance 1 on host Machine_X.

bcappmanage -stopApp -domain default-lt -cred

56
-undeployApp
Synopsis bcappmanage -undeployApp
Description Undeploys the configured TIBCO BusinessConnect application.

Example
• Undeploys the TIBCO BusinessConnect application using the credential file
C:/temp/cred.properties.
bcappmanage -undeployApp -domain default-lt -cred


| 57
Appendix B Configuration Properties File
This appendix contains a sample file commonConfig.properties, which is

installed by the application TIBCO BusinessConnect in the directory
BC_HOME/tools/bcappmanage.
Topics
• commonConfig.properties, page 58

58
| Appendix B Configuration Properties File
commonConfig.properties
The file commonConfig.properties is initially installed by the application TIBCO

BusinessConnect in the directory BC_HOME\tools\bcappmanage. In this
example, user information is entered in bold text.
More details about this file are available in Chapter 3, Parameters for
Example 1 commonConfig.Properties
#
# Copyright (c) 2003-2011 TIBCO Software Inc.
# All Rights Reserved.
#
# This software is the confidential and proprietary information of
# TIBCO Software Inc.
#
#==========================================================
# *** Common variables ***
#==========================================================
#================================
# *** JDBC Maps ***
#
# Samples JDBC driver and URLs where <type> = <repo|audit|nr|runtime>:
#
# bc.<type>.db.driver = com.mysql.jdbc.Driver
# bc.<type>.db.url = jdbc:mysql://[host]:[port]/[database]
#
# bc.<type>.db.driver = oracle.jdbc.driver.OracleDriver [ deprecated by Oracle ]
# bc.<type>.db.driver = oracle.jdbc.OracleDriver [ new Driver class introduced by
Oracle from ojdbc5.jar ]
# bc.<type>.db.url = jdbc:oracle:thin:@[host]:[port]:[sid]
#
#
#
# Native Vendor Driver support
# ============================
#
# Oracle OCI
# ----------
# bc.<type>.db.driver = oracle.jdbc.OracleDriver
# bc.<type>.db.url = jdbc:oracle:oci:@<Service Name>
#
# Microsoft SQL Server driver
# ---------------------------
# bc.<type>.db.driver = com.microsoft.sqlserver.jdbc.SQLServerDriver
# bc.<type>.db.url = jdbc:sqlserver://<host>:<port#>;databaseName=<databaseName>
#
# DB2 Universal Driver
# ---------------------

commonConfig.properties 59
|
# bc.<type>.db.driver = com.ibm.db2.jcc.DB2Driver
# bc.<type>.db.url = jdbc:db2://<host>:<port#>/<databaseName>
#================================
# Repository connection prameters

#
bc.repo.db.driver=com.mysql.jdbc.Driver
bc.repo.db.url=jdbc:mysql://axw3k1:3306/john
bc.repo.db.userID=john1
bc.repo.db.password=john1
bc.repo.db.connectionPool.size=32
# Audit connection parameters

#
bc.audit.db.driver=com.mysql.jdbc.Driver
bc.audit.db.url=jdbc:mysql://axw3k1:3306/john
bc.audit.db.userID=john1
bc.audit.db.password=john1
bc.audit.db.connectionPool.size=
# NR connection parameters
#
bc.nr.db.driver=com.mysql.jdbc.Driver
bc.nr.db.url=jdbc:mysql://axw3k1:3306/john
bc.nr.db.userID=john1
bc.nr.db.password=john1
bc.nr.db.connectionPool.size=
#
# Runtime connection parameters
#
bc.runtime.db.driver=com.mysql.jdbc.Driver
bc.runtime.db.url=jdbc:mysql://axw3k1:3306/john
bc.runtime.db.userID=john1
bc.runtime.db.password=john1
bc.runtime.db.connectionPool.size=
#================================
# Bindings Map
#================================
#
# List of hosts where interior servers need to be deployed. Repeat the host name for
multiple interior server
# instances on the same host. Ex,
# interior.hosts=host1,host2,host3,host1
#
bc.appmanage.interior.hosts=
# (Optional)
# The min, max heap sizes, thread stack size and classpath extensions for the
interior engines can be specified(in MBs) as shown below.
# The first token in the key is interior, the next token refers to the host
# name, the next token specifies the instance occurence within that host (for
interiors)and the last token specifies
# whether the value is min / max heap size, thread stack size or append/prepend
classpath.

60
# Since this is a java properties file, prepend/append classpaths should always use
'/' as the path separator.
# Ex,
#
# bc.appmanage.interior.host1.1.minHeap=500
# bc.appmanage.interior.host1.1.maxHeap=1000
# bc.appmanage.interior.host1.1.threadStack=512
# bc.appmanage.interior.host1.1.appendclasspath=c:/temp
# bc.appmanage.interior.host1.1.prependclasspath=c:/temp2
# bc.appmanage.interior.host1.2.minHeap=800
# bc.appmanage.interior.host1.2.maxHeap=1200
# bc.appmanage.interior.host1.2.threadStack=1024
# (Optional)
# The general settings for deployed engines can be set as shown below.
interiors)and the last token specifies
# the specific attribute being set which is one among - startonboot, enableverbose,
maxlogfilecount & maxlogfilesize.
# Ex,
#
# bc.appmanage.interior.host1.1.startonboot=true
# bc.appmanage.interior.host1.1.enableverbose=true
# bc.appmanage.interior.host1.1.threadcount=14
# (Optional)
# The NT service settings for deployed engines can be set as shown below.
interiors) and the last token identifes
# this key as defining the NT service setting. The value has three tokens of which
the first one indicates the
# service startup type which can be either 'manual' or 'automatic'. The second and
third tokens specify the user id
# and password for the service's logon account. Note that the userid should
mandatorily specify the domain. The double
# backslashes are required, slash being part of the properties file syntax. To run
the service under the default local
# system account, leave the userid and password empty.
#
# bc.appmanage.interior.host1.1.ntservice=automatic.domain\\joe.changeme
# bc.appmanage.interior.host1.2.ntservice=manual.domain\\joe.changeme
# (Optional)
# Interior Server Fault Tolerance Group Settings can be set as shown below.
#
# Note: The properties for heartbeatIntervals, activationInterval and
activationDelay are specified in seconds.
#
# bc.appmanage.ftGroupSettings.service=7505
# bc.appmanage.ftGroupSettings.network=
# bc.appmanage.ftGroupSettings.daemonHost=
# bc.appmanage.ftGroupSettings.daemonPort=7505
# bc.appmanage.ftGroupSettings.heartbeatInterval=5

commonConfig.properties 61
|
# bc.appmanage.ftGroupSettings.activationInterval=15
# bc.appmanage.ftGroupSettings.activationDelay=10
# (Optional)
# The Oracle client path for configuring interior engines with OCI driver can be set
as shown below.
# bc.appmanage.interior.host1.1.oracleclientpath=<Oracle Home Path1>
# bc.appmanage.interior.host2.1.oracleclientpath=<Oracle Home Path2>
#================================
# Cluster/FT Map
#================================
#
# Mapping of FT groups to interior engine instances. Key is the group name and value
is a comma separated list of
# interior engine instances under that group with the syntax <host.index>. Repeat
the entry for multiple
# FT groups. Ex
# bc.appmanage.ft.group.FTG1=host1.1,host2.1
# bc.appmanage.ft.group.FTG2=host3.1, host1.2
#
bc.appmanage.ft.group.<groupname>=
# (Optional)
# Mapping of public smart routing cluster queues to FT groups. Key is the cluster
queue name name and value is a
# comma separated list of FT groups asigned to that cluser. Repeat the entry for
multiple cluster queues. Ex,
# bc.appmanage.cluster.queue.Q1=FTG1
# bc.appmanage.cluster.queue.Q2=FTG2
#
#bc.appmanage.cluster.queue.<queuename>=
#
# A comma separated list of FT groups assigned to the default (NO MATCHING RULES)
cluster queue.
#
bc.appmanage.cluster.queue.default=

62

| 63
Index
A deploying and managing applications 14
activate protocol 14
-activateProtocol 28
-assignService 32 E
audit, non-repudiation, and runtime connection
parameters 19 ENV_NAME viii
export configuration repository 13
export deployment configuration 13
-exportConfigRepo 44
B -exportDeployConfig 47
binding maps 20
C import configuration repository 14

import deployment configuration 14
cluster/FT map 24 -importConfigRepo 48
-configFTClusterMap 41 -importDeployConfig 50
configuration repository connection parameters 19
configuration tasks overview 27
configure FT cluster map 15
create application 14 J
create installation 14
create tables 14 JDBC maps 19
-createApp 29
-createGatewayToken 30
-createInstallation 37
-createTables 39 K
customer support xi
-killApp 52
D
L
-deleteApp 42
deploy application 15 -listGatewayToken 53
-deployApp 43

64
| Index
M U
machines to Interior Server bindings 20 -undeployApp 56
managing applications using bcappmanage 13
mapping fault-tolerant groups to service instances 24
mapping public Smart Routing clusters to fault-toler-
ant groups 24
O
online help 9
optional service instance JVM Min / Max Heap and
Thread Stack Size 20
optional service instance NT service startup
parameters 22
other management tasks 15
P
preparing for deployment 13
S
sample bindings for the Interior Server 20
start application 15
-startApp 54
starting bcappmanage 12
-startTransports 34
-stopApp 55
-stopTransports 35
support, contacting xi
T
technical support xi
TIBCO_HOME viii

TIBCO BusinessConnect Scripting Deployment User S Guide

Uploaded by

Copyright:

Available Formats

TIBCO BusinessConnect Scripting Deployment User S Guide

Uploaded by

Document Information

Original Title

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

TIBCO BusinessConnect Scripting Deployment User S Guide

Uploaded by

Copyright:

Available Formats

TIBCO BusinessConnect™

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

Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Chapter 3 Parameters for commonConfig.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Appendix A Command Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

TIBCO BusinessConnect Scripting Deployment User’s Guide

Appendix B Configuration Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

TIBCO BusinessConnect Scripting Deployment User’s Guide

TIBCO BusinessConnect™ software is a B2B (business-to-business) gateway that

• Related Documentation, page vi

TIBCO BusinessConnect Scripting Deployment User’s Guide

This section lists documentation resources you may find useful.

TIBCO BusinessConnect Documentation

Other TIBCO Product Documentation

TIBCO BusinessConnect Scripting Deployment User’s Guide

TIBCO BusinessConnect 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 BusinessConnect Scripting Deployment User’s Guide

Table 1 General Typographical Conventions (Cont’d)

Table 2 Syntax Typographical Conventions

TIBCO BusinessConnect Scripting Deployment User’s Guide

Table 2 Syntax Typographical Conventions

TIBCO BusinessConnect Scripting Deployment User’s Guide

Connecting with TIBCO Resources

How to Join TIBCOmmunity

How to Access TIBCO Documentation

How to Contact TIBCO Support

TIBCO BusinessConnect Scripting Deployment User’s Guide

TIBCO BusinessConnect Scripting Deployment User’s Guide

Chapter 1 Scripting Deployment

This chapter introduces the TIBCO BusinessConnect Scripting Deployment tool,

TIBCO BusinessConnect Scripting Deployment User’s Guide

TIBCO BusinessConnect Scripting Deployment enables the configuration and

TIBCO BusinessConnect Scripting Deployment User’s Guide

TIBCO BusinessConnect Scripting Deployment Architecture

TIBCO BusinessConnect Scripting Deployment (bcappmanage) combines the

TIBCO BusinessConnect Scripting Deployment User’s Guide

Figure 1 illustrates a typical usage scenario for the TIBCO BusinessConnect

TIBCO BusinessConnect Scripting Deployment User’s Guide

Figure 1 TIBCO BusinessConnect Scripting Deployment Architecture

Source Administration Domain

Target Administration Domain

Administrator Login Command Line Terminal

Fault Tolerant Deploy Application

TIBCO BusinessConnect Scripting Deployment User’s Guide

TIBCO BusinessConnect Scripting Deployment’s Tasks

The two major tasks performed by the TIBCO BusinessConnect Scripting

Preparation for Deployment

This task exports the TIBCO BusinessConnect configuration repository CSX

Manage Configuration Repository Commands

TIBCO BusinessConnect Scripting Deployment User’s Guide

• -importConfigRepo Import the previously exported configuration repository

Deploying and Managing TIBCO BusinessConnect Application

Manage Deployment Configuration Commands

Manage Application Service Deployment Commands

TIBCO BusinessConnect Scripting Deployment User’s Guide

Manage Application Service Instances Commands