--- title: "KNX dictionary: recognize group addresses in Boss’nX" description: Define in Boss’nX the CMD and FB keywords that recognize the group addresses of an imported ETS project, then check the classification before the structure. canonical: https://wiki.can-nx.com/en/guides/boss-knx-dictionary/ language: en product: Boss’nX audience: - administrateur - installateur context: "Boss’nX on a computer: Dictionary step of KNX commissioning, after importing the .knxproj file" --- # KNX dictionary: recognize group addresses in Boss’nX Context: Boss’nX on a computer: Dictionary step of KNX commissioning, after importing the .knxproj file The Boss’nX KNX dictionary recognizes the group addresses imported from ETS using command (**CMD**) and status feedback (**FB**) keywords, arranged by component category. It prepares the detected components, which you then create in **Structure**: saving it does not, on its own, create the supervision’s components. The saved dictionary is also used to classify the group addresses of later imports. Intended for administrators and installers commissioning a building, right after [importing the .knxproj file](https://wiki.can-nx.com/en/guides/boss-knx-project/). ## Before you start - Your role has **Manage topology**. - You are working on a computer, in the relevant supervision. From the hypervision, first open this supervision. - The .knxproj file has been imported; otherwise, the step stays locked. ## Open the dictionary 1. Open **Menu → KNX commissioning**, then the **Dictionary** step. 2. Wait for **Loading saved dictionary...** to finish. If loading fails, see [troubleshooting](https://wiki.can-nx.com/en/guides/boss-knx-project-help/) before replacing existing rules. The **Component template configuration** panel contains the rules. **Group addresses** shows the imported addresses and their recognition. ## Prepare the categories 1. In the **Template** column, select an existing category. 2. To create one, click **+ Category**, then check **Component type** in its panel and choose the type you want in the list. A category that already exists cannot be created a second time under the same name. 3. To start from the suggested model, use **Load default template**. If the template already contains categories, a confirmation announces that it will be replaced: this button replaces the current template instead of adding to it. Cancel if you need to keep these rules. ## Add a datapoint and its keywords 1. In the category, click **+ Add datapoint**. A group appears with a **Datapoint name...** field and two rows: **CMD** for the command, **FB** for the status feedback. 2. Give the datapoint a name, then leave this field. 3. In each relevant row, click **+ Keyword**, type a keyword suited to the names of the project’s addresses, then confirm with Enter or leave the field. Add other keywords if necessary. 4. For a feedback-only datapoint, fill in **FB** and leave **CMD** without a keyword. A row without a keyword is not kept when saving: a group whose two rows are empty is therefore not saved as a recognition datapoint. The datapoint name and its keywords have different functions: renaming the datapoint does not replace defining the keywords. Fictitious example: a datapoint named `Living room temperature` may contain only feedback keywords, chosen after reading the names of this project’s addresses. To correct a datapoint: - the small cross on a chip removes that keyword; - the row’s cross, **Delete this row**, removes the whole row, with a confirmation when it contains keywords; - **Create feedback** or **Create command** restores the missing counterpart; - the **Delete pair** trash can removes both rows after confirmation. ## Choose the creation mode The **Creation mode** applies to the selected category: - **Type-based** groups items of the same type in the same space to prepare a component of that type. - **Name-based** keeps the groupings recognized by name. **Apply to all** extends the chosen mode to all categories; use it only if this organization suits the whole project. The **Reorder** handle, on the left of a datapoint group, changes its order in the category. Check the resulting grouping in **Structure** before creating the components. ## Limit the search to part of the addresses A scope limits the search for a datapoint’s keywords to part of the group address tree. 1. On the datapoint group, click **Search scope** to prepare the same scope for **CMD** and **FB**. For a single row, use its target button, **Set the search scope**. 2. In **Group addresses**, the **Search scope — …** banner identifies the datapoint and, for a single row, **CMD** or **FB**. Check this target before checking any box. 3. Check the branches or addresses you want; the chevrons expand the groups. A branch can cover several addresses: check the **address(es) covered** counter. Fictitious example: the `1/2` branch limits the scope to the addresses of this branch. 4. Click **Confirm** to apply the selection. **Cancel** only discards the scope being prepared. 5. Wait for the save, then check the scope chips on the relevant rows and the number of recognized addresses. **Confirming a completely empty selection removes the scope restriction.** It is not a way to “recognize no address”: to remove a recognition role, delete it or remove its keywords. While the scope is being selected, the text search is hidden and saving is disabled. Prepare only one selection at a time and finish it with **Confirm** or **Cancel** before switching tasks. ## Check the recognized addresses In **Group addresses**, **Recognized** and **Not yet recognized** describe the result of the latest available classification, not a KNX communication state. - **Search an address or a name…** finds an imported address. Clear the search to see everything again. - After classification, a row’s **N address(es)** badge filters the inventory on its matches. Click this badge again or **Clear** in the **Filtered: …** banner to remove this filter. Typing a search also replaces this filter. - During a save or after it fails, the counters may still reflect the previous classification. Wait for the processing to finish and read the messages before drawing a conclusion. ## Save the dictionary Changes to keywords, modes and scopes are saved automatically, with a new classification. After typing a name, leave the field to save this change. 1. At the bottom of the panel, wait for **Saving…** to finish. 2. The save control, **Save now**, can show **Saved** or **Failed — Retry**. Click it to explicitly request saving and updating the classification, in particular after a reset or to check that your rules have been applied. 3. Wait for it to finish without closing the page. 4. Check the matches, then click **Next step** to [review the components in Structure](https://wiki.can-nx.com/en/guides/boss-knx-structure/). ## Exclude labels Exclusions list the labels to ignore during import, for example to filter out diagnostic, test or maintenance addresses found in the KNX project. 1. In **Template → Exclusions**, type a label in **Add an ignored label**, then click **Add**. 2. Check the resulting classification. An exclusion does not, on its own, delete a component that has already been created. The cross on a chip removes this exclusion. **Show advanced filters → + Add rule** offers a **Pattern** field and **Case insensitive** for a regex rule. Use only a rule validated for your project. To have a rule confirmed or to explain an uncertain match, contact support rather than adding more and more filters. ## Delete a category or reset the template - **Delete category** asks for confirmation before deleting its entries. - **Reset**, at the bottom of the panel, asks for confirmation before deleting all the categories and keywords. After confirming, click **Save now** to apply this reset, then check the result. **Reset** is separate from **Reset topology**, which concerns the building’s organization. These actions do not offer an automatic restore of an earlier template: for an uncertain recovery, contact support. ## Check the result 1. Wait until **Saved** appears after your last change. The same text shown before your changes, or a structure that is already accessible, does not indicate that the last change has been applied. 2. In **Group addresses**, check the number of recognized addresses and the matches of the rows you changed. 3. In **Structure**, check the groupings before creating the components. ## Troubleshooting - Locked step: [import the .knxproj file first](https://wiki.can-nx.com/en/guides/boss-knx-project/). - Loading failure, **Failed — Retry** or another failure message: follow [dictionary troubleshooting](https://wiki.can-nx.com/en/guides/boss-knx-project-help/). If the problem persists, contact support@can-nx.com. French labels: **Dictionnaire**, **Configuration du template de composant**, **Template**, **+ Catégorie**, **Type de composant**, **+ Ajouter un datapoint**, **+ Mot-clé**, **Périmètre de recherche**, **Définir le périmètre de recherche**, **Valider**, **Annuler**, **Par type**, **Par nom**, **Appliquer à tout**, **Adresses de groupe**, **Enregistrer maintenant**, **Enregistré**, **Échec — Réessayer**, **Charger le template par défaut**, **Réinitialiser**.