Protocol Service

When archiving documents and components, the protocol service writes these accesses into a protocol database.

The protocol reader service provides a REST API to inspect the protocol written.

The following configurations are independent from the specific configured service:

<repo>.protocolservice.document.properties

These Properties are directly from the saved document and show the state at the time of protocol creation (in ArchiveLink Component, CMIS document, ILM Ressource). Not all properties are always filled, e.g. expirationdate is only filled when retention is used.

Value	Description

Value	Description
`starttime`	Start Time of the operation
`endtime`	Time the operation was finished
`requestid`	internal request id, reqmains the samen, when internaly multiple operations happen at the same time (e.g. two components are created in ArchiveLink)
`path`	logical path for the file
`id`	protocol id, unique to each entry
`repository`	repositoryId
`status`	Status of the operation (Success, error, etc.)
`message`	usually specific error message
`command`	kind of operation, one of:`create, read, update, delete, info, admin, unknown, query, supplementary`
`subcommand`	subcommand within an command, e.g. within a create a viruscan could be performend which results in subcommand `scangetrequests`
`object`	type of the object: document or container
`module`	Usually `ContentServer` can be customized https://kgs-software.atlassian.net/wiki/spaces/DOCUEN/pages/3894935555
`client`	ip of the client that initiated the request
`user`	user that initiated the request, when supported or systemuser that runs the application
`objectid`	internal repository wide unique id of the object
`contentLength`	length of the original document
`contentType`	Type of the document as delivered by the client
`contentDisposition`	content disposition header as delivered by the client (usually (`attachment; filename*=UTF-8''data`)
`contentDigest`	Hash of the file
`contentDigestAlgorithm`	Algorithm of the hash value of the original document
`encryptedcontentdigest`	additional hash when the document is stored encrypted
`contentEncoding`	Encoding when delivered by the client
`creationTime`	Time the document was created
`modificationTime`	Time the document was modified
`creationUser`	user that initiated the request, when supported or systemuser that runs the application
`sourceFilename`	Original name of the file, when delivered with `Content-Disposition` Header, or componentid in ArchiveLink
`bucket`	Azure Container name or S3 bucket name
`repositoryname`	External repository name (e.g. FI, HR …)
`name`	name of the document (usually data)
`metadefinion`	only for CMIS supplementary requests
`metatype`	addocument for document, adfolder for folder
`expirationdate`	expirationdate, when retention is used
`destructiondate`	destructiondate, when retention is used
`node`	node on that the request is running (e.g. Hostname)
`statuscode`	Statuscode of the operation, usually like a http status code

<repo>.protocolservice.container.properties

These Properties are directly from the saved folder and show the state at the time of protocol creation (in ArchiveLink Document, CMIS folder/container, ILM Collection)

Value	Description

Value	Description
`starttime`	Start Time of the operation
`endtime`	Time the operation was finished
`requestid`	internal request id, reqmains the samen, when internaly multiple operations happen at the same time (e.g. two components are created in ArchiveLink)
`path`	logical path for the file
`id`	protocol id, unique to each entry
`repository`	repository
`status`	Status of the operation (Success, error, etc.)
`message`	usually specific error message
`command`	kind of operation, one of:`create, read, update, delete, info, admin, unknown, query, supplementary`
`module`	Usually `ContentServer` can be customized https://kgs-software.atlassian.net/wiki/spaces/DOCUEN/pages/3894935555
`statuscode`	Statuscode of the operation, usually like a http status code
`node`	node on that the request is running (e.g. Hostname)
`repositoryname`	External repository name (e.g. FI, HR …)
`subcommand`	subcommand within an operation, e.g. within a create a viruscan could be performend which results in subcommand `scangetrequests`
`name`	name of the document (usually data)
`client`	ip of the client that initiated the request
`user`	user that initiated the request, when supported or systemuser that runs the application
`object`	type of the object: document or container

<repo>.protocolservice.additional.properties

These properties are not directly attached to an object but are tied to the request:

Value	Description

Value	Description
`traceid`	The MDC value the is used for the request
`virusscanerror`	If the virusscan service is used, outcome of the virusscan is stored in this field