Product Block
Package: BASIC
1. General
The blocks "Item Group - Basic Settings", "Item Group" and "Summary" in the billing modules are also referred to as "Product Block", as products and/or services can be selected here.
The product block is available in the following modules, which are counted among the so-called "billing modules":
- Orders
- Deals
- Incoming Invoices
- Purchase Orders (brainX CRM only)
- Credit Notes
- Delivery Notes (brainX CRM only)
- Invoices
- Cancellations (product block only limitedly usable)
- Contracts (brainX APP only)
After opening the settings item "Product Block", it is divided into three areas:
- Settings → Formatting of numeric values in product blocks and settings for dynamic item groups
- Fields for Product and Service Items → Create and edit fields for product and service items
- Item Groups → Edit properties (including managing values for item groups) and define the default billing interval per item group
Basic Setup - Product Block
If settings have been changed in one of the four areas, the "Save" button at the top right becomes active. Only after clicking the button and saving the changes are they active in the system.
2. Settings
The following fields are available in the "Settings" area:
- Formatting of numeric values in product blocks (toggle) → Using the toggle (active/inactive), it is set whether numeric values in the product blocks are automatically formatted.
- Allow dynamic item groups (toggle) → Using the toggle (active/inactive), it is set whether new item groups can be created directly when selecting an item group.
If the setting is active, users have the option to create new item groups directly when selecting an item group in the product block.
After clicking the "Add item group" button, the "Create item group" button is displayed in the flyout menu:
Flyout menu item group
After clicking the "Create item group" button, the "New Item Group" popup opens:
Popup "New Item Group"
After entering the name in the "Item Group" field and clicking the "Create item group" button, the new item group is created and displayed immediately.
The item group is only created in the currently edited record. It is not permanently saved. New item groups that are to be permanently saved must be created via the Item Groups settings item.
3. Fields for Product and Service Items
In the "Fields for Product Items" and "Fields for Service Items" blocks, fields are managed that have a reference to products or services respectively.
Both blocks are identically structured; the following functions apply to both.
Fields can be newly created, edited, hidden and restored; additionally, audit-proof fields can be loaded.
On mouseover of the block, several action icons are displayed.
Action icons for product item fields
Action icons for service item fields
The following action icons are available in the upper area:
- Create new optional field (icon "Plus") → Create a new, user-defined field
- Hidden optional fields (icon "crossed-out eye") → Show hidden optional fields
- Load audit-proof field (icon "open folder") → Load audit-proof fields of the module
Two additional action icons are available for each field:
- Edit properties (icon "Pencil") → Edit properties of the field
- Remove field (icon "crossed-out eye") → Remove field
The quantity and list price of items in the product block can be entered with up to 6 decimal places. Trailing zeros are truncated in the display. This is particularly helpful when billing small units (e.g. API tokens).
The sales prices of products and services can also be entered with up to 6 decimal places.
3.1. Create New Optional Field
After clicking the action icon "Create new optional field" (icon "Plus"), the popup "Add custom field" opens.
Popup Add Custom Field - Type Text
The popup "Add custom field" is divided into three areas:
- Properties → depending on the selected field type (e.g. Text, Number etc.), additional (required) fields for input are displayed.
In the Modules field, the modules in which the new optional field should be displayed can be selected (optional).
If no module is selected in the "Modules" field, the field will be displayed in all modules.
- Name → Enter the field name in all languages
- Default value → Optional entry of a default value
3.2. Hidden Optional Fields
After clicking the action icon "Hidden optional fields" (icon "crossed-out eye"), the popup "Hidden Fields" opens.
The action icon "Hidden optional fields" is only clickable/active when hidden fields exist.
In the popup, all hidden fields are listed. These can be selected via checkbox and shown again by clicking the "Show selected" button.
Popup Hidden Fields
3.3. Load Audit-Proof Field
After clicking the action icon "Load audit-proof field" (icon "open folder"), the popup "Hidden Fields" opens.
In the popup, all audit-proof fields are listed. These can be selected via checkbox and loaded/displayed by clicking the "Show selected" button.
Popup Audit-Proof Fields
3.4. Edit Properties
After clicking the action icon "Edit properties" (icon "Pencil"), the popup "Edit properties" opens.
Depending on the field type of the field to be edited, the display of the fields shown in the popup differs.
Non-editable fields are displayed "grayed out". All other fields can be edited accordingly (e.g. selection of modules, change of name or default values).
Popup Edit Properties - Field type selection list (values of the selection list not editable)
Popup Edit Properties - Field type selection list (values of the selection list editable)
Popup Edit Properties - Field type Checkbox
Popup Edit Properties - Field type Date
3.5. Remove Field
After clicking the action icon "Remove field" (icon "crossed-out eye"), a note with the following text is displayed: "The field will be hidden and can be shown again at any time. No information will be deleted."
Note Hide Field
After clicking the "Close" button, the field is hidden. The field can be shown again using the Hidden optional fields function.
4. Item Groups
In the "Item Groups" block, item groups are managed centrally. Here, among other things, the values of the item groups can be maintained and a default billing interval can be defined per item group.
Item groups can alternatively also be edited directly via the Layout of the respective billing modules. The "Item Groups" settings item serves as a central location for cross-module management.
4.1. Edit Properties
After clicking the action icon "Edit properties" (icon "Pencil"), the popup "Edit properties" opens:
Popup Edit Properties
The "Item Groups" field is only limitedly editable. Certain properties cannot be edited, but are still displayed for informational purposes.
On the left side, all basic settings are configured. In the right column, additional settings can be made.
4.1.1. Basic Settings
The basic settings area is divided into the following sections:
- Properties
- Field "Type" → Only serves to display the field type (selection list) of the "Item Group" field.
- Allow creation of new values (checkbox) → If this option is selected, users with the appropriate profile permission can create new values in this selection list.
The functionality is identical to the "Allow dynamic item groups" function in the "Settings" block. - Value sorting (selection list) → The options "as defined" (block "Values of the selection list"), "ascending" and "descending" are available here.
- Name → Name of the selection list field of the item group (display only, not editable)
- Values of the selection list → Values/names of the item groups (multilingual). Item groups can be added, removed, renamed and sorted (drag & drop) here.
- Default value → Default value of the item group which is displayed when adding a new item group.
4.1.2. Settings
The following fields are available in the "Settings" area:
-
Active → Only serves to display that the "Item Group" field is active. The checkbox cannot be deactivated, as an item group is always required.
-
Required field → Required fields are marked with a red asterisk * in the creation and editing view of a record. A record cannot be saved if there is no valid value in a required field!
-
Mass editing → In list views of modules, the mass editing action is available. The checkbox cannot be deactivated, as an item group is always required.
-
Quick creation → At various places in the brainX system, new records can be created using the so-called "quick creation" (e.g. action "Create" in the navigation bar). This means that only a popup window with the most important fields is displayed, instead of the creation view of a new record.
If the "Quick creation" setting has been activated, the field is also available accordingly in the popup window.
-
Additional information → If the "Additional information" setting has been activated, the field is not available in the main data entry mask, but is displayed in a separate sidebar in the detail view of a record.
4.2. Default Billing Interval
For each item group, a default billing interval can optionally be saved.
After clicking the "Default billing interval" selection list, a selection list with all existing billing intervals opens.
Item Groups - Select Default Billing Interval