retrieveProcessAppPackage command-line utility (deprecated)

The retrieveProcessAppPackage command-line utility is used to extract an installation package before installing it on an offline server.

Purpose

The retrieveProcessAppPackage utility is located in the install_root/BPM/Lombardi/tools/process-installer directory.

You can customize your offline installation by using optional parameters at the command line to override the default values for this utility.
Important: You must specify any optional parameters before you specify the required parameters.

The syntax differs depending on whether you have a stand-alone or network deployment environment. The command is run against the default profile, although you can use optional parameters to run the command against a different profile.

The following syntax uses the retrieveProcessAppPackage.bat command; on UNIX systems, use retrieveProcessAppPackage.sh instead.
  • Stand-alone environment
    retrieveProcessAppPackage.bat {optional_parameters} process_app_acronym snapshot_name offline_server_name install_package_name user_name user_password
  • Network deployment environment
  • retrieveProcessAppPackage.bat {optional_parameters} -host host_name -port port_name -nodeName node_name -serverName server_name process_app_acronym snapshot_name offline_server_name install_package_name user_name user_password

Parameters

Table 1. Parameters for retrieveProcessAppPackage
Option Required or Optional Description Default
-?

-help

Optional Displays these command-line options and a description for each option None
-branch branch_name Optional The name of the workspace in which the snapshot to be installed resides None
-h host_name

-host host_name

Required in a network deployment environment The host on which to run the offline installation utility The host specified in the existing profile
-t port

-port port

Required in a network deployment environment The port used by the IBM® Business Process Manager server on the specified host (WC_defaulthost). In an ND environment, connect to the HTTP server. The port specified in the existing profile, which is port 9080 by default, but will be different if that port is in use when the profile is created.
-profileName profile_name Optional The name of the profile The profile set as the default in the current environment
-nodeName node_name Required in a network deployment environment The node name in a network deployment environment None
-serverName server_name Required in a network deployment environment The server name in a network deployment environment None
process_app_acronym Required The acronym of the process application for which you created the installation package None
snapshot_name Required The name of the snapshot for which you created the installation package
Note: If the name includes spaces, enclose it in quotation marks.
None
offline_server_name Required The name of the offline server where you plan to install the snapshot
Note: If the name includes spaces, enclose it in quotation marks.
None
install_package_name Required The name of the installation package
Note: If the name includes spaces, enclose it in quotation marks.
None
username Required The user account to run the offline installation utility.
Note: The user account specified must be a member of the tw_admins security group in order to install to offline production servers. For other types of servers (for example, staging and test), the specified user must be a member of the tw_authors security group.
The user name specified in the existing profile
password Required The password for running the offline installation utility. The password specified in the existing profile
For Linux operating systemFor UNIX operating systemIf a parameter name includes spaces, either put the name in quotation marks or put a backslash before each space in a name, as shown in the following examples:
retrieveProcessAppPackage.sh TESTDPL Test\ Snapshot Dev\ Offline test_package_file.zip 

OR

retrieveProcessAppPackage.sh TESTDPL "Test Snapshot" "Dev Offline" test_package_file.zip