IArtifactFieldChangeAddin

Add-in responsible for triggering events when edit actions are called upon document fields.

Trigger Event(s): Document edited

Table 1. *IArtifactFieldChangeAddin* interface methods declaration and description
Method	Description
signed	Triggered after a field is signed
	Parameter	Type	Description
	fieldId	String	Identifier of the addressed field
	artifactDetails	ArtifactDetails	Context of the artifact (artifact variables and properties) with read-only access

	Returns	Type	Description
	-	-	-
unsigned	Triggered after a field is unsigned
	Parameter	Type	Description
	fieldId	String	Identifier of the addressed field
	artifactDetails	ArtifactDetails	Context of the artifact (artifact variables and properties) with read-only access

	Returns	Type	Description
	-	-	-
changed	Triggered after a field’s content changes
	Parameter	Type	Description
	fieldId	String	Identifier of the addressed field
	artifactDetails	ArtifactDetails	Context of the artifact (artifact variables and properties) with read-only access

	Returns	Type	Description
	-	-	-

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

Table 2. Available implementations for IArtifactFieldChangeAddin
Implementation	Default	Description
DefaultArtifactFieldChangeAddin	✓	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-field-changed",
        "class": "novabase.connect.paperless.esign.core.extensions.impl.DefaultArtifactFieldChangedAddin"
    },

	...
]

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

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

    {
        "type": "artifact_field_changed",
        "extension": "artifact-field-changed"
    },

    ...
]