Parameters
|
name
|
String
Optional. The name of the task. This name appears in various places in the
My webMethods user interface, such as on the
Details
View tab in My Inbox and in the Task Management Results list.
A task does not require a name. If a
name is assigned, it does not need to be unique. Maximum length is 255
characters.
|
|
customTaskID
|
String
Optional. An application-defined identifier for the task. This ID is separate
from the internal taskID that the
Task Engine automatically generates and assigns to a task instance.
The identifier in
customTaskID is visible in the
user interface and is also searchable using the
pub.task.taskclient:searchTasks
service. For example, if a task relates to an order approval process, you might
assign the order number to the
customTaskID.
Note: Although
customTaskID is meant to
uniquely identify a task, the
Task Engine does not enforce uniqueness of the value in this field.
The application is responsible for assigning unique identifiers to
customTaskID if they are
needed.
|
|
assignedTaskList
|
String
List Optional. The IDs of the principals (users or roles on
IBM My webMethods Server) to which this task is assigned. Setting this list
assigns the task to the specified users or roles. The
Task Engine uses this list to route the task to the appropriate
users.
|
|
priority
|
String
Optional. The priority of the task. Must be one of the following values (values
are case-sensitive):
none low medium high critical
|
|
expireDate
|
java.util.Date Optional. The date and time when the
task instance expires. When
expireDate is reached, the
Task Engine automatically switches the
status value for the task to
"expired."
If an expire date is not specified, the
task never expires.
|
|
parentTaskID
|
String. The value of the parent task ID in the case
when tasks are used for collaboration workflow. When queuing a new task, if a
valid taskID is specified for "parentTaskID", the task to be queued is created
as a child task of the parent task. For more information, see
IBM webMethods BPM Task Development Help.
|
|
isMandatory
|
Integer Optional. Specifies if the collaboration task
is a mandatory task. A parent task can be marked as completed only when the
status of all the mandatory child tasks is Completed, Error, Canceled, or
Expired.
|
| taskScheduleDate
|
Date Specifies the date and
time the task should start. The status of the task changes based on the value
specified for
taskScheduleDate.
- If you specify a date that is later
than the current date, the task status will be
Scheduled.
- If you do not specfiy a date, the
task will be
active.
Note: Configure a scheduler rule in
Designer so that the status of a
task changes from
Scheduled
to
active
when the task starts or queues at the scheduled time.
|
|