Integration Server 10.5 | Built-In Services Reference Guide | Scheduler Folder | Summary of Elements in this Folder | pub.scheduler:getTaskInfo
 
pub.scheduler:getTaskInfo
WmPublic. Retrieves information about a task on the Scheduler.
Input Parameters
taskID
String Task identification number.
Output Parameters
type
String Code indicating the task's type. Will be one of the following:
complex
once
repeat
runAsUser
String The user ID whose access rights are used to execute the service.
target
String Server or servers on which the task is to run. (Clustered environments only). A value of:
*$any indicates that the task will run on any, but only one, server in the cluster.
For more information about scheduled tasks in a clustered environment, see the chapter about managing services in webMethods Integration Server Administrator’s Guide.
*$all indicates that the task will run on all servers in a cluster.
When you schedule a task to run on all servers in the cluster, the server divides the task into a main or parent task, and a child task for each server in the cluster. You can perform some actions (activate, suspend, delete) individually on the child tasks, but if you want to change the characteristics of a task, you must do so through the parent task.
For a parent task, this service returns $all in the Target parameter.
For each child task, this service returns the hostname:port on which the task is to run.
For more information about scheduled tasks in a clustered environment, see the chapter about managing services in webMethods Integration Server Administrator’s Guide.
*hostname indicates that the task will run on this particular server. This service returns hostname:port if:
*Your server is running in a cluster, a task was scheduled to run on all servers in the cluster, and this is one of the child tasks. (See the description of $all above.)
*Your server is running in a cluster and you requested a specific server.
*Your server is not running in a cluster.
For more information about scheduled tasks in a clustered environment, see the chapter about managing services in webMethods Integration Server Administrator’s Guide .
description
String Text string describing this task.
lateness
String The number of minutes (after the scheduled execution time) after which the server is to take a special action for a late task. You specify the action to be taken in the latenessAction parameter, described below. The server checks scheduled tasks at startup, and again periodically. If the server finds a task that is overdue and has exceeded the lateness period, the server performs the requested lateness action. If the server finds a task that is overdue but has not yet exceeded the lateness period, the server starts the task immediately.
latenessAction
String Action to take if a task has missed its scheduled start time by a number of minutes you specify in the lateness parameter. Possible actions are:
*run immediately or 0 - Runs the task immediately
*skip and run at next scheduled interval or 1 - Skips this execution of the task and runs it again at the next scheduled run time.
*suspend or 2 - Places the task in a suspended state until an administrator resumes or cancels the task.
service
String Name of the service associated with the task.
nextRun
String Next date and time that the task is scheduled to run. The date and time is expressed as the number of milliseconds from January 1, 1970, 00:00:00 GMT.
execState
String Current state of the task.
Tasks can be in one of the following states:
A value of...
Indicates that...
0
The task is currently active.
1
The task is currently running.
2
The task has been suspended or has expired.
For tasks that are scheduled to run on all servers in the cluster, you might see different statuses among the parent and child tasks. For example, the parent's status might be Active, while one child's status is Active, and another child's status is Suspended.
In general, the status of the parent task will be Active if at least one child task is active or running, Suspended if all child tasks are suspended, or Expired, if all child tasks are expired.
inputs
Document Conditional. Document (IData object) containing the inputs, if any, to the scheduled service.
oneTimeTaskInfo
Document Conditional. Information about the complex task represented by taskID. This parameter is present only if type is once.
Key
Description
date
String Conditional. Date on which to run the task, in yyyy/MM/dd format.
time
String Conditional. Time at which to run the task, in HH:mm:ss format.
repeatingTaskInfo
Document Conditional. Information about the task represented by taskID. This parameter is present only if type is repeat.
Key
Description
interval
String Conditional. Time interval (measured in seconds) between repetitions of the task.
doNotOverlap
String Conditional. Indicates whether recurrences of this task will overlap.
complexTaskInfo
Document Conditional. Information about the task. This parameter is present only if type is complex.
Key
Description
startDate
String Conditional. Date on which the task is scheduled to start, in yyyy/MM/dd format.
startTime
String Conditional. Time at which the task is scheduled to start, in HH:mm:ss format.
endDate
String Conditional. Date on which the task expires, in yyyy/MM/dd format.
endTime
String Conditional. Time at which the task expires, in HH:mm:ss format.
minutes
String List Conditional. Minutes at which the task is scheduled to run. Minutes are represented by integers between 0 and 59.
hours
String List Conditional. Hours when the task is scheduled to run. Hours are represented by integers between 0 and 23.
months
String List Conditional. Months during which the task is scheduled to run. Months are represented by integers between 1 and 12, where “1” indicates January and “12” indicates December.
daysOfWeek
String List Conditional. Days of the week on which the task is scheduled to run. Days are represented by integers between 1 and 7, where “1” indicates Sunday and “7” indicates Saturday.
daysOfMonth
String List Conditional. Days of the month on which the task is scheduled to run. Days are represented by integers between 1 and 31.