Overview

While Alluvial provides predefined roles for managing user access, there are times when more granular control is required.

Custom Roles allow you to restrict access to specific project content—for example, making a visualization visible only to a particular group of users.

Getting Started with Custom Roles

Custom Roles can be created and managed through the project administration page, accessible via the Menu Admin section in the left-hand navigation menu or by clicking on the Custom Roles card.

If your project does not have any Custom Roles yet, the Custom Roles page will be empty. Get started by clicking on the CREATE CUSTOM ROLE button and filling out the form that appears.

After creating the role, make sure to save it by clicking the SAVE button.

By clicking on the + button next to each Custom Role, you can add various resources (entities) from your project to the role. By default, entities may be rolled up inside of the newly created role. In this case, click on the arrow next to each Custom Role to expand and view the content within.

Much like with the Menu Layout module, entities can be moved from one Custom Role to another by clicking and dragging them as needed.

Assigning a Custom Role and Access Control

Creating the Custom Role and add entities to it is only the first step. To enforce access control, the Custom Role must be assigned to specific people within your project. This is done by navigating to User Administration and selecting the user you want to assign the role to.

More than one Custom Role can be assigned to a user if needed. After selecting the desired roles, make sure to click the SAVE button to apply the changes.

Only users with the assigned Custom Role can access the associated visualization. This restriction applies to all users, including project administrators.

NOTE: If you cannot see a visualization that others can, check whether a Custom Role needs to be applied to your account for that project.

Additional Functionality

The following additional functionalities are available for managing Custom Roles:

Editing Custom Role Names

Each Custom Role has an edit icon (pencil) next to it. Clicking this icon opens a form that allows you to modify the name.

Deleting Entities and Roles

Clicking on the broom icon next to each role will remove all entities from that Custom Role. Clicking on the trash can icon beside an individual entity will remove just that item from the Custom Role.

All entities must be removed from a Custom Role before the role itself can be deleted. Once empty, click on the trash can icon next to the Custom Role to delete it.