SiteScheduledJobs (Component)
The SiteScheduledJobs object provides information on site level jobs that are scheduled. It also lets you 'unschedule' a job. The returned data includes information about the last time a job was run.
Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)
Customization is not supported for this component.
Methods:
changeJobDefinitionState | Changes the state of the specified job definition. |
cloneJob [L] | Clones the specified Scheduled Job to run on a specified server. |
create [L] | Create a new scheduled job. |
delete [L] | Deletes the specified scheduled job. |
deleteJobDefinition [L] | Deletes the specified Job definition, plus any Scheduled Jobs that were created from it. |
getDefaultProperties | The name of the job to return default properties for. |
getID | Returns the id of the scheduled job based on the display name. |
getJobDefinitionDialogXML | Returns the XML that describes the job definition. |
getJobDefinitions | Returns a list of jobs available to be scheduled. |
getLastRunStatus | Returns zero or more structures, each containing information on a site scheduled job's last run on each server. |
getList | Returns zero or more structures, each containing information on a site's scheduled jobs. |
getProperties | Retrieves information about the specified scheduled job's properties. |
getSchedule | Retrieves information about the specified scheduled job's schedule and server on which it runs. |
importJobDefinition [L] | Imports the definition of a job definition. Either creates a new Job Definition or updates an existing Job Definition. |
refreshJobCredentials | Updates credentials for all scheduled jobs owned by the current site. |
saveProperties [L] | Saves information about the specified scheduled job's properties. |
saveSchedule [L] | Saves the information about the specified scheduled job's schedule and server on which it runs. |
synchronizeJobs [L] | Synchronize jobs on all servers. |
validateProperties | Validates a scheduled job's properties. If the properties do not validate, an exception will be thrown. |