iPlanet Process Manager, Version 6.5 Process Builder's Guide |
ContentsAbout This Manual
Overview of Process Builder Components
Conventions Used in This Manual
Using Process Builder
Advanced Scripting and Setting Up Searching
Sample Applications
Reference Material
Viewing Documentation
For More Information
Chapter 1 Overview of iPlanet Process ManagerWorkflow in Business Processes
Designing a Process
Performing Tasks in a Process
Administering Processes
Summary of Process Manager Components
Chapter 2 Introduction to Process BuilderAbout Processes and Process Builder
What is a Process?
About Applications
What is Process Builder?
Who Should Use Process Builder?
What is a Process Instance?
Creating an Application
Configuring Builder for Secure Deployment
Deploying an Application
Sample Applications
About https Deployment Support for Process Builder
Configuring Builder for Deployment Through a Proxy
Configuring the Server (iWS and iPM)
Enabling Content Store Over https
Configuring Builder for Internationalization Support
Enabling Non-ASCII Character Display in Builder
Starting Process Builder
Enabling the InputMethodEditor for Non-ASCII Character Display in Builder
Operating Character Set Changes
Configuring Locale Settings for Applications Using Mulitbyte Characters
Editing the preferences.ini File
Using Process Builder
Specifying a Cluster
Starting Process Builder on Windows NT
Specifying a Corporate Directory
Adding or Changing Local Application Folders
Starting Process Builder on Solaris
Process Builder Applications
Application Tree View
Process Map
Map Palette
Activities Tab
Messages Window
Documentation Tab
Main Toolbar
Menu Commands
Application
HTML Page Editor Toolbar
Edit
Insert
Format
Window
Help
Chapter 3 Planning an ApplicationPlanning Overview
Planning the Process Map
Entry Points
Planning Assignments
User Activities
Automated Activities
Custom Activities
Subprocesses
Decision Points
Parallel Processing
Exit Points
Transitions
Notifications
Exceptions
Planning Groups and Roles
Determining the Data Requirements
Planning for Monitoring
Planning Delegations
File Attachments
Planning Forms
Planning Access to Forms
Planning Custom Scripts
Planning Searches
Planning Deployment
Chapter 4 Creating an ApplicationApplication Creation Overview
Getting Information from the Administrator
Creating a New Application
The New Application Dialog Box
Using Sample Applications
Setting Application Properties
The Application Properties Dialog Box
Applications and the Corporate Directory
Deleting an Application
Setting Your Corporate Directory
Chapter 5 Designing a Process MapDrawing the Process Map
Saving a Process Map to a File
Adding Items with the Map Palette
Deleting Items
Entry Points
User Activities
Setting Activity Expirations
Automated Activities
Setting Activity Assignments
Using Parallel Approval
Parallel Approval Completion Script
Subprocesses
Connecting the Parent and Child Process
Custom Activities
Using a Custom Activity
Exception Manager
Custom Activity Inspector Window
Inspector Window After Setting a Custom Activity
Adding a Custom Palette
Default Exception Manager
Decision Points
Creating an Exception Manager
Exception Manager Properties
Split-Join (Parallel Processing)
Properties of a Parallel Process
Notifications
Adding a Parallel Process
Notification Properties
Exit Points
Built-in Email Notification Scripts
Transitions
Types of Transitions
Adding a Transition
Transition Properties
Setting the Property for a Virtual Transition
Example Using a True/False Field
Setting the Property for a Conditional Transition
Chapter 6 Defining Groups and RolesGroups and Roles Overview
Default Groups and Roles
Creating Groups and Roles
The Create a New Role or Group Dialog Box
Prioritizing Groups and Roles
Types of Groups and Roles
The Application Group Dialog Box
Adding a New Group or Role
The Corporate Group Dialog Box
The Dynamic Group Dialog Box
The Field Role Dialog Box
Deleting Groups and Roles
Chapter 7 Defining Data FieldsData Field Overview
Creating a Data Field
The Create a New Data Field Dialog Box
Setting Field Properties
Creating a Custom Data Field
Creating a Predefined Data Field
Adding a Data Field
Custom Data Fields with Predefined Class IDs
CheckBox
Custom Data Fields with Your Own Class ID
Computed
Date
DateTime
Digital Signature
File Attachment
Usage Tips for File Attachments
Password
File Attachment Properties
Radio Buttons
Select List
TextArea
TextField
URL
UserPicker Widget
Predefined Data Fields
Address
Deleting Data Fields
Name
Telephone
Setting Up the Content Store
The Content Store Inspector Window
Troubleshooting the Content Store
Chapter 8 Designing FormsPlanning Forms
Creating Forms
Modifying Forms
Using Process Builder's Form Editor
Adding a Banner to Forms
Using an External Editor
Using the HTML Page Editor Toolbar
Using the Edit, Insert and Format Menus
Edit
Using Right-Mouse-Button Menu Commands
Insert HTML Element
Format
Changing Field Properties for a Form
Hints for Setting Field Properties
Accessing the Data Dictionary
Using Scripts to Validate User Input
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 ScriptsOverview of Scripts
Kinds of Scripts
Predefined Scripts
When to Use Scripts
About Writing Scripts
Assignment Scripts
Predefined
Completion Scripts
Verification Scripts
Email Notification Scripts
Creating Scripts
defaultNotificationHeader()
Initialization and Shutdown Scripts
defaultNotificationSubject()
emailById(userId)
emailOfAssignees()
emailOfCreator()
emailOfRole(role)
The Script Editor Window
Using Client-side Scripts
Setting a Script as a Template
Chapter 10 Deploying an ApplicationBefore You Deploy
Set up and Configure iPlanet Process Manager
Steps for Deploying an Application
Deploy Subprocesses First
Save the Process Map, If Desired
Fix Application Errors
The Deploy Application Dialog Box
Revising a Deployed Application
Summary of Allowed Revisions
Redeploying an Application
Changes to Activities and Transitions
Deployed Applications Compared with Local Copies
Changes to Data Elements
Changes to Forms, Scripts, and Content Store
Using a Backup of a Local Application
Saving a Local Application to Another Name
Deploying an Application to More Than One Cluster on the Same Machine
Deploying Applications with the Command Line Deploy Tool
Deploying an Application with the pmdeploy Command
A Typical Deployment Descriptor .dd File
Syntax for pmdeploy
Chapter 11 Advanced Techniques for ScriptingIntroduction
Getting Information about the Current Process
Getting and Setting Data Field Values
Getting Information about Users and their Attributes
Getting Data Field Values in Decision Point and Automation Script Transitions
Finding Users and Accessing their Attributes
Accessing the Content Store
Modifying User Attributes
Adding and Deleting Users
Example of Accessing a Stored Item
Logging Error and Informational Messages
Storing Files in the Content Store
Verifying Form Input
Verifying Form Input with Client-Side JavaScript
Initializing and Shutting Down Applications
Event Handler Example
Verifying Form Data in Completion Scripts
onSubmitForm Example
Debugging Hints
Displaying the Progress of a Script
Sample Scripts
Testing Expiration Setter and Handler Scripts
Assignment Script
Expiration Setter Script
Expiration Handler Script
Completion Script
Automation Script
Chapter 12 Scripting with EJB ComponentsCalling EJB Components from JavaScript
A Sample Script
Handling Exceptions
Data Conversion Issues
Adding EJB References to a Process Manager Application
Adding iAS EJB References to a Process Manager Application
Adding iAS EJB References
Adding EJB References to an Application Using the Command Line Deploy Tool
Chapter 13 Setting Up SearchingTypes of Searching
Global Searching
Enabling Searching
Application-Specific Searching
Allowing a Group to Search
Setting Up Forms
Allowing Searching for Fields
Chapter 14 The Data Sheet ApplicationData Sheet Application Overview
Data Sheet Process Map
Data Sheet Walkthrough
The Data Sheet Entry Point
Groups and Roles
The Title Field
Add Art Activity
Assignment Script
The Automated Activity
Expiration Setter Script
The Forms
The Approve Pricing (Product Manager) Activity
Assignment Script
The VP Approval Decision Point
Forms
Notification
The Approve Price (VP) Activity
Assignment Script
Exit Points
Forms
Data Dictionary
Forms
Script Dictionary
Content Store
The buildDS Script
The lookupCode Script
The buildDataSheet Script
The computeTitle Script
Finished Data Sheet Example
The description.txt File
Configuring the Data Sheet Application
The image.gif File
The printer.html Template File
The Finished Data Sheet
Configuration Hints
How Users Access the Data Sheet
Adding an Email Attribute for a User
Process Express and iPlanet Application Server
Using File Attachments and Content Stores
Step 1: Administer the Web Server
Step 2: Edit the Access Control List
Step 3: Assign the Content Store's Style
Step 4: Optionally, Add a Directory to the Web Server
Step 5: Set the Values for the Application's Content Store
Chapter 15 The Office Setup ApplicationOffice Setup Application Overview
Office Setup Process Map
Office Setup Walkthrough
Start Entry Point
The Office Setup Groups
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
Data Dictionary
Form Dictionary
Script Dictionary
Completion Scripts
Customizing the Appearance of the Forms
setRequesterField
Toolkit Scripts
verifySetup
buildExitNotification
Embedded Client-Side Script
Configuring the Office Setup Application
Advanced Office Setup Application
Chapter 16 The Loan Management and Credit History ApplicationsLoan 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
Groups and Roles
Verification Work Item
Check Credit History Subprocess
Check Credit History Subprocess Properties
Credit History Application as a Subprocess
Data Mapping
Completion Script
The Subprocess Failed Exception Manager
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
Data Dictionary
Loan Management Script Dictionary
storeCreditInformation Completion Script
Credit History Script Dictionary
CustomerId Toolkit Script
LookUpCreditHistory Automation Script
Configuring the Loan Management Application
Configuring the Credit History Application
Chapter 17 The Insurance Claim Processing ApplicationApplication Overview
Process Map
Entry Point
Application Walkthrough
Activities
Custom Activities
Look Up Details
Decision Point
Update Log
Log Denial
Exit Points
The Entry Point (Enter Policy No.)
Groups and Roles
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)
Group and Role Priorities
Data Dictionary
Forms
Script Dictionary
Entry.html
Resubmit.html
Details.html
EnterClaim.html
Confirmation.html
Approver.html
Clarify.html
InfCustomer.html
SendCheck.html
ClaimApproved.html
ClaimDenied.html
ExpirationExit.html
Expiration Scripts
Required Files
Script at Policy Details Activity
Completion Scripts
Script at Enter Claim Details Activity
Script at Confirmation
Script at Resubmit Policy No.
Completion Script at Policy Details Activity
Completion Script at Enter Claim Details Activity
The database.xml File
Configuring the Insurance Claim Processing Application
The Policy.log File
The Banner Image
The Background Image
Custom Activity Code
The LogPerformer Activity
The LogdenialPerformer Activity
The LookupPerformer Activity
Code Walkthrough for LookupPerformer.java
Definitions and Packages
The init, perform, and destroy Methods
The GetPolicy Method
Appendix A JavaScript API ReferenceProcessInstance
getCreationDate
WorkItem
getCreatorUser
getData
getEntityKey
getEntryNodeName
getExitNodeName
getInstanceId
getPriority
getRoleUser
getTitle
setData
setEntityKey
setRoleById
addUserAssignee
ContentStore
addGroupAssignee
assignees
extend
getCreationDate
getExpirationDate
getNodeName
hasExpired
isStateActive
isStateRunning
isStateSuspended
isUserAssignee
moveTo
removeAssignees
resume
setExpirationDate
suspend
copy
CorporateDirectory
download
exists
getBaseURL
getBaseURL
getBaseURL
getContent
getException
getRootURL
getSize
getStatus
getVersion
initialize
isException
list
mkdir
move
remove
rmdir
store
upload
addUser
User
deleteUserByCN
deleteUserByDN
deleteUserById
getUserByCN
getUserByDN
getUserById
modifyUserByCN
modifyUserByDN
modifyUserById
getUserId
Logging and Error Handling Global Functions
logErrorMsg
Assignment, Completion, and Email Scripts
logHistoryMsg
logInfoMsg
logSecurityMsg
checkParallelApproval
Miscellaneous Global Functions
defaultNotificationHeader
defaultNotificationSubject
emailById
emailOfAssignees
emailOfCreator
emailOfRole
randomToGroup
toCreator
toGroup
toManagerOf
toManagerOfCreator
toManagerOfRole
toParallelApproval
toUserById
toUserFromField
ejbLookup
Miscellaneous Global Fu
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
Alphabetical Summary of JavaScript Methods and Functions
url_OnListApplications
url_OnListEntryNodes
Appendix B Reserved Words