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 5

• Online Help, page 8

2

|

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

|

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.

Figure 1 TIBCO BusinessConnect Scripting Deployment Architecture

TIBCO BusinessConnect Scripting Deployment’s Tasks

|

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

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.

For more details, see Task A: Preparing for Deployment on page 11.

6

|

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

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.

Manage Application Service Instances Commands

• -startApp Start TIBCO BusinessConnect service instances.

For more details, see Task B: Deploying and Managing TIBCO BusinessConnect Applications.

TIBCO BusinessConnect Scripting Deployment’s Tasks

|

• -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.

8

|

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:

-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:

|

Chapter 2 Getting Started

This chapter shows the sequence for configuring and deploying TIBCO BusinessConnect application using TIBCO BusinessConnect.

Topics

• Starting bcappmanage, page 10

• Managing Applications Using bcappmanage, page 11