Contents

This document includes the following topics:

  1. Introduction
  2. Prerequisites
  3. How to install and set up the Web client extensions SupportPac
  4. How to use the Web client extensions
  5. Sample Application
  6. API documentation

Introduction

IBM MQSeries Workflow - Web Client Extensions V1.0 provides a set of components for developing applications based on the IBM MQSeries Workflow Web client. Using these functions, you can develop workflow applications with professional, attractive, and sophisticated Web based user interfaces. The extended components are fully compatible with other functions provided by the Web Client. Web Client Extensions V1.0 provides features for:

The following figure illustrates the combination of a user exit, using multiple JSPs, and suspending and resuming an activity.

Reusing process instantiation data

The data from the previous process instance can be reused when instantiating a new process instance. By using this feature, you can avoid making end users have to enter the same data again.

Suspending and resuming activity implemetations

By using this feature, you can allow the end user to save the current activity as a draft. At anytime in the future, the user can restart the activity and continue from where they were.

Using multiple JSPs for a single activity implementation

You can use this feature to implement a single activity with multiple JSPs. You can provide a variety of Web interfaces, such as the navigation of user's data input.

Using the framework for user exit functions

You can define user-exits according to your needs. For example, you can specify code that provides evaluation data before or after a certain Web command is executed. Because the code is specified in JSPs, you need not know how to compile and publish the code. The data is evaluated on Web servers, therefore you can use any Web browser.

Prerequisites

IBM MQSeries Workflow - Web Client Extensions V1.0 requires the following prerequisites:

This SupportPac program and a sample application have been developed and tested under the following environment:


How to install and setup the Web client extensions SupportPac

This section describes how to install and setup IBM MQSeries Workflow - Web Client Extensions V1.0 in your IBM MQSeries Workflow Web Client environment.

Installation

To install the Web Client Extensions V1.0:

  1. Download the WA84.zip file from the MQSeries Workflow SupportPac Web site.
  2. Unzip the file to the root directory of Web Client for IBM MQSeries Workflow 3.3.2 (for example, c:\MQSeries Workflow)
  3. Copy two action image resources into the following directory.
    • If you use WebSphere Application Server Version 3.5:
        <MQWFDir>/cfgs/<ConfigID>/WebClient/webpages/images/action/
      (where <MQWFDir> is the root directory for IBM MQSeries Workflow, for example, "c:/MQSeries Workflow".)
    • If you use WebSphere Application Server Version 4.0:
        <WASDir>/installedApps/MQWFWebClient_<ConfigID>/fmcohcli.war/images/action/
      (where <WASDir> is the root directory for IBM WebSphere Application Server V4.0, for example, "c:/WebSphere/AppServer".)
  4. Copy fmcojext.jar file into the following directory and make sure that fmcohcli.jar file is located in the same directory. If not, copy the jar file to the destination directory.
    • If you use WebSphere Application Server Version 3.5:
        <MQWFDir>/cfgs/<ConfigID>/WebClient/webpages/WEB-INF/lib/
    • If you use WebSphere Application Server Version 4.0:
        <WASDir>/installedApps/MQWFWebClient_<ConfigID>/fmcohcli.war/WEB-INF/lib/

Zip file contents

After you have unzipped the WA84.zip file, you will have the following files:

Setup

To be able to use the extensions provided in this SupportPac, you must modify the file WebClient.properties. The WebClient.properties file is located in the following directory.

If you use WebSphere Application Server Version 3.5:
  <MQWFDir>/cfgs/<ConfigID>/WebClient/
(where <MQWFDir> is the root directory for IBM MQSeries Workflow, for example, "c:/MQSeries Workflow".)

If you use WebSphere Application Server Version 4.0:
  <WASDir>/installedApps/MQWFWebClient_<ConfigID>/fmcohcli.war/
(where <WASDir> is the root directory for IBM WebSphere Application Server V4.0, for example, "c:/WebSphere/AppServer".)

  1. To use CommandHandlerAdapter as the CommandHandler, edit the [Servlet] section of WebClient.properties and set:

     CommandHandler=com.ibm.workflow.servlet.sample.CommandHandlerAdapter

  2. To use JSPViewer as the DefaultViewer, edit the [Servlet] section of WebClient.properties and set:

     DefaultViewer=com.ibm.workflow.servlet.client.JSPViewer

  3. To add the four command handlers provided in this package, edit the [CommandHandlerAdapter] section of WebClient.properties and set:

    com.ibm.workflow.servlet.clientx.wext.ReuseProcessDataHandler = i
    com.ibm.workflow.servlet.clientx.wext.RestartAsDraftHandler = j
    com.ibm.workflow.servlet.clientx.wext.ChangePageHandler = n
    com.ibm.workflow.servlet.clientx.wext.PageEventHandler = m

    Where i, j, n, and m are index numbers which are appropriate for your Web Client environment.

  4. In the WebSphere Application Server Administration Console, select an existing application server for the Web Client for MQSeries Workflow and restart it.

  5. To verify that IBM MQSeries Workflow - Web Client Extensions V1.0 is installed correctly, and to see how it looks and works, try using the Sample Application.

 

How to use the Web client extensions

How to use IBM MQSeries Workflow - Web Client Extensions V1.0 is described in detail here.

 

Sample application

A sample application that uses the features provided in this SupportPac is described in detail here.

 

API documentation

Each method in the IBM MQSeries Workflow Web Client Extensions V1.0. API is described in detail here.


© Copyright IBM Corporation 2001. All Rights Reserved.