Important

You are browsing the documentation for version 1.6 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Available in OroCRM Available in OroCommerce

Create and Manage Roles

You can create new roles and apply permissions to fit specifically your business processes, clone and modify the existing roles.

See a short demo on how to create a and manage roles or continue reading the step-by-step guidance below.

Create a Role

To create a new role in:

  1. Navigate to System > User Management > Roles in the main menu.

  2. Click Create Role on the top right.

  3. In the General section, provide the role name.

    ../../../../../../_images/create_new_role_from_scratch.png
  4. In the Additional section, specify the following:

    • Description — Use the built-in text editor to format the provided description.

    • Organization — Select the organization that the user role belongs to.

      Note

      If you want this role to be applicable for all organizations defined in the system, do not specify any organization. In this case, the field value becomes System-wide. If there is only one organization defined in the system or you do not have global access rights, there is no option for selecting an organization.

  5. In the Entities section, you can set three types of permissions - entity-level, field-level and system capabilities:

    • To specify access levels for entity-level permissions, click on the arrow icon next to the required permission (e.g. create or assign), and select the access level from the list. By default, access levels for each permission are set to None.

      ../../../../../../_images/single_entity_level_permissions.png

      To set the same access level for all actions on entity, select the required access level from the ellipsis menu at the end of the entity row.

      ../../../../../../_images/entity_level_permissions.png
    • To specify access levels for field-level permissions, click + to the left of the entity name. Click on the arrow icon next to the required permission, and select the access level from the list. Read more on how to enable field-level permissions in the Apply Permissions to Entity Fields topic.

      ../../../../../../_images/enable_field_acl.gif
    • To set system capabilities, enable or disable the check box next to the required options.

      ../../../../../../_images/cloned_role_system_capabilities.png
  6. In the Workflows section, specify access levels for workflows and workflow transitions. There are two permissions for workflows, view and perform transitions. By default, all workflow access levels are set to None. Choose the workflow or the transition to which you want to assign different permissions, click on the action name and select the required access level from the list.

    Tip

    If you do not see individual transitions of the workflow, click the + Expand icon in front of the workflow name to expand the list of transitions.

    ../../../../../../_images/create_role_workflow_permissions.png
  7. In the Users section, select check boxes in front of the users to whom you want to assign this role.

  8. Click Save.

Clone a Role

You can create a role by cloning the existing one:

  1. Navigate to System > User Management > Roles in the main menu.

  2. On the page of All Roles, click the ellipsis menu at end of the corresponding row of the selected role, and then click the Clone icon.

    ../../../../../../_images/clone_role_from_grid.png

    Alternatively, you can clone the role from the page of the selected role by clicking Clone on the top right.

    ../../../../../../_images/clone_role_from_role_page.png
  3. The page that opens has all of the settings as the original role. Modify the settings as required.

    ../../../../../../_images/cloned_role.png
  4. In the General section, update the role name.

  5. In the Additional section, provide the following information:

    • Description — Use the built-in text editor to format the provided description.

    • Organization — Select the organization that the user role belongs to.

      Note

      If you want this role to be applicable for all organizations defined in the system, do not specify any organization. In this case the field value becomes System-wide. If there is only one organization defined in the system or you do not have global access rights, there is no option for selecting an organization.

  6. In the Entities section, you can set 3 types of permissions, entity-level, field-level and system capabilities:

    • To specify access levels for entity-level permissions, click on the arrow icon next to the required permission, and select the access level from the list.

      ../../../../../../_images/single_entity_level_permissions.png

      To set the same access level for all actions on entity, select the required access level from the ellipsis menu at the end of the entity row.

      ../../../../../../_images/entity_level_permissions.png
    • To specify access levels for field-level permissions, click + to the left of the entity name. Click on the arrow icon next to the required permission, and select the access level from the list. Read more on how to enable field-level permissions in the Apply Permissions to Entity Fields topic.

    ../../../../../../_images/enable_field_acl.gif
    • To set system capabilities, enable or disable the check box next to the required options.

      ../../../../../../_images/cloned_role_system_capabilities.png
  7. In the Workflows section, specify access levels for workflows and workflow transitions. There are two permissions for workflows, view and perform transitions. Choose the workflow or the transition to which you want to assign different permissions, click on the action name, and select the required access level from the list.

    Tip

    If you do not see individual transitions of the workflow, click the + Expand icon in front of the workflow name to expand the list of transitions.

    ../../../../../../_images/create_role_workflow_permissions.png
  8. In the Users section, select check boxes in front of the users to whom you want to assign this role.

  9. Click Save.

Edit a Role

To edit an existing role:

  1. Navigate to System > User Management > Roles in the main menu.

  2. On the page of All Roles, click the ellipsis menu at end of the corresponding row of the selected role, and then click the Edit icon.

    ../../../../../../_images/edit_role.png

    Alternatively, you can edit the role from the page of the selected role by clicking Edit on the top right.

    ../../../../../../_images/edit_role_from_role_page.png
  3. On the page that opens, update the information as necessary.

Delete a Role

You can delete roles if they are not assigned to any user, and if you are granted permissions to delete roles.

To delete an existing role:

  1. Navigate to System > User Management > Roles in the main menu.

  2. On the page of All Roles, click the ellipsis menu at end of the corresponding row of the selected role, and then click the Delete icon.

    ../../../../../../_images/delete_role.png

    Alternatively, you can edit the role from the page of the selected role by clicking Delete on the top right.

    ../../../../../../_images/delete_role_from_page.png

Related Articles