This case leads you through the process of the API call to prepare an envelope. Generally this call helps you to prepare all steps and the whole configuration for an envelope you want to send later.

Table of Contents

The Story

A car seller is in the final step of selling the car to a customer. He/She creates the contract and adds all the features, that the car will later include, in the document. In order not to overwrite the signature field with text, the seller has created a dynamic field so that the signature field is dynamically placed on the page.

Use Case Description

In a car sales, it is likely that with additional features, which should be installed in the new car, the signature field in the contract is not always on the same position (page 1) but on the second or third. Therefore, it makes sense to place dynamic placeholders. Exactly this case will be described here.

...

Image Removed

Integration

Advanced Document Tags

Advanced document tags are a solution to define interactive form elements in a PDF document by inserting text placeholders. Such advanced document tags are considered in following use cases:

Creating a draft or template from eSignAnyWhere WebUI
Creating a draft or sending an envelope via eSignAnyWhere API by using the prepare-method for document parsing.

Info

title	Alternatives

eSignAnyWhere is offering following alternatives to insert interactive elements:

Prepare a PDF document with Acrobat Form Fields (simple field types such as text input can be defined e.g. with OpenOffice; signature fields can be inserted with Adobe Acrobat Pro.
Form Fields can't be assigned automatically to the proper signer. Less options for configuration.
Use the simpler sig-string notation as plain-text within the PDF document
Sig strings are supported also by other products of Namirial (xyzmo Client, etc). Fields created via sig strings can't be assigned automatically to the proper signer. Less options for configuration. Benefit is the freely

defineable

definable start (and optional end) marker string.
Define the fields entirely in the envelope JSON

or XML

structures when creating a draft or sending an envelope via API

Dimension limitation

Info

Please note that if the height or width of the advanced document tag exceeds the size (width and height) of the document following notification will be displayed:

Image Removed

Dimenstion Limitations Image Added

General Syntax

Info

title	Recommendations for correct parsing

Note that the Advanced Document Tag must be placed in a single-line within your document. No word wrap (also no automatic word wrap) must happen within your document tag. To ensure that parsing the document tag works fine, use a small, but not too small, font. We recommend to use a sans-serif font (e.g. Arial) in the advanced document tag and use a font size of 4pt to avoid issues with unexpected spaces being inserted between characters during parsing.

Info

title	Measurement unit

The measurement unit for e.g. width or height is pixel

The advanced document tag starts with two opening square brackets ("[["), followed by the field definition parameters which are separated by the colon (":"). The advanced document tag ends with two closing square brackets ("]]").

The first field definition parameter is the field name (optionally prefixed by a quantifier ("!" or "*").

The 2nd field definition parameter is the assignment.

Then, attributed element definitions follow.

The first element definition is the field type, attributed in brackets ("(" and ")") with parameters of the field.

Additional element definitions such as labels, default text, font setting, sizing or offset may follow.

Parameters

`!`	required (optional)
`*`	read only (optional)
`fieldname`	String (required)
`:signer1`	Assigned to signer; “signer” or “signer1”, “signer2”, … (required)
`:objecttype`	Type, e.g. signature, combobox, … (mandatory)
`:property`	additional parameters (allow using of some short notation (e.g. l,r,c instead left, right, center, …))

Signature Fields

Note: The following signature types are supported: Click2Sign, Draw2Sign, Type2Sign, RemoteSignature, BiometricSignature, LocalCertificateSignature, DisposableCertificate, OtpSignature (as of October 2019, eSAW 3.6)

...

and additionally SwissComOnDemandCertificate since eSAW 21.

...

27.

Sample for Click2Sign and Draw2Sign

[[!sigField1:signer1:signature(sigType="Click2Sign,Draw2Sign",batch=1):label("some label"):size(width=150,height=60)]]
sigType, batch, label, size are optional.

Sample for Automatic Remote Signature
Note: To use an automatic remote signature you must have the role “Automatic Sealing Sender” enabled, otherwise you are not able to proceed.

[[!sig1:signer1:signature(sigType="AutomaticRemoteSignature"):size(height=50):label("some label")]]

Sample for SwissComOnDemandCertificate Signature

[[!sigField1:signer1:signature(sigType="SwissComOnDemandCertificate"):label("some label"):size(width=150,height=60)]]

Form Fields

Attachments

[[myAttachment:signer:attachment:label("some label"):size(width=10,height=10)]]

label, size are optional.

Textfield

Info

Please note: If a textfield has a default text configured and is set "required" the textfield will be considered as "already filled". This means that it is possible to finish the envelope without explicitely typing data into the textfield.

[[*myText:signer2:text(maxLength=100,password=1,multiline=true):default("default text"):font(name=Arial, color=#FF0000, size=12):alignment(left):size(width=10,height=10)]]

maxLength, password, default, font, alignment (left|right|center), size, multi-line are optional

Code Block

language	java
theme	Eclipse

 "Range": {
                 "From": "-300,00 €",
                 "To": "5.000,00 €"
          },

You can type in any numbers. If you define the same number for “FROM” and “TO” you can only type in the given number. For example if you define 400,00 for “FROM” and “TO” the recipient can only type in this number into the Text Field.

Input Validation Image Modified

The (optional) input validation definition might be helpful to limit the user input to the expected values. Also check the workstep configuration documentation for accepted formats.

Date

Requires a date field for signer1

[[!someDate:signer1:date(format="dd. MMMM yyyy"):range(from="13. März 2018",to="18. December 2019")]]

range is optional and must match with defined format

Email
- optional for email field
- ```
[[someMail:signer:email()]]
```
Number
- ```
[[someNumber:signer:number(decimalPlaces=2,decimalSeparator=comma,thousandsSeparator=point,symbol="€",symbolLocation=endWithBlank):range(from="-300,00 €",to="5.000,00 €")]]
```
- range, decimalSeparator, thousandsSeparator, symbol, symbolLocation, are optional
- decimalSeparator: comma, point, apostrophe, none
- thousandsSeparator: comma, point, apostrophe, blank, none
- symbolLocation: start, startWithBlank, end, endWithBlank
- range must match with defined format
phone
- ```
[[somePhone:signer:phone(type=international)]]
```
- type: international, internationalLeadingZero, internationalLeadingPlus

time

[[someTime:signer:time(format="HH:mm"):range(from="12:00",to="18:00")]]

range is optional
range must match the defined format

Checkbox

A required checked checkbox is for only one signer.

...

[[*myText:signer2:text(maxLength=100,password=1,multiline=true):default("default text"):font(name=Arial, color=#FF0000, size=12):alignment(left):size(width=10,height=10)

...

]]

checked, size is optional.

maxLength, password, default, font, alignment (left|right|center), size, multi-line are optional.

Checkbox

A required checked checkbox is for only one signer.

[[!chk1:signer:checkbox:size(width=10,height=10):checked]]

checked, size is optional.

RadioButton

All items of a group have to have the same name. Group of three RadioButtons for one recipient:

[[testRbnGroup:signer:radio(Red):size(width=10,height=10):checked]]
[[testRbnGroup:signer:radio(Green):size(width=10,height=10)]]
[[testRbnGroup:signer:radio(Blue):size(width=10,height=10)]]

checked, size is optional.

[[myDrop:signer:dropdown(options="Red,Green,Blue",values="R,G,B",editable=1):default("R"):font(name=Arial, color=#FF0000, size=12):alignment(left):size(width=10,height=10)]]

values, editable, default, size, font, alignment (left|right|center) are optional.

List

[[myList:signer:list(options="Red,Green,Blue",values="R,G,B",multiSelect=1):default("R"):font(name=Arial, color=#FF0000, size=12):alignment(left):size(width=10,height=10)]]

values, multiSelect, default, size, font, alignment (left|right|center) are optional.

Offset

You can define a offset by using

:offset(x=-10.5,y=-50.6)

The offset starts at the lower left position, is using points as units and numbers (double) as input. A positive x value moves to right and a positive y value moves up. Note: this is support eSAW version 3.0+.

Variables

Use to reuse some fragments and allow an easier placement of the text markup into floating text.

Definition:

[[#myFontSettings=:font(name=Arial, color=#FF0000, size=12):alignment(left)]]

Usage:

[[myList:signer:list(options="Red,Green,Blue",values="R,G,B",multiSelect=1):default("R")$myFontSettings:size(width=10,height=10)]]

In the next section you can find a input validation example for REST. With this configuration only numbers from -300,00 to 5.000,00 are allowed in the Textfield.

Code Block

language	java
theme	Eclipse

 "Range": {
                 "From": "-300,00 €",
                 "To": "5.000,00 €"
          },

you can type in any numbers. If you define the same number for “FROM” and “TO” you can only type in the given number. For example if you define 400,00 for “FROM” and “TO” the recipient can only type in this number into the Text Field.

The following steps (including the optional use of the advanced document tag) are necessary for the API call:

...

Workflow

The following steps (including the optional use of the advanced document tag) are necessary for the API call:

Prepare a document with advanced document tags
1. First, create or prepare a document with advanced document tags. These tags are placeholders within the document that will be replaced with specific data or values. Make sure to format the tags correctly so that they can be recognized and replaced appropriately.
Upload document
1. Start by uploading the prepared document that contains the advanced document tags using the appropriate API endpoint. Make sure to note the FileId returned from this call as you will need it later.
Prepare file
1. Before sending the document, you need to prepare the file. Please see JSON configuration below. With this configuration it is possible to clear the advanced document tags from the document with this variable set to true: ClearAdvancedDocumentTags
  This will remove any existing advanced document tags from the document.
Define recipient
1. Define the specific recipient for the envelope, as in a standard envelope sending process. Proved recipient details such as name, email, and any other relevant information.
Send envelope
1. Now, with the document prepared and the recipient defined, send the envelope using the send envelope api call. Use the FileId obtained from the initial document upload call to associate the correct document with the envelope.

...

Please also see the developer mode for this tutorial here: Visit the developer mode.

Prepare a document with advanced document tags

For this case you can use the following document which includes one text field and one checkbox:

Download the

...

document advanced_document.pdf.

Upload the document

Make sure you upload a document which contains advanced document tags to see the differences in preparing the envelope.

Preparing the

...

file

If you are using the Advanced Tags via API you have to call

...

file/prepare to use them.

...

Method	REST endpoint
POST	https://demo.esignanywhere.net/api/v6/file/prepare

For this call you need the File Id which you got from the upload file call

...

and the following sample configuration:

steps descriptor.

The next configurations show you sample workstep configuration.

Section

Code Block

language	java
theme	Eclipse

{
  "

SspFileIds

FileIds": [
    "

##FILE-ID##

string"
  ],
  "

AdHocWorkstepConfiguration

ClearAdvancedDocumentTags":

{ "WorkstepLabel": "string"

true,

SmallTextZoomFactorPercent": 0, "WorkstepTimeToLiveInMinutes": 0, "FinishAction": { "ClientActions": [

SigStringConfigurations": [

RemoveDocumentFromRecentDocumentList

StartPattern":

true,

CallClientActionOnlyAfterSuccessfulSync

string"

: true

ClientName

EndPattern": "string",

CloseApp

ClearSigString": true,

Action

SearchEntireWordOnly":

"string"

true

}
  ]
}

Sending the envelope

You can now add the configuration you get as response from the prepare call to your send envelope call and send the document to recipients.

Available configurations

Expand

title	All available configurations

Code Block

language	java
theme	Eclipse

{
    "UnassignedElements": {    ]
    },
    "NoSequenceEnforcedTextBoxes": true[],
        "SigTemplateCheckBoxes": {[],
        "SizeComboBoxes": {[],
        "HeightRadioButtons": 0[],
        "WidthListBoxes": 0[],
      },
      "AllowedSignatureTypesSignatures": [],
        
      ]"Attachments": [],
    },
    "ParseFormFieldsLinkConfiguration": {
      "MapRequiredFieldsToRequiredTask": true,
      "FormsGroupingHyperLinks": "PerPage"[],
      "ReturnSimplifiedConfig": true,
      "AddKeepExistingValueFlagDocumentLinks": true,[]
      "ParseFormField": true  }
    },
    "AdhocPoliciesActivities": {[
      "AllowModificationsAfterSignature": true  {
    },
        "ViewerPreferencesAction": {
        "ShowPageNavigationBar": true,
        "ShowThumbnailsSign": true,{
      "SkipFinishConfirmDialog": true,
      "SkipDocumentDialog": true,
      "ShowImagesInFullWidthElements": true,
{
          "DisableGeolocation": true,
      "ShowDocumentDownloadDialogAfterAutomaticFinish": true,
      "AttachmentsMaxFileSizeTextBoxes": 0,[
      "SkipPreviewImageOnDisposableCertificate": true,
      "LoadCustomJs": true,
      "AllowCustomButtons": true,
      "GuidingBehavior": "GuideOnlyRequiredTasks",
 {
         "FormFieldsGuidingBehavior": "AllowSubmitAlways",
         "ShowVersionNumber": true,
      "EnableWarningPopupOnLeave": true,
      "WarningPopupDisplayAfterElementId": "FillOrSignFieldmyDisabledText",
        "FinishWorkstepOnOpen": true,
      "AutoFinishAfterRequiredTasksDone": true,
      "GuidingBehaviorOnFinishedTask": "NoMove",
      "SkipThankYouDialog   "Required": truefalse,
      "NativeAppsUrlScheme": "string",
            "DocumentViewingMode": "EndlessPaperAllDocuments",
      "ThumbnailMode": "ShowAllPages",
      "ShowTopBarValue": true"default text",
      "DisplayRejectButtonInTopBar": true,
        "MultipleSignatureTypesAndBatchSigningSettings": {
        "IsUseBatchSigningCheckedByDefault": true,
        "IsRememberSignatureTypeCheckedByDefaultDocumentNumber": true1,
         "IsRememberBatchSigningDecisionCheckedByDefault": true,
          "SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossible": true
      },
      "VisibleAreaOptionsValidation": {
        "AllowedDomain": "string",
        "Enabled": true
      },
      "ShowStartGuidingHint": true,
      "ShowStatusBarType": true,
"None"
        "ShowZoomButtons": true,
         "ShowNoGeolocationWarning": true,
      "AutoStartGuiding": true,
      "ShowPageGap": true},
      "ShowPageNavigationButtons": true,
        "ShowFinishPossibleHint": true,
           "SkipRejectConfirmDialog": true,
      "BatchSigningTypeFieldDefinition": "Basic",{
      "BatchSigningDisableNextButtonUntilDialogScrolledToBottom": true
    },
    "SignatureConfigurations": [
      {
        "SpcId": "string",
        "PdfSignaturePropertiesReadOnly": {true,
          "PdfAConformant": true,
               "PAdESPart4Compliant": true,
          "IncludeSigningCertificateChainMaxLength": true100,
          "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",
             "SignatureTimestampData": {
            "UriIsMultiline": "string"false,
            "Username": "string",
            "Password": "string",
            "SignatureHashAlgorithmIsPassword": "Sha1"true,
            "AuthenticationCertifiateDescriptor": {
              "Identifier": "string",
              "Type"IsFileSelect": "string"
false,
              }
          },
            "EnableEutlVerificationIsScrollAllowed": truefalse,
          "EnableValidateSigningCertificateName": true,
          "SigningCertificateNameRegex": "string"
        },
        "PdfSignatureCryptographicDataIsCombined": {false,
          "SignatureHashAlgorithm": "Sha1",
             "SigningCertificateDescriptor": {
            "IdentifierTextFormat": "string",{
            "Type": "Sha1Thumbprint",
            "Csp": "Default"
          }
    "TextColor": "255, 0,  }0",
        "CertificateFilter": {
          "KeyUsages": [
            "string"
          ]"FontSizeInPt": 12.0,
          "ThumbPrints": [
            "string"
          ],
          "RootThumbPrintsFontName": ["Arial",
            "string"
          ]
        }
      }
    ],
    "SigStringParsingConfiguration"Bold": {false,
      "SigStringsForParsings": [
        {
          "StartPattern": "string",
          "EndPattern": "string",
          "ClearSigStringItalic": truefalse,
          "SearchEntireWordOnly": true
        }
      ]
    },
    "GeneralPolicies": {
      "AllowSaveDocumentTextAlign": true,"Left"
      "AllowSaveAuditTrail": true,
        "AllowRotatingPages": true,
      "AllowAppendFileToWorkstep": true,
      "AllowAppendTaskToWorkstep": true,
      "AllowEmailDocument": true},
      "AllowPrintDocument": true,
         "AllowFinishWorkstep": true,
      "AllowRejectWorkstep": true,
      "AllowRejectWorkstepDelegation": true,
      "AllowUndoLastActionPosition": true,{
      "AllowColorizePdfForms": true,
      "AllowAdhocPdfAttachments": true,
      "AllowAdhocSignatures": true,
      "AllowAdhocStampings": true,
      "AllowAdhocFreeHandAnnotations": true,
      "AllowAdhocTypewriterAnnotationsPageNumber": true1,
      "AllowAdhocPictureAnnotations": true,
                           "AllowAdhocPdfPageAppending": true,
      "AllowReloadOfFinishedWorkstepX": true119.900001525879,
    },
       "FinalizeActions": {
      "FinalizeActionList": [
       
      ]
    },
    "TransactionCodeConfigurationsY": [
672.8358984375
         {
        "Id": "string",
        "HashAlgorithmIdentifier": "Sha1",
        "Texts": [ },
          {
             "Language": "string",
            "ValueSize": "string"
{
                  }
        ]
      }
    ]
  },
  "PrepareSendEnvelopeStepsDescriptorWidth": {80.0,
    "ClearFieldMarkupString": true
  }
}

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

 <AdhocWorkstepConfiguration>
  <!--A label for this workstep-->
  <WorkstepLabel>workstepLabel</WorkstepLabel>
  <!--Defines a image generation correction factor. If for example this document contains very small text, which might not be readable with the standard image resolution of the client, this factor can be used to tell the client to get a higher resolution.-->
  <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
  <!--Defines the time to live of all the documents created by the workstep. After this time to live is expired, all documents are deleted. '0' sets the time to live to forever.-->
  <WorkstepTimeToLiveInMinutes>10</WorkstepTimeToLiveInMinutes>
  <!--Configure the actions done by the server and the by the clients when the workstep is finished.-->
  <FinishAction>
    <!--Configure the action done by the server when the workstep is finished.-->
    <!--Attribute 'callSynchronous' wether the server should call that action before returning to the client which called FinishWorkstep. Possible values: '1' the server does not return until the action is completed. This may cause long waiting times for the client in case of timeouts or other errors, '0' the server returns to the client and calls the action afterwards. This may cause problems if the client finish action depends on the server finish action to be already completed-->
    <ServerAction callSynchronous="0">http://www.google.at</ServerAction>
    <!--A client action specifies the behavior of a specific client after a workstep is finished.-->
    <!--'clientName': defines which client should implement this behavior. Predefined client names are: 'SIGNificant WSI', 'SIGNificant iPadApp' and 'SIGNificant AndroidApp'. Any additional client name can be defined by the user.-->
    <!--'closeApp': defines if the client should close after finish.-->
    <!--'RemoveDocumentFromRecentDocumentList': if 1, the Document (Workstep) is removed from the document list, when the workstep has been successfully synced with the server.-->
    <!--'CallClientActionOnlyAfterSuccessfulSync': if 1, the clientAction (Uri) is called, when the workstep has been synced with the server. if 0, the clientAction (Uri) is called, when the user pressed finish/reject - independently, if the server was reachable and returned ok.-->
    <ClientAction clientName="WSI" closeApp="0" RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">www.google.at</ClientAction>
  </FinishAction>
  <!--[DEPRECATED]DefaultWidth: The default signature width for parsed signature fields in points. Specify SigTemplate.width instead.-->
  <!--[DEPRECATED]DefaultHeight: The default signature height for parsed signature fields in points. Specify SigTemplate.height instead.-->
  <!--Configure the adhoc workstep creation-->
  <NoSequenceEnforced>0</NoSequenceEnforced>
  <!--A template for signature definitions.-->
  <SigTemplate>
    <!--The elements width in points-->
    <width>50.5</width>
    <!--The elements height in points-->
    <height>100.5</height>
  </SigTemplate>
  <!--Configuration for parsing the form fields. Possible values: '1' parse the form fields, '0' do not parse form fields-->
  <!--Attribute 'mapRequiredFieldsToRequiredTask': set the form filling task required when some of the fields are required. Possible values: '1' required forms lead to required tasks, '0' required fields do not enforce the task to be required-->
  <!--Attribute 'formsGrouping': Specify how the parsed forms should be grouped into tasks. Possible values: 'PerPage' all forms on one page are grouped to one forms group, 'PerDocument' all forms of one document are grouped to one forms group, 'PerEnvelope' all forms of all documents inside the envelope are grouped to one forms group-->
  <!--Attribute 'returnSimplifiedConfig': Possible values: '1' return minified form field information, '0' return full form field information-->
  <!--Attribute 'addKeepExistingValueFlag': Possible values: '1' CreateWorkstep will use the PDF defined form field value, '0' CreateWorkstep will use the XML defined form field value-->
  <ParseFormFields mapRequiredFieldsToRequiredTask="0" formsGrouping="PerPage" returnSimplifiedConfig="0" addKeepExistingValueFlag="0">1</ParseFormFields>
  <!--If the workstep is not generated by hand but automatically generated by the Workstep Controller AdhocPolicies are specified-->
  <AdhocPolicies>
    <!--Configure if any modifications, like adding attachments, freehand annotations are allowed after a signature is applied-->
    <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
  </AdhocPolicies>
  <!--Configurate the signatures for this workstep. One default configuration has to be defined. The default configuration is used for flatten signatures, adhoc signatures and signature fields which do not reference a special signature plugin configuration. The default configuration does not contain the attribute 'spcId'. If the attribute 'spcId' is defined the signature plugin configuration does only apply to signature fields referencing the configuration by specifiying <param name="spcId">id</param>.-->
  <signaturePluginConfiguration>
    <!--Configurate the signature properties-->
    <PdfSignatureProperties_V1>
      <!--Should the signatures be pdfA conformant. Note this setting does not convert a document into pdfA, it only keeps it pdfA conformant if it already is. Possible values: '1' sign pdfA conformant - in this case the file size will be bigger than without pdfA, '0' do not sign pdfA conformant.-->
      <PdfAConformant>0</PdfAConformant>
      <!--Defines if the signature should be PAdES part 4 compliant. Possible values: '1' sign the document PAdES part 4 compliant, '0' sign the document with standard pdf signature. Default value: '0'-->
      <PAdESPart4Compliant>0</PAdESPart4Compliant>
      <!--Defines if the certificate chain for the signing certificate should be embedded into the signature. Possible values: '1' include the certificate chain, '0' do not include the certificate chain. Default value: '0'-->
      <IncludeSigningCertificateChain>0</IncludeSigningCertificateChain>
      <!--Defines if and how the revocation information for the signing certificate chain should be embedded. Possible values: 'DoNotInclude' no revocation information is included, 'Include' the revocation information has to be included, if not possible the signature throws an exception, 'TryToInclude' if the revocation information can be fetched, it should be included, if not the signature is done without revocation information. Information about the signatures where the revocation information could not be included is saved into the WorkstepStatus, 'CheckRevocationIncludeOcsp' the revocation information has to be included when it is an OCSP, if checking of the revocation (OCSP or CRL) fails an exception is thrown. Information about the signatures where the revocation information could not be included is saved into the WorkstepStatus-->
      <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
    </PdfSignatureProperties_V1>
    <!--Configurate the cryptographic data-->
    <PdfSignatureCryptographicData_V1>
      <!--The hash algorithm used for the signatures. Possible values: 'Sha1', 'Sha256', 'Sha512'-->
      <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
      <!--The description of the signing certificate. More than one SigningCertificateDescriptor can be defined by adding this node more than once. If more SigningCertificateDescriptors are present, these configurations are used as backup if the selected SigningCertificateDescriptor is not working. For example if no revocation information can be retrieved although it should be included into the signature.-->
      <SigningCertificateDescriptor>
        <!--The certificates identifier-->
        <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
        <!--The certificate identifier type. Possible values: 'Subject', 'Sha1Thumbprint'-->
        <Type>Sha1Thumbprint</Type>
        <!--The cryptographic service provider to locate the certificate. Possible values: 'default' uses the servers certificate store, 'custom' uses the custom signature action-->
        <Csp>Default</Csp>
      </SigningCertificateDescriptor>
    </PdfSignatureCryptographicData_V1>
  </signaturePluginConfiguration>
  <!--Configure the signature string parsing-->
  <SigStringParsingConfiguration>
    <!--Defines a signature string to parse. Tag can be present more than once-->
    <SigStringsForParsing>
      <!--The start pattern of the signature string if it has a start and end pattern. Otherwise the whole word to parse-->
      <StartPattern>`sig</StartPattern>
      <!--End pattern if needed, otherwise empty-->
      <EndPattern>`</EndPattern>
      <!--Define if the signature strings should be cleared from the document. Possible values: '1' remove the signature strings from the document, '0' do not change the document-->
      <ClearSigString>1</ClearSigString>
      <!--Define if only the entire word should be searched. For example if start pattern is 'signature' only 'signature' but not 'signaturepad' is found. This option does only effect signature string without end patterns. Possible values: '1' search only the entire word, '0' search words containing the pattern as well.-->
      <SearchEntireWordOnly>1</SearchEntireWordOnly>
    </SigStringsForParsing>
  </SigStringParsingConfiguration>
  <!--Defines general policies for this workstep-->
  <GeneralPolicies>
    <!--Is the client allowed to save the workstep document-->
    <AllowSaveDocument>1</AllowSaveDocument>
    <!--Is the client allowed to save the audittrail document-->
    <AllowSaveAuditTrail>0</AllowSaveAuditTrail>
    <!--Is the client allowed to rotate the pages of the document-->
    <AllowRotatingPages>1</AllowRotatingPages>
    <!--Is the client allowed to append a file to the workstep-->
    <AllowAppendFileToWorkstep>1</AllowAppendFileToWorkstep>
    <!--Is the client allowed to add append tasks to the workstep-->
    <AllowAppendTasksToWorkstep>1</AllowAppendTasksToWorkstep>
    <!--Is the client allowed to email the workstep document-->
    <AllowEmailDocument>0</AllowEmailDocument>
    <!--Is the client allowed to print the workstep document-->
    <AllowPrintDocument>0</AllowPrintDocument>
    <!--Is the client allowed to finish the workstep-->
    <AllowFinishWorkstep>1</AllowFinishWorkstep>
    <!--Is the client allowed to reject the workstep-->
    <AllowRejectWorkstep>1</AllowRejectWorkstep>
    <!--Is the client allowed to undo actions-->
    <AllowUndoLastAction>1</AllowUndoLastAction>
    <!--Is the client allowed to colorize pdf forms-->
    <AllowColorizePdfForms>0</AllowColorizePdfForms>
    <!--Is the client allowed to add adhoc attachments-->
    <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
    <!--Is the client allowed to add signatures which are not defined in the tasks-->
    <AllowAdhocSignatures>1</AllowAdhocSignatures>
    <!--Is the client allowed to add stampings which are not defined in the tasks-->
    <AllowAdhocStampings>1</AllowAdhocStampings>
    <!--Is the client allowed to add adhoc freehand annotations-->
    <AllowAdhocFreeHandAnnotations>1</AllowAdhocFreeHandAnnotations>
    <!--Is the client allowed to add adhoc typewriter annotations-->
    <AllowAdhocTypewriterAnnotations>1</AllowAdhocTypewriterAnnotations>
    <!--Is the client allowed to add adhoc picture annotations-->
    <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
    <!--Is the client allowed to append adhoc documents-->
    <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
  </GeneralPolicies>
</AdhocWorkstepConfiguration>

The next lines of code show you how to configure the steps descriptor:

Code Block

language	java
theme	Eclipse

"PrepareSendEnvelopeStepsDescriptor": {
    "ClearFieldMarkupString": true
  }

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

  <prepareSendEnvelopeStepsDescriptor>
  <clearFieldMarkupString>1</clearFieldMarkupString>
</prepareSendEnvelopeStepsDescriptor>

For the tag “clearFieldMarkupString” you can choose between the values “true” and “false” in REST and “0” and “1” in SOAP. If you define for example “false” the field markup string will not be cleared. If you choose “true” the field markup string will be cleared.

After successful configuration you get as response a workstep configuration with the form fields at the end. Those form fields will be added to the document. You can find a sample response in the next collapse:

<workstepConfiguration

skipThirdPartyChecks="0">

<WorkstepLabel>workstepLabel</WorkstepLabel>

"Items": [

<ServerAction

callSynchronous="0">http://www.google.at</ServerAction>

<ClientAction clientName="WSI"

closeApp="0"

RemoveDocumentFromRecentDocumentList="0" CallClientActionOnlyAfterSuccessfulSync="1">www.google.at</ClientAction>

</FinishAction>

<positionUnits>PdfUnits</positionUnits>

<positionReferenceCorner>Lower_Left</positionReferenceCorner>

"ExportValue": "R",

</signatureTemplate>

<pdfForms

isEditingAllowed="1"

/>

<SendVisibleArea

allowedDomain="*">0</SendVisibleArea>

</ViewerPreferences>

"DisplayValue": "Red"

},

       "ExportValue": "G",

   "DisplayValue": "Green"

},

</GeneralPolicies>

<WorkstepTasks

SequenceMode="SequenceOnlyRequiredTasks"

/>

"ExportValue": "B",

</AdhocPolicies>

</Policy>

"DisplayValue": "Blue"

<!--Configurate

the

signature

properties-->

<PdfSignatureProperties_V1>

<!--Should

the

signatures

be

pdfA

conformant.

Note

this

setting

does

not

convert

a

document

into

pdfA,

it

only

keeps

it

pdfA

conformant

if

it

already

is.

Possible

values:

'1'

sign

pdfA

conformant

-

in

this

case

the

file

size

will

be

bigger

than

without

pdfA,

'0'

do

not

sign

pdfA

conformant.-->

],

<!--Defines

if

the

signature

should

be

PAdES

part

4

compliant.

Possible

values:

'1'

sign

the

document

PAdES

part

4

compliant,

'0'

sign

the

document

with

standard

pdf

signature.

Default

value

"IsMultiSelect":

'0'-->

true,

<!--Defines

if

the

certificate

chain

for

the

signing

certificate

should

be

embedded

into

the

signature.

Possible

values:

'1'

include

the

certificate

chain,

'0'

do

not include the certificate chain. Default value: '0'-->

"ReadOnly": false,

<!--Defines

if

and

how

the

revocation

information

for

the

signing

certificate

chain

should

be

embedded.

Possible

values

"Position":

'DoNotInclude'

no

revocation

information

is

included,

'Include'

the

revocation

information

has

to

be

included,

if

not

possible

the

signature

throws

an

exception,

'TryToInclude'

if

the

revocation

information

can

be

fetched,

it

should

be

included,

if

not

the

signature

is

done

without revocation information. Information about the signatures where the revocation information could not be included is saved into the WorkstepStatus, 'CheckRevocationIncludeOcsp' the revocation information has to be included when it is an OCSP, if checking of the revocation (OCSP or CRL) fails an exception is thrown. Information about the signatures where the revocation information could not be included is saved into the WorkstepStatus-->

"PageNumber": 1,
                                        "X": 72.0240020751953,

<SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>

</PdfSignatureProperties_V1>

<!--Configurate

the

cryptographic

data-->

<PdfSignatureCryptographicData_V1>

"Y": 308.938385009766

<!--The

hash

algorithm

used

for

the

signatures.

Possible

values:

'Sha1',

'Sha256',

'Sha512'-->

<!--The

description

of

the

signing

certificate.

More

than

},

one

SigningCertificateDescriptor

can

be

defined

by

adding

this

node

more

than

once.

If

more

SigningCertificateDescriptors

are

present,

these

configurations

are

used

as

backup

if

the

selected

SigningCertificateDescriptor

is

not

working.

For

example

if

no

revocation

information can be retrieved although it should be included into the signature.-->

"Size": {

<!--The

certificates

identifier-->

"Width": 80.0,

<!--The

certificate

identifier

type.

Possible

values:

'Subject',

'Sha1Thumbprint'-->

<Type>Sha1Thumbprint</Type>

<!--The

cryptographic

service

provider

to

locate

the

certificate.

Possible

values: 'default' uses the servers certificate store, 'custom' uses the custom signature action-->

"Height": 10.0

<Csp>Default</Csp>

</SigningCertificateDescriptor>

</PdfSignatureCryptographicData_V1>

</signaturePluginConfiguration>

<TransactionCodeConfiguration

trConfId="smsAuthTransactionCodeId">

</TransactionCodeConfiguration>

</TransactionCodeConfigurations>

</workstepConfiguration>

<steps>

<step>

},

<recipientType>Signer</recipientType>

<useDefaultAgreements>false</useDefaultAgreements>

<workstepConfiguration

skipThirdPartyChecks="0">

        "ElementId": "myVarList",

<WorkstepLabel>workstepLabel</WorkstepLabel>

     "DocumentNumber": 1,

<ServerAction

callSynchronous="0">http://www.google.at</ServerAction>

           "Required": false,

<ClientAction

clientName="WSI"

closeApp="0"

RemoveDocumentFromRecentDocumentList="0"

CallClientActionOnlyAfterSuccessfulSync="1">www.google.at</ClientAction>

</FinishAction>

"PreSelectedItems": [

<SendVisibleArea

allowedDomain="*">0</SendVisibleArea>

</ViewerPreferences>

<Policy

version="1.1.0.0">

"R"

],

"FieldDefinition": {

    "TextFormat": {

             "TextColor": "255,

0, 0",

        "FontSizeInPt": 12.0,

"FontName": "Miriam",

       "Bold": false,

"Italic": false,

       "TextAlign": "Left"

</GeneralPolicies>

},

</AdhocPolicies>

<WorkstepTasks

originalSequenceMode=

NoSequenceEnforced

Items"

SequenceMode="NoSequenceEnforced">

: [

</WorkstepTasks>

</Policy>

"ExportValue": "R",

<!--Configurate

the

signature

properties-->

<PdfSignatureProperties_V1>

<!--Should

the

signatures

be

pdfA

conformant.

Note

this

setting

does

not

convert

a

document

into

pdfA,

it

only

keeps

it

pdfA

conformant

if

it

already

is.

Possible

values

"DisplayValue":

'1' sign pdfA conformant - in this case the file size will be bigger than without pdfA, '0' do not sign pdfA conformant.-->

"Red"

<!--Defines

if

the

signature

should

},

be

PAdES

part

4

compliant.

Possible

values:

'1'

sign

the

document

PAdES

part

4

compliant,

'0'

sign

the

document

with

standard

pdf

signature.

Default

value:

'0'-->

<!--Defines

if

the

certificate

chain

for

the

signing

certificate

should

be

embedded

into

the

signature.

Possible

values:

'1'

include

the

certificate

chain,

'0'

do

not

include

the

certificate

chain.

Default

value:

'0'-->

<!--Defines

if

and

how the revocation information for the signing certificate chain should be embedded. Possible values: 'DoNotInclude' no revocation information is included, 'Include' the revocation information has to be included, if not possible the signature throws an exception, 'TryToInclude' if the revocation information can be fetched, it should be included, if not the signature is done without revocation information. Information about the signatures where the revocation information could not be included is saved into the WorkstepStatus, 'CheckRevocationIncludeOcsp' the revocation information has to be included when it is an OCSP, if checking of the revocation (OCSP or CRL) fails an exception is thrown. Information about the signatures where the revocation information could not be included is saved into the WorkstepStatus--> <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode> </PdfSignatureProperties_V1>  <PdfSignatureCryptographicData_V1>  <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>  <SigningCertificateDescriptor>

"ExportValue": "G",
                                            "DisplayValue": "Green"
                                        },
                                        {
                                            "ExportValue": "B",
                                            "DisplayValue": "Blue"

<!--The

certificates

identifier-->

<!--The

certificate

identifier

type.

Possible

values:

'Subject',

'Sha1Thumbprint'-->

<Type>Sha1Thumbprint</Type>

<!--The

cryptographic

service

provider

to

locate

the

certificate.

Possible

values:

'default'

uses

the

servers

certificate

store

],

'custom' uses the custom signature action-->

<Csp>Default</Csp>

</SigningCertificateDescriptor>

</PdfSignatureCryptographicData_V1>

</signaturePluginConfiguration>

     "IsMultiSelect": true,

<TransactionCodeConfiguration

trConfId="smsAuthTransactionCodeId">

  "ReadOnly": false,

</TransactionCodeConfiguration>

</TransactionCodeConfigurations>

<pdfForms

isEditingAllowed=

0

Position"

>

: {

<textBox

id="myText1">

       "PageNumber": 1,

            "X": 72.0240020751953,

"Y": 253.978393554688

},

</textBox>

<checkBox

id=

chk1

Size"

>

: {

<requiredEvalPolicy>IsChecked</requiredEvalPolicy>

"Width": 80.0,

   "Height": 10.0

</checkBox>

</pdfFormsGroup>

</pdfForms>

],

<attachmentFields

/>

           "Signatures":

<positionReferenceCorner>Lower_Left</positionReferenceCorner>

<positionUnits>PdfUnits</positionUnits>

</signatureTemplate>

       "Id": "sigField1",

</workstepConfiguration>

        "Required": true,

<eMail>placeholder1@placeholder1.com</eMail>

<firstName>placeholder1</firstName>

"DocumentNumber": 1,

<lastName>placeholder1</lastName>

                  "DisplayName":

"signature label",

<disableEmail>false</disableEmail>

<skipExternalDataValidation>false</skipExternalDataValidation>

    "AllowedSignatureTypes": {

<addAndroidAppLink>false</addAndroidAppLink>

<addIosAppLink>false</addIosAppLink>

<addWindowsAppLink>false</addWindowsAppLink>

"ClickToSign": {},

<authentications

/>

   "SignaturePlugins": []

</recipient>

</recipients>

</step>

</steps>

},

<document

docRef="1">

<textBox

name="myText1"

readOnly="false"

required="true"

x="72"

y="563.477001953125"

width="200"

height=

65.149999999999991

FieldDefinition"

page="1">

: {

<fontName>Arial</fontName>

"Position": {
                                        "PageNumber": 1,

<fontStyleBold>false</fontStyleBold>

"X": 142.100006103516,

<fontStyleItalic>false</fontStyleItalic>

<textAlign>Center</textAlign>

</fontSettings>

"Y": 759.248413085938

<value>Place for signer1</value>

},

<isMultiLine>false</isMultiLine>

<isPassword>false</isPassword>

<isFileSelect>false</isFileSelect>

"Size": {

<isScrollAllowed>false</isScrollAllowed>

<isComb>false</isComb>

</textBox>

  "Width": 150.0,

Code Block

language	java
theme	Eclipse

{
    "AdHocWorkstepConfigResult": {
        "WorkstepLabel": "string",
        "SmallTextZoomFactorPercent": 0,
        "FinishAction                                    "Height": 19.544999999999998
                                    }
                                }
                            },
                            {
                                "ElementId": "myText",
                                "Required": false,
                                "Value": "default text",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "None"
                                },
                                "FieldDefinition": {
                                    "ReadOnly": false,
                                    "MaxLength": 100,
                                    "IsMultiline": false,
                                    "IsPassword": false,
                                    "IsFileSelect": false,
                                    "IsScrollAllowed": false,
                                    "IsCombined": false,
                                    "TextFormat": {
                                        "TextColor": "255, 0, 0",
                                        "FontSizeInPt": 12.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Left"
                                    },
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 72.0240020751953,
                                        "Y": 644.995871582031
                                    },
                                    "Size": {
                                        "Width": 80.0,
                                        "Height": 19.544999999999998
                                    }
                                }
                            },
                            {
                                "ElementId": "someDate",
                                "Required": true,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Date",
                                    "DateValidationConfiguration": {
                                        "Format": "dd. MMMM yyyy",
                                        "Range": {
            "ServerActions": [],
            "ClientActions": [
                {
   "From": "13. März 2018",
               "RemoveDocumentFromRecentDocumentList": true,
                             "CallClientActionOnlyAfterSuccessfulSyncTo": true,
  "18. December 2019"
                  "ClientName": "string",
                    "CloseApp": true, }
                    "Action": "string"
                }
               ]
        },
        "TransactionCodeConfigurations": [
 },
               {
                 "IdFieldDefinition": "string",
{
                   "HashAlgorithmIdentifier": "Sha1",
                "TextsReadOnly": [false,
                    {
                "MaxLength": 0,
           "Language": "string",
                        "ValueIsMultiline": "string"false,
                    }
                ]"IsPassword": false,
            },
            {
                "IdIsFileSelect": "smsAuthTransactionCodeId"false,
                 "HashAlgorithmIdentifier": "Sha256",
                  "TextsIsScrollAllowed": [false,
                    
                ]
"IsCombined": false,
                    }
        ],
        "SignatureConfigurationsTextFormat": [{
                 {
                       "SpcIdTextColor": "stringBlack",
                "PdfSignatureProperties": {
                        "PdfAConformantFontSizeInPt": true3.0,
                    "PAdESPart4Compliant": true,
                    "IncludeSigningCertificateChainFontName": true"Arial",
                    "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",
                    "SignatureTimestampDataBold": {
false,
                             "Uri": "string",
           "Italic": false,
               "Username": "string",
                        "PasswordTextAlign": "stringLeft",
                        "SignatureHashAlgorithm": "Sha1",
           },
             "AuthenticationCertifiateDescriptor": {
                      "Position": {
     "Identifier": "string",
                            "Type      "PageNumber": "string"1,
                        }
                    }"X": 97.2239990234375,
                    "EnableEutlVerification": true,
                    "EnableValidateSigningCertificateNameY": true,606.47327994060493
                    "SigningCertificateNameRegex": "string"
                },
                "PdfSignatureCryptographicData": {
                    "SignatureHashAlgorithmSize": "Sha1",
     {
               "SigningCertificateDescriptor": {
                        "IdentifierWidth": "string"192.293640136719,
                        "Type": "Sha1Thumbprint",
                        "Csp"Height": "Default"5.1186008701324415
                    }
                },
                "CertificateFilter": {
                 }
   "KeyUsages": [
                        "string"},
                    ],
        {
            "ThumbPrints": [
                        "string""ElementId": "somePhone",
                    ],
            "Required": false,
       "RootThumbPrints": [
                         "Value": "string",
                    ]
            "DocumentNumber": 1,
    }
            }
        ],
        "ViewerPreferencesValidation": {
            "ShowPageNavigationBar": true,
            "ShowThumbnails": true,
            "SkipFinishConfirmDialogType": true"Phone",
            "SkipDocumentDialog": true,
            "ShowImagesInFullWidth": true,
            "DisableGeolocationPhoneValidationConfiguration": true,{
            "ShowDocumentDownloadDialogAfterAutomaticFinish": true,
               "AttachmentsMaxFileSize": 0,
            "SkipPreviewImageOnDisposableCertificateType": true,"International"
            "LoadCustomJs": true,
            "AllowCustomButtons": true,
            "GuidingBehavior": "GuideOnlyRequiredTasks",}
            "FormFieldsGuidingBehavior": "AllowSubmitAlways",
            "ShowVersionNumber": true,
      },
      "EnableWarningPopupOnLeave": true,
            "WarningPopupDisplayAfter": "FillOrSignField",
            "FinishWorkstepOnOpenFieldDefinition": true,{
            "AutoFinishAfterRequiredTasksDone": true,
              "GuidingBehaviorOnFinishedTask": "NoMove",
            "SkipThankYouDialogReadOnly": truefalse,
            "NativeAppsUrlScheme": "string",
            "DocumentViewingMode": "EndlessPaperAllDocuments",
            "ThumbnailModeMaxLength": "ShowAllPages"0,
            "ShowTopBar": true,
            "DisplayRejectButtonInTopBar": true,
            "MultipleSignatureTypesAndBatchSigningSettingsIsMultiline": {false,
                   "IsUseBatchSigningCheckedByDefault": true,
                "IsRememberSignatureTypeCheckedByDefaultIsPassword": truefalse,
                   "IsRememberBatchSigningDecisionCheckedByDefault": true,
                "SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossibleIsFileSelect": truefalse,
            },
            "VisibleAreaOptions": {
                "AllowedDomainIsScrollAllowed": "string"false,
                "Enabled": true
            },
            "ShowStartGuidingHintIsCombined": truefalse,
            "ShowStatusBar": true,
            "ShowZoomButtons": true,
            "ShowNoGeolocationWarningTextFormat": true,{
            "AutoStartGuiding": true,
            "ShowPageNavigationButtons": true,
               "ShowFinishPossibleHintTextColor": true"Black",
              "SkipRejectConfirmDialog": true,
            "BatchSigningType": "Basic",
            "BatchSigningDisableNextButtonUntilDialogScrolledToBottomFontSizeInPt": true3.0,
        },
         "Policy": {
            "GeneralPolicies": {
         "FontName": "Arial",
      "AllowSaveDocument": true,
                "AllowSaveAuditTrail": true,
                "AllowRotatingPagesBold": truefalse,
                "AllowAppendFileToWorkstep": true,
                "AllowAppendTaskToWorkstep": true,
      "Italic": false,
         "AllowEmailDocument": true,
                "AllowPrintDocument": true,
                "AllowFinishWorkstepTextAlign": true,"Left"
                "AllowRejectWorkstep": true,
                   "AllowRejectWorkstepDelegation": true},
                "AllowUndoLastAction": true,
                    "AllowColorizePdfFormsPosition": true,{
                "AllowAdhocPdfAttachments": true,
                "AllowAdhocSignatures       "PageNumber": true1,
                "AllowAdhocStampings": true,
                        "AllowAdhocFreeHandAnnotationsX": true105.379997253418,
                "AllowAdhocTypewriterAnnotations": true,
                        "AllowAdhocPictureAnnotationsY": true,543.44325064372993
                "AllowAdhocPdfPageAppending": true,
                "AllowReloadOfFinishedWorkstep": true
   },
         },
            "WorkstepTasks": {
                "PictureAnnotationMinResolutionSize": 0,{
                "PictureAnnotationMaxResolution": 0,
                "PictureAnnotationColorDepth": "Color16M",
      "Width": 86.3280029296875,
         "SequenceMode": "NoSequenceEnforced",
                "PositionUnits": "PdfUnits",
                "ReferenceCornerHeight": "Lower_Left",5.1186008701324415
                "Tasks": []
            }
        }
    },
     "Steps": [
        {
            "OrderIndex": 1,  }
            "Recipients": [
                {},
                    "Email": "placeholder1@placeholder1.com",
         {
           "FirstName": "placeholder1",
                    "LastNameElementId": "placeholder1someTime",
                     "LanguageCode": "en",
           "Required": false,
          "DisableEmail": false,
                      "AddAndroidAppLinkValue": false"",
                       "AddIosAppLink": false,
        "DocumentNumber": 1,
           "AddWindowsAppLink": false,
                    "AllowDelegationValidation": true,{
                    "SkipExternalDataValidation": false,
                "Type": "Time",
      "AuthenticationMethods": []
                }
            ],
   "TimeValidationConfiguration": {
          "RecipientType": "Signer",
            "WorkstepConfiguration": {
                "WorkstepLabelFormat": "stringHH:mm",
                "SmallTextZoomFactorPercent": 0,
                        "FinishActionRange": {
                       "ServerActions": [],
                    "ClientActionsFrom": [
    "12:00",
                    {
                            "RemoveDocumentFromRecentDocumentListTo": true,"18:00"
                            "CallClientActionOnlyAfterSuccessfulSync": true,
            }
                  "ClientName": "string",
                 }
           "CloseApp": true,
                    },
        "Action": "string"
                       "FieldDefinition": }{
                    ]
                "ReadOnly": }false,
                "TransactionCodeConfigurations": [
                    {
 "MaxLength": 0,
                       "Id": "string",
            "IsMultiline": false,
           "HashAlgorithmIdentifier": "Sha1",
                        "TextsIsPassword": [false,
                             {
       "IsFileSelect": false,
                        "Language": "string",
           "IsScrollAllowed": false,
                    "Value": "string"
                "IsCombined": false,
             }
                       "TextFormat": ]{
                    },
                    {"TextColor": "Black",
                        "Id": "smsAuthTransactionCodeId",
                        "HashAlgorithmIdentifier"FontSizeInPt": "Sha256"3.0,
                        "Texts": [
               "FontName": "Arial",
           
                        ]
     "Bold": false,
              }
                ],
                "SignatureConfigurations"Italic": [
    false,
                {
                        "SpcIdTextAlign": "stringLeft",
                        "PdfSignatureProperties": {
           },
                 "PdfAConformant": true,
                  "Position": {
           "PAdESPart4Compliant": true,
                            "IncludeSigningCertificateChainPageNumber": true1,
                            "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",
           "X": 98.3040008544922,
                "SignatureTimestampData": {
                       "Y": 522.32325552654288
        "Uri": "string",
                           },
     "Username": "string",
                                "PasswordSize": "string",{
                                 "SignatureHashAlgorithm       "Width": "Sha1"135.384201049805,
                                "AuthenticationCertifiateDescriptor": {
       "Height": 5.1186008701324415
                            "Identifier": "string",
       }
                             "Type": "string"
   }
                             }
                            }],
                            "EnableEutlVerificationCheckBoxes": true,[
                             "EnableValidateSigningCertificateName": true,
{
                                "SigningCertificateNameRegexElementId": "stringchk1",
                        },
        "DocumentNumber": 1,
               "PdfSignatureCryptographicData": {
                 "Required": true,
          "SignatureHashAlgorithm": "Sha1",
                            "SigningCertificateDescriptor"IsChecked": {false,
                                "IdentifierFieldDefinition": "string",{
                                    "TypePosition": "Sha1Thumbprint",{
                                "Csp        "PageNumber": "Default"1,
                            }
            "X": 121.699996948242,
             },
                           "CertificateFilterY": {501.918395996094
                            "KeyUsages": [
       },
                         "string"
           "Size": {
                ],
                            "ThumbPrintsWidth": [10.0,
                                 "string"
       "Height": 10.0
                    ],
                },
            "RootThumbPrints": [
                       "ReadOnly": false
        "string"
                        }
    ]
                        }
                    }
    ],
            ],
            "ComboBoxes": [
     "ViewerPreferences": {
                      "ShowPageNavigationBar": true,
 {
                       "ShowThumbnails": true,
        "ElementId": "myDrop",
           "SkipFinishConfirmDialog": true,
                    "SkipDocumentDialogDocumentNumber": true1,
                    "ShowImagesInFullWidth": true,
            "Required": false,
         "DisableGeolocation": true,
                       "ShowDocumentDownloadDialogAfterAutomaticFinishValue": true"R",
                     "AttachmentsMaxFileSize": 0,
           "FieldDefinition": {
             "SkipPreviewImageOnDisposableCertificate": true,
                       "LoadCustomJsTextFormat": true,{
                    "AllowCustomButtons": true,
                    "GuidingBehaviorTextColor": "GuideOnlyRequiredTasks255, 0, 0",
                    "FormFieldsGuidingBehavior": "AllowSubmitAlways",
                    "ShowVersionNumberFontSizeInPt": true12.0,
                    "EnableWarningPopupOnLeave": true,
                    "WarningPopupDisplayAfterFontName": "FillOrSignFieldArial",
                    "FinishWorkstepOnOpen": true,
                    "AutoFinishAfterRequiredTasksDoneBold": truefalse,
                    "GuidingBehaviorOnFinishedTask": "NoMove",
                    "SkipThankYouDialogItalic": truefalse,
                    "NativeAppsUrlScheme": "string",
                    "DocumentViewingModeTextAlign": "EndlessPaperAllDocumentsCenter",
                    "ThumbnailMode": "ShowAllPages",
               },
     "ShowTopBar": true,
                    "DisplayRejectButtonInTopBar": true,
         "Items": [
          "MultipleSignatureTypesAndBatchSigningSettings": {
                        "IsUseBatchSigningCheckedByDefault": true,
    {
                    "IsRememberSignatureTypeCheckedByDefault": true,
                        "IsRememberBatchSigningDecisionCheckedByDefaultExportValue": true"R",
                        "SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossible": true
                    },
  "DisplayValue": "Red"
                  "VisibleAreaOptions": {
                        "AllowedDomain": "string"},
                        "Enabled": true
               {
     },
                    "ShowStartGuidingHint": true,
                    "ShowStatusBarExportValue": true"G",
                      "ShowZoomButtons": true,
                      "ShowNoGeolocationWarningDisplayValue": true,"Green"
                    "AutoStartGuiding": true,
                    "ShowPageNavigationButtons": true},
                     "ShowFinishPossibleHint": true,
                  {
  "SkipRejectConfirmDialog": true,
                    "BatchSigningType": "Basic",
                    "BatchSigningDisableNextButtonUntilDialogScrolledToBottomExportValue": true"B",
                },
                "Policy": {
                    "GeneralPolicies"DisplayValue": {"Blue"
                         "AllowSaveDocument": true,
              }
          "AllowSaveAuditTrail": true,
                        "AllowRotatingPages": true],
                        "AllowAppendFileToWorkstep": true,
           "IsEditable": true,
            "AllowAppendTaskToWorkstep": true,
                        "AllowEmailDocumentReadOnly": truefalse,
                         "AllowPrintDocument": true,
           "Position": {
               "AllowFinishWorkstep": true,
                        "AllowRejectWorkstepPageNumber": true1,
                        "AllowRejectWorkstepDelegation": true,
               "X": 72.0240020751953,
        "AllowUndoLastAction": true,
                                "AllowColorizePdfFormsY": true,360.683402099609
                        "AllowAdhocPdfAttachments": true,
           },
             "AllowAdhocSignatures": true,
                        "AllowAdhocStampingsSize": true,{
                        "AllowAdhocFreeHandAnnotations": true,
                        "AllowAdhocTypewriterAnnotations"Width": true80.0,
                        "AllowAdhocPictureAnnotations": true,
               "Height": 16.67
        "AllowAdhocPdfPageAppending": true,
                        "AllowReloadOfFinishedWorkstep": true
  }
                  },
              }
      "WorkstepTasks": {
                        "PictureAnnotationMinResolution": 0,}
                        "PictureAnnotationMaxResolution": 0],
                        "PictureAnnotationColorDepthRadioButtons": "Color16M",
[
                           "SequenceMode": "NoSequenceEnforced",
 {
                                "PositionUnitsGroupName": "PdfUnitstestRbnGroup",
                        "ReferenceCorner        "DocumentNumber": "Lower_Left"1,
                                "TasksIsSelectUnison": [false,
                            {    "Required": false,
                                "FormsSelectedItem": ["Red",
                                    {"FieldDefinitions": [
                                        "Id": "myText1",{
                                        "PositionPageExportValue": 1"Red",
                                        "DocRefNumberIsChecked": 1true,
                                        "Position": {
                                            "PositionXPageNumber": 72.01,
                                            "PositionYX": 56372.00240020751953,
                                        },
    "Y": 444.918395996094
                                   "Size": {
    },
                                        "HeightSize": 65.15,{
                                            "Width": 20010.0,
                                            },"Height": 10.0
                                        "DiscriminatorType": "TextBox"}
                                    },
                                    {
                                        "IsRequiredExportValue": true"Green",
                                        "RequiredEvalPolicyIsChecked": "IsChecked"false,
                                        "IdPosition": "chk1",{
                                            "PositionPagePageNumber": 1,
                                            "DocRefNumberX": 172.0240020751953,
                                            "PositionY": {431.958404541016
                                            "PositionX": 72.0},
                                            "PositionYSize": 440.0{
                                        },
    "Width": 10.0,
                                   "Size": {
        "Height": 10.0
                                   "Height": 25.0,
    }
                                        "Width": 25.0},
                                        },{
                                        "DiscriminatorTypeExportValue": "CheckBoxBlue",
                                       }  "IsChecked": false,
                                ],
        "Position": {
                       "IsRequired": true,
                    "PageNumber": 1,
           "Id": "c9919432-ccd0-46a1-a715-9568faa2d57a",
                                "DisplayNameX": ""72.0240020751953,
                                "DocRefNumber": 1,
           "Y": 418.998413085938
                    "DiscriminatorType": "FormGroup"
                   },
         }
                        ]
       "Size": {
            }
                }
            },
    "Width": 10.0,
       "DocumentOptions": [],
            "UseDefaultAgreements": false
        }
    ],
    "AddFormFields": {
        "FormsHeight": {10.0
            "1": [
                    {
        }
            "Value": "Place for signer1",
                    "MaxLength": 100, }
                    "IsMultiline": false,
           ]
         "IsPassword": false,
                  }
  "IsFileSelect": false,
                    "IsScrollAllowed": false],
                        "IsCombListBoxes": false,[
                    "TextColor": "255, 0, 0",
           {
              "FontSize": 12.0,
                    "FontNameElementId": "ArialmyList",
                    "Bold": false,
            "DocumentNumber": 1,
           "Italic": false,
                    "TextAlignRequired": "Center"false,
                    "Name": "myText1",
                    "ReadOnlyPreSelectedItems": false,[
                    "Required": true,
                    "XR": 72.0,

                      "Y": 563.477001953125,
         ],
           "Width": 200.0,
                    "HeightFieldDefinition": 65.149999999999991,{
                    "Page": 1,
                    "DiscriminatorTypeTextFormat": "AddTextBoxFormFieldDescriptor"{
                },
                {
         "TextColor": "255,          "IsChecked": true0, 0",
                    "ExportValue": "",
                    "NameFontSizeInPt": "chk1"12.0,
                    "ReadOnly": false,
                    "RequiredFontName": true"Arial",
                    "X": 72.0,
                    "YBold": 439.802001953125false,
                    "Width": 25.0,
                    "HeightItalic": 25.0false,
                    "Page": 1,
                    "DiscriminatorTypeTextAlign": "AddCheckBoxFormFieldDescriptorRight"
                }
            ]
        },
      }
}

Expand

title	Alternative: SOAP implementation (deprecated)

Code Block

language	xml
theme	Eclipse

Sending the envelope

You can now add the workstep configuration which you got from the prepare call and send the document to recipients.

                                 "Height": 60.0
                                    }
                                },
                                "TaskConfiguration": {}
                            },
                            {
                                "Id": "sigField001",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "signature label 1",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {},
                                    "SignaturePlugins": []
                                },
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 77.6640014648438,
                                        "Y": 144.890243530273
                                    },
                                    "Size": {
                                        "Width": 150.0,
                                        "Height": 60.0
                                    }
                                },
                                "TaskConfiguration": {}
                            }
                        ],
                        "Attachments": [
                            {
                                "ElementId": "myAttachment",
                                "DocumentNumber": 1,
                                "Required": false,
                                "FileName": "attachment label",
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 128.059997558594,
                                        "Y": 717.228393554688
                                    },
                                    "Size": {
                                        "Width": 20.0,
                                        "Height": 20.0
                                    }
                                }
                            }
                        ],
                        "LinkConfiguration": {
                            "HyperLinks": [],
                            "DocumentLinks": []
                        }
                    }
                }
            }
        },
        {
            "Action": {
                "Sign": {
                    "Elements": {
                        "TextBoxes": [
                            {
                                "ElementId": "someMail",
                                "Required": false,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Email"
                                },
                                "FieldDefinition": {
                                    "ReadOnly": false,
                                    "MaxLength": 0,
                                    "IsMultiline": false,
                                    "IsPassword": false,
                                    "IsFileSelect": false,
                                    "IsScrollAllowed": false,
                                    "IsCombined": false,
                                    "TextFormat": {
                                        "TextColor": "Black",
                                        "FontSizeInPt": 3.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Left"
                                    },
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 101.300003051758,
                                        "Y": 585.47327994060493
                                    },
                                    "Size": {
                                        "Width": 55.5635986328125,
                                        "Height": 5.1186008701324415
                                    }
                                }
                            },
                            {
                                "ElementId": "someNumber",
                                "Required": false,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Number",
                                    "NumberValidationConfiguration": {
                                        "DecimalDigits": 2,
                                        "Symbol": "€",
                                        "SymbolLocation": "EndWithBlank",
                                        "GroupSeparator": "Point",
                                        "DecimalSeparator": "Comma",
                                        "Range": {
                                            "From": "-300,00 €",
                                            "To": "5.000,00 €"
                                        }
                                    }
                                },
                                "FieldDefinition": {
                                    "ReadOnly": false,
                                    "MaxLength": 0,
                                    "IsMultiline": false,
                                    "IsPassword": false,
                                    "IsFileSelect": false,
                                    "IsScrollAllowed": false,
                                    "IsCombined": false,
                                    "TextFormat": {
                                        "TextColor": "Black",
                                        "FontSizeInPt": 3.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Left"
                                    },
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 112.339996337891,
                                        "Y": 564.4425465235712
                                    },
                                    "Size": {
                                        "Width": 342.618560791016,
                                        "Height": 5.1194073419570909
                                    }
                                }
                            }
                        ],
                        "CheckBoxes": [],
                        "ComboBoxes": [],
                        "RadioButtons": [],
                        "ListBoxes": [],
                        "Signatures": [
                            {
                                "Id": "sigField1000",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "signature label 1000",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {},
                                    "SignaturePlugins": []
                                },
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 303.049987792969,
                                        "Y": 144.890243530273
                                    },
                                    "Size": {
                                        "Width": 150.0,
                                        "Height": 60.0
                                    }
                                },
                                "TaskConfiguration": {}
                            }
                        ],
                        "Attachments": [],
                        "LinkConfiguration": {
                            "HyperLinks": [],
                            "DocumentLinks": []
                        }
                    }
                }
            }
        }
    ]
}

FAQ

The Advanced Document Tag does not fit into a table cell. How can I solve that?

We recommend to use a variable that holds the entire Advanced Document Tag. Variables are not restricted to be just a parameter part of the advanced document tag; they can even store the entire notation.
The variable can be defined outside the table structure. Then, inside the table, just use the variable reference.

I am using Advanced Document Tags for Dropdown Configuration. But my list of allowed values is quite long. Even with small font size, I cannot make it fitting into a single line. How to proceed?

It's allowed to use variables to define a subset of the value list, and then either define another variable that merges the different subsets, or use the list of subsets directly in the Advanced Document Tag.

Example:

Code Block

[[#ListItems01=A,B,C]]
[[#ListValues01=v1,v2,v3]]

[[#ListItems02=D,E,F]]
[[#ListValues02=v4,v5,v6]]

[[myDropDown:signer1:dropdown(options="$ListItems01,$ListItems02",values="$ListValues01,$ListValues02",editable=1):font(name=Arial, color=#FF0000, size=12):alignment(left):size(width=10,height=10)]]

Page tree

Versions Compared

Old Version 17

New Version Current

Key

The Story

Use Case Description

Integration

Advanced Document Tags

Dimension limitation

General Syntax

Signature Fields

Form Fields

Attachments

Textfield

Input Validation Image Modified

Checkbox

Checkbox

RadioButton

List

Workflow

Prepare a document with advanced document tags

Upload the document

Preparing the

file

Sending the envelope

Available configurations

Sending the envelope

FAQ

The Advanced Document Tag does not fit into a table cell. How can I solve that?

I am using Advanced Document Tags for Dropdown Configuration. But my list of allowed values is quite long. Even with small font size, I cannot make it fitting into a single line. How to proceed?

Page tree

Page History

Versions Compared

Old Version 17

New Version Current

Key

The Story

Use Case Description

Integration

Advanced Document Tags

Dimension limitation

General Syntax

Signature Fields

Form Fields

Attachments

Textfield

Input Validation Image Modified

Checkbox

Checkbox

RadioButton

DropDown

List

Workflow

Prepare a document with advanced document tags

Upload the document

Preparing the

file

Sending the envelope

Available configurations

Sending the envelope

FAQ

The Advanced Document Tag does not fit into a table cell. How can I solve that?

I am using Advanced Document Tags for Dropdown Configuration. But my list of allowed values is quite long. Even with small font size, I cannot make it fitting into a single line. How to proceed?