Page: Roles and requirements

Introduction

Roles and requirements are use to allow or disallow users to access certain pages or menu items.

To enter roles for a user or an account, put each role on a separate line. Any name is fine, as long as you use it consistently, e.g. 'dealer' or 'sales'. A default role for the main user for an account is 'accountadmin'.

For a page or menuitem you can enter requirements. If a user has a role that matches a line in the requirements, then that user has permission. If you want a user to have multiple roles before allowing access, put them on a single line separated by a plus-sign, e.g. 'dealer + sales' requires both the dealer and the sales role.

New: exclude roles

Available from Stentor version 6.1.5

To show a menuitem or page only to users that don't have a particular role, add 'not-' to the role in the requirements field.

When you enter 'not-accountadmin' to a page it can't be seen by any account admins. You can add this prefix to any role in the requirements, so 'dealer + not-sales' will work, as will 'not-dealer + not-sales'. Note that this only works in the requirements field, you can't give a user a 'not-' role.

Augmented: access control component

Available from Stentor version 6.5

The access control component now has a full-fledged 'requirements' field, where you can specify the requirements with more precision, as described above. Note that when the 'accountadmin' role is specified in the 'access' dropdown list, it will be considered as an extra line in the requirements field.

Examples

A user Jill is a reseller of our products. We assign her the role 'dealer'. Now she can see the dealer-specific contact information page where we added that role to the requirements. She must be logged in for this to work of course.

Both Jill and Jack are dealers. Jack iss also a preferred partner. Jill gets the role 'dealer' and Jack gets both 'dealer' and 'partner'. They can both see the dealer-specific contact information page, but only Jack has access to the partner promotion page where we set the requirements to 'dealer + partner'.

Can I combine roles?

For a user you can assign multiple roles, just enter each one on a separate line. For requirements you can require a combination of roles by adding them with a plus-sign (AND), or you can require any of the specified (combination of) roles by putting them on separate lines (OR).

Can I exclude a certain role?

Yes, from version NEXT_RELEASE you can add the prefix 'not-' to any role in the erquirements field. Users that have this role can't see the page or menuitem you've excluded for them.

Can I show or hide a part of the page based on roles?

Yes, by using an 'access control' component as a wrapper. You set the necessary requirements on the 'access control' component.