IAnalyticsAddin

Whenever an analytics entry is stored in the repository the same entry is given to the IAnalyticsAddin implementation as to make any use of that information. Any changes made to the object received will not affect the analytics repository entry.

Trigger Event(s): When given events occur like creating a document or signing a document, among others.

Table 1. IAnalyticsAddin interface methods declaration and description
Method	Description
storeArtifactAnalytics	Receives the information regarding the artifact analytics event
	Parameter	Type	Description
	artifactAnalytics	ArtifactAnalytics	Object containing all of its analytics entry information

	Returns	Type	Description
	-	-	-
storeSignatureAnalytics	Receives the information regarding the signature analytics event
	Parameter	Type	Description
	signatureAnalytics	SignatureAnalytics	Object containing all of its analytics entry information

	Returns	Type	Description
	-	-	-
storeUserAnalytics	Receives the information regarding the user session analytics event
	Parameter	Type	Description
	userAnalytics	UserAnalytics	Object containing all of its analytics entry information

	Returns	Type	Description
	-	-	-

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

Table 2. Available implementations for IAnalyticsAddin
Implementation	Default	Description
DefaultAnalyticsAddin	✓	Provides a point of interaction with the analytic events

Configuration

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

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

	{
        "name": "analytics-addin",
        "class": "novabase.connect.paperless.esign.core.extensions.impl.DefaultAnalyticsAddin"

    },

	...
]

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

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

    {
        "type": "analytics",
        "extension": "analytics-addin"
    },

    ...
]