The retrieveProcessAppPackage and installProcessAppPackage commands

The retrieveProcessAppPackage and installProcessAppPackage commands are used to extract an installation package, and then install that package on an offline server.

You can customize your offline installation by using optional parameters to override the defaults for the retrieveProcessAppPackage and installProcessAppPackage utilities. You override the defaults at the command line. Refer to the following sections for information about the optional and required parameters for each command.

Important: You must specify any optional parameters before you specify the required parameters.

retrieveProcessAppPackage

Before you can run the retrieveProcessAppPackage.bat command, you must use the Process Center to install the model to an established offline server. If you do not install the model to an offline server, you will receive a command-line error when you run the command. Information about installing a model to an offline server is found in the topic "Installing snapshots on offline process servers."

The retrieveProcessAppPackage command extracts the installation package; it must be run before you can install the package. The syntax differs depending on whether you have a stand-alone or network deployment environment. The following examples use 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

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

installProcessAppPackage

The installProcessAppPackage installs the snapshot on the offline server. The syntax differs depending on whether you have a stand-alone or network deployment environment. The following examples use the installProcessAppPackage.bat command; on UNIX systems, use installProcessAppPackage.sh instead.

Stand-alone environment

installProcessAppPackage.bat {optional_parameters} install_package_name user_name user_password

Network deployment environment

installProcessAppPackage.bat {optional_parameters} -host host_name -port port_name -nodeName node_name -serverName server_name install_package_name user_name user_password

Table 2. Parameters for installProcessAppPackage
Option	Required or Optional	Description	Default
-? -help	Optional	Displays these command-line options and a description for each option	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
`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 (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