pub.scheduler:addComplexTask

service

String Name of the service you want to schedule for execution on the server.

description

String Text string describing this task.

target

String Server or servers on which the task is to run. (Clustered environments only). Set to:

any to run the task on any server in the cluster. The task will run on only one of the servers.

For example, suppose that all the servers in your cluster share a single database for a parts inventory application, and that a particular function needs to run against that database once a day. Any of the servers can perform this task, therefore you can specify the all option to schedule a task to run on any of the servers.

Note:

There is no predetermined order in which servers in the cluster are selected to run tasks. Rather, the first server to detect that a task is ready to be executed runs it.

For more information about how Integration Server handles the scheduling of tasks in a clustered environment, see the chapter about managing services webMethods Integration Server Administrator’s Guide.

all to run the task on all servers in the cluster.

For example, suppose you run an application on each server in the cluster, and each server maintains its own database for that application. If you need to run a cleanup task against all the databases every day, you can schedule a task to run every day on all the servers in the cluster.

hostname to run the task on a specific server in the cluster.

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 specified with 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.

runAsUser

String Optional. User ID under which the service is to be executed. If you do not specify a user name, the “Default” access rights are used.

inputs

Document Optional. Document (IData object) containing the input to the scheduled service.

Note:

You can also assign values to input parameters of services using the Assign Inputs option while scheduling a task in Integration Server Administrator.

startTime

String Optional. Time at which the task is scheduled to start, in the format HH:mm:ss. If you do not specify a startTime, the current time is used.

startDate

String Optional. Date on which the task is scheduled to start, in the format yyyy/MM/dd. If you do not specify a startDate, the current date is used.

endTime

String Optional. Time at which the task expires, in the format HH:mm:ss. If you do not specify an endTime, the server uses the current time.

endDate

String Optional. Date on which the task expires, in the format yyyy/MM/dd. If you do not specify an endDate, the server executes this service for an indefinite period of time.

months

String List Optional. 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. If you do not specify months, the task will run every month.

hours

String List Optional. Hours at which the task is scheduled to run. Hours are represented by integers between 0 and 23. If you do not specify hours, the task runs every hour.

minutes

String List Optional. Minutes at which the task is scheduled to run. Minutes are represented by integers between 0 and 59. If you do not specify minutes, the task runs every minute.

daysOfMonth

String List Optional. Days of the month on which the task is scheduled to run. Days are represented by integers between 1 and 31. If you do not specify daysOfMonth, the task runs every day of the month.

daysOfWeek

String List Optional. 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. If you do not specify daysOfWeek, the task runs every day of the week.

taskID	String Identification number of the task added to the scheduler.
type	String Code indicating the type of task added. For this type of task, the value of type will be complex.
taskAdded	String Indicates whether the task was successfully added to the Scheduler. If the task was successfully added to the Scheduler, taskAdded contains true. If the task was not successfully added, the server throws an exception and terminates the service.