Plug-in Documentation

IBM Business Process Manager (WebSphere BPM)

Overview

Overview

The IBM Business Process Manager source configuration plug-in imports Process Application snapshots as component versions.

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 6

  • Fixes APAR PH08149: MultipleCompilationErrorsException: The current scope already contains a variable of the name props.
  • Fixes MissingPropertyException: No such property: Colections for class: import

Version 3

  • Fixes APAR PI98195 Adds activeSince parameter to Snapshot object.

Version 2

  • Updated Version name to match the names in WebSphere BPM and avoid conflicts between branches.
  • Added Track property. If left blank, all snapshots in each track/branch will be imported.
  • Updated Snapshot artifact name from export.zip to export.twx.

Version 1

Initial release of the IBM WebSphere BPM source configuration plug-in.

Usage

Summary

The IBM WebSphere BPM source configuration plug-in for IBM UrbanCode Deploy creates component versions from Process Application snapshots originating from the Process Center. The component versions are made up of a single file called export.twx that contains the snapshots .twx file. This file is directly used in the IBM WebSphere BPM automation plug-in. Manual import and export of the Process Application snapshots artifact can be found on IBM WebSphere BPMs knowledge center. Specifically, this plug-in creates a file identical to the BPMExport command. Therefore, it should be used in conjunction with the BPMImport command or the Import Process Application plug-in step in a component process.

In general, we suggest using a continuous integration or build tool to push artifacts from the main tool, such as IBM WebSphere BPM, into IBM UrbanCode Deploy. However, in some scenarios this approach is cumbersome and can cause significant headache. In those instance, you use its associated source configuration plug-in to import artifacts easily. In this source configuration model, you must abide by the architecture requirement of mapping one Process Application to one IBM UrbanCode Deploy component. There are ways to get around this requirement, however, additional scripting or personalized processes will be required.

Agent Model

The IBM WebSphere BPM source configuration plug-in utilizes the REST API. This allows the IBM UrbanCode Deploy agent to be placed anywhere with network access to the Process Center that contains your Process Application snapshots. However, any agent located on the BPM server will be required to perform deployments as the automation plug-in uses the wsadmin command line interface.

Sample Configuration

This source configuration plug-ins base configuration contains five properties.

  • WebSphere BPM URL (required): This is the base IBM WebSphere BPM Process Center server URL. All REST API endpoints are constructed from the specified URL. Example: https://ibmbpm:9443
  • Process Application (required): The name or acronym of the Process Application that contains the snapshots to import.
  • Track: The Track, or Branch, name from where to retrieve Snapshots. If empty, Snapshots from all tracks will be imported.
  • Username: The username to authenticate with IBM WebSphere BPM.
  • Password : The password to authenticate with IBM WebSphere BPM.
  • Trust All Certificates: Select to accept all SSL certificates when authenticating with the IBM WebSphere BPM. If you receive a SSLHandshakeException error, selecting this check box is a temporary solution to get around the issue.

There is also one optional property on manual import.

  • Snapshot Name: Specify a single Snapshot name or acronym to import.

Sample configuration IBM WebSphere BPM source config plug-in

Many of these properties are pulled directly from the Process Application snapshots page. The picture below illustrates where to find the the URL, Process Application and snapshots names in a browser.

Sample Application Process snapshots page

If the above list of screenshots was imported successfully, the components versions tab may look like the below screenshot. Regardless of the snapshot value specified for the manual import, the versions name will be the Snapshots name and its acronym in parenthesis. Note in the below screenshot that two versions may first look like duplicates. However, they are actually from two different tracks, hence the different acronyms.

Sample Component Version tab

Component Version Properties

In the IBM WebSphere BPM automation plug-in, many steps require a combination of three values: Process Application, Snapshot, and Track names. In an attempt to make process creation easier, these three component version properties are assigned to each version on creation. However, security changes were made to IBM UrbanCode Deploy to minimize unwarranted property creation. Therefore, to take full advantage of the source configuration plug-in, create the following three Version Property Definitions under the components Configuration tab.

  • procAppAcronym
  • snapshotAcronym
  • trackAcronym

On configuration, the tab should resemble the below screenshot:

Sample Version Property Definitions

The error explained above will manifest itself in the standard output logs as the outlined string:

Settings

Process properties in the WebSphere BPM plug-in

IBM WebSphere BPM Component Properties

Properties for the IBM WebSphere BPM Component Properties role
Name Type Description
Password Password Password to authenticate with the WebSphere BPM server.
Process Application String Name or acronym of the Process Application to import.
Trust All Certificates Boolean Select to trust all unsecure certificates.
Track String The Track, or Branch, name from where to retrieve Snapshots. If empty, Snapshots from all tracks will be imported.
Username String Username to authenticate with the WebSphere BPM server.
WebSphere BPM URL String Base URL for the WebSphere BPM server.

IBM WebSphere BPM Import Properties

Properties for the IBM WebSphere BPM Import Properties role
Name Type Description
Snapshot Name String Specify a Snapshots name or acronym to import.