Versions Compared

Old Version 19

changes.mady.by.user Manuel Gierlinger

Saved on

compared with

New Version 20

changes.mady.by.user Christoph Bimminger

Saved on

Key

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

...

Section

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

After successful configuration you get as response the configuration for the fields you added with the field markups.

Code Block
languagejava
themeEclipse
{
    "UnassignedElements": {
        "TextBoxes": [],
        "CheckBoxes": [],
        "ComboBoxes": [],
        "RadioButtons": [],
        "ListBoxes": [],
        "Signatures": [],
        "Attachments": [],
        "LinkConfiguration": {
            "HyperLinks": [],
            "DocumentLinks": []
        }
    },
    "Activities": [
        {
            "Action": {
                "Sign": {
                    "Elements": {
                        "TextBoxes": [
                            {
                                "ElementId": "myText1",
                                "Required": true,
                                "Value": "Place for signer1",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "None"
                                },
                                "FieldDefinition": {
                                    "ReadOnly": false,
                                    "MaxLength": 100,
                                    "IsMultiline": false,
                                    "IsPassword": false,
                                    "TextFormat": {
                                        "TextColor": "255, 0, 0",
                                        "FontSizeInPt": 12.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Center"
                                    },
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 72.0,
                                        "Y": 563.4767578125
                                    },
                                    "Size": {
                                        "Width": 200.0,
                                        "Height": 65.149999999999991
                                    }
                                }
                            }
                        ],
                        "CheckBoxes": [
                            {
                                "ElementId": "chk1",
                                "DocumentNumber": 1,
                                "Required": true,
                                "IsChecked": true,
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 72.0,
                                        "Y": 439.8017578125
                                    },
                                    "Size": {
                                        "Width": 25.0,
                                        "Height": 25.0
                                    },
                                    "ReadOnly": false
                                }
                            }
                        ],
                        "ComboBoxes": [],
                        "RadioButtons": [],
                        "ListBoxes": [],
                        "Signatures": [],
                        "Attachments": [],
                        "LinkConfiguration": {
                            "HyperLinks": [],
                            "DocumentLinks": []
                        }
                    }
                }
            }
        }
    ]
}


Expand
titleAll available configurations


Code Block
languagejava
themeEclipse
{
    "UnassignedElements": {
        "TextBoxes": [],
        "CheckBoxes": [],
        "ComboBoxes": [],
        "RadioButtons": [],
        "ListBoxes": [],
        "Signatures": [],
        "Attachments": [],
        "LinkConfiguration": {
            "HyperLinks": [],
            "DocumentLinks": []
        }
    },
    "Activities": [
        {
            "Action": {
                "Sign": {
                    "Elements": {
                        "TextBoxes": [
                            {
                                "ElementId": "myDisabledText",
                                "Required": false,
                                "Value": "default text",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "None"
                                },
                                "FieldDefinition": {
                                    "ReadOnly": true,
                                    "MaxLength": 100,
                                    "IsMultiline": false,
                                    "IsPassword": true,
                                    "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": 119.900001525879,
                                        "Y": 672.8358984375
                                    },
                                    "Size": {
                                        "Width": 80.0,
                                        "Height": 19.544999999999998
                                    }
                                }
                            },
                            {
                                "ElementId": "myText",
                                "Required": false,
                                "Value": "default text",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "None"
                                },
                                "FieldDefinition": {
                                    "ReadOnly": false,
                                    "MaxLength": 100,
                                    "IsMultiline": false,
                                    "IsPassword": false,
                                    "IsFileSelect": false,
                                    "IsScrollAllowed": false,
                                    "IsCombined": false,
                                    "TextFormat": {
                                        "TextColor": "255, 0, 0",
                                        "FontSizeInPt": 12.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Left"
                                    },
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 72.0240020751953,
                                        "Y": 644.995871582031
                                    },
                                    "Size": {
                                        "Width": 80.0,
                                        "Height": 19.544999999999998
                                    }
                                }
                            },
                            {
                                "ElementId": "someDate",
                                "Required": true,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Date",
                                    "DateValidationConfiguration": {
                                        "Format": "dd. MMMM yyyy",
                                        "Range": {
                                            "From": "13. März 2018",
                                            "To": "18. December 2019"
                                        }
                                    }
                                },
                                "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": 97.2239990234375,
                                        "Y": 606.47327994060493
                                    },
                                    "Size": {
                                        "Width": 192.293640136719,
                                        "Height": 5.1186008701324415
                                    }
                                }
                            },
                            {
                                "ElementId": "somePhone",
                                "Required": false,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Phone",
                                    "PhoneValidationConfiguration": {
                                        "Type": "International"
                                    }
                                },
                                "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": 105.379997253418,
                                        "Y": 543.44325064372993
                                    },
                                    "Size": {
                                        "Width": 86.3280029296875,
                                        "Height": 5.1186008701324415
                                    }
                                }
                            },
                            {
                                "ElementId": "someTime",
                                "Required": false,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Time",
                                    "TimeValidationConfiguration": {
                                        "Format": "HH:mm",
                                        "Range": {
                                            "From": "12:00",
                                            "To": "18: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": 98.3040008544922,
                                        "Y": 522.32325552654288
                                    },
                                    "Size": {
                                        "Width": 135.384201049805,
                                        "Height": 5.1186008701324415
                                    }
                                }
                            }
                        ],
                        "CheckBoxes": [
                            {
                                "ElementId": "chk1",
                                "DocumentNumber": 1,
                                "Required": true,
                                "IsChecked": false,
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 121.699996948242,
                                        "Y": 501.918395996094
                                    },
                                    "Size": {
                                        "Width": 10.0,
                                        "Height": 10.0
                                    },
                                    "ReadOnly": false
                                }
                            }
                        ],
                        "ComboBoxes": [
                            {
                                "ElementId": "myDrop",
                                "DocumentNumber": 1,
                                "Required": false,
                                "Value": "R",
                                "FieldDefinition": {
                                    "TextFormat": {
                                        "TextColor": "255, 0, 0",
                                        "FontSizeInPt": 12.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Center"
                                    },
                                    "Items": [
                                        {
                                            "ExportValue": "R",
                                            "DisplayValue": "Red"
                                        },
                                        {
                                            "ExportValue": "G",
                                            "DisplayValue": "Green"
                                        },
                                        {
                                            "ExportValue": "B",
                                            "DisplayValue": "Blue"
                                        }
                                    ],
                                    "IsEditable": true,
                                    "ReadOnly": false,
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 72.0240020751953,
                                        "Y": 360.683402099609
                                    },
                                    "Size": {
                                        "Width": 80.0,
                                        "Height": 16.67
                                    }
                                }
                            }
                        ],
                        "RadioButtons": [
                            {
                                "GroupName": "testRbnGroup",
                                "DocumentNumber": 1,
                                "IsSelectUnison": false,
                                "Required": false,
                                "SelectedItem": "Red",
                                "FieldDefinitions": [
                                    {
                                        "ExportValue": "Red",
                                        "IsChecked": true,
                                        "Position": {
                                            "PageNumber": 1,
                                            "X": 72.0240020751953,
                                            "Y": 444.918395996094
                                        },
                                        "Size": {
                                            "Width": 10.0,
                                            "Height": 10.0
                                        }
                                    },
                                    {
                                        "ExportValue": "Green",
                                        "IsChecked": false,
                                        "Position": {
                                            "PageNumber": 1,
                                            "X": 72.0240020751953,
                                            "Y": 431.958404541016
                                        },
                                        "Size": {
                                            "Width": 10.0,
                                            "Height": 10.0
                                        }
                                    },
                                    {
                                        "ExportValue": "Blue",
                                        "IsChecked": false,
                                        "Position": {
                                            "PageNumber": 1,
                                            "X": 72.0240020751953,
                                            "Y": 418.998413085938
                                        },
                                        "Size": {
                                            "Width": 10.0,
                                            "Height": 10.0
                                        }
                                    }
                                ]
                            }
                        ],
                        "ListBoxes": [
                            {
                                "ElementId": "myList",
                                "DocumentNumber": 1,
                                "Required": false,
                                "PreSelectedItems": [
                                    "R"
                                ],
                                "FieldDefinition": {
                                    "TextFormat": {
                                        "TextColor": "255, 0, 0",
                                        "FontSizeInPt": 12.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Right"
                                    },
                                    "Items": [
                                        {
                                            "ExportValue": "R",
                                            "DisplayValue": "Red"
                                        },
                                        {
                                            "ExportValue": "G",
                                            "DisplayValue": "Green"
                                        },
                                        {
                                            "ExportValue": "B",
                                            "DisplayValue": "Blue"
                                        }
                                    ],
                                    "IsMultiSelect": true,
                                    "ReadOnly": false,
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 72.0240020751953,
                                        "Y": 308.938385009766
                                    },
                                    "Size": {
                                        "Width": 80.0,
                                        "Height": 10.0
                                    }
                                }
                            },
                            {
                                "ElementId": "myVarList",
                                "DocumentNumber": 1,
                                "Required": false,
                                "PreSelectedItems": [
                                    "R"
                                ],
                                "FieldDefinition": {
                                    "TextFormat": {
                                        "TextColor": "255, 0, 0",
                                        "FontSizeInPt": 12.0,
                                        "FontName": "Miriam",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Left"
                                    },
                                    "Items": [
                                        {
                                            "ExportValue": "R",
                                            "DisplayValue": "Red"
                                        },
                                        {
                                            "ExportValue": "G",
                                            "DisplayValue": "Green"
                                        },
                                        {
                                            "ExportValue": "B",
                                            "DisplayValue": "Blue"
                                        }
                                    ],
                                    "IsMultiSelect": true,
                                    "ReadOnly": false,
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 72.0240020751953,
                                        "Y": 253.978393554688
                                    },
                                    "Size": {
                                        "Width": 80.0,
                                        "Height": 10.0
                                    }
                                }
                            }
                        ],
                        "Signatures": [
                            {
                                "Id": "sigField1",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "signature label",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {},
                                    "SignaturePlugins": []
                                },
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 142.100006103516,
                                        "Y": 759.248413085938
                                    },
                                    "Size": {
                                        "Width": 150.0,
                                        "Height": 60.0
                                    }
                                },
                                "TaskConfiguration": {}
                            },
                            {
                                "Id": "sigField001",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "signature label 1",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {},
                                    "SignaturePlugins": []
                                },
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 77.6640014648438,
                                        "Y": 144.890243530273
                                    },
                                    "Size": {
                                        "Width": 150.0,
                                        "Height": 60.0
                                    }
                                },
                                "TaskConfiguration": {}
                            }
                        ],
                        "Attachments": [
                            {
                                "ElementId": "myAttachment",
                                "DocumentNumber": 1,
                                "Required": false,
                                "FileName": "attachment label",
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 128.059997558594,
                                        "Y": 717.228393554688
                                    },
                                    "Size": {
                                        "Width": 20.0,
                                        "Height": 20.0
                                    }
                                }
                            }
                        ],
                        "LinkConfiguration": {
                            "HyperLinks": [],
                            "DocumentLinks": []
                        }
                    }
                }
            }
        },
        {
            "Action": {
                "Sign": {
                    "Elements": {
                        "TextBoxes": [
                            {
                                "ElementId": "someMail",
                                "Required": false,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Email"
                                },
                                "FieldDefinition": {
                                    "ReadOnly": false,
                                    "MaxLength": 0,
                                    "IsMultiline": false,
                                    "IsPassword": false,
                                    "IsFileSelect": false,
                                    "IsScrollAllowed": false,
                                    "IsCombined": false,
                                    "TextFormat": {
                                        "TextColor": "Black",
                                        "FontSizeInPt": 3.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Left"
                                    },
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 101.300003051758,
                                        "Y": 585.47327994060493
                                    },
                                    "Size": {
                                        "Width": 55.5635986328125,
                                        "Height": 5.1186008701324415
                                    }
                                }
                            },
                            {
                                "ElementId": "someNumber",
                                "Required": false,
                                "Value": "",
                                "DocumentNumber": 1,
                                "Validation": {
                                    "Type": "Number",
                                    "NumberValidationConfiguration": {
                                        "DecimalDigits": 2,
                                        "Symbol": "€",
                                        "SymbolLocation": "EndWithBlank",
                                        "GroupSeparator": "Point",
                                        "DecimalSeparator": "Comma",
                                        "Range": {
                                            "From": "-300,00 €",
                                            "To": "5.000,00 €"
                                        }
                                    }
                                },
                                "FieldDefinition": {
                                    "ReadOnly": false,
                                    "MaxLength": 0,
                                    "IsMultiline": false,
                                    "IsPassword": false,
                                    "IsFileSelect": false,
                                    "IsScrollAllowed": false,
                                    "IsCombined": false,
                                    "TextFormat": {
                                        "TextColor": "Black",
                                        "FontSizeInPt": 3.0,
                                        "FontName": "Arial",
                                        "Bold": false,
                                        "Italic": false,
                                        "TextAlign": "Left"
                                    },
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 112.339996337891,
                                        "Y": 564.4425465235712
                                    },
                                    "Size": {
                                        "Width": 342.618560791016,
                                        "Height": 5.1194073419570909
                                    }
                                }
                            }
                        ],
                        "CheckBoxes": [],
                        "ComboBoxes": [],
                        "RadioButtons": [],
                        "ListBoxes": [],
                        "Signatures": [
                            {
                                "Id": "sigField1000",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "signature label 1000",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {},
                                    "SignaturePlugins": []
                                },
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 303.049987792969,
                                        "Y": 144.890243530273
                                    },
                                    "Size": {
                                        "Width": 150.0,
                                        "Height": 60.0
                                    }
                                },
                                "TaskConfiguration": {}
                            }
                        ],
                        "Attachments": [],
                        "LinkConfiguration": {
                            "HyperLinks": [],
                            "DocumentLinks": []
                        }
                    }
                }
            }
        }
    ]
}


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)]]