Customize process application installations on offline Process Servers

WebSphere Lombardi Edition 7.2 > Run and installing processes > Releasing and installing processes

Customize process application installations on offline Process Servers

When installing process applications to offline Process Server in your Lombardi environment, you have the option of customizing those installations. You can choose from the following methods to customize installation of process applications on offline Process Servers:

Method See...

Create a custom script to use with the installProcessAppPackage.cmd (.sh) Create a custom script
Override the default settings for retrieveProcessAppPackage.cmd (.sh) and installProcessAppPackage.cmd (.sh) at the command prompt or using the process-installer.properties file Overriding default offline install settings
Perform each step of the installation separately, allowing for more robust customization between steps Performing offline installation steps separately

Create a custom script

Follow the standard procedure for installing process applications to offline Process Servers.
To create a custom script to use with the installProcessAppPackage.cmd (.sh) utility that you implement during the standard procedure:

On the offline Process Server where you want to customize the installation, open a command prompt and go to the [Lombardi_home]/tools/process-installer directory.

Open the customProcessAppPreInstall.cmd (.sh) file. For example, on Windows you can enter the following at a command prompt:
notepad customProcessAppPreInstall.cmd
Add commands that you want to run immediately before the process application snapshot is installed on the offline Process Server and then save your changes.
Run the installProcessAppPackage.cmd (.sh) utility
This utility automatically invokes customProcessAppPreInstall.cmd (.sh) before beginning the installation.

Overriding default offline install settings

You can also customize your offline installation by overriding the defaults for the retrieveProcessAppPackage.cmd (.sh) and installProcessAppPackage.cmd (.sh) utilities. You can override the defaults at the command line or by using the settings in the [Lombardi_home]/tools/process-installer/process-installer.properties file. For example, you can change the default host, port, user name, and password used for offline installation.
The process-installer.properties file includes the following settings:

Set Default Description
pcs.host Local host Specify the name of the host on which to run the utility.
pcs.port Port used by Lombardi server on local host Specify the port used by the Lombardi server on the specified host.
pcs.username tw_admin 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.
pcs.encrypted tw_admin (encrypted password) The encrypted password for the specified user. See Encrypting passwords in Lombardi installation guides for instructions.

You can specify the following options at the command-line when running the retrieveProcessAppPackage.cmd (.sh) and installProcessAppPackage.cmd (.sh) utilities:

Option Description Default

-h [host], --host [host] The host on which to run the offline installation utility. Set in the process-installer.properties file.
-t [port], --port [port] The port used by the Lombardi server on the specified host. Set in the process-installer.properties file.
-u [username], --username [username] The user account to run the offline installation utility.
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.
Set in the process-installer.properties file.
-p [password], --password [password] The password for running the offline installation utility. Set in the process-installer.properties file.
--branch [branch_name] The name of the workspace in which the snapshot to be installed resides. No default exists.
-?, --help Displays these command-line options and a description for each option. No default exists.

Performing offline installation steps separately

To perform each step of process application installation separately, you can run the following commands individually or add them to a batch file or script, which enables you to perform customization tasks between installation steps. These commands are located in the [Lombardi_home]/tools/process-installer directory.
For each of the following commands, you must specify the name of the installation package. For example:
importProcessAppPackage.cmd [install_package_name]
Where [install_package_name] is the name that was assigned to the installation package using retrieveProcessAppPackage.cmd

Command Description

importProcessAppPackage.cmd (.sh) Imports the installation package (zip file) so that all library items within it are available for customization or alteration via custom scripts or the process application's installation service.
customProcessAppPreInstall.cmd (.sh) Runs any commands that you add. You should add commands that you want to run immediately before the process application snapshot is installed on the offline Process Server as instructed in Create a custom script.
executeProcessAppInstallationService.cmd (.sh) Runs the installation service for each referenced toolkit and then runs the installation service for the process application.
migrateProcessAppGlobalData.cmd (.sh) Migrates data such as participant groups, EPVs, and environment variables to the new snapshot version that you are installing. The Process Server migrates data according to the rules outlined in Data migration rules.
migrateProcessAppInstances.cmd (.sh) Migrates currently running process instances according to the migration option chosen when the installation package was created. Migrate instances describes the migration options. If other snapshot versions are not discovered, migration does not occur.

Parent topic: Releasing and installing processes

+
Search Tips | Advanced Search

Method	See...
Create a custom script to use with the installProcessAppPackage.cmd (.sh)	Create a custom script
Override the default settings for retrieveProcessAppPackage.cmd (.sh) and installProcessAppPackage.cmd (.sh) at the command prompt or using the process-installer.properties file	Overriding default offline install settings
Perform each step of the installation separately, allowing for more robust customization between steps	Performing offline installation steps separately

Set	Default	Description
pcs.host	Local host	Specify the name of the host on which to run the utility.
pcs.port	Port used by Lombardi server on local host	Specify the port used by the Lombardi server on the specified host.
pcs.username	tw_admin	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.
pcs.encrypted	tw_admin (encrypted password)	The encrypted password for the specified user. See Encrypting passwords in Lombardi installation guides for instructions.

Option	Description	Default
-h [host], --host [host]	The host on which to run the offline installation utility.	Set in the process-installer.properties file.
-t [port], --port [port]	The port used by the Lombardi server on the specified host.	Set in the process-installer.properties file.
-u [username], --username [username]	The user account to run the offline installation utility. 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.	Set in the process-installer.properties file.
-p [password], --password [password]	The password for running the offline installation utility.	Set in the process-installer.properties file.
--branch [branch_name]	The name of the workspace in which the snapshot to be installed resides.	No default exists.
-?, --help	Displays these command-line options and a description for each option.	No default exists.

Command	Description
importProcessAppPackage.cmd (.sh)	Imports the installation package (zip file) so that all library items within it are available for customization or alteration via custom scripts or the process application's installation service.
customProcessAppPreInstall.cmd (.sh)	Runs any commands that you add. You should add commands that you want to run immediately before the process application snapshot is installed on the offline Process Server as instructed in Create a custom script.
executeProcessAppInstallationService.cmd (.sh)	Runs the installation service for each referenced toolkit and then runs the installation service for the process application.
migrateProcessAppGlobalData.cmd (.sh)	Migrates data such as participant groups, EPVs, and environment variables to the new snapshot version that you are installing. The Process Server migrates data according to the rules outlined in Data migration rules.
migrateProcessAppInstances.cmd (.sh)	Migrates currently running process instances according to the migration option chosen when the installation package was created. Migrate instances describes the migration options. If other snapshot versions are not discovered, migration does not occur.