Quick Settings
Management of Realms, Components, and Users
Realms and Components
The FLOWBOX structure is divided into so-called user realms into which individual components are added. A realm is displayed in the sidebar, and upon selection, its user components appear in the panel.
A component is an element such as a sensor, measuring device, technology, logic block, variable, map, etc.
A complete list of all available components can be found in Application Settings / Manage Components, where you can see both an overview of already added components assigned to realms, as well as the option to add new ones.
Each user is then assigned permissions specifying which realms they can access, which components they can use, and with what level of authorization (e.g., view-only, control allowed, configuration allowed, etc.).
For more information please see: https://flowbox-docs.atlassian.net/wiki/spaces/DOC/pages/557097
Initial Setup
Path to the System settings:
Create a User Realm
Go to Application Settings by clicking on the MENU in the top-right corner and selecting Manage Realms.
Select the New Realm button and name the realm. A so-called realm alias is automatically generated, defining the unique “address” of the realm used internally by FLOWBOX. The alias must be unique, and the system will not allow two realms with the same alias. However, realm names themselves can be duplicated.
Choose whether you want the realm to be displayed on the panel (by default, a realm is visible) or if it should be a hidden “system realm”, which is not intended to be shown to users on the panel.
User notifications are used for sending alarm messages (SMS, E-mail, Pushover) based on the monitoring settings of individual components within a realm. Once a user has been created (see. Adding a New User) for whom alarm notifications from this realm are required, their name should be entered into this field. In the event of an alarm - see Monitoring and Notifications, the user will then receive the corresponding notification messages.
User Management – Adding a New User, User Permissions
In Application Settings, select Manage User and click the Add User button.
Enter the username and the user’s email address (used for password resets or for receiving alarm notifications, if alarms are configured - see. Monitoring and Notifications OLD ). Select the language, and if SMS notifications are used, also provide the phone number. You can also set an initial password for the user here. If no password is specified, the user will be prompted to create their own upon first login.
Select the Advanced tab, where you can enter the user’s real name, choose the temperature unit, language, or enable the color-blind assistance mode. This section also displays advanced statistics and less commonly used settings.
Next, configure the permissions. You can either use the predefined roles in the Groups tab, or assign specific permissions only to this user via the Permissions tab. You can manage Group permissions “Manage user roles” in Application Settings Menu
Select New Grant, and in the Permissions sub-tab specify what you want to allow for the user. You can choose from predefined macros, individual items, or a combination of both.Next, go to the Scope sub-tab, where you define what the selected permission applies to. If nothing is selected, the setting will apply globally. Finally, you must CONFIRM the configuration!
You can review the user’s settings by selecting the Spy icon (left button).
Adding a Component to a User Realm
In Appliaction Settings, select Manage Components, then choose New Component.
Select the desired component from the catalog of available components. For quick access, you can search by name or use the filter buttons.
By clicking on the desired component, you will proceed to the basic component settings. Enter the name (a component alias will be suggested automatically), select the realm, and fill in the required or optional component attributes as needed.
Select the History tab and configure the rules for data storage and visualization. Enable History, set the logging interval, or choose Immediate write to history.
The final step is to save the configuration by clicking the Create button.
On the panel, verify that the component is displayed correctly, and if needed, adjust it in the Display tab.
Example of component display in a user realm on the panel:
