Build it yourself

A project has been prepared, which served as the basis to build this sample. The project already contains the code implementing the plugin and the required packaging information. To import the prepared project interchange file, perform the following steps:

1. Download the PPPluginV2Sample.zip file, and save it to a temporary directory.
2. In WebSphere Integration Developer, click File > Import. The Import window opens.



3. Select Other > Project Interchange.
4. Click Next. The Import Project Interchange Contents window opens.



5. Click Browse next to the From zip file field.
6. Browse to the temporary directory and select the zip file you downloaded in step 1.
7. Click Open.
8. Select your workspace directory as your Project location root.
9. Click Select All.
10. Click Finish.
11. Wait until the automatic build process has finished.

You can use a Java project for implementing the plugin. Also, you can use any desired Java package structure. In the provided sample, all classes are defined under the same package 'sample'.

You need to provide a class implementing the pre-defined com.ibm.task.spi.StaffQueryResultPostProcessorPlugin2 interface. In order to have the class definition available in the project Java build path, you need to include the file <wps-root>/ProcessChoreographer/client/taskapi.jar, where <wps-root> denotes the root directory of your WebSphere Process Server installation. The same jar serves to provide definitions of required Human Task Manager API objects such as Task, TaskTemplate, etc.

Note that other plugin implementations may require additional libraries to be included into the build path. In case your sample needs access to Business Flow Manager API objects, you need to include the file <wps-root>/ProcessChoreographer/client/bpeapi.jar. In case, your plugin contains code accessing the Human Task Manager or Business Flow Manager EJB API methods, you need to include additional J2EE classes, as contained for instance in the file <wps-root>/plugins/javax.j2ee.ejb.jar .

For packaging, a logical name of the plugin has to be defined. Using this name, a configuration file has to be provided in the META-INF/services directory of the project. In this file, in the first non-comment line, the name of the class implementing the StaffQueryResultPostProcessorPlugin2 interface is expected.

In the provided sample, the following applies:

• the logical name of the plugin is: PPPluginV2
• the name of the configuration file in META-INF/services is: com.ibm.task.spi.PPPluginV2StaffQueryResultPostProcessorPlugin
• the name of the plugin implementation class is: sample.SubstitutionPlugin

The project has to be exported as a jar file containing the Java classes and the configuration file.

1. In WebSphere Integration Developer, right-click on the project PPPluginV2Sample > Export. The Export window opens.
2. Select Java > JAR file, the JAR File Specification window opens.



3. Select the project PPPluginV2Sample.
4. Select the export destination as desired
5. Click Next, the JAR Packaging Options window opens.



6. Unselect the option 'Export class files with compile errors'
7. Click Finish

You can download the pre-packaged PPPluginV2.jar file to see the expected packaging.

In order to be available for Human Task Manager, the jar file should be placed in the <wps-root>/lib or <wps-root>/lib/ext directory.

For registering, the standard WebSphere Application Server defined approach applies:

1. In a browser, open the administrative console.
   The default URL is
2. Select the submenu Environment > Shared libraries, the Shared Libraries window opens



3. Select the scope for which the library should be provided.
   The same scope or a higher scope should be selected as the one used for deploying the TaskContainer application. For instance, if TaskContainer has been deployed to a cluster, the plugin library should be registered for that cluster or the entire cell. This avoids having to register the shared library for each server individually.
4. Click New, the New library window opens
5. Specify the name of the shared library, for instance: SharedLibrary4PPPluginV2
6. Specify the classpath to the plugin jar file, for instance: C:/wrap70/w/p/lib/ext/PPPluginV2.jar



7. Click OK
8. Click Save

For a WPS installation, only one Post Processor Plugin can be made available. Moreover, the shared library representing the plugin has to be linked with the TaskContainer application. Again, the standard WebSphere Application Server defined approach applies:

1. Log in to the Admin Console of WebSphere Application server
2. Select the submenu Applications > WebSphere Enterprise Applications, the Enterprise Applications window opens
3. Select the TaskContainer_... application, the window showing application details opens



4. Select Shared library references, the Shared Library References window opens



5. Select theTaskContainer_... application
6. Click Reference shared libraries, the Shared library mapping window opens



7. Select the plugin shared library (e.g. SharedLibrary4PPPluginV2) and move it to the list of selected shared libraries
8. Click OK, in the Shared Library references window, you should see the new association
9. Click OK
10. Click Save

The following steps need to be applied:

1. Log in to the Admin Console of WebSphere Application server
2. Select the submenu Servers > WebSphere application servers, the Application servers window opens



3. Select your server or cluster, e.g. server1, the corresponding window opens



4. Select submenu Business Integration > Business Process Choreographer > Human Task Manager, the Human Task Configuration page opens



5. Select submenu custom properties, the Custom properties page opens



6. Click Staff.PostProcessorPlugin, the window for setting the value opens.
7. Specify the logical plugin name used at the plugin packaging time, e.g.: PPPluginV2
8. Click OK
9. Click Save
10. Restart the server to make (this and all above) changes effective

Note that the setting Staff.PostProcessorPlugin.EnableResultSharing has to be associated with the default value 'false', when implementing a plugin according to the StaffQueryResultPostProcessorPlugin2 interface.