...

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.

Contains a list

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

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 Commander service and 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 actions

Parameter Optional Description

comment action cleanupAfterDays

Code Block

language	yml
title	Example cleanupConfiguration.json

{
	"audit": {
		"defaultCleanupAfterDays": -1,
		"actions": [				
			{
				"comment": "OBJECT_CREATED",
				"action": 100, 
				"cleanupAfterDays": -1
			},
			{
				"comment": "DOCUMENT_ACCESSED",
				"action": 400,
				"cleanupAfterDays": 1
			}			
		]
	}
}

The corresponding command is audit cleanup with two available parameters:

ParameterDescriptionExample-h | --helpDisplay the help for the command.audit cleanup -h-t | --tenantSpecify the target tenant. If not specified, the command is executed for all tenants.

audit cleanup -t default

(with the example tenant default)

When executed, the command reads the configuration

excerpt

Antje: Cleanup Section moved to Commander tooling page

For a cleanup the audit trail, the commander service can be used as a tool to remove audit trail entries.

>>> audit-cleanup Command

Modification History

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

Excerpt

hidden	true

The audit trail is the history protocol of an object, serving to document its total lifecycle. There are many different actions that trigger the creation of a new entry in the respective object's audit trail.

Section

border	true

Column

The audit trail is the history protocol of an object, serving to document its total entire lifecycle. There are many different actions that trigger the creation of a new entry in the respective object's audit trail. In this article, an overview of the different history codes is provided , that can occur in the audit trail.

Anchor

	auditTrail_HistoryCodes
	auditTrail_HistoryCodes

History Codes

The GET "/dms/objects/{id}/history” REST endpoint returns a list of changes made to the object with the id ID {objectId}. The meanings of the individual history codes are listed in the table below.

Core API

Action code

Description

Detail

Constant

Subaction code

Explanation

Endpoints triggering the entry	Description	Explanation
Import:
100

Object created

	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

101

Document created

OBJECT_CREATED_WITH_CONTENT

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

110

/{objectId}/tags/{name}/state/{state}

Object tag created

OBJECT_TAG_CREATED

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

/tags

DELETE /api/dms/objects/{

name

objectId}/

state

versions/{

state}Deletion:200

versionNr} (up to 2023 Summer)

Object irrevocably deleted

OBJECT_DELETED

	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

}/versions/{versionNr

}

202

Object marked for deletion

OBJECT_FLAGGED_FOR_DELETE

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

210

/tags/{name}

Object tag deleted

OBJECT_TAG_DELETED

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

tags

versions/{

name}

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

Index data modified

OBJECT_METADATA_CHANGED

The index data

-

POST /api/dms/objects/{objectId}

PATCH /api/dms/objects/{objectId}

Metadata modified

The metadata of the object or its status was edited using functions of the client or via an update carried out during the import operation.

301

OBJECT_DOCUMENT_CHANGED

-

DELETE /api/dms/objects/{objectId}

api

dms/objects/

objectId

301

Content changed

OBJECT_DOCUMENT_CHANGED

The document was edited using functions of the client or via an update carried out during the import operation.

/api/dms/objects/{objectId}/contents/file

303

Object updated and content moved

OBJECT_UPDATE_CONTENT_MOVED

The object was updated and the document was moved.

-	POST /api/dms/objects/{objectId}/actions/move/ contents/repositories/{repositoryId} POST /api/dms/objects/{objectId}/versions/{versionNr}/ actions/move/contents/repositories/{repositoryId}

310Object tag modifiedOBJECT_TAG_UPDATEDOne of the object's tags was changed.

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

Output content

DOCUMENT_ACCESSED

-

GET /api/dms/objects/{objectId}/contents/file

GET /api/dms/objects/{objectId}/versions/{versionNr}/contents/file

GET /api/dms/objects/{objectId}/contents/renditions/pdf

Output content

The document content was read by the user, printed, or otherwise output. No changes were made

./api/dms/objects/{objectId}/contents/file401Index data retrievedMETADATA_ACCESSEDDie Indexdaten des Objektes wurden zur Ansicht abgerufen.

.

As of 2022 Summer: If a user retrieves the binary content file of the same object version multiple times within 10 minutes, only the first retrieval is documented in the audit trail.

The following processes internally retrieve the object's binary content file and thus trigger the creation of an audit entry as well:

the first retrieval of a PDF rendition after the object creation

401

METADATA_ACCESSED

-

POST /api/dms/objects/search

GET /api/dms/objects/{objectId}

GET /api/dms/objects/{objectId}/versions

402Text preview downloadedRENDITION_TEXT_ACCESSEDThe text rendition of the object's document file was retrieved.

GET /api/dms/objects/{objectId}/contents/renditions/pdf

Metadata retrieved

The object's metadata were retrieved for viewing.

The following processes internally retrieve the object's metadata and thus trigger the creation of an audit entry as well:

each retrieval of a PDF rendition

402

RENDITION_ACCESSED

1

GET /api/dms/objects/{objectId}/contents/renditions/text

Text rendition accessed

Rendition of the binary content accessed.

If a user retrieves the same type of rendition for the same object multiple times within 10 minutes, only the first retrieval is documented in the audit trail.

The subaction specifies the type of rendition

2

GET /api/dms/objects/{objectId}/contents/

renditions/text

renditions/pdf

PDF rendition accessed

Info

icon	false

Read on

Section

Column

width	45%

Retrieving Document History Entries

Insert excerpt

	Retrieving Document History Entries
	Retrieving Document History Entries
nopanel	true

Keep reading

Column

width	45%

Endpoint for retrieving a document's history

This endpoint retrieves the history entries of a DMS object identified by objectId. History entries document modifications of or actions performed on a DMS object. Keep reading

...

Versions Compared

Old Version 37

New Version Current

Key

Table of Contents

History Codes

Read on

Retrieving Document History Entries

Endpoint for retrieving a document's history

Page Comparison

Versions Compared

Old Version 37

New Version Current

Key

Table of Contents

History Codes

Read on

Retrieving Document History Entries

Endpoint for retrieving a document's history