Page tree

This documentation corresponds to a historical version of Yellowfin

Access the latest release, or view a list of available versions of the documentation.

Skip to end of metadata
Go to start of metadata

Role List

This section describes how roles are created and managed within Yellowfin. Roles are allocated to users and define a set of functions that the user is permitted to access within the system. The role list is accessible via the Admin Console. As a default you will have a number of pre-configured roles. These are listed below.


Sample Yellowfin Roles

When Yellowfin is initially deployed a standard set of roles is provided to you. These are:


Consumer & Collaborator

This user can only access public content and contribute to collaborative features such as streams, timeline, etc.
Personal Content Writer & CollaboratorThis user can only create personal content for their own consumption - not public shared content. They can collaborate within streams, timeline, etc.
Public Content Writer & CollaboratorThis user can create content to be consumed by themselves and other users in the system. They can collaborate using features such as streams, timeline, etc.
Public Content Writer & Collaborator - Advanced

This user can create content to be consumed by themselves and other users in the system. They can collaborate using features such as streams, timeline, etc.

This user also has extended access to create and manage views, report approval, and other admin items. This role should be used sparingly.

System AdministratorThis user has the widest range of access to the system, and as such you should have a very limited number of people assigned this role. They can do everything from create content through to managing system tasks.


Create Role

In order to create a new role you will need complete the following:

  1. Click on the Add button located at the bottom of the Roles list in the Admin Console
  2. You will now be taken to the Role Details page and will need to define these components:
    1. Provide a meaningful Name and Description that outlines the purpose or use of the role
    2. Enable the role as Mandatory, Default, or Guest as required. (Optional)


      This means that once this role has been created, and at least one user assigned the role, when users are deleted Yellowfin will check the role to ensure there is always at least one user with this role in the system. So if you try to delete the only user assigned the Mandatory role you will experience the following error:

      Default Role

      This means that when a user is created in Yellowfin, either by an Administrator, or through LDAP, they will be assigned this role unless otherwise specified

      Guest Role

      Guest roles are used for accessing external content.

    3. Select an existing public storyboard to present to new users from the Welcome page. (Optional)
    4. Enable/Disable functions as required. A description of each function is available by hovering over the info icon on the right hand side.
      Note: See Available Security Functions for a full list.
    5. Define the CRUD permissions where required. Some functions will have a C R U D check list as part of the settings. The acronym CRUD refers to all of the major functions that need to be implemented. Each letter in the acronym can be mapped to a standard SQL statement:


      INSERT new records


      SELECT records from the database


      UPDATE records in the database


      DELETE records in the database

      One example of CRUD access is for dashboards. If a user only has R selected they will be able to read dashboard but not create new dashboard tabs or add reports to their tabs. Whilst a user with CRUD will be able to create and delete dashboard tabs.

    6. The last option you have in the role settings is to specify what columns should be made available to users when viewing the report list.
  3. Click Save when you have completed editing to make your role available.
    Note: Yellowfin will do a function check to ensure you do not breach your license agreement.


Edit/Copy Role

In order to edit the permissions assigned to a role, or make a duplicate copy of a role to manipulate use the drop down list next to the role name on the Admin Console.


Delete Role

In order to delete a role use the drop down list next to the role name on the Admin Console. You will then be prompted to confirm the deletion on a separate page.

Note: if there are users attached to a role you choose to delete, the users will also be removed from the system.