%SYS.Task.IntegrityCheck

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 cconsole.log (which will send email if it's configured).

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 1

Summary

Properties
%RunDate %RunTime Directory Filename KeepDays
Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
GetCollectionType GetPropertyName GetSettings GetTaskName
OnSubmit OnTask SetSettings

Parameters

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

Properties

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 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 KeepDays as %Integer [ InitialExpression = 0 ];
Number of days to keep files before puring - 0 means never purge

Methods

method OnTask() as %Status
Execute $$CheckList^Integrity() for all databases. Create an output log file, check for errors and report failure in cconsole.log. Purge old INTEGRIT-*.LOG files if KeepDays is set.
Copyright © 1997-2020 InterSystems Corporation, Cambridge, MA