Configuration of document types

A document type is a group of documents that are always handled in the same way by signotec software. This includes automatically inserting signature fields when loading a document, for example. Such document properties can be defined centrally through document configurations in a PDF.

Document configuration

The document configuration offers the option of assigning special behaviors to certain documents. Such settings can be defined programmatically via the REST web service or centrally in a configuration file.

The name and the location of the configuration file is defined in the settings. If a path to a configuration file has been defined and this file is missing, it will still not lead to an error message. The file must only be populated with a valid JSON structure if it exists. Otherwise, an error will occur when the application starts.

The documentation concerning the JSON structure is a part of the default implementation of the persistence. This can be changed as described in the corresponding section.

Structure of the document configuration file

The document configuration file must contain a JSON array. This contains JSON structures, each of which contains a separate document configuration. When a document is loaded, all available configurations are iterated through and the first one that meets all of the conditions is applied to the document to be loaded.

The file is read when the application is started. signoSign/Universal will not start if the content of the file does not contain a valid JSON array or a JSON element in the array contains an error when the application is launched. Every individual attribute that a document configuration can contain is described below.

Structure of the JSON array in the document configuration file:

[
  {
   /* doc config 1 */
  },
  {
   /* doc config 2 */
  }
]    

Structure of a document configuration

The JSON structure transferred to the application is converted as is into an object that can be used by signoSign/Universal. All possible document configuration attributes are listed below. However, distinctions are still made between selection conditions and actual configurations for the attributes.

Selection conditions

A document configuration contains attributes that act as conditions as to whether or not a configuration is applied to a document. Any number of condition attributes can be specified in a configuration. A configuration is only then applied to a document if all the conditions for a document are met.

documentFileNamePattern

This applies if the specified character string matches the file name of the document to be loaded. The asterisk symbol (*) acts as a wildcard character here.

Example: A configuration that is applied to a document, the transferred file name of which begins with "abc".

[
     {        
         "documentFileNamePattern": "abc*"
     }        
]        

documentIdPattern

This applies if the specified character string matches the document ID of the document to be loaded. The asterisk symbol (*) acts as a wildcard character here.

Example: A configuration that is applied to a document, ID of which begins with "1".

[
     {        
         "documentIdPattern": "1*"
     }        
]        

The document ID may be a non-numeric value if an alternative persistence implementation is used.

documentIdTarget

This applies if the specified character string matches the document ID of the document to be loaded.

Example: A configuration that is applied to a document with the ID 2.

[
     {        
         "documentIdTarget": "2"
     }        
]        

documentOriginTypes

This refers to a bit mask and is specified as an integer value between 1 and 31. This attribute allows configurations to be applied to documents of certain origins.

The following values exist:

• 1 – for templates

• 2 – for editable documents based on templates

• 4 – for all editable documents

• 8 – for imported documents

• 16 – for documents opened via a sharing case

Example: A configuration that is applied to templates and imported documents

[
     {        
         "documentOriginTypes": 9
     }        
]        

Configuration attributes

These are attributes of the configuration that actually influence how the document is handled in the Viewer.

signatureFieldMask

This is a key-value pair that determines which signature fields are displayed and available for signing to the calling user. The key here is the calling user name to which the mask is to apply. The value is a character string and contains identifiers for signature fields that are separated by a semicolon (;). An identifier for signature fields consists of either a page number and tab order or the technical signature field name.

Example: Shows the user "User1" the signature field with the tab order 0 on page 1 and the signature field with the name "SIGNATURE1" when the document is loaded

[
     {        
         "signatureFieldMask": {
             "User1" : "(1,0);SIGNATURE1"
         }
     }        
]

signatureFields

You can also set a field statically or dynamically here. The attribute is a JSON array. This can contain dynamic ("@type":"dynamic",) and static ("@type":"static",) signature fields. Static signature fields are positioned in the document using fixed parameters. Dynamic signature fields can be positioned in the document relative to a position of text. Each signature field comprises a number of attributes. These consist of general and type-dependent attributes.

General signature field attributes

Static signature field attributes

Dynamic signature field attributes

Example: Two signature fields are inserted when the document is loaded. A static field on page 1 and a dynamic field where the text "searchtext" occurs.

[
    {        
      "signatureFields":[
         {
            "@type":"static",
            "option":0,
            "signer":"signer",
            "posX":500,
            "posY":20,
            "width":200,
            "height":50,
            "pageNumber":1
         },         
         {
            "@type":"dynamic",
            "option":0,
            "signer":"string",
            "offsetX":20,
            "offsetY":45,
            "width":200,
            "height":50,
            "keyword":"searchtext",
            "recursive":false
         }
      ]
    }        
]

formFieldProperties

This attribute is a JSON array. Each element defines additional behaviour for individual form fields of certain types. Each element consists of general and type-dependent attributes. The general attributes are used here to identify the relevant form field.

Form field attributes: general

Either the pageNumber and tabOrder or fieldName must be defined to identify a form field. If both are specified, the fieldName takes precedence.

Form field attributes: signatures

Example:

[
    {
        "formFieldProperties":[
            {
                "@type":"signature",
                "fieldName":"string",
                "tabOrder":0,
                "pageNumber":0,
                "shown":true
            }
        ]
    }
]

Form field attributes: check boxes

Attribute	Description	Range of values
padSelectionSignatureField	signoPAD API/Web (version 1.4.1 and later) allows you to transfer check boxes to a hardware pad so you can set them there. This field lets you define whether the check box is to be inserted via the signature device and which signature field it is to appear in front of. A signature field is specified either via the signature field name or page number and tab order. The process happens together with the first signature if an empty character string is transferred. Check boxes connected to a signature field in this way are no longer inserted into the document in a destructive way when it is saved. Check boxes connected to a signature are saved incrementally together with the corresponding signature. In addition, the form field information of this type of check box is also included in the encrypted signature data themselves.	String
padSelectionText	If a check box for setting on a hardware pad is to be defined, a text to be displayed together with the check box on the signature device must also be transferred. The possible length of the text is dependent on the signature device used as the specified text is scaled on the display. This means that the more text that has to be displayed, the smaller the font will be. If several check boxes are defined for a signature, they will appear on the display together, if possible. If this is not possible for technical reasons, the entries will be spread over multiple pages. ‘\n’ is used for a line break in the text.	String
checkRequiredToSignSignatureField	A signature field can also be specified here, just as it can for the padSelectionSignatureField value. The corresponding check box must be ticked to be able to start the signing process for the specified signature field. The process described for the first signing process applies if an empty character string is specified. If this check box is also configured for entry on a hardware pad, the validation process to determine whether the corresponding check box is ticked only runs after confirmation has been given in the dialog box on the hardware pad.	String
checkRequiredToSignSignatureFieldText	If the checkRequiredToSignSignatureField value has been defined, this value is displayed as a notification in the Viewer and the signing process is canceled if the corresponding checkbox has not been ticked.	String
showIndex	An index that determines the sequence for displaying the check box on the pad.	Integer

Example:

[
    {
        "formFieldProperties":[
            {
                "@type":"checkbox",
                "fieldName":"CheckBoxFormFIELD",
                "tabOrder":0,
                "pageNumber":0,
                "padSelectionSignatureField":"signFIELD",
                "padSelectionText":"Lorem ipsum dolor sit amet, consetetur.",
                "checkRequiredToSignSignatureField":"signFIELD",
                "checkRequiredToSignSignatureFieldText":"Lorem ipsum dolor sit amet",
                "showIndex":0
            }
        ]
    }
]

sharingCaseProperties

In this area of the document configuration, you can influence the behavior of documents when they are released or shared. The following attributes are available.

Rejecting and temporarily saving processes can also be controlled globally by persistence.documentSharingRejectable and persistence.persistencedocumentSharingDeferrable.

Example:

[
    {
        "sharingCaseProperties":[
            {
                "completionCallbackURL":"https://signotec.com",
                "rejectable":true,
                "deferrable":false,
            }
        ]
    }
]