retrieveProcessAppPackage command-line utility (deprecated)

Edit online

Use the retrieveProcessAppPackage command-line utility to extract an installation package before installing it on an offline server.

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.

Location

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

Syntax

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:

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

-help: Optional parameter that displays available command-line options with descriptions.
-branch branch_name: Optional parameter that specifies the name of the workspace in which the snapshot to be installed resides.
-host host_name: Specifies the host on which to run the offline installation utility. The default value is the host specified in the existing profile. The -host parameter is required in a network deployment environment.
-port port: Specifies the port used by the IBM® Business Automation Workflow server on the specified host (WC_defaulthost). In an ND environment, connect to the HTTP server. The default value is the 9080 port, but it is different if that port is in use when the profile is created. The -port parameter is required in a network deployment environment.
-profileName profile_name: Optional parameter that specifies the name of the profile. By default, the parameter uses the value the default profile set as in the current environment.
-nodeName node_name: Specifies the node name in a network deployment environment. The -nodeName parameter is required in a network deployment environment.
-serverName server_name: Specifies the server name in a network deployment environment. The -serverName parameter is required in a network deployment environment.
process_app_acronym: Required parameter that specifies acronym of the process application for which you created the installation package.
snapshot_name: Required parameter that specifies the name of the snapshot for which you created the installation package.
Note: If the name includes spaces, enclose it in quotation marks.
offline_server_name: Required parameter that specifies the name of the offline server where you plan to install the snapshot.
Note: If the name includes spaces, enclose it in quotation marks.
install_package_name: Required parameter that specifies the name of the installation package.
Note: If the parameter name includes spaces, enclose it in quotation marks.
username: Required parameter that specifies the user account to run the offline installation utility. The default value is the user name specified in the existing profile.
Note: The user account specified must be a member of the tw_admins security group 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.
password: Required parameter that specifies the password for running the offline installation utility. The default value is the password specified in the existing profile.

Examples

If 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

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