generateDescription

generateDescription(): TimeStamp;

The generateDescription method of the JadeAuditAccess class creates a description file containing a list of the names and required metadata of all schemas, classes, and properties.

This serverExecution method extracts the metadata from your JADE environment and writes a list of the names and required metadata of all schemas, classes, and properties to the description file. The file is in the format required by the loadDescription method. The description file name is generated as description<timestamp>.txt, where the <timestamp> value is the current date and time in the format yyyyMMddhhmmss.

The location of the generated file is specified by the JournalRootDirectory parameter in the [PersistentDb] section of the JADE initialization file. If this parameter is not set, the default location is the root journal directory.

This generateDescription function is invoked automatically (depending on the values of the EnableDeltaLogging and UseJournalDescriptions parameters in the [PersistentDb] section of the JADE initialization file) at the end of any reorganization or by calling this method from your JADE code.

The description file is automatically created only when the EnableDeltaLogging parameter and the UseJournalDescriptions parameter in the [PersistentDb] section of the JADE initialization file are set to true.

As this method updates the database and is audited, the process that calls it must be in transaction state.