IArtifactAuditAddin

Add-in responsible for handling auditable events occurring in the server.

Trigger Event(s): Submit; Create; Access to document data, Sign, Purge, Cancel; Reset; Page change; field change

Table 1. IArtifactAuditAddin interface methods declaration and description
Method	Description
audit	Audit an incoming event
	Parameter	Type	Description
	auditEvent	AuditEvent	Information of the audited event, such as the audited action, date of event etc.

	Returns	Type	Description
	-	-	-

Table 2. *AuditEvent* structure and element description
AuditEvent
Parameter	Type	Description
action	AuditAction	Auditable actions over an artifact
date	Date	Date of the event
user	String	User who caused the event
ip	String	Ip address from where the user caused the event
parentId	String	Unique identifier of the parent process of which this artifact is part of (for future reference)
artifactId	String	Unique identifier of the affected artifact
objectId	String	Unique identifier of the object to be accessed
page	Integer	Page affected by the event (if applicable)
artifactStatus	ArtifactStatus	Status of the artifact at the time of the event (CREATED, PENDING, CANCELLED, SUBMITTED, PURGED)
artifactStep	short	Artifact step when at the time of the event
description	String	Event description

Table 3. Auditable actions
Auditable actions
Action	Description
CREATED	Artifact created
STATUS	Artifact status changed
OPENED	Artifact opened by user
CLOSED	Artifact closed by user
PAGE	Artifact navigated by user
SIGNED	Artifact field signed by user
UNSIGNED	Artifact field unsigned by user
RESET	Artifact reset by user
CHANGED	Artifact field changed by user
TRANSCRIPTION	Added transcription

eSign brings an out-of-the box implementation for this interface that is described below

Table 4. Available implementations for IArtifactAuditAddin
Implementation	Default	Description
DefaultAuditAddin	✓	Does nothing

Configuration

First the add-in needs to be loaded as an extension,

"_comment" : "List all the extensions to be used",
"extensions" :
[
	...

	{
        "name": "artifact-auditing",
        "class": "novabase.connect.paperless.esign.core.extensions.impl.DefaultAuditAddin"
    },

	...
]

Optionally, set as the default add-in by establishing the class path for the type "artifact_audit"

"_comment" : "List all the default addins to be used",
"addins" :
[
    ...

    {
        "type": "artifact_audit",
        "extension": "artifact-auditing"
    },

    ...
]