Common component properties
Basic component properties
Regardless of type, each component has defined properties available in the panel shown on the right after selecting the component.
Section Basic properties
Id
id
Unique technical identifier of the field (assigned automatically when adding the component).
Business identifier
mid
Business identifier of the field (by default it is the same as id, but it can be changed). The business identifier (Mid) is a unique identifier associated with business logic. Once assigned, it will be easier to find a specific component when adding listeners or input and output parameters for Page Services. Label (Text) and Formatted content (TextContent) components do not have mids.
The business identifier should be written in camelCase and should not contain spaces or Polish diacritics. WARNING!
Because the Uniflow data model is based on business field identifiers (mid) rather than id, when using the Uniflow data model on the form business field identifiers must not repeat (e.g. we have two different components with the same business identifier or a component has the same mid as a session variable id).
Label
label
Component label displayed above the component (attribute is not supported in some channels).
Disabled field displayed as a label
labelIfDisabled
Checked (set to "true") means that a disabled component is displayed as text (on the form it appears presented as a label).
Availability of the functionality depends on the license and may not be available in all deployments.
Demo form: demoLabelIfDisabled
Contextual help
toolTips
Defining dynamic contextual help for the component depending on conditions.
More at: Contextual help - Tooltip
Data model key
model
For fields that can accept values, specifies two-way binding with the data model.
More at: Storing data in the model
Section Data quality
Visibility condition
visibleCondition
Visibility condition of the field (conditions are entered using the editor described in Advanced condition editor).
Enabled condition
enabledCondition
Condition for the field being editable (conditions are entered using the editor described in Advanced condition editor).
Maximum value length
maxPropertyLength
For security reasons every text value on the platform (e.g.: content of a text field, value and description of a dropdown, radio value, etc.) is validated for length. By default the platform does not accept strings longer than 256 characters. If due to business requirements it is necessary to change the maximum length, this can be done using the attribute Maximum value length. Availability of the functionality depends on the license and may not be available in all deployments.
WARNING!
The system has an additional hard limit (default: 10485760 characters) - this is an absolute limit that will not be overridden by the Maximum value length attribute.
Required condition
requiredCondition
Condition for the field being required (conditions are entered using the editor described in Advanced condition editor).
Default value
defaultValue
For fields that can accept values, specifies the initial value of the component.
Section Interactions
Listening
listeningOn
List of components that the component depends on. Changing the values of listened-to components will cause the component's state to be refreshed.
More at: Listening and clearing.
External data source
enternalDataSource
Defining external data sources.
Field clearing
clearOn
List of components that trigger clearing of data entered into the component.
Value source from another field
valueSourceId
ID of another component that will provide the value for this component (an example of usage is described in: Passing values between components or form pages).
Section Security
Whitelist characters
extraWhitelistCharacters
For security reasons every text value on the platform (e.g.: content of a text field, value and description of a dropdown, radio value, tile group value, etc.) is validated for allowed characters. By default the platform allows the following character classes:
letters (including diacritical marks of all languages),
digits,
whitespace characters (various kinds of spaces, tabs, newline markers, etc.),
the following special characters: '.' (dot), ',' (comma), '-' (dash), '_' (underscore).
If a value containing a character outside the list arrives at the server, the server will restore the last safe value. If due to business requirements it is necessary to extend the list of special characters for a given field, the attribute Whitelist characters (extraWhitelistCharacters) can be used for this purpose. The value of the attribute is a string of characters that should be allowed in the given field.
WARNING!
When extending the list of allowed characters, for security reasons you must ensure that the services to which this value will be sent are prepared to accept the given character and are properly secured.
The @ character (at sign) is disallowed by default unless the field type is "email" (parameter Data type (expected type)).
IMPORTANT!
For components that, in addition to a label, also have a value (e.g. Radio group, Tile group), and these values for some reason differ (in the context of disallowed characters), it is necessary to define it in Whitelist characters both values - we define this for the Tile Group, not for a single Tile.
Example: e.g. for a tile with the label "5+" the option value was defined as ">5" - in such a situation in the whitelist as allowed characters we must define both "+" and ">"
(using different values for the label and the value is not a recommended solution; it is recommended to use consistent values).
Technical field
technicalField
Field used for internal template logic needs, not propagated to downstream systems and not visible on the form. The property is available for selected components.
Section Styling
Style name
styleName
Name of the component style (in Eximee Webforms corresponds to the CSS style that will be assigned to the component).
Section Other
Automatic value update
autoServerUpdate
Automatic sending of the value to the server (regardless of whether anything is listening to that component). Additionally, when this flag is checked, processing in the graph (after a value change) starts from the component whose value changed (by default processing starts from its successors).
WARNING!
This setting has a large impact on the performance of the form platform. It should be used only where required (e.g. when using a Suggester). In doubtful situations please contact the Consdata team.
Example form with a suggester and the autoServerUpdate property: test_autoserverUpdate.
GTM Tag / Enabling GTM
gtmTagName/pushTagsToGtm
Possibility to configure the functionality Google Tag Manager. By default the field is not checked (value "false").
Collecting statistics
getStats
Field used to collect statistics about the given component. By default the field is not checked (value "false").
Visibility on printout
printable
Specifies whether the component should be visible on the printed form. By default the field is checked (value "true").
Behavior of value change when component is hidden
preserveValueWhenHidden
This flag is used to prevent the component's value from being reset to default when it becomes hidden (or is hidden after parking). The component's value will also be preserved after parking and will be available for use in subsequent sessions. By default the field is not checked (value "false").
Functionality is not available for some components.
Visibility conditions
For each component in the Properties panel you can specify its visibility conditions by clicking Add visibility condition in the VISIBILITY CONDITION (available in the Data qualitysection). In the displayed condition editor you can enter conditions written in a simple expression language (more in Advanced condition editor). The expression language used is described in Expression language for defining conditions.
The component is visible only if the condition entered in the VISIBILITY CONDITION.
Required conditions
For each component in the Properties you can specify the conditions under which the component is required by clicking Add required condition in the REQUIRED CONDITION (available in the Data quality). The condition editing window is analogous to the component visibility condition editing window. JavaScript language described in Expression language for defining conditions.
is used to define conditions.
Components for which the condition is met are required and it is not possible to proceed to the next form page without entering a value.
For each component in the Properties Read-only mode conditions for components you can specify the conditions under which the component is presented in read-only mode by clicking in the Add enabled conditionENABLED CONDITION Expression language for defining conditions.
. The condition editing window is analogous to the component visibility condition editing window. JavaScript language described in
Listening
is used to define conditions. Listening and clearing).
For components with an unmet condition, editing their values is disabled during form presentation.
For each component you can specify a list of components that the given component listens to (more in
Based on listening, a dependency graph is created. When a component's state changes, the dependency subgraph containing all paths ending at the changed component is topologically sorted and components in the subgraph are refreshed. Components are refreshed in the order resulting from the topological sort such that only those components whose at least one direct predecessor in the graph changed state are refreshed.
</server>
Last updated
Was this helpful?