JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Java CAPS Worklist Manager Service Engine User's Guide     Java CAPS Documentation
search filter icon
search icon

Document Information

Using the Worklist Manager Service Engine

Worklist Manager Service Engine Overview

Worklist Manager Service Engine Features

Worklist Manager Service Engine Architecture

Worklist Manager Components

Worklist Manager Database

Task Definition Wizard

Task Definition Editor

About the Worklist Manager Console

Worklist Manager Projects

The Worklist Module Project

The BPEL Project

The Composite Application Project

About Worklist Manager Tasks

Task Definition File

Task Definition Schema

XPath Expressions in Task Definitions

Automatic email Notifications

Changing Variables

Task Escalations and Timeouts

Security

Worklist Manager Task Validation

Steps to Implement a Worklist Manager Task

Defining Worklist Manager Tasks

(Optional) Connecting to the LDAP Server

To Connect to the LDAP Server

(Optional) Installing the Sample Worklist Manager Console Projects

To Install the Sample Worklist Manager Console

Creating the Worklist Module Project

To Create the Project

Creating the XML Schema Definition (XSD)

To Create the XML Schema Definition

Creating the WSDL Document

To Create the WSDL Document

Creating the Worklist Manager Task Definition

To Create the Worklist Manager Task Definition

Assigning Users and User Groups to a Task

To Assign File Realm Users and Groups to a Task

To Assign LDAP Users and Groups to a Task

Configuring Advanced Task Options

Defining Time Limits and Deadlines for a Task

To Define Task Timeouts

Adding Keywords to a Task

To Add Keywords

Defining Automatic Task Escalations

To Define Automatic Escalations

Defining Automatic Task Notifications

To Define Automatic Notifications

To Associate a Notification With a Task Status Change or Escalation

To Configure the Email BC for Task Notification

Defining Custom Notifications

To Define a Custom Notification

Defining Trigger Actions Using the Mapper

To Define Trigger Actions Using the Mapper

Initializing Variables Using the Mapper

To Initialize Variables Using the Mapper

Creating the Worklist Manager Database

Creating the Worklist Manager Database

Creating the Database for JavaDB (Derby)

Creating the Database for MySQL

Creating the Database for Oracle

Setting the GlassFish JVM Classpath to the Database Drivers

To set the GlassFish JVM Classpath settings

Creating the JDBC Connection Pool and JDBC Resource

To Create the JDBC Connection Pool

To Create the JDBC Resources

Configuring the Service Engine to Use the Worklist Manager Database

To Configure the Service Engine for the Database

Configuring Worklist Manager Service Engine Runtime Properties

To Configure WLM SE Runtime Properties

Worklist Manager Service Engine Runtime Property Descriptions

Defining Worklist Manager Console Security

Defining Worklist Manager Console Security Using a File Realm

To Create a User Login Profile in the File Realm

To Define Security Roles for the Worklist Manager Console

To Map Groups to Security Roles for the Worklist Manager Console

Defining Worklist Manager Console Security Using LDAP

To Create an LDAP Realm in the GlassFish Server

To Update web.xml for the Worklist Manager Console (for LDAP)

To Map User Groups to Security Roles for the Worklist Manager Console (for LDAP)

To Configure the Worklist Manager Service Engine for LDAP

Including the Worklist Manager Task in a BPEL Process

To Include the Worklist Manager Task in a BPEL Process

Creating and Deploying the Composite Application

To Create and Deploy the Composite Application

Testing the Worklist Manager Composite Application

Creating a Test Case

To Create a Test Case

Configuring Test Properties

To Configure Test Properties

Defining the Test Input

To Define Test Input

Running Test Cases

To Run a Single Test Case

To Run All Test Cases in a Project

Reviewing Test Case Results

Using the Default Worklist Manager Console

Installing and Deploying the Worklist Manager Console Sample

To Install and Deploy the Worklist Manager Console Sample

Logging In to the Worklist Manager Console

To Launch the Worklist Manager Console From a Browser

To Launch the Worklist Manager Console From the GlassFish Admin Console

Searching for Tasks

To Search for Tasks

Claiming a Task

To Claim a Task

Completing a Claimed Task

To Complete a Task

Reassigning a Task

To Reassign a Task

Using XPath Expressions and Functions in Task Definitions

About WLM XPath Functions

Standard Functions

wlmfn:get-task-owner as xs:string

LDAP Functions

wlmfn:get-email() as xs:string

wlmfn:get-email($arg as xs:string) as xs:string

wlmfn:get-manager-email() as xs:string

wlmfn:get-manager-email($arg as xs:string) as xs:string

wlmfn:get-manager-uid() as xs:string

wlmfn:get-manager-uid($arg as xs:string) as xs:string

Initializing Variables

Entering XPath Variables in Design View

Using the Task Mapper

Creating Worklist Manager Task Mappings

To Create a Mapping Without Using any Functions

To Use a Function in a Mapping

To Delete a Link or Function From a Mapping

XPath Function Reference

Operator Functions

Boolean Functions

String Functions

Node Functions

Number Functions

Date and Time Functions

WLM Functions

Customizing the Worklist Manager Console

About the Worklist Manager Console

Pages

Addressable Entities

Technologies

Functionality and UI Semantics Specification

Common page elements

Page Header

Page Footer

Login Page Elements

Tasks List Page Elements

Tasks List Table

Page Navigator

Page Size Selector

Sort Selector

Priorities Legend

Search Box

Basic Search Box

Advanced Search Box

Task Info Page Elements

Task Info Box

Task Input Data Box

Task Output Data Box

Help Page Elements

Customizing the Worklist Manager Console

Customizing the Appearance

Localizing

Correcting security settings

Correcting the Task Input Data Display

Correcting the Task Output Data Display

Creating a Custom Worklist Manager Console

Creating the Web Application and Composite Application

To Configure the Web Application

To Create the Composite Application

WLM Client WSDL API

GetTaskList

GetTask

ClaimTask

CompleteTask

GetTaskInput

GetTaskOutput

SetTaskOutput

ReassignTask

RevokeTask

Using the Default Worklist Manager Console

This topic provides instructions for using the default Worklist Manager Console provided with the WLM SE. This console is provided primarily for testing and development purposes, but you can customize it to fit your needs. You can also create a custom console for handling the Worklist Manager tasks using the client API. For more information, see Creating a Custom Worklist Manager Console.

The default Worklist Manager Console displays a search box below which any tasks that match a search are displayed. By default, tasks are ordered by their ID number (which is also the order in which the tasks were submitted). The worklist shows the task ID, title, status, submission date, users and groups to which it is assigned, the user who has claimed the task, and the deadline for completion.

Task IDs are highlighted based on the task priority.

Typical steps for completing a task are searching for the task, claiming the task, and then marking it as complete. The last two steps can be combined into one. Perform any of the following procedures to manage worklist tasks:

Installing and Deploying the Worklist Manager Console Sample

The WLM SE includes several sample projects that you can use to quickly get started using Worklist Manager projects. One of the samples defines a Worklist Manager Console. You can download and use this sample, or customize it to fit your needs. By default, when you install the WLM SE, this sample is already deployed and ready to run.

To Install and Deploy the Worklist Manager Console Sample

  1. Right-click in the NetBeans Projects window, and select New Project.

    The New Project Wizard appears.

  2. Under Categories, expand Samples and then select SOA.
  3. Under Projects, select WLM Console.
  4. Click Next.
  5. Enter a name for the project, and then click Finish.

    Two new projects appear in the projects tree. One is the Worklist Manager Console web project, and the other is the composite application for the console.

  6. Make any necessary security changes to the console.

    For more information, see Defining Worklist Manager Console Security.

  7. Clean and build the web project and then the composite application project.
  8. Deploy the composite application project.

Logging In to the Worklist Manager Console

You can log in to the default Worklist Manager Console either by launching the console from the GlassFish Admin Console or by entering the URL directly into a web browser.

To Launch the Worklist Manager Console From a Browser

  1. Open a web browser, and enter one of the following URLs:
    • To launch the console that is automatically deployed by the WLM SE:

      http://localhost:8080/wlm-sample

    • To launch the console that is manually deployed from the WLM Console sample projects:

      http://localhost:8080/wlm

  2. Enter one of the user names and passwords you defined in Defining Worklist Manager Console Security.

To Launch the Worklist Manager Console From the GlassFish Admin Console

  1. From a web browser, launch the GlassFish Admin Console.

    The default URL for the console is http:/localhost:4848.

  2. In the left navigation panel, click Web Applications.
  3. In the list that appears, click Launch next to one of the following web applications:
    • To launch the console that is automatically deployed by the WLM SE:

      WLMConsoleCompApp-WLMConsoleWeb with the /wlm context root.

    • To launch the console that is manually deployed from the WLM Console sample projects:

      WLMConsoleCompApp-WLMConsoleWeb (or whatever you named your Worklist Manager project and composite application) with the /wlm-sample context root.

    The Login page of the Worklist Manager Console appears.

  4. Enter one of the user names and passwords you defined in Defining Worklist Manager Console Security.

Searching for Tasks

The WLM SE supports full-text and keyword searches or Worklist Manager tasks.

To Search for Tasks

  1. To perform a basic search, enter a search term into the Search field and then click Search.

    Any tasks that contain the search criteria and that do not have a status of Completed appear in the task list.


    image:Figure shows the results of a basic search.
  2. To perform an advanced search, do the following:
    1. In the Search box, click Advanced Search.

      The Advanced Search fields appear.


      image:Figure shows the Advanced Search fields.
    2. Enter any of the following information for the search:
      • Task Statuses: Select one or more of the following: Assigned, Claimed, Escalated, Completed, Expired, and Failed. Use the Ctrl and Shift keys to select multiple statuses.

      • Task Owners: Specify the names of users and groups who own the tasks you want to find. If you specify more than one user or group, separate the names with a space.

      • Text Search: Enter a word or words by which to search.

    3. When you have entered all of your criteria, click Search.

      Any tasks matching the criteria appear in the task list.


    image:Figure shows the results of an advanced search.
  3. Once you perform a search, you can do any of the following:
    • To repeat the previous query, click Last Query above the Search box.
    • To view all tasks, click All Tasks above the Search box.
    • To view only the tasks you have claimed, click My Tasks above the Search box.
    • To re-sort the results of a search, click in the Sort By field and then select the column by which you want to sort.
    • To navigate back and forth through the worklist, use the Previous and Next buttons or the button corresponding to the page you want to view.
    • To change the number of tasks display on each page, select a new value from the Tasks per Page field.

Claiming a Task

Once a task you want to complete appears in the task list, you can claim the task. You can only complete tasks you have claimed, and you can claim and complete the task at the same time that you claim it.

To Claim a Task

  1. In the task list, select the task you want to claim.

    The page changes to show the task information.


    Note - The page you see may be different from the image below, depending on how the Worklist Module project was implemented.



    image:Figure shows a task ready to be claimed.
  2. Click Claim.

    Additional information for the task appears on the page, the Claimed By property changes to your user name, and the task status changes to Claimed.


    image:Figure shows a claimed task, ready to be completed.
  3. Do one of the following:
    • To modify the task output without completing the task, make the necessary changes and then click Save.

      Any changes you made to the output are saved.

    • To complete the task, make the necessary changes to the task output and then click Save and Complete.

      The status for the task changed the Completed.

    • If you do not want to claim the task after all, click Revoke.

      The Claimed By property is cleared and the task status changes back to Assigned.

Completing a Claimed Task

If you did not complete a task at the time you claimed it, you can return to the task and update the required information to complete the task.

To Complete a Task

  1. In the task worklist, click on a task you have claimed (the task status will be Claimed).
  2. In the response section of the window, modify any necessary information in the message.

    Note - The page you see may be different from the image below, depending on how the Worklist Module project is implemented.



    image:Figure shows a task with its output modified.
  3. Click Save and Complete.

    The status for the task changes to Complete.


    Note - The task remains in the Worklist Manager database, and can be viewed by searching for tasks with a status of Complete.


Reassigning a Task

At times it might be necessary to reassign a task to someone other than yourself. This can only be done before a task is claimed.

To Reassign a Task

  1. Perform a search for the task to reassign.
  2. In the worklist, select the task to reassign.
  3. Click Reassign.

    Two fields appear so you can reassign the task to a user or a group.


    image:Figure shows a task ready to be reassigned.
  4. Enter the user or group name to which the task should be reassigned.
  5. Click Reassign again.

    The task's Assigned To properties change to user or group names you entered, and the task worklist reappears.