As stated earlier in this document, when you configure Business Transaction Management for the first time, we recommend that you use the browser-based Configuration Wizard. For users who want to execute various aspects of the configuration from the command line, a Command Line Interface (CLI) is provided.
The CLI provides command-line equivalents to many configuration tasks. Relevant to this document, which describes configuration of Business Transaction Management using the browser-based configuration wizard, are the configure and registerContainer commands. Both of these commands are part of the CLI and provide an alternative to the wizard approach to configuration.
Complete documentation for the configure and registerContainer commands, as well as the entire CLI, can be found in the Business Transaction Management online help. In the Table of Contents, navigate to Administering and configuring AMS, and then the sub-topic Command line utilities/Command line interface.
The CLI executable is located in the install_dir/tools directory—ap.bat for Windows and ap.sh for Unix-like systems.
Command syntax:
ap configure -i inputFile -s sphereUrl -l username:password
The configure command takes an XML configuration file as an argument. This configuration file specifies all the setup information for Business Transaction Management, including database type and connection information, deployment credentials, and so on. You can develop this configuration input file in either of the following ways:
Use a sample file that is provided with the Business Transaction Management distribution. Sample application server-specific files are located in:
Install_Dir/samples/cli/config_files/yourAppServerConfig.xml
Business Transaction Management_install_dir is the directory where you unzipped your Business Transaction Management distribution.
Use the generated configuration file that is output when you perform initial configuration of Business Transaction Management using the browser-based Configuration Wizard. The wizard produces a configuration file that contains all the configuration information (sphere URL, database connection information, performance server location, authentication credentials, and so on). You can use this configuration file as input to the configure command. The generated configuration file is located at the following location after you have used the Configuration Wizard:
appServer_install_dir/amberpoint/globalPreferences/essentialConfiguration.xml
The registerContainer command takes an XML configuration file as an argument. This configuration file specifies all the setup information for the application server, including agent message log database type and connection information, deployment credentials, and so on. A sample configuration file that you can use to create your own file is located in:
install_dir/samples/cli/config_files/RegisterContainer.xml
Invoking the CLI
The CLI executable is located in the install_dir/tools directory—ap.bat for Windows and ap.sh for Unix-like systems.
Command syntax:
ap registerContainer -i inputFile -s sphereUrl -l username:password