Skip to main content


class %SYS.Task.IntegrityCheck extends %SYS.Task.Definition

Perform an Integrity Check for all databases. The task will create an output log file, parse the log for errors and report failures in messages.log (which will send email if it's configured).

Property Inventory

Method Inventory


parameter TaskName = IntegrityCheck;
Inherited description: This defines the user-visible name of this task. It is defined in the subclasses.


property Directory as %String [ InitialExpression = $zu(12) ];
The directory where the Integrity Check logs will be kept. Note that the logs here can be automatically purged using the KeepDays property
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property Filename as %String;
The file name to be used for the log. Leaving this blank will cause the file name to be automatically generated in the the format INTEGRIT-YYYYMMDD_sec.LOG. Files which are generated in this format can be automatically purged using the KeepDays property.
Property methods: FilenameDisplayToLogical(), FilenameGet(), FilenameIsValid(), FilenameLogicalToDisplay(), FilenameLogicalToOdbc(), FilenameNormalize(), FilenameSet()
property KeepDays as %Integer [ InitialExpression = 0 ];
Number of days to keep files before puring - 0 means never purge
Property methods: KeepDaysDisplayToLogical(), KeepDaysGet(), KeepDaysIsValid(), KeepDaysLogicalToDisplay(), KeepDaysNormalize(), KeepDaysSet()


method OnTask() as %Status
Execute $$CheckList^Integrity() for all databases. Create an output log file, check for errors and report failure in messages.log. Purge old INTEGRIT-*.LOG files if KeepDays is set.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab