Unified Task List Developer Pack 

Unified Task List Developer Pack

About the Developer Pack

The Developer Package is provided to allow you to get started with the Unified Task List Portlet and the Business Process Support builders included with this Portlet. Inside the Developer Pack you will find an end to end sample for business process transactions in WebSphere Portal Server using WebSphere Process Server as the business process engine. There are also sample WebSphere Portlet Factory models provided to show how to quickly and easily create human task processing Portlets for WebSphere Portal Server using Portlet Factory builders included in the Unified Task List catalog bundle.

Developer Pack Prerequisites

Runtime:
WebSphere Process Server 7.0.0.3
WebSphere Portal Server 7.0
The Unified Task List Portlet for WebSphere Portal Server
Download link:
https://greenhouse.lotus.com/plugins/plugincatalog.nsf/assetDetails.xsp?action=editDocument&documentId=B83A591CD238D9AA85257706006AE752
Documentation:
http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Unified_Task_List


Development:
WebSphere Integration Developer 6.1,6.2,7.0 (this is only required if you are using your own business processes for WebSphere Process Server.)
WebSphere Portlet Factory 7.0.0.1 (this is required if you plan on developing new task processing Portlets for custom business processes.)
The Unified Task List Portlet for WebSphere Portal Server
Download link:
https://greenhouse.lotus.com/plugins/plugincatalog.nsf/assetDetails.xsp?action=editDocument&documentId=B83A591CD238D9AA85257706006AE752
Documentation:
http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Unified_Task_List

Verifying the Developer Pack Contents

About this task

After downloading the Unified Task List Developer Pack you should verify that it contains the following files.

WebspherePortletFactoryArchiveGeneratorUpdateSite
A plugin for WebSphere Integration Developer which can be used to export Business Process meta-data for use with the Human Task Processing Action builder to create task processing Portlets.

HRSupport.ear
A support application for the sample HR business process for WebSphere Process Server. This must be installed before the HRMod.ear application file.

HRMod.ear
The HR sample business process for WebSphere Process Server.

PA_SamplePortlets.war
This is a sample war file generated in WebSphere Portlet Factory which contains two task processing Portlets for the sample HR business process. It also contains a sample Portlet for initiating the approve standard application human task in the HR business process.

SamplePortletsWPF.zip
This Portlet Factory archive includes the required wsdl files for each Human Task in the HR business process and the Portlet Factory models used to create the sample task processing Portlets. There is also a wsdl file and a Portlet for starting an instance of the HR business process Human Task.

license.zip
This archive contains the licence files for the Unified Task List Developer Package.

Retrieving the HTM SOAP endpoint from your WebSphere Process Server

About this task

The following instructions show you how to retrieve the HTM SOAP endpoint from your Process Server. The HTM SOAP endpoint is required in the default_wps_server.properties file found in the WebContent/config/wps_config directory of the sample Portlet Factory project.

Retrieving the HTM SOAP endpoint from your WebSphere Process Server

1. Open your Process Server Administrative Console, e.g. https://:/ibm/console/logon.jsp
2. Select Applications - Applications Types - WebSphere enterprise applications.
3. From the list of enterprise applications select the one named TaskContainer__
4. On the Configuration tab in the Web Services Properties section select Publish WSDL files.
5. Select the link named TaskContainer___WSDLFiles.zip and save the archive to your local file system.
6. Open the archive with an archive application
7. Open the following file within the archive TaskContainer__.ear\h.jar\META-INF\wsdl\com\ibm\task\api\sca\HTMWS.wsdl
8. Scroll to the bottom of the file to the element named soap:address
9. Copy the location value to the WebContent/WEB-INF/config/wps_config/default_wps_server.properties file e.g. http://:/HTMIF__/sca/com/ibm/task/api/sca/HTMWS

What to do next

Update the PA_SamplePortlets.war file with the HTM SOAP endpoint from your Process Server

Updating the PA_SamplePortlets.war file with the HTM SOAP endpoint

Things to do before you start this task

Retrieve the HTM SOAP endpoint from your WebSphere Process Server

About this task

This section describes how to update the PA_SamplePortlets war file with the HTM SOAP endpoint from your Process Server.

Updating the Sample Portlets war file with the HTM SOAP endpoint from your Process Server

1. Using an archive program open the PA_SamplePortlets.war file included in the Developer Package download.
2. Locate the file WebContent/WEB-INF/config/wps_config/default_wps_server.properties
3. Open the file default_wps_server.properties and update the property HTM_SOAP_Endpoint with the HTM SOAP endpoint location value retrieved in the previous step.
4. Save your changes to the file and close it.
5. If prompted choose to save the changes to the archive war file.

What to do next

Create a new Task Provider Instance in the Unified Task List.

Creating a new Task Provider Instance in the Unified Task List

Things to do before you start this task

1. Install the Unified Task List Portlet.

About this task

This task includes the steps required to create a Process Server Query Table API Task Provider Instance for the Unified Task List.
For more information on the Unified Task List you can view the wiki document here:http://wiki1.swg.usma.ibm.com/ldd/portalwiki.nsf/dx/Unified_Task_List

1. Open the Unified Task List page
2. Open the portlet menu and choose Configure
3. Click the link for Task Provider Instances
4. Click Add, The Task Provider Instances page shows.
5. Select IBM WebSphere Process Server7 (Task Query Table API) from the dropdown
6. Type in a name for the Task Provider Instance
7. Check the Enable checkbox
8. Click next
9. On this page give change the SOAP Endpoint settings from the default http://host:port/HTMJAXWSAPI/HTMJAXWSService to http://:/HTMJAXWSAPI/HTMJAXWSService
10. Click Save on the Provider Instances page and again on the main Configure page.
11. Click Back.

What to do next

Install the Sample Business Process and Task Processing Portlets.

Installing the Sample Business Process and Task Processing Portlets

Things to do before you start this task

Update the Unified Task List Portlet war file with the SOAP endpoint from your Process Server
Install the Unified Task List Portlet to Portal Server.

About this task

In this task you will install the sample HR business process to Process Server and the sample task processing Portlets to Portal Server.

Installing the sample business process and task processing Portlets

1. First install the HRSupport.ear on WebSphere Process Server accepting the default settings during the install. When it is installed, start it.
• Open the Admin Console of WebSphere Process Server and login: https://:/ibm/console/logon.jsp
• Select Applications - Application Types - WebSphere enterprise applications.
• Select Install and Browse. Browse to the directory where you expanded the Developer Package archive and select the HRSupport.ear file.
• Click Next, if prompted select Fast Path as the option to install the application.
• On the page Step 1: Select installation options, accept the defaults and click Next.
• On the page Step 2: Map modules to servers, ensure the modules for the application are assigned to server1. If not, select each module with server1 highlighted and click Apply.
• Click Next
• On the last page Step 3: Summary, review the settings and click Finish.
• When the Application has finished installing select Save directly to master configuration.
• On the Enterprise Applications page select the HRSupport and click Start. Once started the application has been successfully installed.
2. Next create the sample staff plugin configuration in your Process Server.You have to create this people directory configuration in your Process Server if it isn't already there:
• Log into the Process Server admin console - https://:/ibm/console/logon.jsp
• Select Resources - People directory provider
• In the table of people directory providers select User Registry People Directory Provider
• Under additional properties select People directory configuration
• Select New
• Browse to the following file in your process server installation, select it and click Next:${WBI_INSTALL_ROOT}/ProcessChoreographer/Staff/UserRegistryTransformation.xsl On a Windows OS the variable ${WBI_INSTALL_ROOT} resolves to C:\WPS\WebSphere\ProcServer
• Enter a Name such as wpswmmconfiguration and Description
• In the JNDI Name field enter bpe/staff/wpswmmconfiguration
• Click Apply
• Now you should be able to install and start the sample HR application.
3. Install the HRMod.ear business process on your Process Server and start it. Repeat the instructions for the HRSupport.ear, this time using the HRMod.ear business process.
4. Deploy the Unified Task List war file to your Portal Server.
5. Deploy the war file PA_SamplePortlets.war to your Portal Server.
6. Create a page, give it the unique name wps.utl and configure it as a Dynamic Page Extension Node using the following command:ConfigEngine.bat action-enable-page-as-extension-node-wp.dynamicui.config -DPageUniqueName=wps.utlNote: All three of the following Portlets can be found in the sample war file PA_SamplePortlets.war.
7. Create a page, give it the unique name com.ibm.StandardApproval and add the Portlet titled 'Approve Standard Application' to it. This page should only be accessed as a dynamic page.
8. Create another page, give it the unique name com.ibm.FourEye and add the Portlet titled 'Four Eye Approval' to it. This page should only be accessed as a dynamic page.
9. Finally create a third page and place the Portlet titled Start Task on it. As the title suggests this Portlet will be used to start the HR standard approval business process. This page can be accessed on a dynamic page or in the normal way.
10. Go to the page with the UTL on it and open the configure view by selecting it from the Portlet menu.
11. In the menu select Task Provider Instances and create a new Task Provider Instance for your Process Server.
12. Next you have to configure the task handling for the Human Tasks surfaced in the UTL. You can create the configurations using the following two sample configurations as a guide:

Figure 1: Standard Approval task handling configuration.

Figure 2: Four Eye Approval task handling configuration.

You can also get more information on Dynamic Pages here:

http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Overview_Developing_a_dynamic_UI_configuration_wp7

What to do next

1. Complete the next section which covers how to process the tasks using the sample Portlets and UTL in Portal Server.

Start to Finish Business Process Completion on WebSphere Portal Server

Things to do before you start this task

1. Installing the Sample Business Process and Task Processing Portlets.

About this task

This task will take you through the steps you need to take to complete the sample business process using the Sample Portlets provided and the Unified Task List. It also includes a figure of the business process flow.

Business process completion from start to finish

1. Open the page containing the Start Task Portlet, fill in the details required in all fields and click Complete.
2. Next open the page containing the Unified Task List Portlet.
3. You should see a new Approve Standard Application task when you click Refresh.
4. Select the checkbox beside the new task and then click Claim.
5. The title of the task is now a clickable link. Click it to lauch a dynamic page.
6. The Approve Standard Application dynamic page should be launched.
7. Complete it by clicking the Complete button. The dynamic page should close and return to the Unified Task List page.
8. Click the Refresh button in the UTL, and you should see a new Four Eye Approval task in the list of tasks retrieved from Process Server.
9. Carry out the same steps 4 -> 7 on the Four Eye Approval task to complete the sample business process.

Figure 3. Business Process Implementation.

What to do next

1. Develop custom business processes and create task processing Portlets for them using the Unified Task List Business Process Support package for WebSphere Portlet Factory.

Getting Started with Task Processing Portlet Development

Things to do before you start this task

1. Download the Unified Task List from the Portal Catalog.
2. Install WebSphere Portlet factory version 7.0.0.1
3. Retrieve the HTM SOAP endpoint from your Process Server.

About this task

This task explains how to get started with task processing Portlets using the Unified Task List Business Process Support package for WebSphere Portlet Factory and the sample task processing Portlets provided in the WebSphere Portlet Factory archive included in the Unified Task List Developer catalog bundle.

1. Copy the Unified Task List Business Process Support package to the Packages directory in your Portlet Factory installation. C:\IBM\PortletFactory7\Designer\FeatureSets\Web-App_7.0.0\Packages
2. Restart WebSphere Portlet Factory.
3. Create a new WebSphere Portlet Factory project and include the following selected Feature Sets:
4. Next import the WebSphere Portlet Factory archive from the UTL developer package download bundle.
5. Right Select the newly created WPF project and select import - WebSphere Portlet Factory Archive
6. Browse to the directory containing the developer package and select the file named SamplePortletsWPF.zip.
7. Select the root directory of the archive and ensure 'SamplePortlets/WebContent' is set as the directory to copy to.
8. Click Finish.
9. Now you are ready to build the WAR file for deployment to Portal Server.
10. Right Select the project and choose Export - WebSphere Portlet Factory Portlet WAR
11. Ensure the Portlet API is set to Java Portlet Standard 2.0 and click Finish.
12. The war file has been generated and is now ready to be imported into WebSphere Portal Server.

The sample WebSphere Portlet Factory Models used to create the task processing Portlets for the developer package can be found in the models directory of the newly created Portlet Factory project. They can be used to understand quickly how to use the Business Process Support builders provided in the Unified Task List Catalog bundle to build task processing Portlets.

Uninstalling the Unified Task List Developer Package

The following topic describes how to remove the Unified Task List Developer package.

Removing the Sample Portlets war file

In this section you will remove the web archive containing the sample task processing Portlets from WebSphere Portal Server.

1. Log into Portal Server as an administrator.
2. Open the Portal Server Administration page.
3. Under Portlet Management, Select Web Modules
4. In the Search by combo box select 'File name starts with', in the Search field enter PA_Sample and click the Search button.
5. from the row of buttons on the right side of the PA_SamplePortlets.war file select the one with the dustbin icon to delete the web module.
6. Next you should see a message saying the web module was successfully deleted.

Removing the Sample HR Business Process

In this section you will remove the sample business process enterprise application and its support enterprise application.

Step 1 Remove any Process Instances from Process Server :

* Note * For this step you will need to complete all Task instances and then Terminate and Delete all Process Instances.
1. Go to the Business Process Choreographer Explorer https://.com:9443/bpc/faces/pages/Login.jsp and 'Complete' all the Task Instances by selecting a task by clicking on the Task name and then clicking on the 'Complete' button. Do this for all instances.
2. Still in the the BPC explorer under 'Process Instances -> started By Me' view. Select each Process Instance and in the page with the process instance information click the 'Terminate' button to stop the instance.
3. Still in the the BPC explorer under 'Process Instances -> Administered By me' view. Select each Process Instance and on the page with the process instance information click the 'Terminate' button to stop the instance.
4. Then select the same Process Instance on the page with the process instance information click the 'Delete' button to remove the instance.

Step 2 Remove the HRMod & HRSupport enterprise applications from your Process Server:

1. Login to the Admin Console on the Process server, Go to Applications -> Application Types -> WebSphere enterprise applications
2. Select the checkbox beside HRSupport enterprise application and click the 'stop' button.
3. Click on the HRMod enterprise application, then click Manage Modules under Modules -> Manage modules
4. Click on - HRModEJB
5. Under Additional Properties click on Business Process and stop any resources that are started. Once stopped go back to HRModEJB.
6. Under Additional Properties click on Human Task and stop any resources that are started.
7. Go to Applications -> Application Types -> WebSphere enterprise applications and stop the enterprise application HRmod.
8. Select the checkbox beside HRMod and HRSupport and click the 'Uninstall' button. This should complete successfully.

Useful Links:

Uninstalling business processes topic covered in the WebSphere Process Server 7.0 InfoCenter
http://publib.boulder.ibm.com/infocenter/dmndhelp/v7r0mx/topic/com.ibm.websphere.bpc.z.doc/doc/bpc/t3de_bpel.html

WebSphere Portlet Factory wiki:
http://www-10.lotus.com/ldd/pfwiki.nsf

WebSphere Process Server Product Documentation
http://www-01.ibm.com/software/integration/wps/library/index.html

WebSphere Portal Server Product Documentation
http://www.ibm.com/developerworks/websphere/zones/portal/proddoc.html