Skip to content

System submodules

ModuleCatalogs
Suggested profileAdministration
PermissionSUBMODULES: WRITE / ADMIN
StatusValidated

Objective

Maintain the catalog of submodules that are assigned to modules and used to assign permissions per user.

How the screen is organized

Table with search and the columns: name, parent module, path, icon and status. Actions: edit, delete.

Available actions

  • Create submodule: high dialog.
  • Edit submodule: adjust name, parent module, path, icon or status.
  • Activate or deactivate: the submodule stops appearing in the sidebar when deactivated.
  • Delete: requires SUBMODULES: ADMIN.

Permissions

  • SUBMODULES: WRITE to create and edit.
  • SUBMODULES: ADMIN to delete.

Before starting

  • Have the parent module created.
  • Define the URL path of the submodule (must match the real path of the module in the webapp).
  • Have the icon configured.

Step by step - Create

  1. Go to Catalogs -> Submodules.
  2. Click New submodule.
  3. Enter: name, key, parent module, path, icon, status.
  4. Confirm.

Expected result

  • The submodule is registered.
  • If it is active and the user has READ (or higher), it appears in the sidebar under its parent module.
  • The system shows a success message.

Pending: add screenshot of catalogos-submodulos-01-dialogo.png.

Common errors

SituationWhat to do
The submodule does not appear in the sidebarVerify that it is active and that the user has read permission.
The path does not loadConfirm that the path is exactly the one defined in the webapp.

Suggested permissions

  • SUBMODULES: WRITE.

Operational recommendations

  • The submodule path must be stable; changing it breaks stored permissions.
  • Document the module-submodule relationship for the team.

Relation with other modules

  • System modules: each submodule belongs to a module.
  • Users and permissions: submodules are the minimum unit of permission assignment.
  • Sidebar: active and visible submodules according to permissions feed the side menu.