IArtifactSubmitAddin

Add-in responsible for implementing actions to be performed when a document is submitted.

Trigger Event(s): Document submission

Table 1. *IArtifactSubmitAddin* interface methods declaration and description
Method	Description
submitArtifact	Submits an artifact
	Parameter	Type	Description
	artifactDetails	ArtifactDetails	Context of the artifact (artifact variables and properties) with read-only access

	Returns	Type	Description
	result	boolean	True if submit was successful, otherwise false
submitStep	Change step in artifact
	Parameter	Type	Description
	artifactDetails	ArtifactDetails	Context of the artifact (artifact variables and properties) with read-only access
	step	short	Artifact step

	Returns	Type	Description
	result	boolean	True if change step is allowed, otherwise false

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

Table 2. Available implementations for IArtifactSubmitAddin
Implementation	Default	Description
DefaultArtifactSubmitAddin	✓	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-submit",
        "class": "novabase.connect.paperless.esign.core.extensions.impl.DefaultArtifactSubmitAddin"
    },

	...
]

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

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

    {
        "type": "artifact_submit",
        "extension": "artifact-submit"
    },

    ...
]