Create, name and save a schema in the Boss’nX editor

The schema editor of a Boss’nX supervision is used to create a new drawing or edit an existing schema. This procedure opens it, fills in the schema name and description, saves it and checks the result. It also explains how to leave the editor without losing pending changes or saving them by mistake.

For administrators and installers, in a supervision opened directly or from a hypervision. To view a drawing without editing it, use the Schemas page.

Before you start

• Your role grants Edit schemas, with View schemas. Check these rights in the role capabilities rather than relying on the role name alone.
• You are working on a computer: the steps below apply to this display. If a control is hard to reach, use a wider screen.
• You want to create or edit a drawing. Add schema, on the Dashboard, only adds a display block: for that goal, follow the block configuration.

Open the editor

1. From the Dashboard of the supervision concerned, open Schemas in the header bar. If this page does not appear in the bar, open Menu, then choose Schemas.
2. If needed, expand the left panel with Expand sidebar.
3. For a new schema, click the + button at the top of the panel, tooltip Create schema. The editor opens with a first, empty layer.
4. For an existing schema, search for its name, hover over its row, open the three vertical dots Actions, then choose Edit schema. To start from a specific layer, first select that layer in the list.
5. On an existing schema, wait until the expected name and content have loaded before changing anything. If the editor stays empty, follow editor troubleshooting.

Fill in the name and description

Both fields are at the top of the left panel, before the Save button and the drawing tools; a small pencil icon appears to the right of each. If the panel is reduced to a column of icons, reopen it with the double-chevron button, tooltip Show panel.

1. In Schema name, type a non-empty name, for example Reception plan (fictional example). A field containing only spaces does not count as a name.
2. In Description (optional), add a short description if useful, for example View of the lobby and reception (fictional example). This field can stay empty.
3. To rename an existing schema, replace the text in the first field. To remove the description, clear its content.

Leading and trailing spaces are removed when saving. Changing a field prepares a change, which is only kept after the save described below.

A named schema can be saved with a layer that is still empty, to be completed later: saving adds no drawing, component or command.

Prepare the drawing

The editor also holds the drawing tools, each described in its own guide:

• organize layers: layer management;
• set up the surface: dimensions and grid, zoom and undo controls, background color, pattern and image;
• add data: placing datapoints and cards, then Linked data to choose the binding of an Icon button;
• find the elements associated with a datapoint: Used datapoints;
• copy a drawing before editing it, or delete a schema that is no longer needed: the list actions.

Save the schema

1. Click Save, in the left panel.
2. If Please enter a schema name. appears, fill in the name, then click Save again.
3. The Save schema? dialog asks Do you want to save the changes to this schema? Review the name and the prepared changes.
4. Click Save in the dialog to confirm, or Cancel to return to the draft without starting the save.
5. During Saving in progress, wait for the end without closing or refreshing the page. The save button is unavailable while sending.
6. Wait for the message Configuration saved successfully. and read the layer summary when it appears: the summary tells you whether all layers were saved, even when the percentage reaches 100%.

If the confirmation shows errors, its button may become Save anyway; warnings may also appear. Read these messages and check the elements concerned before continuing, using the guide to schema problems and fixes. This button continues saving despite the messages, without guaranteeing that the configured elements are usable.

If Resolve conflicts appears during saving, follow choosing layer versions.

Leave the editor with pending changes

When you open another page, for example Schemas in the header bar or a page of the Menu, an Unsaved changes dialog may offer three choices:

Choice	Expected result
Stay	The editor stays open and you keep the draft to continue. Esc or a click outside has the same effect when no save is in progress.
Leave without saving	You leave without saving the changes still pending. Changes saved earlier are not affected.
Save & leave	Saving starts; navigation continues when it succeeds. First check that the name is filled in and that you want to save these changes.

To review the name or the messages before saving, choose Stay, then use Save in the editor. Save & leave starts saving directly; it does not open a preview.

During saving, the three choices are unavailable. If saving fails, the dialog may stay open: read the displayed message and follow save troubleshooting. Choose Leave without saving only if you accept abandoning what is still pending.

A new, still blank schema may also show this dialog. If you do not want to create it, choose Leave without saving. Cancel in the Save schema? confirmation keeps the draft in the editor and does not replace this leaving choice.

Check the result

1. Open Schemas in the header bar or in the Menu, and clear the search text if needed.
2. Explicitly click the schema name in the list. After a successful creation, the schema appears there.
3. To review the name or description in their fields, reopen Actions → Edit schema and wait for loading.

After saving, the editor may stay open: this is normal, and you can keep working.

Troubleshooting

Observation	Action
Please enter a schema name.	Fill in Schema name with non-empty text, then save again.
The editor stays empty on an existing schema	Wait for loading, then return to the list and reopen Edit schema on the right row.
The summary shows layers as Failed	Note the layers and the message, keep the page open and run Save again.
The dialog stays open after Save & leave	Read the message, choose Stay, check the name, then run Save again.
Control hard to reach	Use a wider screen. To get back to the list from the editor, use Schemas, in the header bar or in the Menu, and answer any prompt about pending changes.

For other messages and special cases, follow save troubleshooting. If the problem persists, contact support@can-nx.com with the schema name, the exact message and the steps already taken.

French labels: Créer un schéma, Modifier le schéma, Nom du schéma, Description (optionnel), Sauvegarder, Sauvegarder le schéma ?, Annuler, Modifications non enregistrées, Rester, Quitter sans enregistrer, Enregistrer et quitter.