Contents


Introduction

About This Guide

Overview of Process Builder Components
Using Process Builder
Advanced Scripting and Setting Up Searching
Sample Applications
Reference Material

Assumptions
Conventions Used in This Guide
Viewing Documentation Online
For More Information

Chapter 1 Overview of iPlanet Process Manager

Workflow in Business Processes
Designing a Process
Performing Tasks in a Process
Administering Processes
Summary of Process Manager Components

Chapter 2 Introduction to Process Builder

About Processes and Process Builder

What is a Process?
What is Process Builder?
Who Should Use Process Builder?
What is a Process Instance?

About Applications

Creating an Application
Deploying an Application
Sample Applications

Starting Process Builder

The preferences.ini File
Starting Process Builder on Windows NT
Starting Process Builder on Solaris

Using Process Builder

Process Builder Applications
Application Tree View
Process Map
Map Palette
Messages Window
Main Toolbar
Menu Commands
HTML Page Editor Toolbar

Chapter 3 Planning an Application

Planning Overview
Planning the Process Map

Entry Points
User Activities
Automated Activities
Custom Activities
Subprocesses
Decision Points
Parallel Processing
Exit Points
Transitions
Notifications
Exceptions

Planning Assignments

Planning Groups and Roles
Planning for Monitoring
Planning Delegations

Determining the Data Requirements

File Attachments

Planning Forms

Planning Access to Forms

Planning Custom Scripts
Planning Searches
Planning Deployment

Chapter 4 Creating an Application

Application Creation Overview
Getting Information from the Administrator
Creating a New Application

The New Application Dialog Box
Setting Application Properties
The Application Properties Dialog Box

Using Sample Applications

Applications and the Corporate Directory
Setting Your Corporate Directory

Deleting an Application

Chapter 5 Designing a Process Map

Drawing the Process Map
Saving a Process Map to a File
Adding Items with the Palette
Deleting Items
Entry Points
User Activities

Setting Activity Expirations
Setting Activity Assignments
Using Parallel Approval

Automated Activities
Subprocesses

Connecting the Parent and Child Process

Custom Activities

Using a Custom Activity
Custom Activity Inspector Window
Inspector Window After Setting a Custom Activity
Adding a Custom Palette

Exception Manager

Default Exception Manager
Creating an Exception Manager
Exception Manager Properties

Decision Points
Split-Join (Parallel Processing)

Properties of a Parallel Process
Adding a Parallel Process

Notifications

Notification Properties
Built-in Email Notification Scripts

Exit Points
Transitions

Types of Transitions
Adding a Transition
Transition Properties
Example Using a True/False Field

Chapter 6 Defining Groups and Roles

Groups and Roles Overview

Default Groups and Roles

Creating Groups and Roles

The Create a New Role or Group Dialog Box
The Application Group Dialog Box
The Corporate Group Dialog Box
The Dynamic Group Dialog Box
The Field Role Dialog Box

Prioritizing Groups and Roles
Deleting Groups and Roles

Chapter 7 Defining Data Fields

Data Field Overview
Creating a Data Field

The Create a New Data Field Dialog Box

Setting Field Properties
Custom Data Fields with Predefined Class IDs

CheckBox
Computed
Date
DateTime
Digital Signature
File Attachment
Password
Radio Buttons
Select List
TextArea
TextField
URL
UserPicker Widget

Custom Data Fields with Your Own Class ID
Predefined Data Fields

Address
Name
Telephone

Deleting Data Fields
Setting Up the Content Store

The Content Store Inspector Window
Troubleshooting the Content Store

Chapter 8 Designing Forms

Planning Forms
Creating Forms
Modifying Forms

Using Process Builder's Form Editor
Using an External Editor
Using the HTML Page Editor Toolbar
Using the Edit, Insert and Format Menus
Using Right-Mouse-Button Menu Commands
Changing Field Properties for a Form
Hints for Setting Field Properties
Accessing the Data Dictionary
Using Scripts to Validate User Input

Adding a Banner to Forms
Setting Access to Forms

Forms for Assignees
Forms for Monitoring the Process
Forms for the Administrator
Setting Access to an Entry Point

Chapter 9 Using Scripts

Overview of Scripts

Kinds of Scripts
When to Use Scripts
About Writing Scripts

Predefined Scripts

Assignment Scripts
Completion Scripts
Email Notification Scripts
Initialization and Shutdown Scripts

Creating Scripts

The Script Editor Window
Setting a Script as a Template

Using Client-side Scripts

Chapter 10 Deploying an Application

Before You Deploy

Set up and Configure Process Manager
Deploy Subprocesses First
Save the Process Map, If Desired
Fix Application Errors

Steps for Deploying an Application
The Deploy Application Dialog Box
Revising a Deployed Application

Summary of Allowed Revisions
Deployed Applications Compared with Local Copies
Using a Backup of a Local Application
Saving a Local Application to Another Name

Redeploying an Application

Chapter 11 Advanced Techniques for Scripting

Introduction
Getting Information about the Current Process

Getting and Setting Data Field Values
Getting Data Field Values in Decision Point and Automation Script Transitions

Getting Information about Users and their Attributes

Finding Users and Accessing their Attributes
Modifying User Attributes
Adding and Deleting Users

Accessing the Content Store

Example of Accessing a Stored Item
Storing Files in the Content Store

Logging Error and Informational Messages
Verifying Form Input

Verifying Form Input with Client-Side JavaScript
Verifying Form Data in Completion Scripts

Initializing and Shutting Down Applications
Debugging Hints

Undefined Items
Adding Helpful Messages to Script Failure Dialog Boxes
Displaying the Progress of a Script
Testing Expiration Setter and Handler Scripts

Sample Scripts

Assignment Script
Expiration Setter Script
Expiration Handler Script
Completion Script
Automation Script

Chapter 12 Scripting with EJB Components

Calling EJB Components from JavaScript
A Sample Script
Handling Exceptions
Data Conversion Issues

Chapter 13 Setting Up Searching

Types of Searching

Global Searching
Application-Specific Searching

Enabling Searching

Allowing a Group to Search
Setting Up Forms
Allowing Searching for Fields

Chapter 14 The Data Sheet Application

Data Sheet Application Overview
Data Sheet Process Map
Data Sheet Walkthrough

The Data Sheet Entry Point
Add Art Activity
The Automated Activity
The Approve Pricing (Product Manager) Activity
The VP Approval Decision Point
The Approve Price (VP) Activity
Exit Points

Groups and Roles
Data Dictionary
Forms
Script Dictionary
Content Store
Finished Data Sheet Example

The description.txt File
The image.gif File
The printer.html Template File
The Finished Data Sheet

Configuring the Data Sheet Application

Configuration Hints
Adding an Email Attribute for a User
Using File Attachments and Content Stores

Chapter 15 The Office Setup Application

Office Setup Application Overview
Office Setup Process Map
Office Setup Walkthrough

Start Entry Point
Assign Office and Specify Computer Work Item
Basic Setup Split
Set Up Phone Work Item
Install Network Connection Work Item
Order Computer Work Item
Install Computer Work Item
Basic Setup Join
CheckSetup Work Item
Setup Complete Exit Point

The Office Setup Groups
Data Dictionary
Form Dictionary
Script Dictionary

Completion Scripts
Toolkit Scripts
Embedded Client-Side Script

Customizing the Appearance of the Forms
Configuring the Office Setup Application

Chapter 16 The Loan Management and Credit History Applications

Loan Management Application Overview
Credit History Application Overview
Loan Management Process Map
Credit History Process Map
Loan Management and Credit History Walkthrough

New Loan Request Entry Point
Verification Work Item
Check Credit History Subprocess
Credit History Application as a Subprocess
Check Authorization Work Item
LookUp Credit History Automated Activity
Canceled Exit Point
OK Exit Point
Meeting Work Item (Parent Process)
Loan Refused Exit Point
Loan Approved Exit Point

Groups and Roles
Data Dictionary
Loan Management Script Dictionary

storeCreditInformation Completion Script
CustomerId Toolkit Script

Credit History Script Dictionary

LookUpCreditHistory Automation Script

Configuring the Loan Management Application
Configuring the Credit History Application

Chapter 17 The Insurance Claim Processing Application

Application Overview
Process Map

Entry Point
Activities
Custom Activities
Decision Point
Exit Points

Application Walkthrough

The Entry Point (Enter Policy No.)
Custom Activity (Look Up Details)
Activity (Policy Details)
Activity (Re-enter Policy No.)
Activity (Enter Claim Details)
Activity (Confirmation)
Activity (Approver)
Activity (Clarification)
Activity (Inform Customer)
Parallel Activities
Activity (Send Check)
Custom Activity (Update Log)

Groups and Roles

Group and Role Priorities

Data Dictionary
Forms
Script Dictionary

Expiration Scripts
Completion Scripts

Required Files

The database.xml File
The Policy.log File
The Banner Image
The Background Image

Configuring the Insurance Claim Processing Application
Custom Activity Code

The LogPerformer Activity
The LogdenialPerformer Activity
The LookupPerformer Activity
Code Walkthrough for LookupPerformer.java

Appendix A JavaScript API Reference

ProcessInstance

getConclusion
getCreationDate
getCreatorUser
getData
getEntityKey
getEntryNodeName
getExitNodeName()
getInstanceId ()
getPriority
getRoleUser
getTitle
setData
setEntityKey
setPriority
setRoleById
setTitle

WorkItem

addUserAssignee
addRoleAssignee
expire
extend
assignees
getCreationDate
getCurrentActivityCN
getExpirationDate
hasExpired
isStateActive
isStateRunning
isStateSuspended
moveTo
removeAssignees
resume
setExpirationDate
suspend

ContentStore

copy
download
exists
getBaseURL
getBaseURL
getBaseURL
getContent
getException
getRootURL
getSize
getStatus
getVersion
initialize
isException
list
mkdir
move
remove
rmdir
store
upload

CorporateDirectory

addUser
deleteUserByCN
deleteUserByDN
deleteUserById
getUserByCN
getUserByDN
getUserById
modifyUserByCN
modifyUserByDN
modifyUserById

User

getUserId

Logging and Error Handling Global Functions

logErrorMsg
logHistoryMsg
logInfoMsg
logSecurityMsg
setErrorMsg

Assignment, Completion, and Email Scripts

checkParallelApproval
defaultNotificationHeader
defaultNotificationSubject
emailById
emailOfAssignees
emailOfCreator
emailOfRole
randomToGroup
toCreator
toGroup
toManagerOf
toManagerOfCreator
toManagerOfRole
toParallelApproval
toUserById
toUserFromField

Miscellaneous Global Functions

ejbLookup
evaluateTemplate
expireIn
getAction
getApplicationName
getApplicationPath
getApplicationPrettyName
getBaseForFileName
getConnector
getContentStore ()
getCreatorUserId
getCorporateDirectory
__getIncludePath
getJndiNamingContext
getProcessInstance
getSubProcessInstance
getWorkItem
__includeFile
mapTo
mount
setConnector
__setIncludePath
setRedirectionURL
url_OnDisplayHistory
url_OnDisplayProcessInstance
url_OnDisplayWorklist
url_OnListApplications
url_OnListEntryNodes

Alphabetical Summary of JavaScript Methods and Functions

Appendix B Migrating from Previous Releases

Migrating from PAE 4.0 to Process Manager 6.0

Assignment Function Changes

Migrating from Process Manager 1.x to Process Manager 6.0

Getting Started
Importing an Application to Process Builder
Migrating SSJS-specific Objects
Migrating Custom Fields

Appendix C Reserved Words Glossary

Index