Skip to main content

Pentaho+ documentation is moving!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

Managing roles

Parent article

Lumada Data Catalog provides roles to organize user access to data curation activities. Additionally, role-based access control (RBAC) governs user access to Data Catalog assets, like access to virtual folders and glossaries, their activity permissions, such as job execution and lineage curation, and their resource read access.

With the right combination of privileges and settings, users within the same role group can:

  • Have access to the same set of assets (Virtual Folders and Glossaries)
  • Have the same activity permissions (Job execution, Business Term/Lineage curation)
  • Have access to the metadata of the resources (Resource Read Access Control)

To manage roles, click Management in the left navigation menu, and then click User Roles.

NoteThis menu is available only to roles assigned the Manage User Roles permission. Only the Root user can update the Admin role and change the Admin user permissions.

Add a new role

Before you add new roles to your system, it is recommended that you plan and create your data sources and glossaries.

To add a new role, you must be assigned the Manage User Roles permission. This task is usually performed by a site administrator.

Perform the following steps to add a new role:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Click Create New Role.

    The Create New Role dialog box opens.
  4. In the Role Name field, enter a name for the role.

    NoteNote that the role name must start with a letter, and must contain only letters, digits, hyphens, or underscores. Spaces before or after the name are not allowed. Make sure that the name strings do not match any Data Catalog reserved names.
  5. In Sample Data Access, specify whether the role can view the Sample Data pane on the canvas.

    See Resource read access control.
  6. In the Role Description field, enter information to describe the purpose of the role.

  7. Click Create New Role.

  8. Select Make Default Role if you want to make this a default role.

    See Set a role as default for more information.
  9. Set the Role Permissions that you want associated with the role.

    See Role-based access control (RBAC) for more information.
  10. Click Save Changes.

Results

The role and permissions are saved.

Next steps

See Assign a user to a role for role assignment instructions.

Set a role as default

When you set a Data Catalog role as default, any new user you create automatically receives the default role permissions. A user with the Manage User Roles permission can set any role to be the default role:

  • You can set more than one role as default.
  • If a user inherits more than one role, the role with the highest permission level governs the user access permissions.

Follow the steps below to set a role as default:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to set as default then click More actions and select Edit Role from the drop-down menu.

    The role details page opens.
  4. Click Make Default Role.

  5. Click Save Changes.

Results

Your settings are saved for the role.

Duplicate a role

You can duplicate any role. When you duplicate a role, you make an exact copy of the role such that the duplicated role inherits its job execution setting and its functional and metadata access levels from the copied role. The duplicated role displays the original role's name as a copy.

Follow the steps below to duplicate a role.

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to duplicate then click More actions and select Duplicate Role from the drop-down menu.

  4. Click Close.

Results

The role is duplicated, and its original name is appended with copy, which you can edit to rename.

Delete a role

You can delete a role that is no longer in use. However, you cannot delete the predefined global_administrator role.

NoteYou cannot delete a role in Data Catalog when users are assigned to that role. When deleting a role, make sure that any user assigned to that role has been assigned another role or has been deleted.

You can delete a role from the list of roles or from the role's Settings tab. Follow the steps below to delete a role.

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to delete then click More actions and select Delete Role from the drop-down menu.

    A confirmation dialog box displays.
  4. Click Remove.

    If no dependencies are found, the role is deleted. If the role being deleted is the only role assigned to a user, the role is not deleted.
  5. Click Close.

Manage role settings

You can redefine the role's access level, resource read access level, and job execution permissions.
NoteAs an Admin user, you cannot update your own role. Only the Root user can update the Admin role and change the Admin user permissions.

Follow the steps below to manage role settings:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to manage then click View Details (right arrow) at the end of the row.

    The role details page opens.
  4. Under the Settings tab, click the role permission setting(s) that you want to change.

    You can update role access level definitions by making changes in the permission group assignments.
  5. Click Save Changes.

Results

The role settings are updated.

Next steps

You can also update the role’s virtual folder access on the Virtual Folder tab and glossaries access on the Glossaries tab, and search access on the Search Dimensions tab.

Assign a virtual folder to a role

Perform the following steps to assign a virtual folder to a role:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to add a virtual folder to and then click View Details (right arrow) at the end of the row.

    The role details page opens.
  4. Click the Virtual Folders tab, then click Add New.

    The Select VFolder dialog box opens.
  5. Select the virtual folder(s) the role can access, then click Assign Items.

    The selected virtual folder(s) are added.
  6. Click Save Changes.

Results

The role is updated. The virtual folder(s) are assigned for the role.

Remove an assigned virtual folder from a role

Perform the following steps to remove an assigned virtual folder from a role:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to remove a virtual folder from and then click View Details (right arrow) at the end of the row.

    The role details page opens.
  4. Click the Virtual Folders tab.

  5. Locate the name of the virtual folder then click its associated Trash bin icon.

    NoteIf all virtual folders are assigned to the role, you need to click Add New and clear the Select All check box to get the list of folders to appear. Then you can select a folder to remove.

    Select the check box for the folder and click Remove.

    The Remove VFolders dialog box opens.
  6. Click Remove.

  7. Click Save Changes.

Results

The role is updated. The virtual folder is deleted from the role.

Assign a glossary to a role

Follow the steps below to assign a glossary to a role:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to assign a glossary to and then click View Details (right arrow) at the end of the row.

    The role details page opens.
  4. Click the Glossaries tab, then click Add New.

    The Select Business Glossary dialog box opens.
  5. Select the glossaries the role should access.

  6. Click Select.

    The selected glossary or glossaries are added.
  7. Click Save Changes.

Results

The role is updated. The glossaries are assigned to the role.

Remove an assigned glossary from a role

Follow the steps below to remove an assigned glossary from a role:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role from which you want to remove a glossary and then click View Details (right arrow) at the end of the row.

    The role details page opens.
  4. Click the Glossaries tab.

  5. Locate the name of the glossary you want to remove then click its associated Trash bin icon.

    NoteIf all glossaries are assigned to the role, you need to click Add New and clear the Select All check box to get the list of glossaries to appear. Then select a glossary to remove.

    Select the check box for the glossary and click Remove.

    A confirmation dialog box opens.
  6. Click Remove.

  7. Click Save Changes.

Results

The role is updated. The glossary is deleted from the role.

Assign search dimensions to a role

Follow the steps below to assign search dimensions to a role:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role that you want to assign a search dimension to and then click View Details (right arrow) at the end of the row.

    The role details page opens.
  4. Click the Search Dimensions tab, then click Add New.

    The Select New Facet dialog box opens.
  5. Select the check box for the facet(s) the role can access. By default, all the search dimensions are selected. If you want to assign a few search dimensions, clear the Select All check box and then select the ones you want to add.

  6. Click Select.

    The selected facet(s) are added.
  7. Click Save Changes.

Results

Search dimensions are assigned for the role.

Remove search dimensions from a role

Follow the steps below to remove assigned search dimensions from a role:

Procedure

  1. Click Management in the left navigation menu.

    The Manage Your Environment page opens.
  2. On the User Roles card, click User Roles.

    The Roles page opens.
  3. Navigate to the role from which you want to remove search dimensions, and then click the More actions (three dots) icon and select Edit Role.

    The role details page appears.
  4. Click the Search Dimensions tab.

  5. Select the check box for the facet(s) you want to remove, and then click Remove.

    NoteIf all search dimensions are assigned to the role, you need to click Add New and clear the Select All check box to get the list of search dimensions to appear. Then you can select a search dimension to remove.

    Select the check box for the search dimension and click Remove.

    A confirmation dialog box opens.
  6. Click Remove to confirm your deletions, and then click Save Changes.

Results

The selected facet(s) are removed.