Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%SYS] >  [Task] >  [IntegrityCheck]
Private  Storage   

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).

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 2


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
CheckPermission GetCollectionType GetPropertyName GetSettings
GetTaskName OnSubmit OnTask SetSettings


Parameters

• parameter TaskName = "IntegrityCheck";
This defines the user-visible name of this task. It is defined in the 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 messages.log. Purge old INTEGRIT-*.LOG files if KeepDays is set.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.