Allowing users access to an Action plug-in is controlled by defining one or more requiredRoles in the configuration file for that plug-in and subsequently enabling the requiredRole as a Capability for a user or user group.
A requiredRole can be a default role or a custom role.
Defining the requiredRole is not mandatory. When not set, all users have access to the plug-in.
<action> <requiredRoles>...</requiredRoles> </action>
For a list of the default roles, see Controlling user access to clients and client features in Elvis 6.
Note: To specify that only a Super user can use the plug-in, use ROLE_SUPERUSER.
To control user access to a specific Action plug-in, a custom role can be defined for that plug-in. This role will then appear in the list of Capabilities in the Management Console.
A custom role should always start with ROLE_CUSTOM_ACTION_ followed by a custom name:
The part after ROLE_ is used as the name in the list of Capabilities and is transformed into a regular writing style.
Example: The role ROLE_CUSTOM_ACTION_MY_ACTION_PLUGIN appears as 'Custom action my action plugin'.
Standard download capability
<requiredRoles> <role>ROLE_DOWNLOAD</role> </requiredRoles>
Custom plugin capability
<requiredRoles> <role>ROLE_CUSTOM_ACTION_MYACTION</role> </requiredRoles>
Standard and custom capability
<requiredRoles> <role>ROLE_IMPORT</role> <role>ROLE_CUSTOM_ACTION_MYACTION</role> </requiredRoles>
- 8 August 2018: Renamed article from 'Elvis 6 action plug-ins setting - requiredRoles'.
- 8 August 2018: Complete re-write of the article.