Skip to content

You are viewing documentation for Immuta version 2.8.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

Project Governance Tutorial

Audience: Data Governors

Content Summary: This page outlines how to manage projects as a Data Governor, including how to customize acknowledgement statements, create purposes, and manage data sources and tags in projects.

Creating Purpose-Based Restrictions

  1. Navigate to the Governance page, and then click the Purposes tab.

    Governor Purposes Tab

  2. Click the Add Purpose button.

    Governor Add Purpose

  3. Type in the name of the new purpose in the new empty text box, opt to customize the acknowledgement statement, and then click Confirm.

Creating Sub-Purposes

  1. Click the Governance icon in the left sidebar and select the Purposes tab.
  2. Click the Edit icon in the Actions column of the purpose you would like to add sub-purposes to.
  3. Scroll to the bottom of this page and click Add Sub-Purposes.

    Sub-Purposes Button

  4. Enter a name in the Enter nested purpose field in the Sub-Purpose Builder.

    Sub-Purpose Builder

  5. Click the arrow to the right of the purpose or sub-purpose(s) to continue adding nested purpose fields.

  6. Click Save.

A list of sub-purposes will populate at the bottom of the page. You can manage these sub-purposes by clicking the edit icon in the Actions column at any time.

Sub-Purpose List

Deleting Purpose-Based Restrictions

  1. Navigate to the Governance page, and then click on the Purposes tab.

    Governor Purposes Tab

  2. Click the trashcan icon in the Actions column of the purpose you want to delete.

  3. Click Confirm to approve the deletion.

Any project that contained the deleted purpose will be treated as no longer compliant, so the project's name will display in red on the My Project and Project Overview pages. Project Owners can get details for fixing the issue by hovering their cursor over the project name.

Customizing Acknowledgement Statements

Acknowledgement statements ensure that project members are aware of (and agree to) all purpose-based restrictions before accessing the project's content. Each purpose is associated with its own acknowledgement statement, meaning that a project with multiple purposes (if allowed) would require users to accept more than one acknowledgement statement. Immuta keeps a record of whether each project member has agreed to the acknowledgement statement(s), and if so, records the purpose associated to the acknowledgement, the time of the acknowledgement, and the text of the acknowledgement itself. All purposes are associated with the default acknowledgement statement unless their statement has been customized.

Customizing the Default Acknowledgement Statement for a Purpose

  1. Click the Governance icon in the left sidebar and select the Purposes tab.

    Governor Settings

  2. Click the edit icon in the Actions column of the purpose you would like to customize.

  3. Click the Edit button above the acknowledgement statement, customize the text, and then click Confirm.

    Governor Settings

The page displays the updated statement, which now will be used by all projects and purposes. The updated statement will also be used by any new members joining existing projects containing purposes with default statements.

Customizing the Acknowledgement Statement for a Sub-Purpose

By default, sub-purposes will inherit the acknowledgment statements of their parent purposes.

To customize the acknowledgement statement for an individual sub-purpose,

  1. Click the Governance icon in the left sidebar and select the Purposes tab.
  2. Click the edit icon in the Actions column of the parent containing the sub-purpose you would like to customize.
  3. In the Sub-Purposes section, click the edit icon in the Actions column of the sub-purpose you would like to manage.

    Edit Sub-Purpose

  4. Customize the Acknowledgement Statement in the dialog that appears, opt to require users to reacknowledge the sub-purpose, and then click Confirm.

    Customize Sub-Purpose Acknowledgement

Viewing Purpose-Based Restrictions Details

  1. Navigate to the Governance page, and then click the Purposes tab.

    Governor Purposes Tab

  2. A list of all purposes is displayed. To filter the list, enter the name of the purpose you are interested in the empty text box.

  3. Click a purpose from the results to view its details.

Details about the selected purpose are displayed in the panel at the right and include the date the purpose was created, when it was modified, and the number of projects that purpose is associated with.

Managing Project Tags

Adding Tags to a Project

  1. Select a project, and then click the Overview tab.
  2. Click the Add Tags button at the bottom of this page.
  3. Begin typing a tag name in the Add Tags window that appears to search for tags.
  4. Select a tag, and then click Add. A list of the applied tags will populate at the bottom of the Project Overview tab.

Project Overview Tab

Removing Tags from a Project

  1. Select a project, and then click the Overview tab.
  2. Scroll to the Tags section at the bottom of this screen, and then click the red "X" on the tag you would like to delete.

    Remove Tag

  3. Click Confirm to remove the tag from the project.

Managing Project Members

Adding Users or Groups to a Project

  1. Select a project, and then navigate to the Members tab.
  2. To add a new user or group to the project, click the Add Members link in the center pane.

    Project Add Members Button

  3. Start typing the user's or group's name in the Add Members modal and select a matching name from the dropdown.

  4. Select a role for the user or group: subscribed or owner.

    Project Add Members Modal

  5. When finished, click Add.

Users and/or group members (as well as alternative project owners) will receive notifications that new users have been added to the project. A similar entry will be posted to the project's activity pane.

Modifying a Member's Role within a Project

  1. Navigate to the Members tab.
  2. Click the dropdown arrow under the Role column next to the member whose role you’d like to change.
  3. Select a role: subscribed or owner.

    Project Modify Member

Notifications will be sent to the affected members and alternative project owners. A similar entry will be posted in the project's activity pane.

Removing Members from a Project

  1. Navigate to the Members tab.
  2. Click the Deny button next to the user or group you would like to remove.
  3. Complete the Reasoning field in the window that appears, and then click Submit.

    Project Remove Member

Alternatively,

  1. Navigate to the Members tab.
  2. Click the checkbox next to the user or group name, and then click Remove in the top left of the Members pane.
  3. Click Confirm.

Notifications will be sent to the affected users and other project members, and a similar entry will be added to the project's activity pane.

Managing Project Subscription Policies

Projects are private by default but can be made public and shared with other users by changing the Subscription Policies setting.

Subscription Policies

Making a Project Public

  1. Navigate to the Policies tab.
  2. Select one of the following options in the Subscribers section:
    • Anyone: Project will be visible to everyone, and all users will be given access.
    • Anyone Who Asks (and Is Approved): Project will be visible in search results, but users must request access and be granted permission. This restriction supports multiple approving parties, meaning that project owners can allow more than one approver or users with specified permission types to approve other users who request access to the project.
    • Users with Specific Groups/Attributes: Project will only be visible in search results for users with the specified groups/attributes, and only these users may subscribe to the project.

Anyone Who Asks (and Is Approved)

  1. Click anyone or an individual selected by user from the first dropdown menu in the Subscription Policy Builder.

    Subscription Policy Builder

    Note: If you choose an individual selected by user, when users request access to a project they will be prompted to identify an approver with the permission specified in the policy, as pictured below.

    Request Access

  2. Select the Admin, Governance, or Audit permission from the subsequent dropdown menu.

    Note: You can add more than one approving party by selecting + Add and repeating steps a and b.

Users with Specific Groups or Attributes

  1. Choose the condition that will drive the policy: when user is a member of a group or possesses attribute.
  2. Use the subsequent dropdown to choose the group or attribute key / value pair for your condition.

    Specific Groups or Attributes

    Note: You can add more than one condition by selecting + ADD. The dropdown menu in the far right of the Subscription Policy Builder contains coordinating conjunctions for your policy. If you select or, only one of your conditions must apply to a user for them to see the data. If you select and, all of the conditions must apply.

  3. Opt to allow users who do not meet the restrictions defined in the policy to still be able to discover the project in the UI by selecting the Allow Discovery checkbox.

    Allow Discovery

  4. Click Save to finish your policy.

The project settings will update, and the Private label next to the project name will disappear.

Reverting a Project to Private

  1. Navigate to the Policies tab.
  2. Click the Individual Users You Select option from the Subscribers pane. In this setting, projects will not be visible to anyone in the search results. Project Owners must manually add and remove users.

The project settings will update, and the Private label will appear next to the project name.

Managing Data Sources in Projects

Project Owners can add or delete data sources from their projects. However, Governors are also able to add and remove data sources from projects, even those they are not members of, in the Project Overview tab or the Data Sources tab.

Adding Data Sources to a Project

  1. Select a project, and then click the Overview tab at the top of the page.
  2. Click the Add Data Sources icon in the top right corner of the Data Sources section.

    Add Data Source

  3. Begin typing the name of the data source in the window that appears to search for data sources.

  4. Select your data source from the dropdown menu and click Add.

Alternatively,

  1. Select a project, and then click the Data Sources tab.
  2. Click Add Data Sources in the top left of the page.
  3. Begin typing the data source name in the window that appears to search for data sources.
  4. Select your data source from the dropdown menu, and then click Add.

Adding Data Sources by Purpose

You can automatically add all data sources to a project that contain a Limit usage to purpose policy that matches the purpose of that project.

For example, consider the following data sources and their corresponding Data Policies:

Medical Records

Data Policy: Limit usage to purpose(s) Analyze patterns to prevent and detect fraud for everyone.

Medical Claims: Credit Accounts

Data Policy: Limit usage to purpose(s) Analyze patterns to prevent and detect fraud for everyone except when user is a member of group Accounting.

Medical Claims: Credit Transactions

Data Policy: Limit usage to purpose(s) Analyze patterns to prevent and detect fraud for everyone except when user is a member of group Accounting.

To add all data sources to a project that contains a matching purpose (in this example, "Analyze patterns to prevent and detect fraud"),

  1. Select a Project, and click the Add Data Sources button on the Data Sources tab.

    Project Add Data Source Button

  2. Click Add By Purpose in the top right of the dialog.

    Project Add Data Sources By Purpose Text

  3. All data sources matching the project's purpose(s) will populate at the bottom of the dialog. Review this list, and then click Save.

    Project Add Data Sources By Purpose List

Removing Data Sources from a Project

  1. Select a project, and then click the Data Sources tab.
  2. Click the Remove Data Source icon in the Actions column of the data source you want to remove from the project.
  3. Click Confirm in the window that appears.

Alternatively,

  1. Select a project, and then click the Overview tab at the top of the page.
  2. Hover your cursor over the data source you would like to remove until a menu appears.
  3. Click the three dots in the top right corner of the menu, and then select Remove.

    Remove Data Source

Posting a Discussion Thread

  1. Navigate to the Discussions tab and click New Discussion.
  2. Enter your text in the Start Discussion box, and then click Save.

    Discussion Thread

Replying to a Discussion Thread

  1. Navigate to the Discussions tab and view open and/or resolved discussions by clicking the Open or Resolved button, respectively.
  2. Click a discussion thread and enter your response in the Enter Reply field.
  3. Click Reply to post your response.

Deleting a Discussion Thread or Reply

As a Governor, you can only delete a discussion thread or reply that you have written.

To permanently delete your own discussion thread,

  1. Navigate to the Discussions tab and view open and/or resolved discussions by clicking the Open or Resolved button, respectively.
  2. Click the discussion thread you would like to delete, and then click Delete in the upper right corner of the discussion window.
  3. Click Delete in the confirmation window that appears.

    Confirm Delete

To delete your own reply,

  1. Select a discussion thread.
  2. Hover your cursor over the reply and click the DELETE text that appears above your comment.
  3. Click Confirm to permanently delete the comment.

Disabling a Project

Disabling a project hides it from all users except the project's owner(s).

To disable a project,

  1. Navigate to the My Projects page.
  2. Click the menu icon next to the project and select Disable.

    Project Disable Button

Alternatively,

  1. Select a project, and then navigate to the Project Overview tab.
  2. Click the menu icon in the upper right corner and select Disable.

A label will appear next to the project indicating it has been disabled, and a notification will be sent out to all subscribers.

Restoring a Project

  1. Navigate to the My Projects page.
  2. Click the menu icon next to the project and select Restore.

    Project Disable Button

Alternatively,

  1. Select a project and navigate to the Project Overview tab.
  2. Click the menu icon in the upper right corner and select Restore.

The label indicating the project was disabled will disappear, and a notification will be sent out to all subscribers.

Changing Project Contexts

  1. Click the dropdown menu in the top right corner of the console.

    Project Select Context

  2. Select your desired project. Once selected, the current project will display at all times in the top right corner of the console.

    Project Selected

If you unsubscribe from the project, this display will default to No Current Project.