Formula Field API
This document contains the Formula field API format, supported attributes, operations, and examples.
Formula field
<formula name=”string” placeholder=”string” search=”boolean” precision=”integer” formatting=”boolean” trailingZeros=”boolean”>value</formula>
Formula is read-only field with the value calculated using EXCEL operations.
Formula Field attributes
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.
search — boolean, defines if field is searchable on envelope search or not, if not set default value false, optional attribute.
precision — integer, defines quantity of decimal numbers allowed, allowed value range from 0 to 7, default value 2, 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.
value — is a formula with only one operation.
SUPPORTED OPERATIONS: SUM, PRODUCT, SUBTRACT, DIVIDE, COUNTA, MAX, MIN
Example 1
SUM({field1},{doc2::field2}) where
{field1} is a value of field1 from the same document.
{doc2::field2} is a value of field2 in document with id ‘doc2’.
Example 2
formula SUM({field1}) next to dynamic table where
{field1} ia a field name from the table.
All values from all rows will summed up.