Plug-in Documentation

IBM Business Process Manager (WebSphere BPM) for IBM UrbanCode Deploy

Overview

Overview

The IBM Business Process Manager plug-in includes steps that take the following actions on Business Process Manager cells:

  • Deploy process application snapshots to an online (connected) Process Server.
  • Deploy process application snapshots to an offline (disconnected) Process Server.
  • Import and Export process applications to and from a Process Center.

Process service modules that are EAR files can also be deployed to a Process Server by using the WebSphere Application Server Deployment plug-in for IBM UrbanCode Deploy.

This plug-in provides the following steps that automate deployment of process applications:

  • Deploy process application snapshot.
  • Generate offline package.
  • Deploy offline package.
  • Export a process application from a Process Center and import it into another Process Center.

The following steps are an overview of the typical process to follow:

  1. Create resources. For the deployment of process application snapshots to an online or offline process server, you must populate resources manually. You can view the resources that you create in the Resources view. Each resource corresponds either to the Process Center or to an offline Process Server.
  2. Define properties for the resources that you created manually.
  3. Define components, applications, and environments to automate deployment.
  4. Deploy.

Compatibility

This plug-in requires version 6.0.1 of IBM UrbanCode Deploy.

The IBM UrbanCode Deploy plug-in for WebSphere Business Process Manager supports Business Process Manager versions 8.5 and later. Standard and Advanced editions are supported.

The steps in this plug-in run on any agents that the IBM UrbanCode Deploy server supports.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

History

Version 13

Fixes APAR PH08137: Exception WASX8009E Invalid Parameter with BPM Deploy Process Application Snapshot step with spaces in Process Server Name

Version 12

Warn the user when either conflicting credential properties or no credential properties are set. General refactoring.

Version 11

  • Updated all descriptions to specify whether the step connects to a Process Server or Process Center server.
  • All step descriptions have the BPM command they are utilizing. If you are having trouble, we recommend referencing the WebSphere BPM documentation for CLI specific help. Many questions can be answered by following WebSphere BPMs official CLI documentation.
  • Most steps will connect to and run against the Process Center server. However, we recommend that there is at least one agent is installed on every Process Server and Process Center server. By running against the agent located on the correct server, this will eliminate the need to specify each steps Host property. This is achievable through proper UrbanCode Deploy environment and resource management.
  • The Update Installation Information steps Process application track property is now optional for Process Center servers. It is still required for Process Servers.

Version 10

All step descriptions now include their wsadmin scriptings commands.

Version 9

Fixes APAR PI78360 Updated acronym parsing and identification.

Version 8

Support encrypted properties.

Version 7

Added timeout to Generate Offline Package to prevent BPM command line race conditions.
The Track, Container, and Snapshot acronym finder will return the entered value if not found.

Version 6

Version 6 adds a verbose mode to display additional troubleshooting output.
Updated finder for identifying the track, snapshot, or container acronym from its full name.

Version 5

Version 5 adds functionality for the following BPM functions:

  • BPMDeactivate
  • BPMExportInstallPackage
  • BPMExtractMigrationPolicy
  • BPMInstallPackage
  • BPMMigrateInstances
  • BPMSetDefaultSnapshot
  • BPMStop
  • BPMSyncEnvironmentVariables
  • BPMSyncEPVValues
  • BPMSyncTeamBindings
  • BPMUpdateInstallationInformation

Minor fixes to Deploy Offline Package and Deploy Process Application Snapshot steps.

Version 4

Version 4 adds functionality to pass the host name to the wsadmin script for all process steps.

Usage

Deploying to an offline Process Server

  1. To deploy a process application snapshot to an offline Process Server, create a resource that represents the Process Center, and then define the following properties for the resource:
    • profile.root.directory: The profile root directory of the managed node running the Process Center application. For example, /opt/IBM/BPM/profiles/processCenterNode01.
    • websphere.user: The WebSphere Application Server administrator user.
    • websphere.password: The WebSphere Application Server administrator password.
    • websphere.connType: The connection protocol for WebSphere Application Server. The connection protocol is SOAP, RMI, or NONE.
    • websphere.port: The port to use with the specified connection type for communication with the application server that is running the Process Center application.
    • offline.server.name: The name of the offline Process Server, which is set in the Process Center console.
  2. Add the agent that is installed on the system that hosts the Process Center to the resource group.
    • Hover over the row for the resource group, click Actions, and then select Add agent.
  3. Create a resource that represents the Process Center, and then define the following properties for the resource:
    • profile.root.directory: The profile root directory of the managed node that runs the Process Center application. For example, /opt/IBM/BPM/profiles/processCenterNode01.
    • websphere.user: The WebSphere Application Server administrator user.
    • websphere.password: The WebSphere Application Server administrator password.
    • websphere.connType: The connection protocol for WebSphere Application Server. The connection protocol is SOAP, RMI, or NONE.
    • websphere.port: The port to use with the specified connection type for communication with the application server that runs the Process Center application.
  4. Add the agent that is installed on the system that hosts the Process Center to the resource group.
    • Hover over the row for the resource group, click Actions, and then select Add agent.
  5. Create components for the resources. Create a component for each resource to deploy. In this case, create two components, one for the Process Center resource and one for the Process Server resource.
  6. Create the deployment process for each component. The Process Center component process must be of the Operational (without version) type. The Process Server component process must be of the Deployment type.
  7. Include the Generate offline package step from this plug-in and the Create Version step from the IBM UrbanCode Deploy Versions plug-in in the Process Center component process. The Create Version step uploads the generated offline process package as a new version to the component created for the Process Server.
  8. Include the Deploy offline package step from this plug-in in the Process Server component process.
  9. Add the components to the resources.
    • Navigate to the resource.
    • Click Actions > Add Component
    • Select the component to use.
  10. Create an application.
    • Navigate to the Applications page.
    • Click Create New Application. You can also use an existing application that is
      attached to the cell to manage.
    • Enter an application name, and then click Save.
    • Click the Components tab, and then add the component that you created in step 5.
  11. Create an application environment.
    • On the Resources page, click Create New Environment.
    • Enter an environment name, and then click Save.
    • Navigate to the environment editor.
    • Click on the environment name, and then click Add Base Resource. Select the group for your Process Center environment.
  12. Create an application process of the deployment type.
    • Click the Processes tab.
    • Add a deployment step.
    • Drag and drop the Install Component step onto the process editor.
      • Select the component that you created for the resource. For example, the component to contain the process application to be deployed.
      • Select the process for the component. For example, select Online snapshot deployment process.
    • Click Save.
  13. Run the process to test the new component.

Deploying to an online Process Server

  1. To deploy a process application snapshot to an online Process Server, create a resource that represents the Process Center, and then define the following properties for the resource:
    • profile.root.directory: The profile root directory of the managed node that runs the Process Center application. For example, /opt/IBM/BPM/profiles/processCenterNode01.
    • websphere.user: The WebSphere Application Server administrator user.
    • websphere.password: The WebSphere Application Server administrator password.
    • websphere.connType: The connection protocol for WebSphere Application Server. The connection protocol is SOAP, RMI, or NONE.
    • websphere.port: The port to use with the specified connection type for the application server that runs the Process Center application.
  2. Add the agent that is installed on the system that hosts the Process Center to the resource group.
    • Hover over the row for the resource group, and then click Actions > Add agent.
  3. Create components for the resources. Create a component for each resource to deploy. The component processes must be of the Deployment type and must include the Deploy process application snapshot plug-in step.
  4. Add the components to the resources.
    • Navigate to the resource.
    • Click Actions > Add Component.
    • Select the component.
  5. Create the application.
    • Navigate to the Applications page.
    • Click Create New Application. You can also use an existing application that is
      attached to the cell to manage.
    • Enter an application name, and then click Save.
    • Click the Components tab, then add the component that you created in step 3.
  6. Create an application environment.
    • On the Resources page, click Create New Environment.
    • Enter an environment name, and then click Save.
    • Navigate to the environment editor.
    • Click the environment name, and then click Add Base Resource. Choose the group for your Process Center environment.
  7. Create an application process of the Deployment type.
    • Click the Processes tab.
    • Add a deployment step.
    • Drag and drop the Install Component step onto the process editor.
      • Select the component that you created for the resource. For example, select a component to contain the process application to deploy.
      • Choose the process for the component. For example, choose Online snapshot deployment process.
    • Click Save.
  8. Run the process to test the new component.

Steps

Process steps in the WebSphere BPM plug-in

Create Generic Install Package

Creates a generic installation package for a process application or toolkit snapshot
that is not targeted to a specific Process Server. (BPMExportInstallPackage)

Input properties for the Create Generic Install Package step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Package Zip String The name of the .zip file that contains the exported process application package.
If blank, the process application acronym is used. This file is saved to the working
directory and overwrites any existing files with the same name.
No
Process application String The process application name or acronym. Yes
Process application snapshot String The process application snapshot name or acronym. Yes
Process application track String The process application track name or acronym. Yes
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Deactivate Snapshot

Deactivates an activate snapshot. (BPMDeactivate)

Input properties for the Deactivate Snapshot step
Name Type Description Required
Force default snapshot Boolean Select to deactivate the default snapshot of the process application or toolkit. If
cleared, default snapshots are not deactivated.
No
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Log File String The name of the log file for message output from running the command. Default log
messages are written to the SystemOut.log
file. The current date and time are appended to prevent overwriting existing
log files. The log file is saved to the working directory.
No
Process application String The process application name or acronym. Yes
Process application snapshot String The process application snapshot name or acronym. Yes
Process application track String The process application track name or acronym. No
Suspend all BPD instances Boolean Immediately suspend all instances associated with the given context.
The instances remain suspended until you resume them. Not supported when Tip is
used for the snapshot acronym.
No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Deploy Offline Package

Deploys the process application snapshot package to an offline Process Server. (BPMInstallOfflinePackage
and BPMSetDefaultSnapshot)

Input properties for the Deploy Offline Package step
Name Type Description Required
Host Name String Host name of the Process Server to connect to. For example: localhost No
Make this snapshot the default Boolean Select to set this snapshot as the default snapshot. No
Process application String The process application name or acronym if this snapshot is set as the default. If
blank, the component name is used.
No
Process application package String The name of the .zip file that contains the process application snapshot package.
By default, the offline.server.name resource property is used. Including the .zip
file extension in the name is optional.
No
Process application snapshot String The process application snapshot name or acronym if this snapshot is set as the default. No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Deploy Process Application Snapshot

Deploys the process application snapshot to an online Process Server. (BPMInstall)

Input properties for the Deploy Process Application Snapshot step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Process application String The process application name or acronym. If blank, the component name is used. No
Process application snapshot String The process application snapshot name or acronym. No
Process application track String The process application track name or acronym. No
Process server name String A list, separated by commas, of names of online Process Servers on which to deploy
the snapshot.
Yes
Skip all governance processes Boolean If selected, the process application snapshot deployment skips all governance processes,
including the approval processes defined by the administrator. Not supported for WebSphere
Business Process Manager earlier than version 8.5.
No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Export Process Application

Exports a process application from a Process Center server. (BPMExport)

Input properties for the Export Process Application step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Package String The name of the .twx file that contains the exported process application. If blank,
the process application acronym is used. Including the .twx file extension in the
name is optional.
No
Process application String The process application name or acronym. If blank, the component name is used. No
Process application snapshot String The process application snapshot name or acronym. No
Process application track String The process application track name or acronym. No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Extract Migration Policy

Extracts the migration policy from Process Center. Use this step to extract the
information used to migrate instances from other snapshots to the newly installed
snapshot. (BPMExtractMigrationPolicy)

Input properties for the Extract Migration Policy step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Migration Policy XML String The name of the file to create. The file will contain the information used to migrate
instances from the
source snapshot to the target snapshot. The file name must be unique and must have
the .xml extension.
This file overwrites any file with the same name in the working directory. If blank,
the component name is used.
No
Process application String The process application name or acronym. Yes
Source process application snapshot String The source process application snapshot name or acronym. Yes
Target process application snapshot String The source process application snapshot name or acronym. Yes
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Generate Offline Package

Creates a .zip file on Process Center that contains a process application snapshot
package. (BPMCreateOfflinePackage and BPMExtractOfflinePackage)

Input properties for the Generate Offline Package step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Process application String The process application name or acronym. If blank, the component name is used. No
Process application snapshot String The process application snapshot name or acronym. No
Process application track String The process application track name or acronym. No
Process server name String A list, separated by commas, of offline Process Servers to create a process application
snapshot package for.
Yes
Skip all governance processes Boolean If selected, the process application snapshot deployment skips all governance processes,
including the approval processes defined by the administrator. Not supported for WebSphere
Business Process Manager earlier than version 8.5.
No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Import Process Application

Imports a process application into a Process Center server. (BPMImport)

Input properties for the Import Process Application step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Process application package String The name of the .twx file that contains the process application package. If blank,
the component name is used. Including the .twx file extension in the name is optional.
No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Install Process Application Snapshot

Installs a process application snapshot from Process Center to a Process Server. (BPMInstallPackage)

Input properties for the Install Process Application Snapshot step
Name Type Description Required
Host Name String Host name of the Process Server to connect to. For example: localhost No
Install Package String The path of the offline installation package that you created and extracted on
the Process Center server and have already placed on the offline Process Servers
file system. Specify an absolute path or a file in the working directory.
Yes
Show Snapshot Info Boolean If selected, the command returns the acronyms of the process application, track, and
snapshot that were installed.
No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Migrate Instances

Migrates all instances on all nodes in the network deployment environment.
Equivalent to clicking Migrate Inflight Data in the Process Admin Console. (BPMMigrateInstances)

Input properties for the Migrate Instances step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Orphan Token Policy File String Optional: The name of a policy file to use during instance migration. The policy file
is distributed to all the nodes in the same network deployment environment before
instance migration.
The policy file must be in XML format.
No
Process application String The process application name or acronym. Yes
Source process application snapshot String The source process application snapshot name or acronym. Yes
Target process application snapshot String The target process application track name or acronym. Yes
Use Network Available Policy File Enumeration:

  • 0
  • false
  • true
Optional: Select TRUE if the policy file is larger than 100 KB. Save the policy file
in a path that is accessible to all nodes.
No
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Set Default Snapshot

Designates a default snapshot on the Process Center or the Process Server. (BPMSetDefaultSnapshot)

Input properties for the Set Default Snapshot step
Name Type Description Required
Host Name String Host name of the Process Server to connect to. For example: localhost No
Process application String The process application name or acronym. Yes
Process application snapshot String The process application snapshot name or acronym. Yes
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Stop Snapshot

Stops a deactivated snapshot on a Process Server. (BPMStop)

Input properties for the Stop Snapshot step
Name Type Description Required
Host Name String Host name of the Process Server to connect to. For example: localhost No
Process application String The process application name or acronym. Yes
Process application snapshot String The process application snapshot name or acronym. Yes
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Sync Values, Variables, and Team Bindings

Synchronize team bindings, environment variables, and exposed process values between
a source and target snapshot. (BPMSyncEnvironmentVariables, BPMSyncEPVValues, and
BPMSyncTeamBindings)
Do not run this step using the deployment manager profile.

Input properties for the Sync Values, Variables, and Team Bindings step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Process application String The process application name or acronym. Yes
Source process application snapshot String The source process application snapshot name or acronym. Yes
Sync EPV Values Boolean Select to copy exposed process values from the source snapshot to the target snapshot. No
Sync Environment Variables Boolean Select to copy environment variables from the source snapshot to the target snapshot. No
Sync Team Bindings Boolean Select to copy teams from the source snapshot to the target snapshot. No
Target process application snapshot String The target process application track name or acronym. Yes
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No

Update Installation Information

Associates an installation package with a specific server, to enable installing the
snapshot installation on the server. (BPMUpdateInstallationInformation)

Input properties for the Update Installation Information step
Name Type Description Required
Host Name String Host name of the Process Center server to connect to. For example: localhost No
Process application String The process application name or acronym. Yes
Process application snapshot String The process application snapshot name or acronym. Yes
Process application track String The process application track name or acronym. Required if updating a
Process Server and optional for a Process Center server. The Default track
will be selected for the Process Center server.
No
Server Name String The Process Server or Process Center server to associate with the process application
or toolkit snapshot and track.
Yes
Use soap.client.props file Boolean Select to use the soap.client.props file for the WebSphere Application Server administrator
credentials.
No