Kavi® Members Help

Chapter 113. Manage Roles

Overview

The Manage Roles tool is used to view and manage the roles that control user access to the organization's website.

Roles

Each role controls access privileges for those areas of the site that are configured to be accessible through this role. A role is rather like a key: it can allow access to locked areas. Your organization's web site will probably include a mix of default roles (e.g., 'org_admin', 'Editor', 'super_admin', etc.) and roles created specifically for your site (e.g., 'steering_committee', 'marketing', etc).

Roles and access privileges are conferred to users through types, including Company Types, Contact types and User Types. When a user is assigned a type, the user inherits whatever roles are associated with that type, thereby acquiring access to areas of the web site that require that role.

For example, one of the most highly privileged roles is the default 'org_admin' role. It grants access to Kavi Members Admin Area and tools, to the Admin Home page and all Admin Areas and tool links displayed on that page. The default User Type 'Organization Admin' is associated with the 'org_admin' role. When a user is assigned the 'Organization Admin' User Type, the user acquires the 'org_admin' role and access to Admin Areas and tools so they can fulfill their administrative responsibilities.

Default Versus Custom Roles

Application-defined roles

These roles give users access to different Kavi tools. The role description indicates what access each role grants to a user. Roles created automatically by Kavi Members or other applications cannot be edited or deleted, which is why these roles are displayed on the Manage Roles page without Edit or Delete links.

Custom-defined roles

Custom roles are often added when creating protected areas of the website meant to be used only by a specific set of users. These custom roles can be edited, and can also be deleted, providing the role is not in use.

Note

If the role is in use, the list of available links in the 'Action' field will not include 'Delete' and it will be necessary to use the Manage User Types and Manage Company Types tools to locate and unclick the checkbox for this role in the 'Associated Roles' field. When this is done you can return to the Manage Roles page and the 'Delete' link will be available.

Example of a custom role:

  • Role: 'steering'

  • Origin: custom

  • Description: Allows access to the steering area

In this example, a custom role of 'steering' is added to pave the way for the creation of a role-protected steering committee area. Once the role exists, the steering committee area is added to the site and configured to require the 'steering' role. A 'Steering Committee' User Type is added and associated with the 'steering' role, so that when this type is assigned to steering committee members, they acquire the role and access privileges for the steering committee pages and content.

Important

If you are an administrator and want to create a protected area, Kavi Groups tools are your best bet as they allow you to create protected areas automatically without the need to add roles or write any code. The creation of role-protected areas beyond the level supported by Kavi Groups tools is nontrivial, requiring some code-writing skills to establish.

Back to top

How to Manage Roles

View a tabular list of existing roles and access tools to add, edit or delete a role.

Role Name

The name assigned to the role.

Origin

This is the name of the application that automatically created the role, or 'custom' if it is custom to this site.

Description

This describes the kind of access granted by this role, specifically the area(s) of the site to which this role provides access.

Action

If this is a custom role and can be edited or deleted, links to tools to manage this role are provided in this field.

Back to top

Related Topics

Back to top