In addition to workflow servlet beans, the configuration for each new workflow type typically includes a request-scoped component of class atg.workflow.servlet.WorkflowTaskFormHandler
. This form handler is used to perform workflow task operations such as setting a task’s owner and firing outcomes.
Read-only properties
The WorkflowTaskFormHandler
class has four properties that together uniquely identify the task being operated on by the form handler: processName
, segmentName
, subjectId
, and taskElementId
. It also has the following read-only properties that can be accessed once the task’s identifying information has been specified:
Property | Description |
---|---|
|
|
| list of |
|
|
Submit methods
The form handler’s submit methods operate on the task on behalf of the WorkflowView
associated with the form. The following submit methods are supported:
Submit Method | Description |
---|---|
| Sets the task’s priority to the value of the |
| Sets the task’s owner to the |
| Claims the task on behalf of the current user’s view |
| Releases the task on behalf of the current user’s view |
| Fires the task outcome identified by the |
The following properties of the WorkflowTaskFormHandler
are typically set in the properties file for this component:
Property | Description |
---|---|
|
|
| Session-scoped |
|
|
| Workflow subject item type |
| Name of the class to use when instantiating the object to be returned by the |
The following properties are typically set in the JSP:
Property | Description |
---|---|
| Name of the workflow process |
| Name of the workflow process segment |
| Repository ID of the workflow subject |
| ID of the workflow element of the task |
| New priority value to be set by the |
| Unique |
| ID of the outcome element to be fired by the |
| flag indicating whether the workflow subject should be updated when the submit methods are executed (see below for details) |
Navigation properties
The WorkflowTaskFormHandler
also has a set of properties that are used to control navigation after a form operation has been completed. These properties specify the URLs to redirect to on certain error and success conditions. If the value for a particular condition is not set, the form is left on the page defined as the action for that form (in other words, no redirect takes place). Each operation has its own successURL
and errorURL
properties. Thus the following properties are available:
setTaskPrioritySuccessURL
setTaskPriorityErrorURL
setTaskOwnerSuccessURL
setTaskOwnerErrorURL
claimTaskSuccessURL
claimTaskErrorURL
releaseTaskSuccessURL
releaseTaskErrorURL
fireOutcomeSuccessURL
fireOutcomeErrorURL
These properties can be set in the properties file of the form handler or by hidden tags in the JSP.