Using the Sun Business Process Manager Worklist Manager for User Activities

Implementing a User Activity

This section provides an overview of how to configure the user activity and other components required to implement a user activity. Each step below is described in detail in the following sections. Perform the following steps to create a BP containing a user activity.

  1. Creating the Worklist Manager Database

  2. Configuring Security

  3. Creating a Web Service Definition

  4. Creating the BPs

  5. Defining Task Assignment Conditions

  6. Configuring the WorkList Manager

Creating the Worklist Manager Database

The Worklist Manager database stores task assignment data, such as the type, priority, and status of the task, as well as who a task is currently assigned to. Before beginning this task, be sure you have database instance created where you can install the Worklist Manager tables.

ProcedureTo create the Worklist Manager database

  1. From the Project Explorer, expand BPM, and then expand WorkListViewer.

  2. Right-click WorklistViewer, and then click Checkout.

  3. On the dialog box, click Check Out.

  4. Right-click Database Scripts, and then click Properties.

    The Database Script Properties dialog box appears.

    Figure 1 Worklist Manager Database Properties

    Figure shows the Worklist Manager Database Script Properties
dialog box.

  5. Configure the database properties to connect to your database, and then click OK.

    See Figure 1 for more information about the values for these properties.


    Note –

    The user whose login information you enter must have DBA privileges to create the new Worklist Manager user.


  6. For Oracle databases only:

    1. In the Project Explorer, right-click the install script file appropriate for your database, and then click Open.

    2. Modify the location of the tablespace data file to the location where you want the file to reside.

    3. Right-click inside the file, and then click Save.

  7. In the Project Explorer, right-click the install script file appropriate for your database, and then click Run.

    Property

    Description 

    Database Type

    The database vendor and version you are using. 

    JDBC URL

    The URL to connect with the database. Enter one of the following: 

    • For Oracle: jdbc:SeeBeyond:oracle://<host>:<port>;SID=<SID>

    • For Sybase: jdbc:SeeBeyond:sybase://<host>:<port>

    • For SQL Server: jdbc:SeeBeyond:sqlserver://<host>:<port>;DatabaseName= <dbname>

    • For DB2: jdbc:SeeBeyond:db2://<host>:<port>;DatabaseName=<SID>;collectionId=JDBCPKG;packageName=JDBCPKG;embedded=true;createDefaultPackage=FALSE

      where <host> is the machine on which the database resides, <port> is the port number on which the database is listening, and <SID> and <dbname> are the name of the database.

    User

    The login ID of a database administrator. This user must be able to create users and assign permissions, as well as create and drop tables. 

    Password

    The password for the administrator user. 

Configuring Security

The Worklist Manager and task assignment window both require a connection to an LDAP directory for user information and authentication. You can optionally configure SSL on the LDAP server to encrypt information.

Configuring the LDAP Server

If you are already using an LDAP server, you can use your existing directory structure. The primary requirement for the Worklist Manager is a mechanism that clearly defines a user hierarchy so managers and supervisors can view the tasks of their subordinates and users can escalate tasks to their supervisors.

OpenLDAP

The Worklist Manager can adapt to your existing OpenLDAP directory structure. You may need to assign each user an attribute that defines their reporting structure, if this has not been done already. You can use the default attribute, Manager, or you can create a new manager attribute. Each user should have an entry similar to Manager: cn=GSmythe, as shown in the sample directory structure in Figure 2.

Figure 2 Sample OpenLDAP Directory Structure

Figure shows a sample user entry for OpenLDAP.

Worklist Manager login credentials for each user are defined by the value of the Naming Attribute used in the distinguished name for each user (typically the cn attribute) and the value of the userpassword attribute. For OpenLDAP, Sun BPM uses an anonymous bind to access the directory server.

You can create custom groups and roles to which Worklist Manager users belong, but this is not required. For information about configuring the Worklist Manager for OpenLDAP, see Configuring an OpenLDAP Connection.

Sun Java System Directory Server

The Worklist Manager can adapt to your existing Sun Java System Directory Server structure. You need to define the reporting structure if this has not been done already. There are a variety of ways to define the reporting structure. Sun provides a default attribute, manager, that you can use to define the upward reporting structure, but you must also use an attribute that defines subordinates. You can also create custom attributes that indicate a user’s managers and subordinates, or define hierarchies in the entrydn attribute of the user. For example, if user “gsmythe” reports to “grose” who in turn reports to “cpina”, the entrydn attribute for “gsmythe” would be similar to:

uid=gsmythe,uid=grose,uid=cpina,ou=people,dc=sun,dc=com

Using the above entrydn, the directory structure would look similar to Figure 3.

Figure 3 Sample Sun Java System Directory Server Structure

Figure shows a sample structure for the Sun Java System
Directory Server.

You can create custom groups and roles to which Worklist Manager users belong, but this is not required.


Note –

To enable task escalation and re-assignment on the Worklist Manager, you need to use the manager attribute to define a user’s supervisor and you need to define the reporting structure in each user’s entrydn attribute as described above. In the manager attribute, be sure to enter the full entrydn value for the supervisor.


When you define the LDAP directory structure, note the Naming Attribute used in the distinguished name for each user. This is typically the uid attribute or the cn attribute. This value is specified in the Worklist Manager External System properties in the Environment. Worklist Manager login credentials for each user are defined by the value of the Naming Attribute and the value of the userpassword attribute. You need to create an administrator user that the Worklist Manager will use as the security principal.

For more information about configuring the Worklist Manager for the Sun Java System Directory Server, see Configuring a Sun Java System Directory Server Connection.

Microsoft Active Directory

The Worklist Manager can adapt to your existing Active Directory structure. You need to define the reporting structure if this has not been done already. Active Directory provides two default attributes, manager and directReports, that define the reporting hierarchy. You can also create custom attributes that indicate a user’s supervisors and subordinates. You can create groups and roles to which Worklist Manager users belong, but this is not required.

In Active Directory, a user’s login ID is defined by the sAMAccountName attribute. This attribute is specified in the Worklist Manager External System properties in the Environment. Worklist Manager login credentials for each user are defined by the value of the sAMAccountName attribute and the value of the userPassword attribute. You need to create an administrator user that the Worklist Manager will use as the security principal.

For more information about configuring the Worklist Manager for Microsoft Active Directory, see Configuring a Microsoft Active Directory Connection.

Configuring Secure Sockets Layer

By default, communications between the Repository and the LDAP server are unencrypted. You can configure the LDAP server and Worklist Manager to use Secure Sockets Layer (SSL).

ProcedureTo encrypt communications between the Repository and the LDAP server

  1. Configure SSL on the LDAP server.

    Ensure that the LDAP server is configured to use the Secure Sockets Layer (SSL). For detailed instructions, see the documentation provided with the LDAP server.

  2. Export the LDAP server certificate to a file.

  3. Import the LDAP server certificate to the Repository’s list of trusted certificates. The following steps use the keytool program. This program is included with the Repository (as well as the Java SDK).

  4. From a command prompt, navigate to <JavaCAPS_home>\repository\1.5.0_10\jre\bin.

  5. Run the following command:

    keytool -import -trustcacerts -alias alias -file certificate_filename -keystore cacerts_filename

    For the -alias option, assign any value.

    For the -file option, specify the fully qualified name of the LDAP server certificate. For example:

    C:\ldap\mycertificate.cer

    For the -keystore option, specify the fully qualified name of the cacerts file, located in <Java CAPS_home>\repository\1.5.0_10\jre\lib\security. For example:

    C:\JavaCAPS51\repository\1.5.0_10\jre\lib\security\cacerts

  6. When prompted, enter the keystore password. The default password is changeit.

  7. When prompted whether to trust this certificate, enter yes.

    The following message appears:

    Certificate was added to keystore

  8. In the Realm element of the server.xml file, modify the URL of the LDAP server as follows:

    1. Set the protocol to ldaps.

    2. Set the port number to the port number that the LDAP server listens on for SSL requests. Typically, this number is 636.

      For example:

      <Realm className="org.apache.catalina.realm.JNDIRealm" connectionURL="ldaps://myldapserver:636">

LDAP and UNIX Java CAPS Environments

If the Logical Host of the Java CAPS environment is running on a UNIX system, you must configure the LDAP Provider URL to connect to the LDAP server. The following is common for a Java CAPS environment.

In this environment, the LDAP provider URL in the Worklist Manager properties must be set to an exact URL.

ProcedureTo set an LDAP provider URL

  1. From the Environment Explorer tab, right-click the Worklist Manager External System, and then click Properties.

  2. In the Configuration list, expand WLMConnector External System Configuration, and then, depending on the LDAP server you are using, click Open Ldap Parameters or Sun Java System Directory Server/ADS.

  3. In the LDAP Provider URL property, enter the exact URL to the LDAP server.

    The URL for the LDAP server is ldap://host:port

    where hostis the name of the machine on which the LDAP server resides, and port is the port number on which the LDAP directory is listening. You can access the port number through the LDAP directory browser or administration tool you are using.

  4. Click OK to save the changes.

Creating a Web Service Definition

Web Service Definitions, embodied as Web Service Definition Language (WSDL) files, can be used to invoke and operate web services on the Internet and to access and invoke remote applications and databases. WSDL files are used when you are building a web service, and expose the BP as a web service.

Creating the BPs

Once you have created the Worklist Manager database and have the LDAP directory structure in place, you can create the main BP that contains the user activity and the sub-process that defines the user activity logic.

Creating the Sub-process

The sub-process defines the flow of data through the user activity, and defines the access point for users to enter the required information.

ProcedureTo create the sub-process

  1. Create the Sun VPD page flows that define the user activity.

  2. Create a BP, and add the modeling elements including the Sun VPD page flows.

  3. Link the modeling elements together.

  4. Create the business rules for the links to define the mapping of data..

  5. When you are done configuring the modeling elements, click Save on the Enterprise Designer toolbar.

Creating a Partner

When creating a BP that will be used as a sub-process, you need to create a partner to associate with the receive and reply activities.

ProcedureTo create a new partner

  1. In the Project Explorer, right-click the sub-process, and then click Properties.

  2. On the BP Properties window, click the Partners tab.

  3. Click New, and enter a name for the partner.

  4. Click OK.

Associating the Partner with Activities

Once you create a partner for the sub-process, you need to associate it with the implement or receive activity and the reply activity of the sub-process. This allows you to connect the components in the Connectivity Map.

ProcedureTo associate the partner with activities

  1. In the BP, select the receive or implement activity.

  2. On the BP Designer toolbar, click Property Sheet.

  3. In the Partner property, select the partner you created above.

  4. Repeat for the reply activity.

Creating the Main BP

The main BP includes the user activity, and invokes the sub-process created in the previous step.

ProcedureTo create the main BP

  1. Create a BP, and add the modeling elements including a user activity.

  2. Link the modeling elements together.

  3. In the Project Explorer, expand the sub-process, and then drag the operation of the sub-process onto the user activity in the BP. This node is named Operation by default, but you can customize the name in the WSD object.

  4. Create the business rules for the links to define the mapping of data.

  5. Define task assignment for the user activity, as described in Defining Task Assignment.

  6. When you are done configuring the modeling elements, click Save on the Enterprise Designer toolbar.

Configuring User Activities Inside While Loops

When creating a BP that includes a user activity inside a while loop, you must take a few extra steps. The following procedure provides the steps for configuring a user activity inside a while loop.

ProcedureTo configure a user activity inside a while loop

  1. Create and configure a user activity as normal.

  2. Add a business rule to the link leaving the user activity.

  3. Open the Business Rule Designer and expand the WLVTask.Input node.

  4. Copy a BP attribute from the Output panel to the All panel, as shown in Figure 4.

    This creates an output container.

    Figure 4 Copy BP Attribute

    Figure shows copying a BP attribute in the Business Rule
Designer.

  5. Open the Business Rules panel and click Show Single Mapping, as shown in Figure 5.

    Figure 5 Business Rules Editor

    Figure shows the Business Rule Designer with the Business
Rules Editor displayed.

  6. Right-click the Copy rule and click Reset Destination, as shown in Figure 6.

    Figure 6 Reset Destination

    Figure shows the Rest Destination context menu in the
Business Rules Editor.

  7. On the Enterprise Designer toolbar, click Save.

Defining Task Assignment

After the BPs are created and configured, you need to connect to the LDAP server and configure the user activity. To configure a user activity, you create expressions that define which users are assigned to a task under specific conditions. You can optionally define automatic task escalation and email notifications for user activities. The task assignment panel also provides a Sun VPD page mapper so you can expose values generated by the user activity to the Sun VPD page flow.


Note –

One default expression is defined in the expression list, which cannot be deleted. This expression is used when no conditions defined for any other expression evaluate to true. At a minimum, you must configure the default expression by assigning a user to the expression; otherwise, BP validation will find a fatal error and you will be unable to deploy.


Creating a Task Assignment Expression

The flow of a specific task is defined by an expression. You can define multiple expressions for each user activity, each defining the conditions under which a task is assigned, the users to whom it is assigned, and what happens once the task is assigned.

ProcedureTo create a task assignment expression

  1. In the main BP, right-click the user activity to which you want to assign LDAP users, and then click Edit Task Assignment Panel.

    The Worklist Manager window appears, as shown in Figure 7.

    Figure 7 Worklist Manager Window: Expression List

    Figure shows the expression list on the Worklist Manager
window.

  2. In the upper section of the window, click Add.

    A new expression appears in the expressions list.

  3. If necessary, use the Move Up and Move Down buttons to place the expression in the correct order.

  4. Configure the expression as described in the following sections.

Defining Task Assignment Conditions

Conditions define how an activity is evaluated for user completion. The Conditions tab of the Worklist Manager window includes a Method Palette, similar to that of the Business Rule Designer. This step is required for all but the default expression.

ProcedureTo define task assignment conditions

  1. On the Worklist Manager window, click the Condition tab.

    The Condition page appears, as shown in Figure 8.

  2. Define the conditions under which a task will be assigned.

    Figure 8 illustrates an example of using methods on the Condition page.

    Figure 8 Worklist Manager Window: Condition Tab

    Figure shows a sample condition on the Worklist Manager
window.

  3. Once the conditions are defined, continue to Assigning Users to the Activity.

Assigning Users to the Activity

In this step, you can create either static or dynamic assignments for the user activity. With static assignments, you specify the users to whom tasks will be assigned when the conditions you defined on the Condition page have been met. To do this, you must connect to a running LDAP server. With dynamic assignments, you specify a field in the incoming data that contains the name of the user to whom that task is assigned. You do not need to connect to the LDAP server to create this assignment. This step is required for all expressions. If a user activity includes an expression with no users assigned, the BP will fail validation.

ProcedureTo assign users to an activity

  1. On the Worklist Manager window, click the Assignments tab.

    The Assignments page appears, as shown in Figure 9.

    Figure 9 Worklist Manager Window: Static Assignments

    Figure shows the Assignment tab on the Worklist Manager
window.

  2. To create static assignments, do the following:

  3. On the Assignments page, make sure the Assignment Type is Static, and then click Connect.

    The LDAP connection properties dialog box appears.

    Figure 10 LDAP connection properties Dialog Box

    Figure shows the LDAP Connection Properties dialog box
(accessed from the Worklist Manager window).

  4. Enter the values in Figure 10, and then click OK.

    The left panel of the Assignments page is populated with the roles, groups, and users defined in your LDAP directory.

  5. From the list in the left panel , select the roles, groups, or users you want to include for this task assignment, and then click Assign.

  6. To create dynamic assignments, do the following:

    1. In the Assignment Type field, select Dynamic.

      The Assignments page changes to display attributes, as shown in Figure 11.

      Figure 11 Worklist Manager Window: Dynamic Assignments

      Figure shows dynamic task assignment on the Worklist
Manager window.

    2. In the attributes list, expand the list and select the field that will contain the name of the user to whom a task will be assigned.

  7. Continue to Defining Task Escalation, or click OK if you are done defining the expression.


    Note –

    Modify the properties to suit your LDAP implementation.


    Field

    Description 

    Host

    The name of the computer on which the LDAP server resides. 

    Port

    The port number on which the LDAP server listens for requests. 

    Base DN

    The root Distinguished Name of the users directory; for example, dc=sun,dc=com.

    Role

    The name of the role to which Worklist Manager users are assigned, if any. This field is not required. 

    Group

    The name of the group to which Worklist Manager users are assigned, if any. This field is not required. 

    Type

    The type of LDAP server you are using. 

    SSL

    An indicator of whether to encrypt data shared between the LDAP server and the Repository. Select this option if SSL is configured. 

    Anonymous

    An indicator of whether to create an anonymous bind to the LDAP server or to use specific login credentials. If you deselect this check box, the fields below become enabled. 

    User DN

    The distinguished name of the user to use to connect to the directory server. 

    Append Base DN

    An indicator of whether to append the value of Base DN to the User DN for authentication.

    Password

    The password associated with the User DN above.

Defining Task Escalation

The Worklist Manager provides the ability to automatically escalate tasks based on either a duration of time or a deadline. When escalation is based on duration, the task can be escalated repeatedly. When it is based on a deadline, the task is only escalated once.

For duration-based escalation, the timer starts when a task is added and when a user checks in, reassigns, or escalates a task. If the specified duration passes without the timer stopping, the task is escalated to all unique managers of the assignee. The timer stops when a task is checked out or completed and when the task has been escalated as high as it can go.

For deadline-based escalation, the timer starts when a task is inserted. The task is only escalated if the timer does not stop prior to the deadline. The timer stops when a task is checked out, completed, or manually escalated. The timer also stops when the deadline is reached and the task is escalated.

Defining task escalation is optional.

ProcedureTo define task escalation

  1. On the Worklist Manager window, click the Timeouts tab.

    The Timeouts page appears, as shown in Figure 12.

    Figure 12 Worklist Manager Window: Timeouts Tab

    Figure shows the Timeouts tab of the Worklist Manager
window.

  2. Click the Enabled checkbox.

  3. To set a duration for escalation, do the following:

    1. In the Alarm Type field, select Static Duration.

    2. Enter the duration in the fields provided.

      Figure 13. specifies that the task must be completed in just under one week before it is escalated.

      Figure 13 Static Duration Fields

      Figure shows the fields to define for static duration
timeouts on the Worklist Manager.

  4. To set a deadline for the escalation, do the following:

    1. In the Alarm Type field, select Static Deadline.

    2. Enter the deadline in the fields provided.

      Figure 14 specifies that the task must be completed before midnight on the last day of February, 2007.

      Figure 14 Static Deadline Fields

      Figure shows a sample static duration timout configuration.

  5. Continue to Exposing User Activity Values to Sun VPD Pages, or click OK if you are done defining the expression.

Exposing User Activity Values to Sun VPD Pages

Using the Page Flow Mapper, you can expose values generated by the user activity to the associated Sun VPD pages. For example, if you map the assignedTo field, pages can be built that display the name of the task assignee.

The mapper has a Method Palette from which you can select methods to manipulate the data in the mapping.

Exposing user activities to Sun VPD pages is optional.

ProcedureTo expose user activity values to Sun VPD pages

  1. On the Worklist Manager window, click the Page Flow Mapper tab.

    The Page Flow Mapper page appears, as shown in Figure 15.

    Figure 15 Worklist Manager Window: Page Flow Mapper

    Figure shows the Page Flow Mapper tab on the Worklist
Manager window.

  2. In the mapper, map any user activity fields in the left panel to nodes in the right panel.

  3. Continue to Define Email Notifications for Tasks, or click OK if you are done defining the expression.

Define Email Notifications for Tasks

You can specify that certain users receive email notifications during different stages of task completion. For example, you might want to notify both the assignee and their managers when they are assigned a task. You can define email notifications for all types of task activities, including assignment, reassignment, escalation, check-ins, checkouts, and completion. This task is optional.

To define email notifications, complete the following tasks:

ProcedureTo define email notification for tasks

  1. On the Worklist Manager window, click the Email Notifications tab.

    The Email Notifications page appears, as shown in Figure 15.

    Figure 16 Worklist Manager Window: Email Notifications Tab

    Figure shows the Email Notifications tab on the Worklist
Manager window.

  2. For each action for which you want to generate email notifications, do the following:

    1. In the Conditions list, select the checkbox next to the action.

    2. In the Send Email Notifications To list, select the users to whom the notifications should be sent.

  3. Click OK.

  4. In the Environment Explorer, configure the Worklist Manager External System properties by doing the following:

  5. Specify the email server connection properties, as described in Defining Email Notification Properties.

  6. In the properties for the LDAP server, enter the name of the LDAP user attribute that contains the email address (for example, “mail”).

    For more information about this property, see Figure 21, , or Figure 23 (depending on the type of LDAP directory you are using).

Configuring the WorkList Manager

When you create the Environment for a user activity BP, you need to create and configure a Worklist Manager External System. The properties you configure for the external system define the Worklist Manager database connectivity, LDAP server and directory information, and custom labels for flex attributes. Perform the following steps to configure the Worklist Manager.

In addition, you must perform one of the following tasks:

Creating the Worklist Manager External System

The Worklist Manager External System is created from the Environment Explorer.

ProcedureTo create the Worklist Manager External System

  1. In the Environment Explorer, right-click the Environment for the user activity Project.

  2. Point to New, and then click Worklist Manager.

  3. Enter a name for the Worklist Manager External System, and then click OK.

    The Properties window appears.

  4. Configure the Worklist Manager, as described in the following sections.

Defining Configuration Properties

The configuration properties of the Worklist Manager define information about the Worklist Manager database and application.

ProcedureTo define configuration properties

  1. On the Worklist Manager Properties window, click WLMConnector External System Configuration (shown in Figure 17).

    Figure 17 Worklist Manager External System Configuration

    Figure shows the Worklist Manager External System Properties
window.

  2. Enter values for the properties described in Figure 17.

  3. Click OK.

    Property 

    Description 

    Database Type

    The type of database you are using. Select from oracle, sybase, sqlserver, or db2.

    Database Host

    The name of the database server. 

    Database Port

    The port number on which the database is listening. 

    Database SID

    The SID name of the database. 

    Database User ID

    The login ID of the WLM user for the database. This should be the same user as was created by the WLM database installation scripts. 

    Database Password

    The password for the WLM user. 

    Database Connection Retry Count

    The number of times the driver will try to connect to the database after an unsuccessful attempt. 

    Database Connection Retry Delay

    The number of seconds the driver waits before retrying to connect to the database server. 

    Database Initial Pool Size

    The number of physical connections with which the database will be initialized. 

    Database Pool Minimum Pool Size

    The minimum number of physical connections in the database pool. 

    Database Pool Maximum Pool Size

    The maximum number of physical connections in the database pool. 

    Database Pool Property Cycle

    The frequency in seconds that the database pool manager should check the pool. 

    Database Pool Idle Time

    The length of time a physical connection can be inactive. 

    Auto Commit

    An indicator of whether to enable the auto-commit feature of the database. 

    Connection Parameters

    The type of LDAP directory you are using. Select from Sun Java System Directory Server, ActiveDirectoryConnection, or OpenLdapConnection.

    WLM Application Name

    The name of the Worklist Manager application that is generated when you deploy the Project. This name is part of the URL used to log into the Worklist Manager and should be unique for each user activity BP. You can deploy multiple BPs with user activities to the same Environment, but each WLM application must have a unique name. In that case, the Environment must include multiple Worklist Manager External Systems. 

    WLM Session Timeout (minutes)

    The number of minutes the Worklist Manager can remain idle before timing out. 

    WLM Initial Order

    The order of the fields on the Worklist Manager. When you click the ellipses next to this property, the Ordering Sequence dialog box appears, where you can select the fields to display on the Worklist Manager, and the order in which they appear. 

Customizing Flex Attribute Labels

Flex attributes are customizable attributes that aid in task assignment. The attributes appear in the Business Rule Designer (as shown in Figure 18) as well as in columns of the Worklist Manager.

You can map values to these attributes in the Business Rule Designer so the values appear in the Worklist Manager. You can also label the attributes to make them easy to identify in the Worklist Manager.

Figure 18 Flex Attributes in the Business Rule Designer

Figure shows a list of flex attributes in the Business
Rule Designer.

ProcedureTo customize flex attribute labels

  1. From the Environment Explorer, right-click the Worklist Manager External System.

  2. Click Properties.

    The Properties dialog box appears.

  3. Click Custom Attribute Labels, as shown in Figure 19.

    Figure 19 Flex Attributes

    Figure shows the Custom Attribute Labels page of the
Worklist Manager External System Properties window.

  4. Define labels for as many attributes as necessary.

  5. Click OK.

Defining Email Notification Properties

If you defined email notifications on the Worklist Manager window for a user activity (see Define Email Notifications for Tasks), you need to define the connection properties for the email server in the Worklist Manager External System properties. You also need to modify the LDAP properties for the directory server you are using by specifying the name of the attribute that contains the users’ email addresses.

ProcedureTo define email notification properties

  1. On the Worklist Manager Properties window, click Email Server Connection Parameters (shown in Figure 17).

    Figure 20 Email Server Connection Properties

    Figures shows the Email Server Connection Properties
page on the Worklist Manager External System Properties window.

  2. Enter values for the properties described in Figure 20.

  3. Click OK.

    Property 

    Description 

    Email Outgoing server

    The name of the email server on which the Worklist Manager email notifications are sent. 

    Email User Name

    The login ID for the email account used by the Worklist Manager. 

    Email Password

    The password for the email account. 

    Sender of Email

    The name that should appear in the email as the sender. This property is used to create a URL, so it cannot contain any spaces. 

    First footer of Email

    A footer for the email notifications. 

    Second footer/Disclaimer of Email

    A second footer or disclaimer for the email notifications. 

Configuring an OpenLDAP Connection

To use OpenLDAP with the Worklist Manager, you must specify certain information about the LDAP directory structure so the Worklist Manager knows where to find the user information defined in the directory. You can use your existing directory structure as long as there is a mechanism for defining a user reporting hierarchy.

The Worklist Manager uses an anonymous bind with OpenLDAP, so you do not need to specify credentials for the security principal.

ProcedureTo configure an OpenLDAP connection

  1. From the Environment Explorer tab, right-click the Worklist Manager External System, and then click Properties.

  2. On the properties page that appears, verify that the Connection Parameters property is set to OpenLdapConnection.

  3. Expand WLMConnector External System Configuration, and then click Open Ldap Parameters.

    The Properties dialog box appears, as shown in Figure 21.

    Figure 21 OpenLDAP Configuration Properties

    Figure shows the OpenLdapParameters page of the Worklist
Manager External System Properties window.

  4. Enter values for the properties in Figure 21.


    Note –

    Modify these values to suit your existing directory structure and attributes.


  5. Click OK.

    Property 

    Description 

    LDAP Initial Context Factory

    The fully qualified name of the factory class that creates the initial context. The initial context is the starting point for JNDI naming operations. 

    LDAP Provider URL

    The URL of the LDAP server. The format of the URL is ldap://<host>:<port>, where <host> is the name of the computer hosting the LDAP server, and <port> is the port number on which the LDAP server is listening for requests.

    Open LDAP RootName

    The name of the root node in the LDAP directory. For example, if the root node is dc=Sun,dc=com, the value for this property would be Sun.

    Open LDAP Version

    The version of OpenLDAP you are running. 

    Open LDAP Search Filter

    A search filter used by the Worklist Manager to search for users. The Worklist Manager will only find those users described by the filter. 

    For example, to use an organization name as the search filter where all Worklist Managers are assigned to the Sun organization, the value for this property would be (o=Sun).

    Open LDAP Search DN

    The DN of the root entry of the portion of the LDAP directory where the Worklist Manager will start the search for users. 

    For example, if users are all defined in an organizational unit named People, the value for this property would be similar to ou=People,dc=sun,dc=com.

    Open LDAP Attribute Role

    The name of the role attribute in the LDAP directory to which Worklist Manager users belong. Only enter a value for this property if you have defined a role to which all Worklist Manager users are assigned. 

    Open LDAP Attribute Manager

    The name of the attribute that specifies reporting hierarchy in the LDAP directory. This is the attribute assigned to a user that specifies who they report to. You can use Manager, the predefine attribute for OpenLDAP, or you can create a custom attribute. The Worklist Manager uses this entry to create the list of users to whom a supervisor can reassign tasks, and to specify the supervisor when a task is escalated.

    Open LDAP Group

    The name of the group attribute in the LDAP directory to which Worklist Manager users belong. Only enter a value for this property if you have defined a group to which all Worklist Manager users are assigned. 

    Open LDAP Email

    The name of the attribute that contains a user’s email addresses. This is used in email notification. 

    Open LDAP Attribute Given Name

    The name of the attribute that contains a user’s first name. This is used in email notification. 

Configuring a Sun Java System Directory Server Connection

To use the Sun Java System Directory Server with the Worklist Manager, you must specify certain information about the LDAP directory structure so the Worklist Manager knows where to find the user information defined in the directory. You can use your existing directory structure as long as there is a mechanism for defining a user reporting hierarchy.

ProcedureTo configure a Sun Java System Directory Server connection

  1. From the Environment Explorer tab, right-click the Worklist Manager External System, and then click Properties.

  2. On the properties page that appears, verify that the Connection Parameters property is set to Sun Java System Directory Server.

  3. Expand WLMConnector External System Configuration, and then click Sun Java System Directory Server/ADS.

    The Properties dialog box appears, as shown in Figure 21.

    Figure 22 Sun Java System Directory Server Configuration Properties

    Figure shows the Sun Java System Directory Server configuration
properties on the Worklist Manager External System Properties window.

  4. Enter the property values for the properties described in .


    Note –

    Depending on how your LDAP directory is set up, not all of these fields are required. The default configuration is not necessarily illustrative of an actual implementation.


  5. Click OK to close the Properties dialog box.

    Property 

    Description 

    Java Naming Provider URL

    The URL of the LDAP server. The format of the URL is ldap://<host>:<port>, where <host> is the name of the computer hosting the LDAP server, and <port> is the port number on which the LDAP server is listening for requests.

    Java Naming Factory Initial

    The fully qualified name of the factory class that creates the initial context. The initial context is the starting point for JNDI naming operations. 

    Java Naming Security Authentication

    The security level to use in JNDI naming operations. Enter one of the following values: 

    • none: Authentication is not required. Use this for anonymous access.

    • simple: Authentication requires a user name and password. You must enter the security principal and credentials below.

    Java Naming Security Principal

    The DN of the security principal used for connecting to the LDAP server. 

    Java Naming Security Credentials

    The password of the naming security principal. 

    Users ParentDN

    The parent DN of the user entries. This property specifies the root entry of the Users portion of the LDAP directory; for example, ou=People,dc=sun,dc=com.

    UserDN Attribute Name In User

    The name of the attribute in a user entry where the user’s DN is defined. The default value is entrydn, which is the default name for the Sun Java System Directory Server attribute.

    UserId Attribute Name In User

    The name of the naming attribute in each user entry. The default name for this attribute in the Sun Java System Directory Server is uid, but can also be cn.

    Roles Parent DN

    The parent DN of the role entries. This property specifies the root entry of the Roles portion of the LDAP directory; for example, dc=sun,dc=com.

    Role Name Field In RoleDN

    The name of the attribute in a role entry that specifies the name of the role. The default name for this attribute in the Sun Java System Directory Server is cn.

    Role Name Attribute Name In User

    The name of the attribute in a user entry that specifies the DNs of the roles to which a user is assigned. The default value is nsroledn, which is the default attribute name in the Sun Java System Directory Server.

    Group ParentDN

    The parent DN of the group entries. This property specifies the root entry of the Groups portion of the LDAP directory; for example ou=Groups,dc=sun,dc=com.

    Group DN Attribute Name In Group

    The name of the attribute in a group entry that specifies the name of the group. The default value is entrydn, which is the default name for the Sun Java System Directory Server attribute.

    Group Name Field In Group DN

    The name of the attribute in a group entry that specifies the name of the group. The default name for this attribute in the Sun Java System Directory Server is cn.

    Group Of User Filter Under Groups ParentDN

    The LDAP search filter used to retrieve all of a user’s groups. This property follows the syntax supported by the java.text.MessageFormat class with {1} marking where the user’s DN should be inserted. For example, uniquemember={1}.

    UserId Attribute Manager

    The name of the attribute in a user entry that specifies the person the user reports to. The default value is manager, which is the attribute the Sun Java System Directory Server provides for this purpose. You can also use the entrydn for this purpose, or you can create custom attributes to define an upward reporting structure.

    Note: To enable task escalation and re-assignment, this value must be manager and each user entry in the LDAP directory must include a manager attribute that specifies the supervisor by their entrydn.

    UserId Attribute Subordinate

    The name of the attribute in a user entry that specifies the people who report to the user. The default value is directReports, which is not used in the Sun Java System Directory Server. You can use a default attribute for Sun, such as secretary or entrydn, or you can create custom attributes to define the downward reporting structure.

    Note: To enable task escalation and re-assignment, this value must be entrydn and the reporting structure for each user must be defined in their entrydn attribute in the LDAP directory.

    UserId Attribute Email

    The name of the attribute in a user entry that specifies an email address. The default value is mail, which is the attribute the Sun Java System Directory Server provides for this purpose. This is used for email notifications (as defined in the Worklist Manager window for a user activity in the BP).

    UserId Attribute Given Name

    The name of the attribute in a user entry that specifies a user’s first name. The default value is givenName, which is the attribute the Sun Java System Directory Server provides for this purpose. This is used during email notification.

Configuring a Microsoft Active Directory Connection

To use Microsoft Active Directory with the Worklist Manager, you must specify certain information about the LDAP directory structure so the Worklist Manager knows where to find the user information defined in the directory. You can use your existing directory structure as long as there is a mechanism for defining a user reporting hierarchy.

ProcedureTo configure a Microsoft Active Directory connection

  1. From the Environment Explorer tab, right-click the Worklist Manager External System, and then click Properties.

  2. On the properties page that appears, verify that the Connection Parameters property is set to ActiveDirectoryConnection.

  3. Expand WLMConnector External System Configuration, and then click Sun Java System Directory Server/ADS.

    The Properties dialog box appears, as shown in Figure 21.

    Figure 23 Microsoft Active Directory Configuration Properties

    Figure shows the Microsoft Active Directory configuration
properties on the Worklist Manager External System Properties window.

  4. Enter the property values for the properties described in Figure 23.


    Note –

    Depending on how your LDAP directory is set up, not all of these fields are required. The default configuration is not necessarily illustrative of an actual implementation.


  5. Click OK to close the Properties dialog box.

    Property 

    Description 

    Java Naming Provider URL

    The URL of the LDAP server. The format of the URL is ldap://<host>:<port>, where <host> is the name of the computer hosting the LDAP server, and <port> is the port number on which the LDAP server is listening for requests.

    Java Naming Factory Initial

    The fully qualified name of the factory class that creates the initial context. The initial context is the starting point for JNDI naming operations. 

    Java Naming Security Authentication

    The security level to use in JNDI naming operations. Enter one of the following values: 

    • none: Authentication is not required. Use this for anonymous access.

    • simple: Authentication requires a user name and password. You must enter the security principal and credentials below.

    Java Naming Security Principal

    The DN of the security principal used for connecting to the LDAP server.

    Java Naming Security Credentials

    The password of the naming security principal. 

    Users ParentDN

    The parent DN of the user entries. This property specifies the root entry of the Users portion of the LDAP directory; for example, cn=Users,dc=sun,dc=com.

    UserDN Attribute Name In User

    The name of the attribute in a user entry where the user’s DN is defined. If you are using the default schema for Active Directory, enter distinguishedName for this property.

    UserId Attribute Name In User

    The name of the attribute in a user entry that defines the user’s login ID. The default name for this attribute in Active Directory is sAMAccountName.

    Roles ParentDN

    The parent DN of the role entries. This property specifies the root entry of the Roles portion of the LDAP directory; for example, ou=SunRoles, dc=sun,dc=com.

    Role Name Field In RoleDN

    The name of the attribute in a role entry that specifies the name of the role. The default name for this attribute in Active Directory is cn.

    Role Name Attribute Name In User

    The name of the attribute in a user entry that specifies the roles to which a user is assigned. 

    The default value, nsroledn, does not apply to Active Directory. The default attribute used by Active Directory is memberOf.

    Group ParentDN

    The parent DN of the group entries. This property specifies the root entry of the Groups portion of the LDAP directory; for example cn=users,dc=sun,dc=com.

    Group DN Attribute Name In Group

    The name of the attribute in a group entry that specifies the DN of the group. If you are using the default schema for Active Directory, enter distinguishedName for this property.

    Group Name Field In Group DN

    The name of the attribute in a group entry that specifies the name of the group. The default name for this attribute in Active Directory is cn.

    Group Of User Filter Under Groups ParentDN

    The LDAP search filter used to retrieve all of a user’s groups. This property follows the syntax supported by the java.text.MessageFormat class with {1} marking where the user’s DN should be inserted. For example (for Active Directory only), (&(member={1})(objectclass=group)).

    UserId Attribute Manager

    The name of the attribute in a user entry that specifies the person a user reports to. The default value is manager, which is the attribute that Active Directory provides for this purpose. You can also create custom attributes to define a reporting structure.

    UserId Attribute Subordinate

    The name of the attribute in a user entry that specifies the people who report to the user. The default value is directReports, which is the attribute that Active Directory provides for this purpose. In Active Directory, directReports is linked referentially to manager, above.

    UserId Attribute Email

    The name of the user attribute that specifies an email address. The default value is mail, which is the attribute that Active Directory provides for this purpose. This is used for email notifications (as defined in the Worklist Manager window for a user activity in the BP).

    UserId Attribute Given Name

    The name of the user attribute that specifies a user’s first name. The default value is givenName, which is the attribute that Active Directory provides for this purpose. This is used during email notification.