Task Engine 10.11 | Task Engine Webhelp | webMethods Task Engine API and Service Reference | Using the Task Engine Built-in Services | pub.task.taskclient:queueTask
 
pub.task.taskclient:queueTask
WmTaskClient. Service that adds a task instance to the Task Engine's queue.
Input Parameters
user
String Optional. The user ID of the My webMethods Server user on whose behalf this service will execute.
If user is not specified, the user ID associated with the WmTaskClient package is used. For information about configuring this user ID, see the PDF publication webMethods Task Engine User’s Guide.
taskTypeID
String Specifies the type of task that you want to queue. Each task type that is deployed on the Task Engine has a unique ID. This ID is assigned by the developer when he or she creates a task application using Software AG Designer.
If you do not know the ID for the task type that you want to queue, contact the administrator of the Task Engine to which Integration Server is connected. An administrator can obtain a list of the task types deployed on the Task Engine by viewing the Task Configuration panel on the Task Engine Administration page in My webMethods.
Task type IDs are case-sensitive. The ID in taskTypeID must exactly match the ID as it is specified on the Task Engine.
TaskQueueInfo
Document Optional. A TaskQueueInfo document containing basic information about the task (e.g., name, priority, start date, list of users to which the task is assigned). See pub.task:TaskQueueInfo for a description of the fields in this document.
TaskData
Document Optional. The business data, if any, associated with this task. TaskData does not have a specified structure. Its content varies according to the task.
CallbackServiceName
String Optional. The name of a service on this Integration Server that will execute when the task ends (that is, when the status of the task changes to "completed," "cancelled," "expired," or "error").
Example: customer.accounts:closeAccount
The signature of the callback service must match the specification described in pub.task:TaskCallbackService.
CallbackData
Document Optional. Any data that you want the task to pass back to the callback service.
ruleSet
String Optional. The name of the rule set to be applied for this task. This must match one of the rule set names defined for the task in the Task Editor of Software AG Designer. When a rule set is specified, then assignments and events for the specified rule set only will be executed for this task instance
retryOnFailure Count
String Optional. Specifies the number of times to attempt to invoke the service. The default is 0 times. When specified, this value will override the configuration value set on the WmTaskClient Home page in IS Administrator.
retryDelay
String Optional. Specifies the number of milliseconds to wait between attempts. The default is 1000 ms (this field is ignored if retryOnFailureCount = 0). When specified, this value will override the configuration value set on the WmTaskClient Home page in IS Administrator
Output Parameters
taskID
String The unique identifier that the Task Engine assigns to the task.
Usage Notes
The user ID specified in user must have permission to queue tasks on the Task Engine. If the supplied ID does not have this permission, an exception is generated.
If the date specified in taskScheduleDate is later than the current date, the status of the task will be set to scheduled. When the task starts or queues at the scheduled time, the global rule for task schedule changes the status of the task from scheduled to active.