Properties on Jobs
Jobs are available under instance through the task property
server/instance[name = '...']/taskThe available properties are:
| Name | Description | Return type | Typical values |
|---|---|---|---|
| category | The category for this job | Entity | Performance, Availability, Capacity, … |
| 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 |
| classification | If this is a instance or database specific job (Relevant in certain cluster scenarios) | Entity | instance, database |
| company | The publisher of this job | String | dbwatch.no |
| description | A short description explaining what this job does | String | Checks free space on drives where data and transaction …. |
| details | A text describing the current state after the last execution of the job | String | No backup information for 2 database(s) (master, msdb). |
| displayname | The name of the job as an Entity | Entity | Blocking statistics, Data file size check, … |
| enabled | If this job is enabled | String | YES, NO |
| event | A list of entry ids in the dialog section of the notes for this job | List of Entities | 966106e9-1341-458c-b1ef-a49c8b011518, |
| event/author | The author the the note entry | Entity | john.smith |
| event/content | The text content of an note entry | String | A comment on the job |
| event/time | When the note entry was created | Number | 1782369251041 |
| event/eventtype | User or system entry | String | user, system |
| executetime | When the job was last executed | Number | 1782369654987 |
| hasnote | If there is a note for this job | Boolean | true, false |
| historicstatus | List of ids for historic not ok status entries for this job | List of Entities | 1, 2, 3 |
| historicstatus/status | The status | Entity | ALARM, WARNING |
| historicstatus/statustime | When this status occurred | Number | 1704859800667 |
| historicstatus/acknowledged | If this status is acknowledged or not | Boolean | true, false |
| historicstatus/details | The details for this job when the status occurred | String | Drive C: 3.7 GB free space. 7 database(s) affected |
| instance | The instance this job is installed on | Entity | |
| 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 |
| longdescription | A longer description explaining what this job does | String | Checks free space on drives where data and transaction …. |
| maxversion | The max version available for this job | Number | 2.2, NA |
| name | The name of the job | String | Blocking statistics, Data file size check, … |
| 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 |
| packagename | The category for this job | String | Performance, Availability, Capacity |
| parameter | The available configuration parameters for this job | List of Entities | warning_threshold, alarm_threshold, … |
| parameter/name | The name of this parameter | String | keep_data_for |
| parameter/value | The current value for this parameter | String | 7 |
| parameter/defaultvalue | The default value for this parameter | String | 5 |
| parameter/description | The description for this parameter | String | Number of days to provide statistics for. |
| preexecution | Optional FDL that will be executed before the job is executed | String | $task/instance/pg_collector_analyze_job |
| schedule | The current execution schedule of the job | Entity | 5m, 30 * * * |
| status | The current status of this job | Entity | OK, WARNING, ALARM |
| statusnumber | The current status of this job represented by a number | Number | 0, 1,2. |
| statustime | The time the job got its current status in milliseconds since 1970 | Number | 1696935690159 |
| taskid | The id used for the job in the engine framework (for engine jobs) | Number | 12 |
| 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 |
| untilnextrun | The number of milliseconds until this job is scheduled to execute again | Number | 575804 |
| upgradable | If this job is upgradable to a newer version | String | YES, NO |
| version | The current version of the installed job | Number | 1, 1.2 |