Everything within this section is only visible while editing. Use status for "stub" (red) "progress" (yellow) "review" (blue) and "refactor" (grey). Everything contained within the table is displayed in the (INTERNAL) Reports page. | Status | |
|---|
| Priority | 3.0 |
|---|
| Note | published, only the object history - rest of the concept is outstanding |
|---|
| Assignee |
|
|---|
Resources Remarks- Antje: page created
- Antje: table with history codes created
 Needs to be moved to the Document Lifecycle page as subpage - if the DLM page is ready to get published- Heading 1 "Summary" deleted for now - needs to be added later on if the concept is written in detail
- Antje: Cleanup Section startet in the hidden part
Cleanup of the Audit Trail It is possible to delete old audit trail entries by means of the audit cleanup command provided by the Commander service, together with a configuration file ./config/system/cleanupConfiguration.json. The audit field in the JSON file contains the details on the deletion of the audit trail entries using the following parameters: | Parameter | Description |
|---|
defaultCleanupAfterDays | An Integer default value for the cleanupAfterDays parameter. It is valid for any action that is not listed in actions. | actions | Contains a list of mappings of the minimum age of audit trail entry types and the corresponding cleanup timing. | Parameter | Description |
|---|
comment | An optional String parameter for the purpose of help. The value is arbitrary and is not evaluated in the Commander service. | action | The Integer Core API code specifying the audit trail entry type. Only existing values are considered. Not existing values lead to ignoring of the mapping element. | cleanupAfterDays | The Integer minimum age of audit trail entries with the history code action in days. Any entry of type action older than cleanupAfterDays will be deleted when the audit cleanup command is executed. Only values >= 0 are valid. If a negative value is set, audit trail entries of the corresponding type will be never deleted. |
|
In the example configuration below, the defaultCleanupAfterDays parameter implies that all audit trail entries can be deleted after 10 days, if not further specified in actions. However, two mappings are listed in actions overwriting the defaultCleanupAfterDays value for two audit trail entry types. The entries of Core API type 100 have do stay forever and will be never deleted. The entries of Core API type 400 can be deleted already after 1 day. The parameter comment, in this example, contains the indication constant of the audit trail entry type. | Code Block |
|---|
| language | yml |
|---|
| title | Example cleanupConfiguration.json |
|---|
| {
"audit": {
"defaultCleanupAfterDays": 10,
"actions": [
{
"comment": "OBJECT_CREATED",
"action": 100,
"cleanupAfterDays": -1
},
{
"comment": "DOCUMENT_ACCESSED",
"action": 400,
"cleanupAfterDays": 1
}
]
}
} |
When the lifetime of the audit trail entries is exceeded, they are not automatically deleted. The deletion of entries takes place only as a result of the execution of the audit cleanup command in the Commander service AND if the specified lifetime is exceeded. When executed, the command reads the cleanupConfiguration.json file. If the file does not exist, the defaultCleanupAfterDays value is set to -1 and thus no entry will be deleted from the audit trail. To the audit cleanup command, two parameters can be given: | Parameter | Description | Example |
|---|
| -h | --help | Display the help for the command. | audit cleanup -h | | -t | --tenant | Specify the target tenant. If not specified, the command is executed for all tenants. | audit cleanup -t default
(with the example tenant default) |
|