Properties on Jobs
Jobs are available under instance through the task property
server/instance[name = '...']/task
The available properties are:
| Name | Description | Return type | Typical values | Extra |
|---|---|---|---|---|
| name | The name of the job | String | Blocking statistics, Data file size check, … | |
| displayname | The name of the job as an Entity | Entity | Blocking statistics, Data file size check, … | |
| description | A short description explaining what this job does | String | Checks free space on drives where data and transaction …. | |
| longdescription | A longer description explaining what this job does | String | Checks free space on drives where data and transaction …. | |
| status | The current status of this job | Entity | OK, WARNING, ALARM | |
| statusnumber | The current status of this job representet by a number | Number | 0, 1,2. | |
| statustime | The time the job got its current status in milliseconds since 1970 | Number | 1696935690159 | |
| details | A text describing the current state after the last execution of the job | String | No backup information for 2 database(s) (master, msdb). | |
| schedule | The current execution schedule of the job | Entity | 5m, 30 * * * | |
| enabled | If this job is enabled | String | YES, NO | |
| version | The current version of the installed job | Number | 1, 1.2 | |
| maxversion | The max version available for this job | Number | 2.2, NA | |
| upgradable | If this job is upgradable to a newer version | String | YES, NO | |
| category | The category for this job | Entity | Performance, Availability, Capacity, … | |
| nextrun | The next time the job is scheduled to execute | String | 10.okt.2023 17:15:25 | |
| nextruntimestamp | The next time the job is scheduled to execute, in milliseconds since 1970 | Number | 1696950925963 | |
| lastrun | The last time the job was executed. | String | 10.okt.2023 05:10:37 | |
| lastruntimestamp | The last time the job was executed, in milliseconds since 1970 | Number | 1696942841019 | |
| untilnextrun | The number of milliseconds until this job is scheduled to execute again | Number | 575804 | |
| taskid | The id used for the job in the engine framework (for engine jobs) | Number | 12 | |
| company | The publisher of this job | String | dbwatch.no | |
| artifact | The artifact for this job | Entity | com.dbwatch.job:ms_transaction_log_size_check:2.1, com.dbwatch.job:ms_data_cache_memory_usage:1.6 | |
| tasktype | The type of job. (alert = has a status, task = does not have a status) | String | alert, task | |
| unacknowledged | If this job has unacknowledged warning or alarms | String | true, false | |
| parameter | The available configuration parameters for this job | List of Entities | warning_threshold, alarm_threshold, … |