...
Page Properties |
---|
| 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 | Status |
---|
---|
colour | Grey |
---|
title | REFActure |
---|
Priority | 3.0 |
---|
| 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 audit cleanup command provided by 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 | 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 | 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 (OBJECT_CREATED) have do stay forever and will be never deleted. The entries of Core API type 400 can be deleted already after 1 days.
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
}
]
}
} |
The corresponding command is audit cleanup
with two available parameters:
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 ) |
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 |
---|
|
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 |
---|
|
Column |
---|
Table of Contents Table of Contents |
---|
exclude | (Table of Contents|Read on|Another Tutorial|Another Concept Article|Another interesting Tutorial|Retrieving Document History Entries|Endpoint for retrieving a document's history) |
---|
|
|
|
...
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 APIExplanationDescription | Constant | Detail | Subaction code | Endpoints triggering the entry | Description | Explanation |
---|
Import: |
100 |
Object created101 | 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 |
110OBJECT_TAG_CREATED | /tagsnamestatestate}Deletion: |
200 | versionNr} (up to 2023 Summer) | Object irrevocably deleted |
OBJECT_DELETED | /versions/{versionNr}202 | Object marked for deletion |
OBJECT_FLAGGED_FOR_DELETE210 | OBJECT_TAG_DELETEDtagsname}versionNr} (as of 2023 Autumn) | Object version deleted. | The object version was deleted and cannot be restored. |
Update: |
300 |
Index data modified | index data 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/dmsobjects/objectId301 | 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
Object updated and content moved | OBJECT_UPDATE_CONTENT_MOVED |
The object was updated and the document was moved. | 310 | Object tag modified | OBJECT_TAG_UPDATED | One of the object's tags was changed. | Output content./api/dms/objects/{objectId}/contents/file | 401 | Index data retrieved | METADATA_ACCESSED | Die Indexdaten des Objektes wurden zur Ansicht abgerufen. | 402 | Text preview downloaded | RENDITION_TEXT_ACCESSED | The text rendition of the object's document file was 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 Info |
---|
|
Read on
Section |
---|
Column |
---|
| Insert excerpt |
---|
| Retrieving Document History Entries |
---|
| Retrieving Document History Entries |
---|
nopanel | true |
---|
| Keep reading
|
Column |
---|
| 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
|
|
|
...