%SYS
IntegrityCheck Class Reference

Perform an Integrity Check for all databases. More...

Inheritance diagram for IntegrityCheck:
Collaboration diagram for IntegrityCheck:

Public Member Functions

_.Library.Status OnTask ()
 Execute $$CheckList^Integrity() for all databases. More...
 
- Public Member Functions inherited from Definition
_.Library.List GetSettings ()
 Return a serialized list of user-defined Property values for an instance of this Task as a $List. More...
 
_.Library.Status OnSubmit (_.Library.String pID, _.Library.String pSubmit)
 This callback is called when this form is submitted. More...
 
_.Library.Status SetSettings (_.Library.List pState)
 Called by the Task Manager prior to running OnTask() to set all Property values. More...
 

Public Attributes

 Directory
 The directory where the Integrity Check logs will be kept. More...
 
 Filename
 The file name to be used for the log. More...
 
 KeepDays
 Number of days to keep files before puring - 0 means never purge. More...
 

Static Public Attributes

 TaskName = None
 Perform an Integrity Check for all databases. More...
 
- Static Public Attributes inherited from Definition
 DOMAIN = None
 This class defines a task that can be executed by the Task Manager. More...
 
 RESOURCE = None
 This specifies a security resource and optional permission. More...
 
 TaskName = None
 This defines the user-visible name of this task. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Definition
_.Library.Boolean CheckPermission (_.Library.String taskClass, _.Library.String namespace, _.Library.Status sc)
 This method checks if the current process has the permission defined by the RESOURCE parameter for the given Task class. More...
 
_.Library.String GetCollectionType (_.Library.String propertyName, _.Library.String tCollection)
 Return a collection type for a property. More...
 
_.Library.String GetTaskName ()
 Returns the localized name of this task.
 

Detailed Description

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

Member Function Documentation

◆ OnTask()

_.Library.Status OnTask ( )

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.

Reimplemented from Definition.

Member Data Documentation

◆ TaskName

TaskName = None
static

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

◆ Directory

Directory

The directory where the Integrity Check logs will be kept.

Note that the logs here can be automatically purged using the KeepDays property  

◆ Filename

Filename

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.  

◆ KeepDays

KeepDays

Number of days to keep files before puring - 0 means never purge.