Skip to main content

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​

  1. Sign in.
  2. Open the warehouse switcher and pick Enterprise. The sidebar footer then reads Enterprise · ADMIN.
  3. The sidebar shows the groups Dashboard, Configuration and Integration.

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 Admin is not enough to open Enterprise from the switcher. The switcher looks for the role ADMIN on a warehouse (a user_warehouse row), not at the user type. See User types and statuses.

What the sidebar has​

GroupItemMenu item codeOpensPage
ConfigurationWarehousesent_warehousesForm warehouse_admin_list_form
ConfigurationUsers & Rolesent_usersA group of four items.
Users & RolesUsersent_users_listForm enterprise_users_shellUsers list
Users & RolesRolesent_roles_listForm enterprise_role_detailRoles
Users & RolesAudit Logent_audit_logForm enterprise_audit_logAudit log
Users & RolesPermission Matrixent_permission_matrixForm enterprise_permission_matrixPermission matrix
ConfigurationTranslationsent_translationsForm translations_tabbedTranslations
ConfigurationHandling Unit Typeshandling_unit_type_menuForm handling_unit_type_list_formHandling unit types
IntegrationEvent Registryent_event_registry_menuForm ent_event_registry_list_formEvent registry
IntegrationEvent Monitorent_integration_event_menuForm ent_integration_event_list_formEvent monitor
IntegrationSubscribersent_integration_subscriber_menuForm ent_integration_subscriber_list_formSubscribers
IntegrationDelivery Logent_event_delivery_menuForm ent_event_delivery_list_formDelivery 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):

  1. The role has a menu_item permission row for the item and its R (read) bit is off. No row at all means the item is shown.
  2. 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 a form row 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.

GateWhere it is checkedRefusal
The form may be openedservices/form_access.rsYour role may not open this form.
The web action behind the button may runextensions/tx_helper.rs, check_action_chain_permissionsForbidden("{action}")
The API method behind the button may runapp-server check_api_callHTTP 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.