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.

...

Integration

Advanced Document Tags

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

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

Info

title	Alternatives

eSignAnyWhere is offering following alternatives to insert interactive elements:

Prepare a PDF document with Acrobat Form Fields (simple field types such as text input can be defined e.g. with OpenOffice; signature fields can be inserted with Adobe Acrobat Pro.
Form Fields can't be assigned automatically to the proper signer. Less options for configuration.
Use the simpler sig-string notation as plain-text within the PDF document
Sig strings are supported also by other products of Namirial (xyzmo Client, etc). Fields created via sig strings can't be assigned automatically to the proper signer. Less options for configuration. Benefit is the freely definable start (and optional end) marker string.
Define the fields entirely in the envelope JSON structures when creating a draft or sending an envelope via API

Dimension limitation

Info

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

Image Removed

Dimenstion Limitations Image Added

General Syntax

Info

title	Recommendations for correct parsing

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

Info

title	Measurement unit

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

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

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

The 2nd field definition parameter is the assignment.

Then, attributed element definitions follow.

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

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

Parameters

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

Signature Fields

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

Sample for Click2Sign and Draw2Sign

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

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

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

Sample for SwissComOnDemandCertificate Signature

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

Form Fields

Attachments

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

label, size are optional.

Textfield

Info

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

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

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

Code Block

language	java
theme	Eclipse

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

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

Input Validation Image Modified

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

Date

Requires a date field for signer1

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

range is optional and must match with defined format

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

time

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

range is optional
range must match the defined format

...

Checkbox

...

[[

...

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

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

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

List

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

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

Offset

You can define a offset by using

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

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

Variables

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

Definition:

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

Usage:

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

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

Code Block

language	java
theme	Eclipse

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

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

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

Workflow

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

Prepare a document with advanced document tags
1. First, create or prepare a document with advanced document

...

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 envelope

If you are using the Advanced Tags via API you have to call file/prepare to use them.

...

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

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

Prepare a document with advanced document tags

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

Download the document advanced_document.pdf.

Upload the document

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

Preparing the file

If you are using the Advanced Tags via API you have to call file/prepare to use them.

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

For this call you need the File Id which you got from the upload file call and the following sample configuration:

Code Block

language	java
theme	Eclipse

{
  "FileIds": [
    "6a1eef93-1234-1234-9526-bceda76addba"
  ],
  "ClearFieldMarkupString": true,
  "SigStringConfigurations": [
    {
      "StartPattern": "string",
      "EndPattern": "string",
      "ClearSigString": true,
      "SearchEntireWordOnly": true
    }
  ]
}

...

Please note the following: If you define “false” for the "ClearFieldMarkupString" the field markup string will not be cleared. If you choose “true” the field markup string will be cleared.

Code Block

language	java
theme	Eclipse

"ClearFieldMarkupString": true,

...

Code Block

language	java
theme	Eclipse

UnassignedElements

FileIds":

{

[
    "string"
  ],
  "

TextBoxes

ClearAdvancedDocumentTags":

[]

true,

"CheckBoxes

"SigStringConfigurations": [

],


    {
      "

ComboBoxes

StartPattern":

[]

"string",

RadioButtons

EndPattern":

[]

"string",

ListBoxes

ClearSigString":

[]

true,

Signatures

SearchEntireWordOnly":

[],

true
    }
  ]
}

Sending the envelope

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

Available configurations

Expand

title	All available configurations

{

UnassignedElements

Position": {

"TextBoxes":

[],

"CheckBoxes":

[],

"ComboBoxes":

[],

"RadioButtons":

[],

ListBoxes

PageNumber":

[]

1,

"Signatures": [],

"Attachments":

[],

"LinkConfiguration":

{

HyperLinks

X":

[]

72.0240020751953,

"DocumentLinks":

[]

}

},

"Activities":

[

{

  "Y": 644.995871582031

"Action":

{

"Sign":

{

},

"Elements":

{

TextBoxes

Size":

[

{

      "Width": 80.0,

"ElementId":

"myDisabledText",

              "Height": 19.544999999999998

"Required": false,

"Value":

"default

text",

"DocumentNumber":

1,

},

"Validation":

{

    {
                                "

Type

ElementId": "

None

someDate",

}

"Required": true,
                                "

FieldDefinition

Value":

{

"",

ReadOnly

DocumentNumber":

true

1,

MaxLength

Validation":

100,

{
                                    "

IsMultiline

Type":

false

"Date",
                                    "

IsPassword

DateValidationConfiguration":

true,

{
                                        "

IsFileSelect

Format":

false,

"dd. MMMM yyyy",

"IsScrollAllowed": false,

       "Range": {

"IsCombined":

false,

            "From": "13. März 2018",

"TextFormat":

{

                      "To": "18. December 2019"

"TextColor":

"255,

0,

0",

"FontSizeInPt":

12.0,

"FontName":

"Arial",

        },
                                "

Bold

FieldDefinition":

false,

Italic

ReadOnly": false,

TextAlign

MaxLength":

"Left"

0,

}

"IsMultiline": false,
                                    "

Position

IsPassword":

{

false,

PageNumber

IsFileSelect":

1

false,

X

IsScrollAllowed":

119.900001525879

false,

Y

IsCombined":

672.8358984375

false,

},

"TextFormat": {
                                        "

Size

TextColor":

{

"Black",
                                        "

Width

FontSizeInPt":

80

3.0,
                                        "

Height

FontName":

19.544999999999998

"Arial",

}

    "Bold": false,

}

             "Italic": false,

},

                        "TextAlign": "Left"

{

"ElementId": "myText"

 },
                                    "

Required

Position":

false,

"Value":

"default

text",

"PageNumber": 1,

"DocumentNumber":

1,

               "X": 97.2239990234375,

"Validation":

{

                       "Y": 606.47327994060493

"Type": "None"

},

},

FieldDefinition

Size": {
                                        "

ReadOnly

Width":

false

192.293640136719,
                                        "

MaxLength

Height":

100,

5.1186008701324415

"IsMultiline": false,

}
                                }

"IsPassword": false,

},

"IsFileSelect":

false,

    {
                                "

IsScrollAllowed

ElementId":

false

"somePhone",

IsCombined

Required": false,

TextFormat

Value":

{

"",
                                "

TextColor

DocumentNumber":

"255, 0, 0",

1,

"FontSizeInPt

"Validation":

12.0,

{
                                    "

FontName

Type": "

Arial

Phone",

Bold

PhoneValidationConfiguration":

false,

{
                                        "

Italic

Type":

false,

"International"

"TextAlign": "Left"

},

Position

FieldDefinition": {

PageNumber

ReadOnly":

1

false,

X

MaxLength":

72.0240020751953

0,

Y

IsMultiline":

644.995871582031

false,

}

"IsPassword": false,
                                    "

Size

IsFileSelect":

{

false,

"Width"

"IsScrollAllowed":

80.0

false,

Height

IsCombined":

19.544999999999998

false,

}

"TextFormat": {

}

        "TextColor": "Black",

},

                    "FontSizeInPt": 3.0,

{

ElementId

FontName": "

someDate

Arial",

"Required":

true,

       "Bold": false,

"Value":

"",

"Italic": false,

"DocumentNumber":

1,

Validation

TextAlign":

{

"Left"

"Type": "Date"

},
                                    "

DateValidationConfiguration

Position": {
                                        "

Format

PageNumber":

"dd. MMMM yyyy"

1,
                                        "

Range

X":

{

105.379997253418,
                                        "

From

Y":

"13. März 2018",

543.44325064372993
                                    },

"To":

"18. December

2019"

                          "Size": {

}

                          "Width": 86.3280029296875,

}

},

"Height": 5.1186008701324415

"FieldDefinition":

{

"ReadOnly": false,

"MaxLength": 0

},

"IsMultiline": false,

IsPassword

ElementId":

false

"someTime",

IsFileSelect

Required": false,

IsScrollAllowed

Value":

false

"",

IsCombined

DocumentNumber":

false

1,

TextFormat

Validation": {

TextColor

Type": "

Black

Time",

FontSizeInPt

TimeValidationConfiguration":

3.0,

{
                                        "

FontName

Format": "

Arial

HH:mm",
                                        "

Bold

Range":

false,

{
                                            "

Italic

From":

false

"12:00",
                                            "

TextAlign

To": "

Left

18:00"
                                        }

,

"Position": {

"PageNumber": 1

},

"X

"FieldDefinition":

97.2239990234375,

Y

ReadOnly":

606.47327994060493

false,

}

"MaxLength": 0,
                                    "

Size

IsMultiline":

{

false,

Width

IsPassword":

192.293640136719

false,

Height

IsFileSelect":

5.1186008701324415

false,

}

"IsScrollAllowed": false,

}

    "IsCombined": false,

},

             "TextFormat": {

{

"ElementId

"TextColor": "

somePhone

Black",

"Required

        "FontSizeInPt":

false

3.0,
                                        "

Value

FontName": "Arial",

"DocumentNumber

       "Bold":

1

false,

"Validation

        "Italic":

{

false,
                                        "

Type

TextAlign": "

Phone

Left"

,

"PhoneValidationConfiguration": {

},
                                    "Position": {

"Type":

"International"

}

"PageNumber": 1,

}

"X": 98.3040008544922,
                                        "

FieldDefinition

Y":

{

522.32325552654288

"ReadOnly": false

},
                                    "

MaxLength

Size":

0,

{
                                        "

IsMultiline

Width":

false

135.384201049805,
                                        "

IsPassword

Height":

false,

5.1186008701324415

"IsFileSelect": false,

}
                                }

"IsScrollAllowed":

false,

"IsCombined": false,

],
                        "

TextFormat

CheckBoxes":

{

[
                            {

"TextColor":

"Black",

                   "ElementId": "chk1",

"FontSizeInPt":

3.0,

          "DocumentNumber": 1,

"FontName

   "Required":

"Arial"

true,

Bold

IsChecked": false,

"Italic

"FieldDefinition":

false,

{
                                    "Position": {

"TextAlign":

"Left"

                                   "PageNumber":

}

1,
                                        "

Position

X":

{

121.699996948242,
                                        "

PageNumber

Y":

1,

501.918395996094
                                    },

"X":

105.379997253418,

                               "Size": {

"Y":

543.44325064372993

                               "Width": 10.0,

},

Size

Height":

{

10.0
                                    },

"Width": 86.3280029296875,

                                "ReadOnly": false

"Height":

5.1186008701324415

}

],

},

"ComboBoxes": [
                            {
                                "ElementId": "

someTime

myDrop",
                                "

Required

DocumentNumber":

false

1,
                                "

Value

Required":

""

false,
                                "

DocumentNumber

Value":

1

"R",
                                "

Validation

FieldDefinition": {
                                    "

Type

TextFormat":

"Time",

{
                                        "

TimeValidationConfiguration

TextColor":

{

 "255, 0, 0",
                                        "

Format

FontSizeInPt":

"HH:mm"

12.0,
                                        "

Range

FontName":

{

"Arial",

From

Bold":

"12:00"

false,

To

Italic":

"18:00"

false,

}

 "TextAlign": "Center"
                                    },

},

 "Items": [

"FieldDefinition":

{

"ReadOnly":

false,

              "ExportValue": "R",

"MaxLength":

0,

                      "DisplayValue": "Red"

"IsMultiline":

false,

},

"IsPassword":

false,

"IsFileSelect":

false,

IsScrollAllowed

ExportValue":

false

"G",

"IsCombined

        "DisplayValue":

false,

"Green"

"TextFormat": {

},

"TextColor": "Black",

{
                                            "

FontSizeInPt

ExportValue":

3.0

"B",
                                            "

FontName

DisplayValue": "

Arial

Blue"

,

"Bold": false,

"Italic": false

],

TextAlign

IsEditable":

"Left"

true,
                                    "ReadOnly":

}

false,
                                    "Position": {
                                        "PageNumber": 1,
                                        "X":

98

72.

3040008544922

0240020751953,
                                        "Y":

522

360.

32325552654288

683402099609
                                    },
                                    "Size": {
                                        "Width":

135

80.

384201049805

0,
                                        "Height":

5

16.

1186008701324415

CheckBoxes

RadioButtons": [
                            {
                                "

ElementId

GroupName": "

chk1

testRbnGroup",
                                "DocumentNumber": 1,
                                "

Required

IsSelectUnison":

true

false,
                                "

IsChecked

Required": false,
                                "

FieldDefinition

SelectedItem":

{

"Red",
                                "

Position

FieldDefinitions":

{

"PageNumber": 1,

{
                                        "

X

ExportValue":

121.699996948242

"Red",
                                        "

Y

IsChecked":

501.918395996094

true,

},

    "Position": {

"Size

             "PageNumber":

{

1,
                                            "

Width

X":

10

72.

0

0240020751953,
                                            "

Height

Y":

10

444.

0

918395996094
                                        },
                                        "

ReadOnly

Size":

false

}

        "Width": 10.0,

}

],

"Height": 10.0

"ComboBoxes": [

{

},

"ElementId":

"myDrop",

"DocumentNumber":

1,

Required

ExportValue":

false

"Green",

"Value

        "IsChecked":

"R"

false,
                                        "

FieldDefinition

Position": {
                                            "

TextFormat

PageNumber":

{

1,
                                            "

TextColor

X":

"255

72.0240020751953,

0, 0",

FontSizeInPt

Y":

12

431.

0,

958404541016

"FontName": "Arial"

},
                                        "

Bold

Size":

false,

{
                                            "

Italic

Width":

false

10.0,
                                            "

TextAlign

Height":

"Center"

10.0

},

"Items":

[

    },
                                    {

"ExportValue": "

R

Blue",

DisplayValue

IsChecked":

"Red"

false,

},

"Position": {

{

 "PageNumber": 1,
                                            "

ExportValue

X":

"G"

72.0240020751953,
                                            "

DisplayValue

Y":

"Green"

418.998413085938
                                        },
                                        "Size": {
                                            "

ExportValue

Width":

"B"

10.0,
                                            "

DisplayValue

Height":

"Blue"

10.0
                                        }

],

}
                                ]

"IsEditable":

true,

"ReadOnly":

false,

],

Position

ListBoxes":

{

[
                            {

"PageNumber":

1,

                   "ElementId": "myList",

"X":

72.0240020751953,

           "DocumentNumber": 1,
                                "

Y

Required":

360.683402099609

false,

},

"PreSelectedItems": [
                                    "

Size

R"

: {

],

"Width":

80.0,

                       "FieldDefinition": {

"Height":

16.67

                   "TextFormat": {

}

                        "TextColor": "255, 0, 0",

}

       "FontSizeInPt": 12.0,

],

RadioButtons

FontName":

[

"Arial",

{

            "Bold": false,

"GroupName":

"testRbnGroup",

                    "Italic": false,

"DocumentNumber":

1,

IsSelectUnison

TextAlign":

false,

"Right"

"Required":

false,

},

"SelectedItem":

"Red",

      "Items": [

"FieldDefinitions":

[

{

                                        "ExportValue": "

Red

R",
                                            "

IsChecked

DisplayValue":

true,

"Red"

"Position": {

},

"PageNumber": 1,

{
                                            "

X

ExportValue":

72.0240020751953

"G",
                                            "

Y

DisplayValue":

444.918395996094

"Green"
                                        },

"Size":

 {
                                            "

Width

ExportValue":

10.0

"B",
                                            "

Height

DisplayValue":

10.0

"Blue"
                                        }

}

],

{

"IsMultiSelect": true,
                                    "

ExportValue

ReadOnly":

"Green"

false,

IsChecked

Position":

false,

{
                                        "

Position

PageNumber":

{

1,

PageNumber

X":

1

72.0240020751953,

X

Y":

72

308.

0240020751953,

938385009766

"Y": 431.958404541016

},

},

"Size": {
                                        "

Size

Width":

{

80.0,

Width

Height": 10.0

,

"Height":

10.0

}

},

},

{

"ElementId": "myVarList",

"ExportValue

"DocumentNumber":

"Blue"

1,

IsChecked

Required": false,
                                "PreSelectedItems": [

"Position": {

"R"

"PageNumber":

1,

            ],
                                "

X

FieldDefinition":

72.0240020751953,

"Y

"TextFormat":

418.998413085938

}

"TextColor": "255, 0, 0",
                                        "

Size

FontSizeInPt":

{

12.0,

"Width": 10.0,

"FontName": "Miriam",

Height

Bold":

10.0

false,

}

"Italic": false,

}

    "TextAlign": "Left"

]

},

}

            "Items": [

],

"ListBoxes":

[

{

                    "ExportValue": "R",

"ElementId":

"myList",

DocumentNumber

DisplayValue":

1,

"Red"

"Required": false,

},

"PreSelectedItems":

[

"R"

                   "ExportValue": "G",

],

FieldDefinition

DisplayValue":

{

"Green"

"TextFormat": {

},

"TextColor": "255, 0, 0",

{
                                            "

FontSizeInPt

ExportValue":

12.0

"B",

"FontName

    "DisplayValue": "

Arial

Blue"

,

"Bold": false,

"Italic": false

],

TextAlign

IsMultiSelect":

"Right"

true,
                                    "ReadOnly":

}

false,
                                    "

Items

Position":

[

{

 "PageNumber": 1,

ExportValue

X":

"R"

72.0240020751953,

DisplayValue

Y":

"Red"

253.978393554688

},

"Size": {

ExportValue

Width":

"G"

80.0,

DisplayValue

Height":

"Green"

10.0

,

{

"ExportValue": "B"

],
                        "Signatures": [

"DisplayValue":

"Blue"

}

 "Id": "sigField1",

]

"Required": true,

"IsMultiSelect"

"DocumentNumber":

true

1,

ReadOnly

DisplayName":

false

"signature label",

Position

AllowedSignatureTypes": {

PageNumber

ClickToSign":

1

{},

X

SignaturePlugins":

72.0240020751953,

[]

"Y": 308.938385009766

},

},

"FieldDefinition": {
                                    "

Size

Position": {
                                        "

Width

PageNumber":

80.0

1,
                                        "

Height

X":

10

142.

0

100006103516,

}

    "Y": 759.248413085938

}

},

},

                 "Size": {

{

ElementId

Width":

"myVarList"

150.0,
                                        "

DocumentNumber

Height":

1,

60.0

"Required":

false,

"PreSelectedItems":

[

},

R

TaskConfiguration": {}
                            },

],

"FieldDefinition":

TextFormat

Id":

{

"sigField001",

"TextColor

"Required":

"255, 0, 0"

true,

FontSizeInPt

DocumentNumber":

12.0

1,

"FontName

"DisplayName": "

Miriam

signature label 1",

Bold

AllowedSignatureTypes":

false,

Italic

ClickToSign":

false

{},

TextAlign

SignaturePlugins":

"Left"

[]

},

Items

FieldDefinition":

[

"Position": {

ExportValue

PageNumber":

"R"

1,

DisplayValue

X":

"Red"

77.6640014648438,

},

"Y": 144.890243530273

{

},

"ExportValue": "G",

"Size": {

DisplayValue

Width":

"Green"

150.0,

},

"Height": 60.0
                                    }

{

},

"ExportValue":

"B",

               "TaskConfiguration": {}

"DisplayValue": "Blue"

}
                        ],

}

       "Attachments": [

],

{
                                "

IsMultiSelect

ElementId":

true

"myAttachment",

ReadOnly

DocumentNumber":

false

1,

Position

Required":

{

false,

"PageNumber

"FileName": "attachment

1

label",

X

FieldDefinition":

72.0240020751953,

Y

Position":

253.978393554688

},

    "PageNumber": 1,

"Size":

{

         "X": 128.059997558594,

"Width":

80.0,

         "Y": 717.228393554688

"Height":

10.0

},

}

     "Size": {

}

              "Width": 20.0,

}

],

   "Height": 20.0

"Signatures":

[

{

"Id":

"sigField1",

"Required":

true,

        ],
                        "

DocumentNumber

LinkConfiguration":

1,

DisplayName

HyperLinks":

"signature label"

[],

AllowedSignatureTypes

DocumentLinks":

{

[]

"ClickToSign": {},

         }
                }

"SignaturePlugins": []

 }
        },
        {

},

"Action": {
                "Sign": {
                    "

FieldDefinition

Elements": {
                        "TextBoxes": [

"Position":

{

"PageNumber":

1,

       "ElementId": "someMail",
                                "

X

Required":

142.100006103516

false,

"Y

"Value":

759.248413085938

"",

}

"DocumentNumber": 1,

Size

Validation": {

Width

Type":

150.0,

"Email"
                                },

"Height":

60.0

                       "FieldDefinition": {

}

                        "ReadOnly": false,

},

TaskConfiguration

MaxLength":

{}

0,

},

"IsMultiline": false,

{

"Id

"IsPassword":

"sigField001"

false,
                                    "

Required

IsFileSelect":

true

false,
                                    "

DocumentNumber

IsScrollAllowed":

1

false,
                                    "

DisplayName

IsCombined": false,

"signature

label

1",

AllowedSignatureTypes

TextFormat": {
                                        "

ClickToSign

TextColor":

{}

"Black",
                                        "

SignaturePlugins

FontSizeInPt":

[]

3.0,

},

        "FontName": "Arial",

"FieldDefinition":

{

"Position

"Bold":

{

false,
                                        "

PageNumber

Italic":

1

false,
                                        "

X

TextAlign":

77.6640014648438,

"Left"
                                    },

"Y":

144.890243530273

                               "Position": {

},

Size

PageNumber":

{

1,
                                        "

Width

X":

150

101.

0

300003051758,
                                        "

Height

Y":

60

585.

0

47327994060493
                                    },

},

    "Size": {

"TaskConfiguration":

{}

            "Width": 55.5635986328125,

}

],

 "Height": 5.1186008701324415

"Attachments":

[

{

"ElementId":

"myAttachment",

},

"DocumentNumber": 1,

 {
                                "

Required

ElementId":

false

"someNumber",
                                "

FileName

Required":

"attachment label"

false,
                                "

FieldDefinition

Value":

{

"",

Position

DocumentNumber":

{

1,

"PageNumber

"Validation":

1,

X

Type":

128.059997558594

"Number",
                                    "NumberValidationConfiguration": {

"Y": 717.228393554688

                                     "DecimalDigits":

}

2,
                                        "

Size

Symbol":

{

"€",
                                        "

Width

SymbolLocation":

20.0

"EndWithBlank",
                                        "

Height

GroupSeparator":

20.0

"Point",

}

    "DecimalSeparator": "Comma",

}

             "Range": {

}

],

      "From": "-300,00 €",

"LinkConfiguration":

{

HyperLinks

To":

[],

"5.000,00 €"

"DocumentLinks": []

}

},

{

"Action":

{

Sign

FieldDefinition": {

"Elements":

{

               "ReadOnly": false,

"TextBoxes":

[

{

"MaxLength": 0,
                                    "

ElementId

IsMultiline":

"someMail"

false,
                                    "

Required

IsPassword": false,
                                    "

Value

IsFileSelect":

""

false,
                                    "

DocumentNumber

IsScrollAllowed":

1

false,
                                    "

Validation

IsCombined":

{

false,
                                    "

Type

TextFormat":

"Email"

},

        "TextColor": "Black",

"FieldDefinition":

{

                "FontSizeInPt": 3.0,

"ReadOnly":

false,

MaxLength

FontName":

0

"Arial",
                                        "

IsMultiline

Bold": false,
                                        "

IsPassword

Italic": false,
                                        "

IsFileSelect

TextAlign":

false,

"Left"

"IsScrollAllowed": false

},
                                    "

IsCombined

Position":

false,

{
                                        "

TextFormat

PageNumber":

{

1,
                                        "

TextColor

X":

"Black"

112.339996337891,
                                        "

FontSizeInPt

Y":

3

564.

0,

4425465235712

"FontName": "Arial"

},

Bold

Size":

false,

{
                                        "

Italic

Width":

false

342.618560791016,
                                        "

TextAlign

Height":

"Left"

5.1194073419570909
                                    }

,

"Position": {

}
                            }

"PageNumber":

1,

                ],
                        "

X

CheckBoxes":

101.300003051758

[],
                        "ComboBoxes": [],

"Y":

585.47327994060493

        "RadioButtons": [],

}

"ListBoxes": [],
                        "Signatures": [

"Size":

{

"Width":

55.5635986328125,

       "Id": "sigField1000",
                                "

Height

Required":

5.1186008701324415

true,
                                "DocumentNumber": 1,

}

                             "DisplayName": "signature label

}

1000",

},

"AllowedSignatureTypes": {

{

ElementId

ClickToSign":

"someNumber"

{},
                                    "

Required

SignaturePlugins":

false,

[]

"Value": ""

},
                                "

DocumentNumber

FieldDefinition":

1,

{
                                    "

Validation

Position": {
                                        "

Type

PageNumber":

"Number"

1,
                                        "

NumberValidationConfiguration

X":

{

303.049987792969,
                                        "

DecimalDigits

Y":

2,

144.890243530273

"Symbol": "€"

},

SymbolLocation

Size":

"EndWithBlank",

{
                                        "

GroupSeparator

Width":

"Point"

150.0,
                                        "

DecimalSeparator

Height":

"Comma",

60.0

"Range":

{

},

"From":

"-300,00

€",

               "TaskConfiguration": {}

"To": "5.000,00 €"

}
                        ],

}

        "Attachments": [],

}

"LinkConfiguration": {

}

"HyperLinks": [],

FieldDefinition

DocumentLinks":

{

[]

"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": [] } } } } } ] }

Code Block

language	java
theme	Eclipse

{
    "UnassignedElements": {    "Attachments": [],
        "LinkConfigurationTextBoxes": {[],
        "CheckBoxes": [],
        "HyperLinksComboBoxes": [],
        "RadioButtons": [],
        "DocumentLinksListBoxes": [],
        }"Signatures": [],
    },
    "ActivitiesAttachments": [],
        "LinkConfiguration": {
            "ActionHyperLinks": {
   [],
             "SignDocumentLinks": {[]
        }
    },
        "ElementsActivities": {[
         {
               "TextBoxesAction": [{
                "Sign": {
           {
          "Elements": {
                        "TextBoxes": [
                            {
                                "ElementId": "myText1myDisabledText",
                                "Required": truefalse,
                                "Value": "Placedefault for signer1text",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "None"
                                },
                                "FieldDefinition": {
                                    "ReadOnly": falsetrue,
                                    "MaxLength": 100,
                                    "IsMultiline": false,
                                    "IsPassword": falsetrue,
                                    "TextFormatIsFileSelect": {
    false,
                                    "TextColorIsScrollAllowed": "255, 0, 0",false,
                                        "FontSizeInPtIsCombined": 12.0false,
                                        "FontNameTextFormat": "Arial",{
                                        "BoldTextColor": false "255, 0, 0",
                                        "ItalicFontSizeInPt": false12.0,
                                        "TextAlignFontName": "CenterArial",
                                    },
    "Bold": false,
                               "Position": {
        "Italic": false,
                               "PageNumber": 1,
        "TextAlign": "Left"
                               "X": 72.0,
    },
                                    "YPosition": 563.4767578125
{
                                        "PageNumber": }1,
                                        "SizeX": {119.900001525879,
                                        "WidthY": 200672.0,8358984375
                                    },
    "Height": 65.149999999999991
                               "Size": {
    }
                                }
    "Width": 80.0,
                       }
                 "Height": 19.544999999999998
      ],
                        "CheckBoxes": [
     }
                       {
          }
                      "ElementId": "chk1",
     },
                           "DocumentNumber": 1, {
                                "RequiredElementId": true"myText",
                                "IsCheckedRequired": truefalse,
                                "FieldDefinitionValue": {
    "default text",
                                "PositionDocumentNumber": {1,
                                "Validation": {
                "PageNumber": 1,
                    "Type": "None"
                       "X": 72.0,
        },
                                "YFieldDefinition": 439.8017578125{
                                    "ReadOnly": }false,
                                    "SizeMaxLength": {100,
                                        "WidthIsMultiline": 25.0false,
                                        "HeightIsPassword": 25.0false,
                                    "IsFileSelect": }false,
                                    "ReadOnlyIsScrollAllowed": false,
                                    } "IsCombined": false,
                            }
        "TextFormat": {
                ],
                        "ComboBoxesTextColor": [] "255, 0, 0",
                          "RadioButtons": [],
              "FontSizeInPt": 12.0,
           "ListBoxes": [],
                             "SignaturesFontName": []"Arial",
                        "Attachments": [],
                "Bold": false,
           "LinkConfiguration": {
                            "HyperLinksItalic": []false,
                            "DocumentLinks": []
             "TextAlign": "Left"
           }
                    }
     },
           }
            }
        }
    ]
}

Expand

title	All available configurations

Code Block

language	java
theme	Eclipse

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.

}
    ]
}

FAQ

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

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

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

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

Example:

Code Block

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

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

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

Page tree

Versions Compared

Old Version 19

New Version Current

Key

The Story

Use Case Description

Integration

Advanced Document Tags

Dimension limitation

General Syntax

Signature Fields

Form Fields

Attachments

Textfield

Input Validation Image Modified

Checkbox

Checkbox

RadioButton

List

Workflow

Prepare a document with advanced document tags

Upload the document

Preparing the envelope

Prepare a document with advanced document tags

Upload the document

Preparing the file

Sending the envelope

Available configurations

Sending the envelope

FAQ

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

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

Page tree

Page History

Versions Compared

Old Version 19

New Version Current

Key

The Story

Use Case Description

Integration

Advanced Document Tags

Dimension limitation

General Syntax

Signature Fields

Form Fields

Attachments

Textfield

Input Validation Image Modified

Checkbox

Checkbox

RadioButton

DropDown

List

Workflow

Prepare a document with advanced document tags

Upload the document

Preparing the envelope

Prepare a document with advanced document tags

Upload the document

Preparing the file

Sending the envelope

Available configurations

Sending the envelope

FAQ

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

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