Enterprise sidebar: Configuration and Integration
The Enterprise sidebar holds the screens that work across all warehouses: users, roles, permissions, translations, handling unit types and the event system.
It is a different sidebar from the warehouse sidebar (Inbound, Inventory, ...).
This section describes every screen under the two Enterprise groups, Configuration and Integration.
How to open it
- Sign in.
- Open the warehouse switcher and pick Enterprise. The sidebar footer then reads
Enterprise · ADMIN. - The sidebar shows the groups
Dashboard,ConfigurationandIntegration.
The switcher offers Enterprise only to a user who holds the role ADMIN on at least one warehouse.
The switch is refused otherwise with Enterprise access requires ADMIN role (crates/services/web-ui-server/src/routes/warehouse_handler.rs:67).
While you are in Enterprise, the server accepts only the role ADMIN for every check (crates/services/web-ui-server/src/domain/warehouse.rs:40, crates/libs/wms-lib-auth/src/authorization/role_resolver.rs:69).
A role named MANAGER or SUPERVISOR does not open Enterprise, even if an API list on these pages names it.
The user type
Adminis not enough to open Enterprise from the switcher. The switcher looks for the roleADMINon a warehouse (auser_warehouserow), not at the user type. See User types and statuses.
What the sidebar has
| Group | Item | Menu item code | Opens | Page |
|---|---|---|---|---|
Configuration | Warehouses | ent_warehouses | Form warehouse_admin_list_form | |
Configuration | Users & Roles | ent_users | A group of four items. | |
Users & Roles | Users | ent_users_list | Form enterprise_users_shell | Users list |
Users & Roles | Roles | ent_roles_list | Form enterprise_role_detail | Roles |
Users & Roles | Audit Log | ent_audit_log | Form enterprise_audit_log | Audit log |
Users & Roles | Permission Matrix | ent_permission_matrix | Form enterprise_permission_matrix | Permission matrix |
Configuration | Translations | ent_translations | Form translations_tabbed | Translations |
Configuration | Handling Unit Types | handling_unit_type_menu | Form handling_unit_type_list_form | Handling unit types |
Integration | Event Registry | ent_event_registry_menu | Form ent_event_registry_list_form | Event registry |
Integration | Event Monitor | ent_integration_event_menu | Form ent_integration_event_list_form | Event monitor |
Integration | Subscribers | ent_integration_subscriber_menu | Form ent_integration_subscriber_list_form | Subscribers |
Integration | Delivery Log | ent_event_delivery_menu | Form ent_event_delivery_list_form | Delivery log |
Source: the menu Enterprise (menu id 3) in crates/libs/wms-lib-sql/sql/wms-meta-ui/migrations/001_baseline.sql (table menu_items) and the events nav_ent_* and nav_handling_unit_type_list in table ui_event.
The first group in the sidebar, Dashboard (ent_dashboard), is not described here.
Warehouse definitions and owners
Warehouses opens the Enterprise warehouse administration form. Registration
creates an inactive warehouse definition; it does not provision a PostgreSQL
schema. The list reports whether the schema is ready, and activation is refused
until deployment preparation is complete.
Owners are maintained in the warehouse sidebar (owner_list) after a
warehouse is selected. They are stored inside that warehouse's schema, so the
old ent_owners placeholder is inactive and is not rendered in Enterprise.
Which items you see
The sidebar hides an item when either of these is true (crates/services/web-ui-server/src/components/partials/sidenav.rs:91):
- The role has a
menu_itempermission row for the item and its R (read) bit is off. No row at all means the item is shown. - The form behind the item is closed to the role (
MetaCache::may_read_form,crates/services/web-ui-server/src/meta/cache.rs:3221). A form is closed only when some role has aformrow for it and this role has none, or has all four bits off.
A hidden item also cannot be opened by its address (navigation_handler.rs:54).
An administrator edits these rows in Permission matrix.
What a button needs
A button works only when all the gates are open.
| Gate | Where it is checked | Refusal |
|---|---|---|
| The form may be opened | services/form_access.rs | Your role may not open this form. |
| The web action behind the button may run | extensions/tx_helper.rs, check_action_chain_permissions | Forbidden("{action}") |
| The API method behind the button may run | app-server check_api_call | HTTP 403 with the method name |
The details, with the default role lists, are on Who can do what.
Pages in this section
Screens
Users list, User card: General tab, Warehouses & Roles tab, API Keys tab, Roles, Audit log, Permission matrix, Translations, Handling unit types, Event registry, Event monitor, Subscribers, Delivery log.
Tasks
Creating a user, Resetting a password, Locking or disabling an account, Assigning a user to a warehouse, Deleting a user, Generating an API key, Revoking an API key, Creating a role, Changing permissions in the matrix, Translating a label or message, Creating a handling unit type, Adding an event type, Adding a subscriber, Finding out why an event was not delivered.
Reference
User types and statuses, Who can do what, Sign-in, passwords and sessions, Event and delivery statuses, Messages catalogue.
Related pages
- Users list
- Who can do what
- Sign-in, passwords and sessions
- Administrator guide: Users, roles and permissions, Integrations and API
- API:
list_user_warehouses(fills the warehouse switcher). RF terminal: none.