Skip to content

Commit b8fe5b4

Browse files
committed
described UI Access Rules
1 parent 6eea3be commit b8fe5b4

File tree

2 files changed

+37
-2
lines changed

2 files changed

+37
-2
lines changed

admin/user-management.rst

+35
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,41 @@ will have access to view all generated alarms. Should it be required to configur
193193
for specific users or groups, please refer to :ref:`alarm-category-config`.
194194

195195

196+
UI Access Rules
197+
---------------
198+
199+
UI access rules allow to hide specific UI elements from user. This does not
200+
securely blocks access - hiding is only implemented in |product_name| Management
201+
Client, so e.g. nxshell is not affected by UI access rules.
202+
203+
UI access rules are stored in textual format, one UI element per line. UI
204+
elements have ``category:name`` format, ``*`` GLOB wildcard can be used to match
205+
multiple elements. E.g. ``perspective:objects.maps`` refers to Maps perspective,
206+
``perspective:*`` refers to all perspectives, ``view:objects.fdb`` is FDB view
207+
(tab) on an object and ``*`` means all UI elements.
208+
209+
Adding UI element means that it should be included. Adding ``!`` prefix means
210+
exclusion. ``^`` prefix means priority inclusion.
211+
212+
Rules are checked in the following order, until a matching rule is found:
213+
214+
#. Priority inclusion rules (rules with ``^`` prefix). If a rule is matched, UI
215+
element is enabled.
216+
217+
#. Exclusion rules (rules with ``!`` prefix). If rule is matched, UI element is
218+
disabled.
219+
220+
#. Inclusion rules (without any prefix). If a rule is matched, UI element is
221+
enabled.
222+
223+
#. If no matching rules found, UI element is disabled.
224+
225+
Default configuration had ``*`` inclusion rule for user ``Everyone`` and
226+
``Admins`` groups, thus enabling all UI elements. Based on that exclusion rules
227+
can be added, or it's possible to remove ``*`` rule and configure specific set
228+
of inclusion and, if needed, exclusion rules.
229+
230+
196231
User Authentication
197232
===================
198233

conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
project_author = "Raden Solutions, SIA"
3030
copyright = '2025, ' + project_author
3131

32-
version = '5.1'
33-
release = '5.1.4'
32+
version = '5.2'
33+
release = '5.2.0'
3434

3535
exclude_patterns = ['build']
3636

0 commit comments

Comments
 (0)