Documentation

Knowledge Base

Answers, guides and best practices for ComfortClick bOS.

Open in Confluence

Configurator User Interface

The configurator provides several tools for navigating, editing, and managing the configuration.

Users can navigate and work with the configuration using the configuration tree on the left side of the configurator, the toolbar functions at the top of the configurator Keyboard shortcuts for faster editing and navigation and Filters for quickly finding specific nodes, devices, tasks, or settings

These tools help users move through the configuration more efficiently, manage larger projects, and quickly access the functions needed during setup and maintenance.

Table of contents

Toolbar functions

Settings menu on the top left side provides major functionality for each configuration. It allows users to backup, restore, import, tweak settings and menu.

74b86615-46bf-4ea1-9ca1-742593c25dfd.png

Going from left to right:

  • Backup configuration: Backs up the current configuration into a .bosBackup file. This file contains all images stored in the configuration, all system and data logs in the tasks. It contains all nodes, devices, functions and the whole visualization with all it's settings and images.

  • Restore configuration: Restores and replaces the current configuration on the machine with the new, imported one. The restored backup contains all settings, images, logs from the configuration.

  • Export configuration: Selected node is exported as a .bos file. Select any node in the configuration and export it. This exported node will not contain images, logs from the configuration. Very useful for exporting only parts of the configuration and not the whole building.

  • Import configuration: Imports the selected node into your configuration. Very useful for importing only parts of the configuration and not the whole building. Does not contain images or logs.

  • Node values: Select any node in the configuration and run this function. It displays all settings and info about the selected node (value, template, type, image and unit).

  • Node settings: Selecting any node in the configuration provides system information about the node (category, name, value)

  • Add: Selecting a node and pressin the add button (or right click on the node and add) allows users to add new devicesm tasks or values under that node (depending on the selected node, e.g. selecting devices node will allow us to add devices, tasks and variables, but selecting the tasks node will only allow us to add tasks and variables).

  • Delete: Selected node is deleted from the configuration.

  • Up: Selected node is moved up.

  • Down: Selected node is moved down.

  • Undo: Undoes the last changed setting in the configuration.

  • Redo: Redoes the last changed setting in the configuration.

  • Help: Opens a complete help section for each node, task, device, function with screenshots and additional information. Ideal for fresh users that require additional information.

config_UI.png

Top menu

In the top right corner of the bOS Configurator interface, you will find several important options:

top_menu.png

  • Reload - Reloads the currently connected server. This action stops all active drivers and restarts the configuration from a clean state.

  • New - Clears the existing configuration and loads a brand-new default configuration. User credentials will also be reset to default.

  • Client - Connects directly to the visualization of the currently connected server.

  • Help - Opens the knowledge base, which provides detailed information on all supported devices, tasks, and nodes.

  • About - Displays the current version of the bOS Configurator and includes a link to the official ComfortClick website.

  • Logout - Logs you out of the currently connected server.


Configuration tree

ComfortClick configurations are organized using a configuration tree. The tree contains the main nodes required to build, manage, and structure a project.

Building - Contains basic information and settings related to the ComfortClick server and the building configuration.

General - Contains additional configuration and customization options, including APIs, integrations, and other general system settings.

Devices - Contains a list of all devices, systems, and integrations used in the configuration.

Tasks - Contains all automation, logic, conditions, schedules, and system operations used in the project.

Themes - Used to create and manage the user interface and visualization presented to the client.

Areas - Used to organize larger projects into separate sections, such as buildings, floors, rooms, or apartments. Areas can also help structure and duplicate parts of the configuration tree when similar layouts or configurations are required.

tree.png

Expand, collapse end search bar

On the top of your configuration tree you will find options to expand collaps and search within your configuration tree.

filter.jpg

Expand all: This function will expand every node, every folder within the configuration tree.
Collapse all: This function will expand every node, every folder within the configuration tree.

Expand: This function expands currently selected node.

Collapse: This function collapses currently selected node.

Search tab: Typing in device or value name you want to find in the configuration will expand the folder where the node is located and will also be highlighted for easier identifying the device.


Configuration nodes

Every device, task, panel, variable, and other configuration element is represented as an individual node in the configuration tree.

Each node provides its own set of Settings, Values, and Functions. The available options depend on the node type and its purpose.

For example, a KNX Group Address node may include:

  • Settings for configuring the KNX group address

  • Templates for changing the node’s appearance and behavior

  • Values for displaying or changing the current value

  • Functions for reading or updating the value

KNX.jpg

A Timer Task node provides a different set of options:

  • Settings for selecting the device or object controlled by the timer

  • Values for configuring delays, durations, and timing parameters

  • Functions for manually triggering, starting, stopping, or resetting the timer

Because each node type has a specific purpose, its available settings, values, and functions may differ significantly.

timer.jpg

Usages tab

Each node in the bOS Configurator includes a Usages tab. This tab shows where the selected node is used in the configuration. Any task, device reference or usage in the Theme will be displayed under usages tab.

This tab is extremely useful to locate where selected node is used for faster location discovery or troubleshooting any cyclical errors and issues.

usages.jpg

Notes tab

Each node in the bOS Configurator includes a Notes tab. This tab allows users to add custom messages or comments that provide additional context or documentation for the selected node.

The Notes tab is especially useful in the following scenarios:

  • Revisiting the configuration after a period of time.

  • Documenting complex logic that may require clarification or explanation.

  • Collaborating on a project where multiple users are working on the same configuration.

Using the Notes tab helps improve project maintainability, team communication, and long-term system understanding.

notes.jpg

Info tab

Each node in the bOS Configurator includes an Info tab. This tab provides detailed system information about the selected node.

The Info tab displays:

  • The current location of the node within the configuration hierarchy

  • The number of subfolders (or parent levels) it resides in

  • The node’s unique ID

  • The node’s name and type

  • The full configuration path to the node

This information is useful for identifying, referencing, and organizing nodes within larger or more complex configurations.

info.jpg

Node functions

Right-clicking any node in the configuration tree opens the node context menu.

The context menu provides quick access to common actions for the selected node, such as:

  • Copying the node

  • Pasting a copied node

  • Removing the node

  • Exporting the node

  • Changing it’s settings, values, functions and more

These options make it easier to duplicate, move, remove, or save parts of the configuration during project setup and maintenance.

df71738e-4037-4ed6-8cbe-0991e5af7f1a.jpg

Selecting the Settings button will open all settings function. If the list is too long you can also use the Filter option on the top left of the form, to filter out the nodes you're searching for.

Using this form, we can change values of different settings within the nodes (changing communication flags for KNX, enable/disable drivers, change address values, etc).

66619323-7c26-4eea-9c9d-b50c2845db20.jpg

Node Values

Selecting any node in the configuration, right clicking and selecting Values function will open all the Values options for the selected node and all its subnodes.

53fb430e-6177-4b30-b757-1bb46589757a.jpg

Selecting the Values button will open all values function. If the list is too long you can also use the Filter option on the top left of the form, to filter out the nodes you're searching for.

Using this form, we can change values of different devices or variables within the nodes (turning devices on/off, change setpoints, change templates and units).

331b15b1-4224-4ea3-ac8c-18c2044b5b32.jpg
Top