Fields and Line Blocks

Fields and line blocks are key components of a document definition in BizzStream Aero. Fields represent individual data elements, while line blocks are used to group fields together in a structured manner, often to handle multiple entries or list data.

Adding and Configuring Fields

To add fields in a document definition, follow these steps:

1. Open the Fields and Lines tab in the document definition editor.
2. Click the Add Field button and provide the necessary details in the right-hand column.
3. Select a Type for the field, and configure its specific properties based on the chosen type.

Adding Line Blocks and Line Fields

Line blocks are used to represent structured data with multiple entries, such as a table or a grid. Line fields are fields that belong to line blocks and are used to capture data within each entry.

Example

Consider an invoice document. It typically includes header information like the recipient's name, invoice date, and address. In addition to this, an invoice may contain detailed information about individual costs incurred, such as call details for a phone bill. For such cases, line fields are created within a line block to accommodate the tabular representation of the cost details.

To add line blocks and line fields:

1. Open the document definition editor and navigate to the Fields and Lines tab.
2. Click the Add Line Block button to create a line block, and provide the necessary details in the right-hand column.
3. Within the line block, click the + icon to add line fields and define their properties.

Line fields are specifically designed to handle list data within controls such as tables or grids.

To add an new line, fill in these properties after pressing +.

Default Field Properties

BizzStream Aero provides various field types that enable administrators to define the required information format within documents. Each field type has a set of default properties that can be further customized. Here are the common properties shared by all fields:

Property	Required	Purpose
Label	Yes	The label represents the field's name or description and is what end users see when viewing a document.
Name	Yes	The name serves as a unique identifier for the field within a document definition. It is used to reference and manipulate the field programmatically.
Type	Yes	The field type defines the characteristics and behavior of the field, such as text, number, date, or dropdown selection.
Active	No	This property allows a field to be deactivated if it's no longer needed, while preserving historical data.
Required	No	Indicates whether the field requires data entry from the end user. If a required field is left empty, the document cannot be saved.
Explanation	No	An optional field that provides additional guidance or instructions to end users about the expected input for a particular field.
Internal Comment	No	An optional field that is only used for internal comments and is not visible for end-users. Used for explaining what the field is used for.
Initial Dynamic Value	No	This property allows setting an initial value for a new document or document line. It can be defined using dynamic BizzStream expressions to make the value context-sensitive. Note: Not applicable for fields of type Attachment, Geolocation, Signature, or Chat.
Dynamic Value	No	This property enables setting or calculating a value based on another field's value. Note: Not applicable for fields of type Attachment, Geolocation, Signature, or Chat.

By customizing these properties, administrators can tailor the behavior and functionality of fields and line blocks to meet their specific requirements.

Setting Field Permissions

Most of the time, you will configure field permissions when configuring an access group tab. However, in the Fields & Lines tab, you can also configure field permissions as long as there is at least one access group. To set field permissions in this tab, do the following:

1. Single-click the field you want to configure permissions for.
2. Click the Add permissions button.
3. Now you can set permissions for the selected field per access group per status.