Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
titleAlternatives

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:

Dimenstion LimitationsImage Added

General Syntax

Info
titleRecommendations 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
titleMeasurement 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)
fieldnameString (required)
:signer1Assigned to signer; “signer” or “signer1”, “signer2”, … (required)
:objecttypeType, e.g. signature, combobox, … (mandatory)
:propertyadditional 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.

Input Validation Image Removed

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="


    Code Block
    languagejava
    themeEclipse
     "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
    
              },

    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 Added

    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

    Checkbox

    ...

    • Email
      • optional for email field
      • [[

    ...

      • someMail:signer:

    ...

    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.

    DropDown

    ...

      • 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
      • thousandsSeparator: comma, point, apostrophe, blank
      • 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
    [[*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.

    ...

    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.

    DropDown

    [[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.

    Offset

    You can define a offset by using

    ...

    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
    languagejava
    themeEclipse
     "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:

    1. prepare a document with advanced document tags
    2. upload the document
    3. prepare the envelope
    4. send 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 here.

    Upload the document

    ...

    Workflow

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

    1. 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.
    2. 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.
    3. 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.
    4. 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.
    5. 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.

    ...

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

    ...

    and the

    ...

    The next configurations show you sample workstep configuration.

    ...

    following sample configuration:

    Code Block
    languagejava
    themeEclipse
    {
      "
    SspFileIds
    FileIds": [
        "
    ##FILE-ID##
    string"
      ],
      "
    AdHocWorkstepConfiguration
    ClearAdvancedDocumentTags": 
    { "WorkstepLabel": "string",
    true,
      
    "
    SmallTextZoomFactorPercent
    SigStringConfigurations":
    0,
     
    "WorkstepTimeToLiveInMinutes": 0, "FinishAction": { "ClientActions":
    [
    
        
    {
    
          
    "
    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
    titleAll available configurations


    Code Block
    languagejava
    themeEclipse
    {
        ]"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",       "SkipThankYouDialogRequired": 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       },       "ShowStartGuidingHintType": true,
          "ShowStatusBarNone":
    true,       "ShowZoomButtons": true,       "ShowNoGeolocationWarning": true,       "AutoStartGuiding": true,       "ShowPageGap": true},
          "ShowPageNavigationButtons": true,          "ShowFinishPossibleHint": true,       "SkipRejectConfirmDialog": true,       "BatchSigningTypeFieldDefinition": "Basic",{
            "BatchSigningDisableNextButtonUntilDialogScrolledToBottom": true     },     "SignatureConfigurations": [       {         "SpcIdReadOnly": "string"true,
            "PdfSignatureProperties": {           "PdfAConformant": true,               "PAdESPart4CompliantMaxLength": true100,
              "IncludeSigningCertificateChain": true,              "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",           "SignatureTimestampDataIsMultiline": {false,
                "Uri": "string",             "Username": "string",
                "PasswordIsPassword": "string"true,
                "SignatureHashAlgorithm": "Sha1",             "AuthenticationCertifiateDescriptor": {
                  "IdentifierIsFileSelect": "string"false,
                  "Type": "string"             }        "IsScrollAllowed": false,
     },           "EnableEutlVerification": true,           "EnableValidateSigningCertificateName": true,           "SigningCertificateNameRegexIsCombined": "string"
       false,
        },         "PdfSignatureCryptographicData": {           "SignatureHashAlgorithm": "Sha1",           "SigningCertificateDescriptorTextFormat": {
                "Identifier": "string",             "Type": "Sha1Thumbprint",             "CspTextColor": "Default"255, 0, 0",
              }         },         "CertificateFilter": {           "KeyUsagesFontSizeInPt": [12.0,
                      "string"           ],           "ThumbPrintsFontName": ["Arial",
                "string"           ],           "RootThumbPrints": [     "Bold": false,
          "string"           ]         }       }     ],     "SigStringParsingConfigurationItalic": {false,
           "SigStringsForParsings": [         {           "StartPattern": "string",           "EndPatternTextAlign": "stringLeft",
              "ClearSigString": true,           "SearchEntireWordOnly": true         }    },
      ]     },     "GeneralPolicies": {       "AllowSaveDocument": true,       "AllowSaveAuditTrail": true,       "AllowRotatingPagesPosition": true,{
            "AllowAppendFileToWorkstep": true,       "AllowAppendTaskToWorkstep": true,       "AllowEmailDocument": true,       "AllowPrintDocument": true,       "AllowFinishWorkstepPageNumber": true1,
          "AllowRejectWorkstep": true,       "AllowRejectWorkstepDelegation": true,       "AllowUndoLastAction                  "X": true119.900001525879,
           "AllowColorizePdfForms": true,         "AllowAdhocPdfAttachments": true,       "AllowAdhocSignatures": true,       "AllowAdhocStampings": true,       "AllowAdhocFreeHandAnnotationsY": true,672.8358984375
          "AllowAdhocTypewriterAnnotations": true,       "AllowAdhocPictureAnnotations": true,       "AllowAdhocPdfPageAppending": true,       "AllowReloadOfFinishedWorkstep": true     },
        "FinalizeActions": {       "FinalizeActionList": [               ]     },     "TransactionCodeConfigurationsSize": [ {
               {         "Id": "string",         "HashAlgorithmIdentifier": "Sha1",         "TextsWidth": [ 80.0,
                 {             "Language": "string",             "ValueHeight": "string"19.544999999999998
                }         ]       }     ]   },
      "PrepareSendEnvelopeStepsDescriptor": {     "ClearFieldMarkupString": true   } }
    Expand
    titleAlternative: SOAP implementation (deprecated)
    Code Block
    languagexml
    themeEclipse
      <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:

     
    <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.-->
     "ElementId": "myText",
              
    <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>
    Code Block
    languagejava
    themeEclipse
    Code Block
    languagexml
    themeEclipse

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

    Code Block
    languagejava
    themeEclipse
    "PrepareSendEnvelopeStepsDescriptor": {
        "ClearFieldMarkupString": true
      }
    Expand
    titleAlternative: SOAP implementation (deprecated)
    <baseResult>ok</baseResult>
       
    <okInfo>
         
    <prepareSendEnvelopeStepsResult>
           
    <workstepConfiguration
     
    skipThirdPartyChecks=
    "
    0
    ExportValue"
    >
    : "G",
          
    <WorkstepLabel>workstepLabel</WorkstepLabel>
             
    <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
             
    <WorkstepTimeToLiveInMinutes>10</WorkstepTimeToLiveInMinutes>
             
    <FinishAction>
               
    <ServerAction callSynchronous="0">http://www.google.at</ServerAction>
    "DisplayValue": "Green"
                
    <ClientAction
     
    clientName="WSI"
     
    closeApp="0"
     
    RemoveDocumentFromRecentDocumentList="0"
     
    CallClientActionOnlyAfterSuccessfulSync="1">www.google.at</ClientAction>
             
    </FinishAction>
             
    <signatureTemplate>
          },
        
    <version>1.2.0.2</version>
               
    <positionUnits>PdfUnits</positionUnits>
               
    <positionReferenceCorner>Lower_Left</positionReferenceCorner>
             
    </signatureTemplate>
         {
       
    <pdfForms
     
    isEditingAllowed="1"
     
    />
             
    <ViewerPreferences>
               
    <SendVisibleArea
     
    allowedDomain="*">0</SendVisibleArea>
             
    </ViewerPreferences>
             
    <Policy version="1.1.0.0">
    "ExportValue": "B",
              
    <GeneralPolicies>
                 
    <AllowSaveDocument>1</AllowSaveDocument>
                 
    <AllowSaveAuditTrail>0</AllowSaveAuditTrail>
            "DisplayValue": "Blue"
       
    <AllowRotatingPages>1</AllowRotatingPages>
                 
    <AllowAppendFileToWorkstep>1</AllowAppendFileToWorkstep>
                 
    <AllowAppendTasksToWorkstep>1</AllowAppendTasksToWorkstep>
               }
     
    <AllowEmailDocument>0</AllowEmailDocument>
                 
    <AllowPrintDocument>0</AllowPrintDocument>
                 
    <AllowFinishWorkstep>1</AllowFinishWorkstep>
             ],
       
    <AllowRejectWorkstep>1</AllowRejectWorkstep>
                 
    <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
                 
    <AllowUndoLastAction>1</AllowUndoLastAction>
           "IsMultiSelect": true,
        
    <AllowColorizePdfForms>0</AllowColorizePdfForms>
                 
    <AllowReloadOfFinishedWorkstep>1</AllowReloadOfFinishedWorkstep>
                 
    <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
          "ReadOnly": false,
         
    <AllowAdhocSignatures>1</AllowAdhocSignatures>
                 
    <AllowAdhocStampings>1</AllowAdhocStampings>
                 
    <AllowAdhocFreeHandAnnotations>1</AllowAdhocFreeHandAnnotations>
         "Position": {
          
    <AllowAdhocTypewriterAnnotations>1</AllowAdhocTypewriterAnnotations>
                 
    <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
                 
    <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
            "PageNumber": 1,
     
    </GeneralPolicies>
               
    <WorkstepTasks
     
    SequenceMode="SequenceOnlyRequiredTasks"
     
    />
               
    <AdhocPolicies>
                 
    <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
      "X": 72.0240020751953,
           
    </AdhocPolicies>
             
    </Policy>
             
    <timeCreated>2019-10-14T11:17:00.8971613Z</timeCreated>
             
    <signaturePluginConfiguration>
         
    <!--Configurate the signature properties-->
     "Y": 308.938385009766
         
    <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>
        "Size": {
     
    <!--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>
      "Width": 80.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'-->
          
    <IncludeSigningCertificateChain>0</IncludeSigningCertificateChain>
    "Height": 10.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>
         
    <!--Configurate
     
    the
     
    cryptographic
     
    data-->
         
    <PdfSignatureCryptographicData_V1>
           
    <!--The hash algorithm used for the signatures. Possible values: 'Sha1', 'Sha256', 'Sha512'-->
    "ElementId": "myVarList",
                    
    <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.-->
    "DocumentNumber": 1,
                                    "Required": false,
                    
    <SigningCertificateDescriptor>
             
    <!--The
     
    certificates
     
    identifier-->
         "PreSelectedItems": [
      
    <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-->
    "R"
                                 
    <Csp>Default</Csp>
       ],
       
    </SigningCertificateDescriptor>
         
    </PdfSignatureCryptographicData_V1>
       
    </signaturePluginConfiguration>
             
    <TransactionCodeConfigurations>
               
    <TransactionCodeConfiguration
     
    trConfId=
    "
    smsAuthTransactionCodeId">
    FieldDefinition": {
                       
    </TransactionCodeConfiguration>
             
    </TransactionCodeConfigurations>
           
    </workstepConfiguration>
     "TextFormat": {
        
    <steps>
             
    <step>
               
    <emailBodyExtra></emailBodyExtra>
               
    <orderIndex>1</orderIndex>
         "TextColor": "255, 0, 0",
      
    <recipientType>Signer</recipientType>
               
    <useDefaultAgreements>false</useDefaultAgreements>
               
    <workstepConfiguration
     
    skipThirdPartyChecks="0">
                 
    <WorkstepLabel>workstepLabel</WorkstepLabel>
      "FontSizeInPt": 12.0,
             
    <SmallTextZoomFactorPercent>100</SmallTextZoomFactorPercent>
                 
    <WorkstepTimeToLiveInMinutes>10</WorkstepTimeToLiveInMinutes>
                 
    <FinishAction>
         "FontName": "Miriam",
            
    <ServerAction
     
    callSynchronous="0">http://www.google.at</ServerAction>
                   
    <ClientAction
     
    clientName="WSI"
     
    closeApp="0"
     
    RemoveDocumentFromRecentDocumentList="0"
     
    CallClientActionOnlyAfterSuccessfulSync="1">www.google.at</ClientAction>
                
    </FinishAction>
    "Bold": false,
                
    <ViewerPreferences>
                   
    <SendVisibleArea
     
    allowedDomain="*">0</SendVisibleArea>
                
    </ViewerPreferences>
    "Italic": false,
                
    <Policy
     
    version="1.1.0.0">
                   
    <GeneralPolicies>
                "TextAlign": "Left"
       
    <AllowSaveDocument>1</AllowSaveDocument>
                     
    <AllowSaveAuditTrail>0</AllowSaveAuditTrail>
                    },
    
    <AllowRotatingPages>1</AllowRotatingPages>
                     
    <AllowAppendFileToWorkstep>1</AllowAppendFileToWorkstep>
                     
    <AllowAppendTasksToWorkstep>1</AllowAppendTasksToWorkstep>
      "Items": [
                 
    <AllowEmailDocument>0</AllowEmailDocument>
                     
    <AllowPrintDocument>0</AllowPrintDocument>
              {
          
    <AllowFinishWorkstep>1</AllowFinishWorkstep>
                     
    <AllowRejectWorkstep>1</AllowRejectWorkstep>
                     
    <AllowRejectWorkstepDelegation>0</AllowRejectWorkstepDelegation>
        "ExportValue": "R",
                
    <AllowUndoLastAction>1</AllowUndoLastAction>
                     
    <AllowColorizePdfForms>0</AllowColorizePdfForms>
                   "DisplayValue": "Red"
    
    <AllowReloadOfFinishedWorkstep>1</AllowReloadOfFinishedWorkstep>
                     
    <AllowAdhocPdfAttachments>0</AllowAdhocPdfAttachments>
                     
    <AllowAdhocSignatures>1</AllowAdhocSignatures>
          },
              
    <AllowAdhocStampings>1</AllowAdhocStampings>
                     
    <AllowAdhocFreeHandAnnotations>1</AllowAdhocFreeHandAnnotations>
                 {
       
    <AllowAdhocTypewriterAnnotations>1</AllowAdhocTypewriterAnnotations>
                     
    <AllowAdhocPictureAnnotations>0</AllowAdhocPictureAnnotations>
                     
    <AllowAdhocPdfPageAppending>0</AllowAdhocPdfPageAppending>
           "ExportValue": "G",
          
    </GeneralPolicies>
                   
    <AdhocPolicies>
                     
    <AllowModificationsAfterSignature>1</AllowModificationsAfterSignature>
          "DisplayValue": "Green"
           
    </AdhocPolicies>
                   
    <WorkstepTasks
     
    originalSequenceMode="NoSequenceEnforced"
     
    SequenceMode="NoSequenceEnforced">
                    },
    
    <Task
     
    id="17006562-45c4-4ab2-83f9-2333bada59c2"
     
    DocRefNumber="1"
     
    enabled="1"
     
    completed="0"
     
    type="FillFormsGroup"
     
    required="1"
     
    displayName=""
     
    />
                   
    </WorkstepTasks>
                 
    </Policy>
        {
            
    <timeCreated>2019-10-14T11:17:00.8971613Z</timeCreated>
                 
    <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.-->
    "ExportValue": "B",
                                                "DisplayValue": "Blue"
          
    <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-->
    "IsMultiSelect": true,
                                        "ReadOnly": false,
                                        "Position": {
                                           
    <SigningCertificateRevocationInformationIncludeMode>DoNotInclude</SigningCertificateRevocationInformationIncludeMode>
     "PageNumber": 1,
      
    </PdfSignatureProperties_V1>
         
    <!--Configurate
     
    the
     
    cryptographic
     
    data-->
         
    <PdfSignatureCryptographicData_V1>
           
    <!--The
     
    hash
     
    algorithm
     
    used
     
    for
     
    the
     
    signatures.
     
    Possible
     
    values:
     
    'Sha1',
     
    'Sha256',
     
    'Sha512'-->
           
    <SignatureHashAlgorithm>Sha256</SignatureHashAlgorithm>
    "X": 72.0240020751953,
         
    <!--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.-->
    "Y": 253.978393554688
                           
    <SigningCertificateDescriptor>
             
    <!--The
     
    certificates
     
    identifier-->
      },
          
    <Identifier>14527a6bcfa8b4d7d0183fca6b735b1c246d14ae</Identifier>
             
    <!--The
     
    certificate
     
    identifier
     
    type.
     
    Possible
     
    values:
     
    'Subject',
     
    'Sha1Thumbprint'-->
             
    <Type>Sha1Thumbprint</Type>
         "Size": {
      
    <!--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>
     "Width": 80.0,
      
    </PdfSignatureCryptographicData_V1>
       
    </signaturePluginConfiguration>
                 
    <TransactionCodeConfigurations>
                   
    <TransactionCodeConfiguration
     
    trConfId="smsAuthTransactionCodeId">
          "Height": 10.0
                         
    </TransactionCodeConfiguration>
                 
    </TransactionCodeConfigurations>
      }
              
    <pdfForms
     
    isEditingAllowed="0">
                   
    <pdfFormsGroup
     
    id="17006562-45c4-4ab2-83f9-2333bada59c2">
         }
               
    <textBox
     
    id="myText1">
                    }
      
    <DocRefNumber>1</DocRefNumber>
                     
    <isRequired>1</isRequired>
         ],
                 
    <positionPage>1</positionPage>
               
    "Signatures": [
        
    <positionX>72</positionX>
                       
    <positionY>563</positionY>
         {
                 
    <width>200</width>
                       
    <height>65.15</height>
    "Id": "sigField1",
                  
    </textBox>
                     
    <checkBox
     
    id=
    "
    chk1
    Required"
    >
    : true,
                     
    <requiredEvalPolicy>IsChecked</requiredEvalPolicy>
                   
    "DocumentNumber": 1,
     
    <DocRefNumber>1</DocRefNumber>
                       
    <isRequired>1</isRequired>
                "DisplayName": "signature label",
        
    <positionPage>1</positionPage>
                       
    <positionX>72</positionX>
             "AllowedSignatureTypes": {
            
    <positionY>440</positionY>
                       
    <width>25</width>
             "ClickToSign": {},
            
    <height>25</height>
                     
    </checkBox>
               "SignaturePlugins": []
      
    </pdfFormsGroup>
                 
    </pdfForms>
                 
    <TypewriterAnnotationTaskInfo
     
    />
       },
             
    <attachmentFields
     
    />
                 
    <signatureTemplate>
             "FieldDefinition": {
        
    <version>1.2.0.2</version>
                   
    <positionReferenceCorner>Lower_Left</positionReferenceCorner>
                   
    <positionUnits>PdfUnits</positionUnits>
      "Position": {
             
    </signatureTemplate>
               
    </workstepConfiguration>
               
    <recipients>
             "PageNumber": 1,
      
    <recipient>
                   
    <eMail>placeholder1@placeholder1.com</eMail>
                   
    <emailBodyExtra></emailBodyExtra>
            "X": 142.100006103516,
         
    <firstName>placeholder1</firstName>
                   
    <lastName>placeholder1</lastName>
                   
    <languageCode>en</languageCode>
         "Y": 759.248413085938
            
    <disableEmail>false</disableEmail>
                   
    <skipExternalDataValidation>false</skipExternalDataValidation>
                 },
     
    <addAndroidAppLink>false</addAndroidAppLink>
                   
    <addIosAppLink>false</addIosAppLink>
                   
    <addWindowsAppLink>false</addWindowsAppLink>
         "Size": {
            
    <allowDelegation>true</allowDelegation>
                   
    <authentications
     
    />
                 
    </recipient>
       "Width": 150.0,
           
    </recipients>
             
    </step>
           
    </steps>
           
    <addFormFields>
             
    <document
     
    docRef=
    "
    1">
    Height": 60.0
                  
    <textBox
     
    name="myText1"
     
    readOnly="false"
     
    required="true"
     
    x="72"
     
    y="563.477001953125"
     
    width="200"
     
    height="65.149999999999991"
     
    page="1">
                 
    <fontSettings>
     }
                 
    <textColor>#FF0000</textColor>
                   
    <fontName>Arial</fontName>
        },
              
    <fontSize>12</fontSize>
                   
    <fontStyleBold>false</fontStyleBold>
           "TaskConfiguration": {}
          
    <fontStyleItalic>false</fontStyleItalic>
                   
    <textAlign>Center</textAlign>
           },
         
    </fontSettings>
                 
    <value>Place
     
    for
     
    signer1</value>
            {
        
    <maxLength>100</maxLength>
                 
    <isMultiLine>false</isMultiLine>
                 
    <isPassword>false</isPassword>
      "Id": "sigField001",
             
    <isFileSelect>false</isFileSelect>
                 
    <isScrollAllowed>false</isScrollAllowed>
              "Required": true,
     
    <isComb>false</isComb>
               
    </textBox>
               
    <checkBox name="chk1" readOnly="false" required="true" x="72" y="439.802001953125" width="25" height="25" page="1"> <isChecked>true</isChecked> </checkBox> </document> </addFormFields> </prepareSendEnvelopeStepsResult> </okInfo>
    {
        "AdHocWorkstepConfigResult": {
            "WorkstepLabel": "string",
            "SmallTextZoomFactorPercent": 0,
            "FinishAction": {
                "ServerActions": [], "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": {
                                                "From": "13. März 2018",
                                                "To": "18. December 2019"
                                            }
                       "ClientActions": [                }
    {                     "RemoveDocumentFromRecentDocumentList": true,          },
              "CallClientActionOnlyAfterSuccessfulSync": true,                     "ClientNameFieldDefinition": "string",{
                        "CloseApp": true,
                        "ActionReadOnly": "string"false,
                    }             ]         }"MaxLength": 0,
            "TransactionCodeConfigurations": [             {                 "IdIsMultiline": "string"false,
                    "HashAlgorithmIdentifier": "Sha1",                    "TextsIsPassword": false,
      [                     {             "IsFileSelect": false,
              "Language": "string",                         "ValueIsScrollAllowed": "string"false,
                        }                "IsCombined": false,
    ]             },             {          "TextFormat": {
         "Id": "smsAuthTransactionCodeId",                 "HashAlgorithmIdentifier": "Sha256",                "TextColor": "Texts": [Black",
                                             ]"FontSizeInPt": 3.0,
                   }         ],         "SignatureConfigurations": [      "FontName": "Arial",
         {                 "SpcId": "string",                 "PdfSignaturePropertiesBold": {false,
                        "PdfAConformant": true,                     "PAdESPart4CompliantItalic": truefalse,
                        "IncludeSigningCertificateChain": true,                     "SigningCertificateRevocationInformationIncludeModeTextAlign": "DoNotIncludeLeft",
                         "SignatureTimestampData": {              },
              "Uri": "string",                         "UsernamePosition": "string", {
                                  "Password": "string",         "PageNumber": 1,
                  "SignatureHashAlgorithm": "Sha1",                         "AuthenticationCertifiateDescriptorX": {97.2239990234375,
                                 "Identifier": "string",          "Y": 606.47327994060493
                     "Type": "string"                         },
                        },                "Size": {
       "EnableEutlVerification": true,                     "EnableValidateSigningCertificateName": true,              "Width": 192.293640136719,
         "SigningCertificateNameRegex": "string"                 },                 "PdfSignatureCryptographicDataHeight": {5.1186008701324415
                        "SignatureHashAlgorithm": "Sha1",               }
         "SigningCertificateDescriptor": {                         "Identifier": "string", }
                            "Type": "Sha1Thumbprint",   },
                         "Csp": "Default"      {
                  }                 },    "ElementId": "somePhone",
                "CertificateFilter": {                     "KeyUsagesRequired": [false,
                            "string"        "Value": "",
               ],                     "ThumbPrintsDocumentNumber": [1,
                            "string"        "Validation": {
               ],                     "RootThumbPrints": [   "Type": "Phone",
                        "string"                "PhoneValidationConfiguration": {
       ]                 }             }       "Type": "International"
      ],          "ViewerPreferences": {             "ShowPageNavigationBar": true,         }
       "ShowThumbnails": true,             "SkipFinishConfirmDialog": true,             "SkipDocumentDialog": true},
                "ShowImagesInFullWidth": true,                "DisableGeolocation": true,   "FieldDefinition": {
            "ShowDocumentDownloadDialogAfterAutomaticFinish": true,             "AttachmentsMaxFileSize": 0,             "SkipPreviewImageOnDisposableCertificateReadOnly": truefalse,
                "LoadCustomJs": true,             "AllowCustomButtons": true,
                "GuidingBehaviorMaxLength": "GuideOnlyRequiredTasks",
      0,
             "FormFieldsGuidingBehavior": "AllowSubmitAlways",             "ShowVersionNumber": true,             "EnableWarningPopupOnLeaveIsMultiline": truefalse,
                "WarningPopupDisplayAfter": "FillOrSignField",             "FinishWorkstepOnOpen": true,             "AutoFinishAfterRequiredTasksDoneIsPassword": truefalse,
                "GuidingBehaviorOnFinishedTask": "NoMove",             "SkipThankYouDialog": true,             "NativeAppsUrlSchemeIsFileSelect": "string"false,
                "DocumentViewingMode": "EndlessPaperAllDocuments",             "ThumbnailMode": "ShowAllPages",             "ShowTopBarIsScrollAllowed": truefalse,
                "DisplayRejectButtonInTopBar": true,             "MultipleSignatureTypesAndBatchSigningSettings": {                 "IsUseBatchSigningCheckedByDefault"IsCombined": truefalse,
                      "IsRememberSignatureTypeCheckedByDefault": true,                 "IsRememberBatchSigningDecisionCheckedByDefaultTextFormat": true,{
                    "SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossible": true             },          "TextColor": "Black",
       "VisibleAreaOptions":  {                 "AllowedDomain": "string",                 "EnabledFontSizeInPt": true3.0,
                 },             "ShowStartGuidingHint": true,             "ShowStatusBarFontName": true"Arial",
                "ShowZoomButtons": true,             "ShowNoGeolocationWarning": true,             "AutoStartGuidingBold": truefalse,
                "ShowPageNavigationButtons": true,             "ShowFinishPossibleHint": true,             "SkipRejectConfirmDialogItalic": truefalse,
                 "BatchSigningType": "Basic",             "BatchSigningDisableNextButtonUntilDialogScrolledToBottom": true         },   "TextAlign": "Left"
        "Policy":  {             "GeneralPolicies": {                },
    "AllowSaveDocument": true,                 "AllowSaveAuditTrail": true,                 "AllowRotatingPagesPosition": true,{
                          "AllowAppendFileToWorkstep": true,                 "AllowAppendTaskToWorkstepPageNumber": true1,
                    "AllowEmailDocument": true,                        "AllowPrintDocumentX": true105.379997253418,
                      "AllowFinishWorkstep": true,                      "AllowRejectWorkstepY": true,543.44325064372993
                     "AllowRejectWorkstepDelegation": true,                 "AllowUndoLastAction": true},
                     "AllowColorizePdfForms": true,                   "AllowAdhocPdfAttachmentsSize": true, {
                          "AllowAdhocSignatures": true,                 "AllowAdhocStampingsWidth": true86.3280029296875,
                     "AllowAdhocFreeHandAnnotations": true,                       "AllowAdhocTypewriterAnnotationsHeight": true,5.1186008701324415
                    "AllowAdhocPictureAnnotations": true,                 "AllowAdhocPdfPageAppending": true, }
                   "AllowReloadOfFinishedWorkstep": true             },   }
             "WorkstepTasks": {                 "PictureAnnotationMinResolution": 0},
                    "PictureAnnotationMaxResolution": 0,           {
         "PictureAnnotationColorDepth": "Color16M",                 "SequenceMode": "NoSequenceEnforced",                 "PositionUnits"ElementId": "PdfUnitssomeTime",
                    "ReferenceCorner": "Lower_Left",
                    "TasksRequired": false,
    []             }         }     },     "StepsValue": ["",
            {             "OrderIndex": 1,
                "RecipientsDocumentNumber": [
       1,
                {                     "EmailValidation": "placeholder1@placeholder1.com",
      {
                     "FirstName": "placeholder1",                     "LastNameType": "placeholder1Time",
                        "LanguageCode": "en",
                        "DisableEmailTimeValidationConfiguration": false,{
                        "AddAndroidAppLink": false,                    "Format": "AddIosAppLink": falseHH:mm",
                        "AddWindowsAppLink": false,                     "AllowDelegationRange": {
     true,                     "SkipExternalDataValidation": false,                     "AuthenticationMethodsFrom": "12:00",
    []                  }             ],             "RecipientTypeTo": "Signer",18:00"
                  "WorkstepConfiguration": {                 "WorkstepLabel": "string",       }
             "SmallTextZoomFactorPercent": 0,                 "FinishAction": {        }
                "ServerActions": [],                   },
     "ClientActions": [                         {     "FieldDefinition": {
                          "RemoveDocumentFromRecentDocumentList": true,             "ReadOnly": false,
                  "CallClientActionOnlyAfterSuccessfulSync": true,                     "MaxLength": 0,
          "ClientName": "string",                             "CloseAppIsMultiline": truefalse,
                                   "Action": "string"    "IsPassword": false,
                       }                 "IsFileSelect": false,
      ]                 },                 "TransactionCodeConfigurationsIsScrollAllowed": [false,
                        {                "IsCombined": false,
           "Id": "string",                             "HashAlgorithmIdentifierTextFormat": "Sha1",{
                            "Texts": [               "TextColor": "Black",
                {                            "FontSizeInPt": 3.0,
       "Language": "string",                                     "ValueFontName": "stringArial",
                                }            "Bold": false,
               ]                     },        "Italic": false,
               {                             "IdTextAlign": "smsAuthTransactionCodeIdLeft",
                            "HashAlgorithmIdentifier": "Sha256",           },
                 "Texts": [                      "Position":  {
                                ]            "PageNumber": 1,
           }                 ],                 "SignatureConfigurationsX": [98.3040008544922,
                        {                         "SpcIdY": "string",522.32325552654288
                            "PdfSignatureProperties": {           },
                     "PdfAConformant": true,                  "Size": {
             "PAdESPart4Compliant": true,                               "IncludeSigningCertificateChainWidth": true135.384201049805,
                                "SigningCertificateRevocationInformationIncludeMode": "DoNotInclude",           "Height": 5.1186008701324415
                    "SignatureTimestampData": {                   }
                 "Uri": "string",                  }
                  "Username": "string",             }
                       "Password": "string",     ],
                               "SignatureHashAlgorithmCheckBoxes": "Sha1",
        [
                               "AuthenticationCertifiateDescriptor": {
                                        "IdentifierElementId": "stringchk1",
                                    "DocumentNumber": 1,
      "Type": "string"                              "Required": true,
        }                            "IsChecked": }false,
                                    "EnableEutlVerificationFieldDefinition": true, {
                                        "EnableValidateSigningCertificateNamePosition": {
      true,                             "SigningCertificateNameRegex": "string"        "PageNumber": 1,
                   },                         "PdfSignatureCryptographicDataX": {121.699996948242,
                                "SignatureHashAlgorithm": "Sha1",           "Y": 501.918395996094
                    "SigningCertificateDescriptor": {                   },
                 "Identifier": "string",                      "Size": {
             "Type": "Sha1Thumbprint",
                                    "CspWidth": "Default"10.0,
                                }            "Height": 10.0
               },                         "CertificateFilter": {},
                                 "KeyUsages": [      "ReadOnly": false
                             "string"       }
                         ],       }
                         "ThumbPrints": [  ],
                            "ComboBoxes": [
        "string"                        {
        ],                             "RootThumbPrintsElementId": ["myDrop",
                                    "stringDocumentNumber": 1,
                               ]     "Required": false,
                      }                   "Value": "R",
     }                 ],                 "ViewerPreferencesFieldDefinition": {
                        "ShowPageNavigationBar": true,               "TextFormat": {
        "ShowThumbnails": true,                     "SkipFinishConfirmDialog": true,                     "SkipDocumentDialog"TextColor": true"255, 0, 0",
                      "ShowImagesInFullWidth": true,                     "DisableGeolocationFontSizeInPt": true12.0,
                        "ShowDocumentDownloadDialogAfterAutomaticFinish": true,                     "AttachmentsMaxFileSizeFontName": 0"Arial",
                        "SkipPreviewImageOnDisposableCertificate": true,
                        "LoadCustomJsBold": truefalse,
                        "AllowCustomButtons": true,                     "GuidingBehaviorItalic": "GuideOnlyRequiredTasks"false,
                        "FormFieldsGuidingBehavior": "AllowSubmitAlways",                   "TextAlign":  "ShowVersionNumber": true,Center"
                                 "EnableWarningPopupOnLeave": true,      },
                  "WarningPopupDisplayAfter": "FillOrSignField",                     "FinishWorkstepOnOpenItems": true,
    [
                       "AutoFinishAfterRequiredTasksDone": true,                    {
    "GuidingBehaviorOnFinishedTask": "NoMove",                     "SkipThankYouDialog": true,                     "NativeAppsUrlSchemeExportValue": "stringR",
                          "DocumentViewingMode": "EndlessPaperAllDocuments",                     "ThumbnailModeDisplayValue": "ShowAllPagesRed",
                         "ShowTopBar": true,                     "DisplayRejectButtonInTopBar": true},
                        "MultipleSignatureTypesAndBatchSigningSettings": {                   {
         "IsUseBatchSigningCheckedByDefault": true,                         "IsRememberSignatureTypeCheckedByDefault": true,            "ExportValue": "G",
               "IsRememberBatchSigningDecisionCheckedByDefault": true,                         "SkipMultipleSignatureTypesAndBatchSigningDialogIfBatchSigningPossible": true      "DisplayValue": "Green"
                 },                     "VisibleAreaOptions": {     },
                       "AllowedDomain": "string",                    {
        "Enabled": true                     },
                        "ShowStartGuidingHintExportValue": true"B",
                        "ShowStatusBar": true,                        "ShowZoomButtonsDisplayValue": true,"Blue"
                        "ShowNoGeolocationWarning": true,                   }
     "AutoStartGuiding": true,                     "ShowPageNavigationButtons": true,            ],
            "ShowFinishPossibleHint": true,                     "SkipRejectConfirmDialog": true,     "IsEditable": true,
                  "BatchSigningType": "Basic",                     "BatchSigningDisableNextButtonUntilDialogScrolledToBottomReadOnly": false,
    true                 },                 "Policy  "Position": {
                        "GeneralPolicies": {                   "PageNumber": 1,
        "AllowSaveDocument": true,                         "AllowSaveAuditTrail": true,         "X": 72.0240020751953,
                  "AllowRotatingPages": true,                         "AllowAppendFileToWorkstepY": true,360.683402099609
                            "AllowAppendTaskToWorkstep": true,           },
                 "AllowEmailDocument": true,                         "AllowPrintDocumentSize": true,{
                            "AllowFinishWorkstep": true,               "Width": 80.0,
            "AllowRejectWorkstep": true,                         "AllowRejectWorkstepDelegation": true,     "Height": 16.67
                      "AllowUndoLastAction": true,                 }
           "AllowColorizePdfForms": true,                        }
    "AllowAdhocPdfAttachments": true,                         "AllowAdhocSignatures": true, }
                           "AllowAdhocStampings": true],
                            "AllowAdhocFreeHandAnnotationsRadioButtons": [
    true,                         "AllowAdhocTypewriterAnnotations": true,  {
                          "AllowAdhocPictureAnnotations": true,         "GroupName": "testRbnGroup",
                  "AllowAdhocPdfPageAppending": true,                 "DocumentNumber": 1,
          "AllowReloadOfFinishedWorkstep": true                     },    "IsSelectUnison": false,
                   "WorkstepTasks": {                "Required": false,
           "PictureAnnotationMinResolution": 0,                         "PictureAnnotationMaxResolutionSelectedItem": 0"Red",
                            "PictureAnnotationColorDepth        "FieldDefinitions": [
    "Color16M",                         "SequenceMode": "NoSequenceEnforced",          {
                  "PositionUnits": "PdfUnits",                         "ReferenceCornerExportValue": "Lower_LeftRed",
                            "Tasks": [                "IsChecked": true,
                      {                      "Position": {
               "Forms": [                                "PageNumber": 1,
       {                                         "IdX": "myText1"72.0240020751953,
                                                "PositionPageY": 1,444.918395996094
                                            "DocRefNumber": 1},
                                            "PositionSize": {
                                                "PositionXWidth": 7210.0,
                                                "PositionYHeight": 56310.0
                                            },
                                        },
       "Size": {                                 {
                  "Height": 65.15,                         "ExportValue": "Green",
                      "Width": 200.0                     "IsChecked": false,
                      },                      "Position": {
                     "DiscriminatorType": "TextBox"                          "PageNumber": 1,
             },                                   "X": 72.0240020751953,
       {                                         "IsRequiredY": true,431.958404541016
                                            "RequiredEvalPolicy": "IsChecked"},
                                            "IdSize": "chk1",{
                                                "PositionPageWidth": 110.0,
                                                "DocRefNumberHeight": 10.0
    1,                                        }
    "Position": {                                   },
             "PositionX": 72.0,                          {
                      "PositionY": 440.0                     "ExportValue": "Blue",
                      },                      "IsChecked": false,
                     "Size": {                      "Position": {
                         "Height": 25.0,                      "PageNumber": 1,
                         "Width": 25.0                      "X": 72.0240020751953,
                     },                           "Y": 418.998413085938
                "DiscriminatorType": "CheckBox"                           },
             }                               "Size": {
    ],                                 "IsRequired": true,          "Width": 10.0,
                         "Id": "c9919432-ccd0-46a1-a715-9568faa2d57a",                      "Height": 10.0
             "DisplayName": "",                              }
      "DocRefNumber": 1,                                 "DiscriminatorType": "FormGroup"}
                                 }   ]
                         ]       }
                 }           ],
         }             },      "ListBoxes": [
         "DocumentOptions": [],             "UseDefaultAgreements": false        {
    }     ],     "AddFormFields": {
            "Forms": {             "1ElementId": ["myList",
                    {                "DocumentNumber": 1,
       "Value": "Place for signer1",                             "MaxLengthRequired": 100false,
                        "IsMultiline": false,           "PreSelectedItems": [
            "IsPassword": false,                     "IsFileSelect": false,     "R"
                   "IsScrollAllowed": false,                ],
        "IsComb": false,                     "TextColor": "255, 0, 0",   "FieldDefinition": {
                    "FontSize": 12.0,                     "FontNameTextFormat": "Arial",{
                        "Bold": false,                     "ItalicTextColor": false"255, 0, 0",
                      "TextAlign": "Center",                     "NameFontSizeInPt": "myText1"12.0,
                        "ReadOnly": false,
                        "RequiredFontName": true"Arial",
                        "X": 72.0,                     "YBold": 563.477001953125false,
                        "Width": 200.0,                        "HeightItalic": 65.149999999999991false,
                        "Page": 1,                     "DiscriminatorTypeTextAlign": "AddTextBoxFormFieldDescriptorRight"
                    },                 {   },
                     "IsChecked": true,                     "ExportValueItems": "",[
                        "Name": "chk1",                   {
     "ReadOnly": false,                     "Required": true,                     "XExportValue": 72.0"R",
                        "Y": 439.802001953125,                        "WidthDisplayValue": 25.0,"Red"
                        "Height": 25.0,                   },
     "Page": 1,                     "DiscriminatorType": "AddCheckBoxFormFieldDescriptor"                {
    }             ]         }     } }
    Expand
    titleAlternative: SOAP implementation (deprecated)
    Code Block
    languagexml
    themeEclipse

    Sending the envelope

    You can now add the workstep configuration which you got from the prepare call and send the document to recipients.
             "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)]]