CREATE MODULE ROLE
Synopsis
CREATE [ OR MODIFY ] MODULE ROLE module.RoleName [ DESCRIPTION 'text' ]
Description
Creates a new module role within a module. Module roles are the foundation of Mendix security – they are referenced by entity access rules, microflow/page access grants, and aggregated into project-level user roles.
Each module role belongs to exactly one module. The role name must be unique within the module. By convention, common role names include User, Admin, Viewer, and Manager.
If the module does not exist, the statement returns an error. If the role exists, CREATE MODULE ROLE returns an error; CREATE OR MODIFY updates it instead, so a security script can be re-run. Without DESCRIPTION, CREATE OR MODIFY keeps the role’s stored description; DESCRIPTION '' clears it.
Parameters
module.RoleName- Qualified name consisting of the module name and the new role name, separated by a dot. The module must already exist.
DESCRIPTION 'text'- Optional human-readable description of the role’s purpose. Left out, a new role has none and an existing role keeps its own.
Examples
Create a basic module role:
CREATE MODULE ROLE Shop.Admin;
Create a role with a description:
CREATE MODULE ROLE Shop.Admin DESCRIPTION 'Full administrative access to shop module';
Create multiple roles for a module:
mdl 1;
CREATE MODULE ROLE HR.Manager DESCRIPTION 'Can manage employees';
CREATE MODULE ROLE HR.Employee DESCRIPTION 'Self-service access';
CREATE MODULE ROLE HR.Viewer DESCRIPTION 'Read-only access';
Make sure a role exists, keeping whatever description it has:
CREATE OR MODIFY MODULE ROLE HR.Manager;