Skip to main content

How do I set role-based permissions or role-based system access?

Describes how roles work, how to create, configure and assign them, how several roles combine, and what deleting a role does.

You will need the Permissions Limited permission to create roles and assign them. To edit or delete a role while multi-campus is on, you also need Permissions Full in your Default permissions, not just in a campus override. Permissions Full is also needed to grant or remove any financial permission in a role.

Whether someone gets their access from roles is decided by their Access choice, not by the roles listed on them.

  • A person marked Role Based with no roles has no permissions and no limit.

  • A person not marked Role Based ignores any roles left over on them.

  • Saving someone as Role Based wipes the permissions, limit, field access and campus overrides stored directly on them. Their overrides then come only from their roles, and Add campus override is hidden on that person.

Roles keep a consistent set of permissions across many users. A role holds a name and description, permissions, restrictions and their values, custom field access, a campus limit, and campus overrides. Roles are read live, so when a role changes, every user who holds it gets the change on their next action.


Creating a role

  1. Open Settings & Tools (Cog icon in the tool-bar) and select Security.

    The Settings & Tools menu with Security
  2. On the Security page, select the Roles tab and click + Add Role.

    The Roles tab with the Add Role button
  3. Enter a name and a description, then click Save.

    • Name - the name of the role as it will appear in the Roles list and when assigning the role to users. This field is required.

    • Description - a short note about who this role is for. This is optional.

    Entering a role name and description
  4. Alternatively, copy an existing role and edit it. Click the three-dot menu at the start of the role's row and choose Copy, then name the new role and continue as in steps 1 to 3.

The three-dot menu on a role with Copy

Warning: Copying a role copies its permissions, limit, field access and campus overrides. Without Permissions Full, the copy leaves out every financial permission, and nothing tells you it did.


Configuring a role

After saving, the role appears in the Roles list. Click the role name, or use the three-dot menu and choose Edit, to open the full editor. At the top are the role's Name, Description and Campuses, then Permissions For, which starts on Default. Below them, the Permissions and Custom Fields tabs hold the role's permissions and field access. Roles with campus overrides show them in the list.

Permissions

The Permissions tab is grouped into collapsible categories (Account Settings, People, Groups, Events, Communication, Financial, Automation, Sermons, Forms, Service Planning, Reporting and Other). Each category shows how many permissions are selected out of the total available, with a color indicator:

  • Full Access (green) - every permission in the category is selected.

  • Partial Access (yellow) - some permissions are selected.

  • No Access (red) - no permissions are selected.

Use Expand All or Collapse All in the top right to open every category at once. Within a category, each permission shows its name and description next to the checkbox. Some sub-groups, such as Contributions under Financial, also include check all and uncheck all shortcuts.

The Permissions tab of the role editor

Campuses

The Campuses field near the top of the editor sets the role's limit. All means the role does not limit its holders.

To limit the role, choose Specific, click choose campuses, and check the campuses this role should be allowed to access in the Campuses drawer. The drawer has check all and uncheck all shortcuts. If your account has more than one organization, you can choose whole organizations instead. A limit names campuses or organizations, never both.

  • Unlike a user's limit, a role's limit can be empty. An empty limit restricts everyone who holds the role to no campus.

  • An organization limit covers every active campus of that organization, including new ones.

The role editor with Campuses set to Specific and the Campuses drawer open with check all and uncheck all

How do campus and organization limits work? explains how limits work in each account state.

Custom Fields

The Custom Fields tab controls access to each custom field on a person's record. Fields are grouped by section, for example General, Check-In and Additional Fields. For each field, choose one of:

  • Hidden - the field is not visible to users with this role.

  • Read Only - users with this role can see the field but cannot change it.

  • Editable - users with this role can see and change the field.

The Custom Fields tab of the role editor

Campus overrides on a role

A role can have campus overrides, just like a Custom user. Each override is a whole replacement set of permissions for one campus, and the role's Default applies at every other campus. To add one, open the three-dot menu beside Permissions For and choose Add campus override. What is a campus override? explains how overrides work.

When you are finished, click Save.

Warning: When you change a role, every user who holds it gets the new settings right away.


Assigning a role to a user

  1. Open the person's profile and click Actions in the top right. Under the Security section, choose Manage system access.

    Manage system access in the Actions menu
  2. In the User Permissions window, set Access to Role Based.

  3. Click choose roles, check the role or roles this person should have, then close the drawer. The window shows a read-only preview of the combined permissions, campuses and custom field access the person will receive.

    Choosing roles for a Role Based user
  4. Click Save.


How several roles combine

When a person holds more than one role, the roles combine by these rules:

  • Permissions add up.

  • Custom field access takes the highest level any role gives.

  • A campus limit holds only if every role has one, and the campuses add up.

  • A restriction holds only if every role that holds its read permission limits it, and the allowed values add up.

  • A role's permissions are not tied to its own campuses.

Warning: One role with no limit removes the limit entirely. If someone holds three roles limited to campuses and one role with Campuses set to All, they are not limited at all.

Example: Role A is limited to North Hills and gives Full Write Events. Role B is limited to Lakeside. Someone holding both is limited to North Hills and Lakeside, and has Full Write Events at both, because Role A's permission is not tied to Role A's campus.

Campus overrides with several roles. For a Role Based user at a campus, each role contributes its override there, or its Default if it has none. Those combine by the same rules, so one role cannot take away what another role gives at that campus.

Example: Role A has an override at North Hills that gives nothing. Role B gives Full Read Groups on its Default and has no override. At North Hills, the person still has Full Read Groups, because Role B's Default counts there.


Deleting a role and financial permissions

  • When you delete a role, anyone left with no role becomes a Guest with no campus limit, and their limit and overrides are removed.

  • While multi-campus is on, editing or deleting a role needs Permissions Full in your Default permissions.

Without Permissions Full, these are refused:

  • Giving someone a role that holds a financial permission, or taking one away.

  • Switching someone who holds such a role to Custom.

  • Deleting a role that holds a financial permission while anyone has it.

Tip: If permissions appear disabled on a person's profile, it is because the person has one or more roles. Those permissions cannot be edited on the profile, because the role can affect other users. To make changes, either edit the role itself under Settings & Tools > Security > Roles, or change the person's Access to Custom.

Other Helpful Articles

Did this answer your question?