class HcJob

+-SystemFunctions

+-HealthCheckM

+-HcJob

+-HcJobScheduler [0..1]

Represents a health check job which can be executed on a ME.
This class facilitates in executing one or more categories of health check rules.
After each job execution the attributes 'lastUpdateTime' and 'lastStatus' in HealthCheckM MOC are updated accordingly.
It is possible to execute the job on demand or by a scheduler.
A report file is generated for each executed health check job and stored in the predefined folder with a compressed archive file containing logs used for the rules evaluation to be used for further investigation.

References from:: HcJob; HealthCheckM;
References to:: HcJob;

Actions

void

execute ( string exportUri , EcimPasswordString exportPassword );: Executes the health check job.
This action executes the health check job, executing the rules for the configured categories, and optionally exports the report file.; Parameters

Name: exportUri
Description: Specifies the URI where the job execution output file is to be exported.
This URI must not contain the file name, that is specified by 'lastReportFileName' attribute value.

The generic URI syntax is defined by RFC 3986. The URI must not contain any password. (The password must be provided in the second parameter of this action).
The URI may be local relative (e.g., data/dir/subdir/), or local absolute (e.g., file:///data/dir/subdir/), or remote (sftp://user@hostname/dir/subdir/).
If the URI is local absolute, report and logs archive files are stored under the provided local path.
If the URI is local relative, report and logs archive files are stored under the file system path built chaining the value of localFileStorePath attribute with the provided relative path.
If the URI is remote, report and logs archive files are stored under the provided remote path.
Note: HTTP based URIs are not supported.

Name: exportPassword
Description: Specifies the password required to access the location specified by the URI.
This parameter is considered only if a SFTP URI is provided, otherwise it is ignored.

Attributes
`FailedHcRule[0..] nonUnique readOnly`	`failedRules` Provides a condensed status for the last job execution. Provides the list of the rules for which the result was not the expected one. It is empty when job status is healthy or not available.
`string key mandatory noNotification restricted`	`hcJobId` Holds the name used when identifying the MO. Specifies the name of the health check job.
`HcRuleParameter[0..] nonUnique`	`inputParameters` Specifies customizable input parameters for rules evaluation. Each item in the list is a triple <hcRule, parameter_name, parameter_value> for which a user-defined attribute can be provided.
`HcJob[0..1]`	`jobToTrigger` Specifies the DN of another job to be executed when the current job reports ME is not healthy. The execution of another job, for instance to execute rules associated to different categories, might give more detailed information about NE status.
`string[0..1] noNotification readOnly`	`lastReportFileName` Specifies the name of the report file which is generated from the latest execution of the job. All the report files are placed in a predefined folder, as indicated by the 'localFileStorePath' attribute value. An archive containing some log files is generated as well. The name format of the report file generated is <MEId>_<JobName>_<Timestamp>. Timestamp is in the format YYYYMMDDTHHmmSS, where 4 digits for the year, 2 digits for the month, 2 digits for the date, 2 digits for the hours, 2 digits for the minutes and 2 digits for the seconds are specified. 'T' acts as a delimiter between date and time in the above timestamp format. If the job is executed by the action, the suffix "_man" is added at the end of the file name.
`DateTime[0..1] readOnly`	`lastRunTime` Specifies the date and time of the last time the job has been executed.
`string[0..1] noNotification readOnly`	`localFileStorePath` Specifies the filesystem path where the ouput report files can be fetched. It is empty if FileM is not installed/configured.
`AsyncActionProgress[0..1] readOnly`	`progressReport` Specifies the execution status and result of the health check job.
`HcCategory[1..] mandatory`	`rulesCategories` Specifies the list of categories of health check rules to be executed.
`HealthStatus readOnly`	`status = NOT_AVAILABLE` Specifies the health status based on result of all executed rules.

class HcJob