zpmt.sh script
The zpmt.sh script uses the customization parameters that you define in a response file to create batch jobs and data files for customizing IBM BPM for z/OS .
You can also use the zpmt.sh script to create batch jobs and data files for customizing WebSphere Application Server for z/OS profiles.
The script is located in the smpe_root/bin and WAS_HOME/bin directories in your z/OS system, where:
- smpe_root represents the root directory for the WebSphere Application Server for z/OS product code.
- WAS_HOME represents the home location of the configuration directories for each node in the configuration file system.
You can run the zpmt.sh script from UNIX System Services.
Syntax
zpmt.sh -responseFile response_file | -profilePath profile_dir -workspace eclipse_workspace_dir -transfer -allocate -replace -installExtension stacked_product_or_feature_pack_INSTALL_ROOT -listExtensions -uninstallExtension -version
Parameters
- -responseFile
- Specifies the fully qualified path to the response file that defines the customization parameters for a stand-alone server, dmgr, or managed node profile. For information about how to create a response file, see Create a response file for the zpmt.sh script.
- -profilePath
- Specifies the fully qualified path to an existing set of generated jobs.
This parameter cannot be used with the -responsefile parameter.
- -workspace
- Specifies the Eclipse workspace directory where zpmt.sh stores metadata, customization definitions, and other configuration artifacts that it generates.
- -transfer
- Copies generated JCL jobs and data files from the UNIX System Services file system to a pair of target partitioned data sets. (The zpmt.sh script first writes the customized JCL jobs and data files to the UNIX System Services file system.) Any existing files of the same name are overwritten when the files are copied to these data sets.
The data sets are named by appending the values .CNTL and .DATA to the zTargetHLQ value, which defines the high-level qualifier within the response file for the profile being customized.
- -allocate
- Attempts to allocate the target data sets. This operation fails if the target CNTL and DATA data sets already exist.
The -transfer parameter is required when -allocate is specified.
- -replace
- Indicates that if a set of jobs currently exists in the location specified by the profilePath variable in the response file, these jobs are to be overwritten. Use this parameter if you want to update your definition and regenerate jobs without having to change your profilePath value or delete the old set of jobs. Both the -workspace and -responseFile parameters are required when -replace is specified. You can optionally specify -transfer and, if the CNTL and DATA data sets do not already exist, -allocate.
- -installExtension
- Installs a feature-pack or stacked-product extension. You must include the fully qualified path of the SMP/E installation root for the stacked product or feature pack.
This parameter extracts the contents of the WebSphere Configuration Tool archive file, which is contained in the specified installation file system, and installs the contents into the Eclipse workspace directory defined with the -workspace parameter.
The first time that you run the zpmt.sh script, install the feature-pack or stacked-product extension for the command. Once added, the support for the feature pack or stacked product remains for subsequent zpmt.sh invocations until the -uninstallExtension parameter is used to remove the extension from the zpmt.sh configuration. There is also a -listExtensions parameter for listing the configured extensions.
- -listExtensions
- Lists the extensions that are currently installed in the specified Eclipse workspace directory.
- -uninstallExtension
- Removes the specified extension from the specified Eclipse workspace directory.
- -version
- Specifies the version number of the extension to uninstall.
Use this parameter to uninstall a specific version of an extension.
Tip: The -installExtension parameter is not relevant for use with IBM BPM for z/OS because the IBM BPM for z/OS extension is provided in the WebSphere Application Server for z/OS file system. If you have used -installExtension to install other feature-pack or stacked-product extensions (for example, the WebSphere Extended Deployment Compute Grid extension), you can use the -listExtensions, -uninstallExtension, and -version parameters to list or remove these extensions.
Examples
The following examples show how to run the zpmt.sh script with various combinations of the available command-line parameters. In these examples, / xxx can be any directory to which a user running zpmt.sh has read and write access.
- zpmt.sh -workspace / xxx -transfer -allocate -responseFile / xxx/ZCellcmd.responseFile
This command performs the following actions:
- Generates the customization jobs in the UNIX System Services location specified by the profilePath variable in the response file
- Allocates the target CNTL and DATA data sets using the high-level qualifier specified by the zTargetHLQ variable in the response file
- Transfers the jobs from the UNIX System Services file system to the CNTL and DATA data sets
- zpmt.sh -workspace / xxx -responseFile / xxx/ZAppSrvcmd.responseFile
This command generates the customization jobs in the UNIX System Services location specified by the profilePath variable in the response file.
- zpmt.sh -workspace / xxx -allocate -transfer -profilePath / xxx/ZAppSrvcmd
This command performs the following actions:
- Allocates the target CNTL and DATA data sets using the high-level qualifier specified by the zTargetHLQ variable in the response file (that was used to generate a set of existing jobs)
- Transfers the existing jobs from the location specified by -profilePath to those data sets
This usage assumes that the jobs have already been generated during a previous invocation of zpmt.sh.
- zpmt.sh -workspace / xxx -transfer -responseFile / xxx/ZDmgrcmd.responseFile
This command transfers the generated jobs from the location specified by the profilePath variable in the response file to the generated CNTL and DATA data sets.
This usage assumes that the jobs have already been generated during a previous invocation of zpmt.sh, and that the target CNTL and DATA data sets have already been allocated.
- zpmt.sh -workspace eclipse_workspace_dir -responseFile response_file -allocate -transfer -replace -installExtension stacked_product_or_feature_pack_INSTALL_ROOT
This command performs the following actions:
- Installs the extension from the specified stack-product or feature-pack installation image
- Generates the customization jobs in the location specified by the profilePath variable in the response file, and replaces any existing customization jobs in this location
- Allocates the target CNTL and DATA data sets using the high-level qualifier specified by the zTargetHLQ variable in the response file
- Transfers the generated jobs from the UNIX System Services file system to the CNTL and DATA data sets
- zpmt.sh -workspace eclipse_workspace_dir -listExtensions
This command generates a list of the extensions that are currently installed in the specified Eclipse workspace directory.
- zpmt.sh -workspace eclipse_workspace_dir -uninstallExtension extension_name -version extension_version
This command removes the specified version of the specified extension from the specified Eclipse workspace directory.