...

repeatedly running the MonitoringJob template using a JS7 - Cycle Instruction,
forwarding health check results to a monitoring solution.
- this can include to forward health check report files when used with a user's monitoring solution.
- this can include to send e-mail indicating a notice or an alert to SOS. Such notices do not include any data related to the user's JS7 environment, they indicate a notice or alert only
  - Alert mails are simplistic like this

The job template makes use of the JS7 - REST Web Service API to retrieve information from the JOC Cockpit.

The job template authenticates with the JS7 - REST Web Service API by use of user account/password and/or by use of a certificate, for details see JS7 - Authentication.
For details about configuration items see JS7 - JITL - Common Authentication.

Display feature availability

StartingFromRelease	2.4.1

...

Name	Required	Purpose	Example
`controller_id`	no	Optionally specifies the identification of the Controller to be checked. By default the current Controller is used.	`controller_prod`
`monitor_report_dir`	yes	Specifies the directory to which the job will store health status report files (.json). The directory has to exist prior to running the job and has to be in reach of the Agent that runs the job. An absolute or relative path can be specified. An expression can be used., for example `env('JS7_AGENT_DATA') ++ '/monitor'`	`env('JS7_AGENT_DATA') ++ '/monitor'` `/var/sos-berlin.com/js7/agent/monitor` `C:\ProgramData\sos-berlin.com\js7\agent\monitor`
`monitor_report_max_files`	yes	The number of report files created will be limited to this value. Older report files will be removed when this value is exceeded	`25`
`from`	yes	Specifies the e-mail address that is used to send mail for notices and alerts. The argument is used by the job to create the `subject` and `body` return variables.	`js7@example.com`

Return Variables

Name	Data Type	Purpose	Example
`monitor_report_date`	String	The date and time for which the health status check has been performed. The date format is `yyyy-MM-dd.HH-mm-ss.K`, for example `2022-07-31.23-12-59.Z` indicating UTC time	`controller_prod`
`monitor_report_file`	String	The path to the report file created for the health status check.
`subject`	String	The subject of an e-mail for use with a later MailJob.
`body`	String	The body of an e-mail for use with a later MailJob, by default the value is the same as for the `subject`.
`result`	Number	The number of problems identified during the health status check. A value 0 indicates absence of problems, other values indicate existence of problems.

Further Resources

...