dox42 SkribbleAction parameters to be used in the server call

Prev Next

In order to use the SkribbleAction in the dox42 Server call, use the action name DigitalSigningCOA.Skribble or create a call with the dox42 Service Designer.

Parameter name

Requirement

Effect

SkribbleAction

mandatory

The action to perform. The available options are:

  • seal

  • signature

  • seal+signature

SkribbleTitle

mandatory for all

According to the Skribble documentation, it should be short and treated like a file name.

SkribbleMessage

mandatory for signature or seal+signature

According to the Skribble documentation, it includes the message which is sent to the signer.

SkribbleQuality

mandatory for signature or seal+signature

According to the Skribble documentation, the available options are:

  • QES (The document must be signed at QES, so every signer must use QES. This is the default level.)

  • AES_MINIMAL(The document will be

    signed with at least AES, but a higher level is preferred. Signers will sign QES, if available, otherwise they will use AES.)

  • AES (The document should be signed with

    AES. Signers will use AES, if available, otherwise they fall back to QES, if available.)

  • SES (The document will be signed with SES by every signer. )

SkribbleLegislation

mandatory for signature or seal+signature

if quality is QES,

AES_MINIMAL or AES

Specifies that the legislation parameter adopts the following values:

  • ZERTES (QES, according to the Swiss law. This is the default value.)

  • EIDAS (QES, according to the EU law)

maxSigners

optional

for signature or seal+signature

Max. number of signers to process placeholders from $$Signer1$$ to $$Signer{maxSigners}$$.

SkribbleCCaddress{1-2}

optional

Given array of e-mail addresses that will be additionally notified upon completed signature request.

SkribbleSigner{0}

optional

for signature or seal+signature

The e-mail address of the signer.

  • You can use as many fields as you want from SkribbleSigner1 to SkribbleSigner{maxSigners}. Not all signers need to sign, but one at least is mandatory.

visualSignatureX

optional

for signature or seal+signature

The X position of the signature (used only if no placeholder $$Signer{}$$ is found in the document).

visualSignatureY

optional

for signature or seal+signature

The Y position of the signature (used only if no placeholder $$Signer{}$$ is found in the document).

  • If there is more than one signer without a placeholder, the different signature fields are placed vertically one above the other, with a space of 5 between two signatures.

visualSignatureWidth

optional

for signature or seal+signature

The desired width of the signature.

  • If not provided, fallback to the value of settings in the web.config; if not defined in the web.config, fallback to 75.

visualSignatureHeight

optional

for signature or seal+signature

The desired height of the signature.

  • If not provided, fallback to the value of settings in the web.config; if not defined in the web.config, fallback to 75.

SkribbleSealImageUrl

optional

for signature or seal+signature

The URL of the seal image with one of the following patterns :

  • C:\temp\seal.png

  • https://www.contoso.com/img/seal.png

visualSealX

optional

for signature or seal+signature

The X position of the seal (used only if no placeholder $$Seal$$ is found in the document).

visualSealY

optional

for signature or seal+signature

The Y position of the seal (used only if no placeholder $$Seal$$ is found in the document).

visualSealWidth

optional

for signature or seal+signature

The desired width of the seal.

  • If not provided, fallback to the value of settings in the web.config; if not defined in the web.config, fallback to 75.

visualSealHeight

optional

for signature or seal+signature

The desired height of the seal.

  • If not provided, fallback to the value of settings in the web.config; if not defined in the web.config, fallback to 75.

Example of SkribbleAction call in dox42 Service Designer