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

Configuring Worklist Manager Service Engine Runtime Properties

The WLM SE Properties Editor allows you to view information about the service engine, configure database and LDAP properties, view statistics on the runtime components, and set log levels for various Worklist Manager components.

The following topics provide instructions for configuring the runtime properties and a reference of the available properties:

To Configure WLM SE Runtime Properties

  1. From the Services window of the NetBeans IDE, expand the Servers node.
  2. If the application server is not already started, right-click the server and then select Start.
  3. Under the application server, expand JBI and expand Service Engines.
  4. If the WLM SE is not started, right-click sun–wlm-engine and then select Start.
  5. If the WLM SE is not started, right-click sun–wlm-engine and then select Properties.

    The Properties Editor appears.


    image:Figure shows the WLM SE runtime Properties Editor.
  6. Modify any of the properties listed in Worklist Manager Service Engine Runtime Property Descriptions.

    Note - Statistic properties are automatically updated by the WLM SE. You do not need to modify these properties.


  7. To apply the changes, stop and restart the WLM SE.

Worklist Manager Service Engine Runtime Property Descriptions

The following table lists and describes each Worklist Manager Service Engine runtime property.

Table 1 WLM SE General Runtime Properties

Property
Description
Description
A general description of the JBI component.
Name
A unique name for the WLM SE in the JBI environment. If you install more than one WLM Service Engine in a JBI environment, make sure that each has a unique name. When the service unit deploys the component, it is matched with the target component name defined in its descriptor file, jbi.xml, which can be modified as needed.
State
The current state of the JBI component. This value can be either Started, Stopped, or Shutdown.
Type
The type of JBI component (service-engine or binding-component).

Table 2 WLM SE Identification Runtime Properties

Property
Description
Version
The version number of the installed service engine.
Build Number
The build number of the installed service engine.

Table 3 WLM SE Configuration Runtime Properties

Property
Description
Default Value
DataSource JNDI
The JNDI name of the JDBC resource for the Worklist Manager database. The name of the default JDBC resource created for the default JavaDB database is jdbc/__workflow.
jdbc/__workflow
DataSource Type
The database platform used by the Worklist Manager database.
Derby
Max Thread Count
The maximum number of threads that can be concurrently processed by the WLM SE.
10
Test Mode
An indicator of whether the WLM SE is running in testing mode. When this option is selected, the Worklist Manager database schema is dropped and recreated each time you start the WLM SE. If it is not selected, the existing Java DB database remains intact each time you start the WLM SE.
Deselected
Persistence Enabled
An indicator of whether persistence is enabled for the WLM SE. Currently, the only supported option is to have persistence enabled.
Selected
Update index on engine start
An indicator of whether the full-text index is updated when you start the WLM SE. When this option is selected, the index is updated.

This is required when a large number of database records are archived and deleted, or after the database has fun for some time (to improve full-text search efficiency).

Selected
Index root directory System Property
The file system directory to use as the root directory for storing the full-text index. This property must be set when the application server is started, and the directory must exist and be accessible.
java.io.tmpdir
LDAP used
An indicator of whether you are using an LDAP directory for authentication and for selecting users and user groups for tasks. The remaining properties below are only used if this option is selected.
Deselected
LDAP host
The address of the server on which the LDAP directory is stored.
localhost
LDAP Port
The port number for the LDAP server. This is used if SSL is not enabled for LDAP in the following property.
389
Is SSL enabled for LDAP
An indicator of whether you are using SSL to connect to the LDAP server. If this option is selected, the LDAP server connection uses the ldaps:// prefix.
Deselected
LDAPS port
The SSL port number for the LDAP server, if SSL is enabled.
636
Login Type
The security level used for logging on to the LDAP server. Select one of the following options:
  • none: Authentication is not required. Use this option for anonymous access.

  • simple: Authentication requires a user name and password. If you select this option, enter the security information in the following two properties.

none
LDAP search login DN
The distinguished named (DN) of the security principal used for LDAP searches. This is required if the Login Type is simple.
No default value.
LDAP search login password
The password for the above security principal. This is required if the Login Type is simple.
No default value.
uid attribute name
The name of the unique ID attribute for each the LDAP user entry. This is used to retrieve the name of a person from the DN.
uid
manager attribute name
The name of the attribute in the LDAP user entry that specifies the user's managers. This is used to retrieve the DN for the person's manager from that person's LDAP entry.
manager
email attribute name
The name of the attribute in the LDAP user entry that specifies the user's email address. This is used to retrieve a person's email address from their LDAP entry.
mail
Base DN in search
The base DN under which LDAP searches are run; for example, dc=company,dc=com. Note that queries run more efficiently under a more specific DN.
dc=example,dc=com
Scope Type
An indicator for the LDAP search of the starting point how deep from the base DN to search. Select one of the following options:
  • sub: Searches LDAP entries at all levels below and including the base DN specified above.

  • one: Searches LDAP entries only at the level just below the base DN specified above. This does not search entries at the base DN level and does not search any levels other than the one below the base DN.

  • base: Searches LDAP entries only at the base DN level.

sub
User filter
A filter to use for an LDAP user search. The default value is (uid=%s), which expands the search to the user's ID.
(uid=%s)
Group filter
A filter to use for an LDAP group search. The default value is (cn=%s), which expands the search to the group's ID.
cn=%s)

Table 4 WLM SE Runtime Statistics

Property
Description
Activated Endpoints
The number of activated endpoints.
Active Exchanges
The number of active exchanges.
Avg. Component Time
The average message exchange component time in milliseconds.
Avg. D.C. Time
The average message exchange delivery channel time in milliseconds.
Avg. Msg. Service Time
The average message exchange message service time in milliseconds.
Avg. Response Time
The average message exchange response time in milliseconds.
Completed Exchanges
The total number of completed exchanges.
Error Exchanges
The total number of error exchanges.
Received Dones
The total number of received dones.
Received Errors
The total number of received errors.
Received Faults
The total number of received faults.
Received Replies
The total number of received replies.
Received Requests
The total number of received requests.
Sent Dones
The total number of sent dones.
Sent Errors
The total number of sent errors.
Sent Faults
The total number of sent faults.
Sent Replies
The total number of sent replies.
Sent Requests
The total number of sent requests.
Up Time
The up time of this component in milliseconds.

The Loggers properties specify the level of logging for each event. You can set the logging level for each logger to any of the following levels:

By default, these are all set to the INFO level.

Table 5 WLM SE Logger Runtime Properties

Property
WLM Component
sun-wlm-engine
com.sun.jbi.engine.workflow
WorkflowEngine
com.sun.jbi.engine.workflow.WorkflowEngine
WorkflowSEBootstrap
com.sun.jbi.engine.workflow.WorkflowSEBootstrap
WorkflowSEInOutThread
com.sun.jbi.engine.workflow.WorkflowSEInOutThread
WorkflowSELifeCycle
com.sun.jbi.engine.workflow.WorkflowSELifeCycle
WorkflowSEServiceUnitManager
com.sun.jbi.engine.workflow.WorkflowSEServiceUnitManager
WLMSEComponentManager
com.sun.jbi.engine.workflow.base.WLMSEComponentManager
WLMSEConfiguration
com.sun.jbi.engine.workflow.base.WLMSEConfiguration
WLMSEEndPointManager
com.sun.jbi.engine.workflow.base.WLMSEEndPointManager
WLMSEExchangeHandler
com.sun.jbi.engine.workflow.base.WLMSEExchangeHandler
WLMSEServiceUnitManager
com.sun.jbi.engine.workflow.base.WLMSEServiceUnitManager
DeploymentLookup
com.sun.jbi.engine.workflow.com.sun.jbi.common.qos.descriptor.DeploymentLookup
MessagingChannel
com.sun.jbi.engine.workflow.com.sun.jbi.common.quos.messaging.MessagingChannel
EndpointLifeCycle
com.sun.jbi.engine.workflow.com.sun.jbi.component.tooklit.endpoint.EndpointLifeCycle
AcceptPoller
com.sun.jbi.engine.workflow.com.sun.jbi.component.toolkit.lifecycle.impl.AcceptPoller
DBOperation
com.sun.jbi.engine.workflow.db.opt.WorkflowSEInOutProvider
WorkflowSEInOutProvider
com.sun.jbi.engine.workflow.process.WorkflowSEInOutProvider
PersistenceTaskManagerImpl
com.sun.jbi.engine.workflow.runtime.model.impl.PersistenceTaskManagerImpl