Page Comparison

...

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.

audit cleanup -t default

(with the example tenant default)

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:

Contains a list of mappings of the minimum age of audit trail entry types and the corresponding cleanup timing.

Page Properties

hidden	true

Status

colour Grey

title REFActure

Priority 3.0

id	REFACTURE

Product Version
Report Note	published, only the object history - rest of the concept is outstanding
Assignee

Resources & Remarks

Remarks

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.

Parameter Description

defaultCleanupAfterDays An Integer default value for the cleanupAfterDays parameter. It is valid for any action that is not listed in actions.

actions

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.

Name	Date	Product Version	Action
Antje	08 FEB 2021	2.4	New page properties macro.
Antje	03 JAN 2022	2022 Spring	restoring added (325)
Antje	23 NOV 2022	2022 Winter	post text rendition (306) added
Antje	28 NOV 2022	2022 Winter	restructure table

Detail	Subaction code	Endpoints triggering the entry	Description	Explanation
Import:
100

	OBJECT_CREATED	-	POST /api/dms/objects	Object created	The specified object was created by functions of the client or by an import.
101	OBJECT_CREATED_WITH_CONTENT	-	POST /api/dms/objects

The object was created using functions of the client or via an import operation.
110	OBJECT_TAG_CREATED: [<`name`>, <`state`>]	<state>	POST /api/dms/objects

	A tag for the object was created.
Deletion:
200	OBJECT_DELETED	-	DELETE /api/dms/objects/{objectId}

Versions Compared

Old Version 46

New Version Current

Key

History Codes

Read on

Retrieving Document History Entries

Endpoint for retrieving a document's history

The object was deleted and cannot be restored.
201 (as of 2023 Summer)	OBJECT_CONTENT_DELETED	-	DELETE /api/dms/objects/{objectId}/contents/file	Binary content of the object is removed.	A new object version was created that has no `contentStreams` section anymore.
202	OBJECT_FLAGGED_FOR_DELETE	-	DELETE /api/dms/objects/{objectId}

	The object was moved to the recycle bin.
210	OBJECT_TAG_DELETED: [<`name`>, <`state`>]	<state>	DELETE /api/dms/objects/{objectId}

A tag for the object was deleted.
220	VERSION_DELETED: [<versionNr>]	-	DELETE /api/dms/objects/{objectId}/

versionNr} (as of 2023 Autumn)	Object version deleted.	The object version was deleted and cannot be restored.
Update:
300

	Object updated and content moved	The object was updated and the document was moved.
306 (as of 2022 Winter)	RENDITION_CHANGED	1	POST /api/dms/objects/{objectId}/contents/renditions/text	Text rendition added/updated.	A rendition of the binary content file of a DMS object was added or updated via endpoint. The subaction specifies the type of rendition.
310	OBJECT_TAG_UPDATED: [<`name`>, <`state`>]	-	POST /api/dms/objects/{objectId}/tags/{name}/state/{state}?overwrite=true POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>	Object tag modified	One of the object's tags was changed.
325	OBJECT_RESTORED_FROM_VERSION: [<`versionNr`>]	-	POST /api/dms/objects/{objectId}/versions/{versionNr}/actions/restore	Object restored from an old version	The data of the old object version were used to update the current object version.
340	DOCUMENT_MOVED	-	POST /api/dms/objects/{objectId} PATCH /api/dms/objects/{objectId}	`system:parentId` property modified	The value for the `system:parentId` property was modified (added, updated, removed). Additionally, an audit entry with action 300 was created.
Retrieve:
400