IArtifactAccessAddin

Add-in responsible for determining who has access write to each field of a document. For instance, if a developer can perform a signature on a field based on some criteria (like a role).

Trigger Event(s): Submit; Access to document data, Sign, Purge, Cancel
Table 1. IArtifactAccessAddin interface methods declaration and description
Method Description

hasAccess

Determines if a given user is authorized to access a given artifact property

Parameter

Type

Description

objectId

String

Unique identifier of the object to be accessed

details

ArtifactDetails

Context of the artifact (artifact variables and properties) with read-only access

Returns

Type

Description

result

boolean

True when the user has access to the artifact property identified by objectId

eSign brings an out-of-the box implementation for this interface that is described below
Table 2. Available implementations for IArtifactAccessAddin
Implementation Default Description

DefaultArtifactFieldAccessAddin

Determines if a given user is authorized to access a given artifact property, based on the "owner" properties specified when creating the document (for more information check the Create Document.)

Configuration

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

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

	{
        "name": "artifact-field-access",
		"class": "novabase.connect.paperless.esign.core.extensions.impl.DefaultArtifactFieldAccessAddin"
    },

	...
]

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

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

    {
        "type": "artifact_access",
		"extension": "artifact-field-access"
    },

    ...
]