.. _templateFields:
Template dynamic fields
=======================
+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Text field** |
+==========================================================================================================================================================+
|``|
+----------------------------------------------------------------------------------------------------------------------------------------------------------+
Text field may have following attributes:
- type - define if this field is text type, mandatory attribute
- name - string, length from 1 up to 128 symbols, restricted symbols &, ", <, >, field name used to fill in on envelope, unique for document, mandatory attribute
- placeholder - field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute
- roleId - id of the role who should fill field on envelope, mandatory attribute
- optional - boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute
- search - boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute
- multilines - boolean, multiline or single line text, multiline should be textarea on UI, optional, default false, optional attribute
- min - integer, allowed values range from 0 to 1000 (if multiline applied than up to 5000), define minimal quantity of symbols has to be entered to field become valid, default value empty, optional attribute
- max - integer, allowed values range from 0 to 1000 (if multiline applied than up to 5000), define maximum quantity of symbols allowed to field to be valid, default value empty, optional attribute
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Number field** |
+========================================================================================================================================================================================================+
|``|
+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Number field may have following attributes:
- type - define if this field is number type, mandatory attribute
- name - string, length from 1 up to 128 symbols, restricted symbols &, ", <, >, field name used to fill in on envelope, unique for document, mandatory attribute
- placeholder - field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute
- roleId - id of the role who should fill field on envelope, mandatory attribute
- optional - boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute
- search - boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute
- formatting - boolean, defines conversion of field data to on UI to local format set up in User profile, optional attribute
- trailingZeros - boolean, defines how to show decimal zeros after field completion, available only with precision value, optional attribute
- precision - integer, defines quantity of decimal numbers allowed, allowed value range from 0 to 7, default value empty, optional attribute
- min - integer, allowed values range from -999999999999999 to 999999999999999, define minimal value has to be entered to field become valid, default value empty, optional attribute
- max - integer, allowed values range from -999999999999999 to 999999999999999, define maximal value allowed in field to be valid, default value empty, optional attribute
+------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Currency field** |
+============================================================================================================================================================+
|``|
+------------------------------------------------------------------------------------------------------------------------------------------------------------+
Currency field may have following attributes:
- type - define if this field is money type, mandatory attribute
- name - string, length from 1 up to 128 symbols, restricted symbols &, ", <, >, field name used to fill in on envelope, unique for document, mandatory attribute
- placeholder - field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute
- roleId - id of the role who should fill field on envelope, mandatory attribute
- optional - boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute
- search - boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute
- formatting - boolean, defines conversion of field data to on UI to local format set up in User profile, optional attribute
- min - integer, allowed values range from -999999999999999 to 999999999999999, define minimal value has to be entered to field become valid, default value empty, optional attribute
- max - integer, allowed values range from -999999999999999 to 999999999999999, define maximal value allowed in field to be valid, default value empty, optional attribute
- precision - 2 (always), you can not change this value and it's not necessary to define
- trailingZeros - true (always), you can not change this value and it's not necessary to define
+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Date and time field** |
+========================================================================================================================================================+
|``|
+--------------------------------------------------------------------------------------------------------------------------------------------------------+
Date and time field may have following attributes:
- type - define if this field is datetime type, mandatory attribute
- name - string, length from 1 up to 128 symbols, restricted symbols &, ", <, >, field name used to fill in on envelope, unique for document, mandatory attribute
- placeholder - field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute
- roleId - id of the role who should fill field on envelope, mandatory attribute
- optional - boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute
- time - boolean, defines if time value would be acceptable on envelope, optional attribute
- search - boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute
- min - integer, allowed values range from -9999 to 9999, define minimal offset of date which can be selected on envelope (from envelope initiation date), default value empty, optional attribute
- max - integer, allowed values range from -9999 to 9999, define maximal offset of date which can be selected on envelope (from envelope initiation date), default value empty, optional attribute
**format**: IS8601, accept both:
- 2019-12-31T23:59:59+02:00
- 2019-12-31T23:59:59Z
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|**Dropdown field** |
+======================================================================================================================================================================================================================+
|``|
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Dropdown field may have following attributes and values:
- type - define if this field is dropdown type, mandatory attribute
- name - string, length from 1 up to 128 symbols, restricted symbols &, ", <, >, field name used to fill in on envelope, unique for document, mandatory attribute
- placeholder - field placeholder displayable on template and envelope, length from 0 up to 1024 symbols, if empty on envelope will be displayed field name, optional attribute
- roleId - id of the role who should fill field on envelope, mandatory attribute
- optional - boolean, defines if field to be filled in optionally or not on envelope, if not set default value false, optional attribute
- allow-custom-value - boolean, defines if custom value would be acceptable on envelope, allow-custom-value and multiSelect is not possible in the same time (only one attribute can be applied), optional attribute
- multiSelect - boolean, defines if multiselect will be available on envelope, allow-custom-value and multiSelect is not possible in the same time (only one attribute can be applied), optional attribute
- search - boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute
field options (max quantity of options 100):
-