Glossary
Form Terms
Form
A user interface component for collecting, displaying, and managing data. Forms are created in the Form Designer and can integrate with workflows and ETL chains.
Form Definition
The template or blueprint for a form, defining its structure, components, rules, and behavior. Stored in MongoDB and reusable.
Form Instance
A runtime occurrence of a form definition. Created when a user opens a form, containing the user’s data and state.
Form Results
The submitted data from a form instance, stored in MongoDB after successful submission.
Form Designer
The visual interface for creating and editing forms. Provides drag-and-drop component placement and property configuration.
Component Terms
Component
A building block of a form. Components include blocks (layout), inputs (data entry), actions (buttons), outputs (display), and others (special purpose).
Root
The top-level component of every form. Represents the form itself and defines form-level properties like validation, scripts, and styling.
Block
A layout container component that structures the form. Examples: Column, Row, Page, Panel, Tab Bar.
Input
A component that collects data from users. Examples: Text Input, Select, Checkbox, Date Input, Dataset Select.
Action
A component that triggers operations. Examples: Button, Button Bar, Render DocX.
Output
A component that displays information. Examples: Alert, Derived Text.
Component ID
A unique identifier for a component within a form. Used to reference the component in rules, scripts, and data binding.
Component Properties
Configuration settings for a component, such as label, default value, validation rules, and styling.
Rule Terms
Rule
A conditional logic statement that controls form behavior. Rules consist of conditions and actions.
Condition
A logical expression that evaluates to true or false. Examples: fieldValue == "Yes", ${roles} contains "Manager".
Action (in Rules)
An operation performed when a rule’s conditions are met. Examples: Show component, Hide component, Enable, Disable, Make Mandatory.
Inverse Rule
A rule where the conditions are inverted (NOT applied). When inverse is enabled, actions execute when conditions are false.
Rule Evaluation
The process of checking rule conditions and executing actions. Occurs when the form loads and when field values change.
Script Terms
Script
JavaScript code that executes at specific points in the form lifecycle to customize behavior.
Before Build Script
Script that executes before the form is rendered. Used to modify form structure or set initial values.
After Build Script
Script that executes after the form is rendered. Used to modify the DOM or initialize third-party libraries.
Submit Script
Script that executes when a button is clicked. Used for custom submission logic or client-side processing.
Script Context
The environment and variables available to scripts, including form data, component references, and user context.
Validation Terms
Validation
The process of checking that form data meets required criteria before submission.
Client-Side Validation
Validation performed in the browser for immediate feedback. Includes mandatory fields, format checks, and custom scripts.
Server-Side Validation
Validation performed on the server before processing. Includes ETL-based validation and business rule checks.
Validation Chainset
An ETL chainset used to validate form data. Must include a Validation Endpoint step.
Validation Endpoint
An ETL step that marks a chainset as a validator, making it available in form configuration.
Validation Issues
An array of validation errors returned by validation chainsets. Format: [{field: "id", message: "error"}].
Mandatory Field
A field that must be filled before form submission. Marked with a red indicator.
Workflow Integration Terms
Workflow State
A component that connects a form to a workflow. Hidden component that manages workflow instance creation and event sending.
Workflow Instance
A specific occurrence of a workflow definition, created when a form is submitted with workflow integration.
elxPublic
Data stored in a workflow instance that is visible to forms and users. Contains form field values and displayable information.
elxPrivate
Data stored in a workflow instance that is only accessible server-side. Contains sensitive information and internal workflow data.
elxHistory
An array of workflow state transitions, including user, timestamp, and result. Displayed in forms using the History component.
elxRedirect
A URL stored in workflow data that determines where the user is redirected after form submission.
elxEvent
The current event being processed by a workflow, including event name and data.
elxAppId
The form ID stored in a workflow instance, linking the workflow to its originating form.
ETL Integration Terms
ETL
Extract, Transform, Load - a data processing framework. Used with forms for validation, transformation, and submission processing.
ETL Chain
A sequence of ETL steps that process data. Can be triggered by form submission or used for validation.
ETL Chainset
A collection of related ETL chains, typically for a specific purpose like form validation or submission processing.
ETL Step
A single operation in an ETL chain. Form module provides 14 form-specific steps.
ETL Record
The data structure passed through an ETL chain, containing form field values and processing results.
Guard Condition
An ETL chain that determines whether a workflow transition is allowed. Returns true/false.
Dataset Terms
Dataset
A query result from a database that can populate form components. Used with dataset-based input components.
Dataset Select
A dropdown component populated from a dataset query.
Dataset Chooser
A searchable selection component with modal dialog, populated from a dataset.
Dataset Picker
A selection component with search and filtering, populated from a dataset.
Dataset Multi-Select
A multi-selection component populated from a dataset.
Dataset Checkbox
A checkbox group component populated from a dataset.
Cascade Group
A component that creates cascading selections where one dataset selection filters the next.
Internationalization Terms
I18N
Internationalization - support for multiple languages and locales in forms.
Base I18N
Default translations provided by the Ambience system for common form elements.
Custom I18N
User-defined translations for form-specific labels, messages, and text.
Language Resolution
The process of determining which language to display, based on user preference, browser settings, and fallbacks.
Language Fallback
The mechanism for displaying text when a translation is not available, falling back to base I18N or English.
Access Control Terms
Privilege
A system-level permission required to access functionality. Form privileges: mod-form, mod-form-edit, mod-form-designer.
Role
A named collection of privileges assigned to users. Forms can be restricted to specific roles.
Workgroup
A multi-tenancy mechanism that isolates forms and data. Users only see forms in their workgroups.
Access Filter
A database filter that restricts which forms a user can see based on roles and workgroups.
Layout Terms
Page
A component that creates multi-page forms. Users navigate between pages using buttons or rules.
Column
A vertical layout container. Can specify width and contains other components.
Columns
A container for multiple column components, creating side-by-side layouts.
Row
A horizontal layout container that places components in a single row.
Rows
A container for multiple row components, creating stacked layouts.
Panel
A collapsible section component with a header and content area.
Tab Bar
A component that creates tabbed navigation, used with Tab Panel components.
Tab Panel
A content area associated with a tab in a Tab Bar.
Modal Dialog
A popup dialog component that overlays the main form.
Repeater
A component that allows dynamic repetition of a section, creating multiple instances of contained components.
Special Component Terms
Hidden
A component that stores data invisibly. Used for passing data, storing state, or holding calculated values.
HTML
A component that displays custom HTML content, including text, images, or embedded elements.
IFrame
A component that embeds external web content in the form.
Image
A component that displays an image from a URL or uploaded file.
Attachments
A component that allows users to upload files. Files are stored and can be retrieved later.
History
A component that displays workflow history, showing state transitions and user actions.
Form Launcher
A component that opens another form, optionally passing data to the launched form.
Form Select
A component that links related forms, allowing selection and navigation to connected forms.
Derived Text
A component that displays calculated or derived text based on other field values.
Vertical Space
A component that adds whitespace between other components for visual spacing.
Toggle Dark Light
A component that allows users to switch between light and dark themes.
Workflow State
A hidden component that manages workflow integration, creating instances and sending events.
Data Terms
Field Value
The data entered by a user in an input component, identified by the component’s ID.
Default Value
The initial value of a component when the form loads.
Placeholder
Hint text displayed in an input component when it’s empty.
Auto-Save
Automatic saving of form data to browser localStorage as the user types, preventing data loss.
Form State
The current data and UI state of a form instance, including field values, validation errors, and component visibility.
Styling Terms
Label Mode
The orientation of field labels relative to inputs. Options: Vertical, Horizontal, None.
Custom CSS
User-defined CSS styles applied to a form at runtime.
Construction Lines
Visual guides in the Form Designer showing component alignment and spacing.
Theme
The visual appearance of a form. Options: Light, Dark.
Submission Terms
Submit
The action of sending form data to the server for processing.
Button Bar
A component containing one or more buttons, typically including a Submit button.
Submission Info
Metadata added to a form submission, such as timestamp, user, and context.
Redirect URL
The URL where the user is sent after successful form submission.
Validation Error
An error message displayed when form data fails validation, preventing submission.
Technical Terms
Scala.js
The client-side framework used to build form runtime functionality in the browser.
MongoDB
The database where form definitions, results, and workflow data are stored.
JSON
The data format used for form definitions, results, and API communication.
REST API
The HTTP API for programmatic access to forms, including fetching definitions and submitting data.
Observable
A stream of data or events. In forms, used for asynchronous operations and data flow.
Task
An asynchronous operation. In forms, used for server-side processing and database operations.