Skip to content

Project Member Guide

Audience: Data Owners, Data Users, and Data Governors

Content Summary: This guide outlines how to search for, subscribe to, and contribute to a project. For information about creating your own project, see the Project Owner guide.

Viewing a Project

My Projects Page

For quick reference, Immuta provides a list of projects you own or are a member of. To view the list,

  1. Click the projects icon in the left sidebar.
  2. Click the My Projects tab.

Project Overview Page

  1. Search for a project.
  2. Select the project from the search results to view more details.

Project Activity Panel

All project-related activities are displayed in the activity panel, which is expanded by default.

To view project activities,

  1. Navigate to the Project Overview tab.
  2. View the Activity panel on the far right of this page.

Searching for a Project

Immuta's Web UI provides a list of all projects, excluding those that have been set to private. Users can search for projects by keyword, tag, or data source.

Search For Project

  1. To access a list of all projects, click on the projects icon in the left sidebar, and then click the All Projects tab.
  2. To filter projects by keyword, type one or more keywords into the search box at the top of the page, and select a keyword from the auto-completed results. If a list does not display, then no keywords matching that text currently exist.
  3. To filter projects by tags, type one or more tag names into the search box at the top of the page and select a tag from the list of auto-completed results. If a list of tags does not display, then no tags matching that text currently exist.
  4. To filter projects by data sources, type one or more data source names into the search box at the top of the page and select a data source from the list of auto-completed results. If a list of data sources does not display, then no data sources matching that text currently exist.

Joining a Project

  1. Search for a project.
  2. View the details for a project that interests you.
  3. Click the Join Project button.

    Join Project Button

  4. After requesting to join a project, you will automatically request access to the data sources withing the project, and these requests will be submitted to the approving parties defined in the policies on the project and the data sources.

    Requests Tab

  5. If the project you want to join contains restrictions, you will be prompted to agree to these restrictions before proceeding with the project. Click I Agree to continue or Decline to leave the project.

    Project acknowledgement

  6. You can access the project if you agreed to the restrictions or if the project you joined has no restrictions. An entry will be posted in the Activity panel, and notifications will be sent to the project owner(s) informing them that you have joined the project.

Leaving a Project

  1. Navigate to the Project Overview tab.
  2. Click the Leave Project button in the upper right corner, and then click Confirm.

    Confirm Leave Project

After leaving a project, that project is removed from the list in the My Projects tab.

Creating a Project-based API Key

Any project member can create project-based API keys, which are used for authenticating external tools with Immuta.

To create a project-based API key,

  1. Navigate to the Project Overview tab.
  2. Click the Get API Key button at the bottom of the left panel.

    Project API Key Button

  3. An API Key modal will display with your requested information. Please store these credentials somewhere secure. If you misplace this information, you will have to generate a new key and re-authenticate all services connected to Immuta via this key.

    Project API Key Modal

  4. Click the Close button.

Creating Project-based SQL Connections

Project SQL accounts are unique to each project and only provide access to the data sources in that project. Project SQL credentials cannot be retrieved from Immuta if they are lost. Credentials can only be re-generated using the instructions below. When a user generates new SQL credentials for a project, any existing SQL credentials for that project the user may have had are revoked.

To create a project-based SQL connection,

  1. Navigate to the Project Overview tab.
  2. Click on the SQL Connection button in the lower left corner.

    Project Credentials Button

  3. A window will display with the connection information. Store these credentials somewhere secure. If you misplace them, you will have to generate a new account and re-authenticate all services connected to Immuta via this account.

    Project SQL Account

  4. Click Close.

Commenting on General Project Discussions

  1. Select a project and click the Discussions tab.
  2. Click Open to view open discussions or Resolved to view resolved discussions.

    Project Open Discussions

  3. Click a discussion to view comments.

    Project Discussion Thread

  4. Click New Discussion to create a new discussion.

    Project New Discussion Button

  5. Type in your comment or question and click Save.

    Project Save New Discussion

  6. A notification will be sent to all project members so that they can view your comment or question and reply.

Deleting a Discussion Thread or Reply

As a project member, 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

The discussion thread and all of its comments are now deleted.

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.

Commenting on Project Data Sources

See the Data Source guide for information on how to comment on project data sources.

Adding Data Sources to a Project

Any project member can add data sources to a project, unless the Project Equalization or Allow Masked Joins features are enabled; in those cases only project owners can add data sources to the project.

To add a data source to a project,

  1. Select the project, and then navigate to the Project Overview tab.
  2. Click the Add Data Sources button in the Data Sources section in the center pane.

    Project Add Data Source Button

  3. Start typing the name of a data source you'd like to include in the project.

    Project Add Data Source Modal 1

  4. Select the data source from the list of auto-completed options in the dropdown menu.

    Project Add Data Source Modal 2

  5. Repeat this process to add additional data sources to the list. Click the delete icon to remove them.

  6. When complete, click the Add button at the bottom of the list.

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

As a project member, you can only delete data sources you've added to the project.

To remove a data source you've added,

  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.
  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

Creating a Derived Data Source

In order for members to create derived data sources within a project, Project Equalization must be enabled. To create a derived data source,

  1. Select a project and navigate to the Policies tab.
  2. Scroll to Create Derived Data Source in the Project Equalization and click Create.

    Create Derived Data Source

  3. Begin typing in the Search by Name or Description text box, and then select the data source(s) from which your new data source will be derived.

    Derived Data Source Modal

  4. Click Save.

  5. Follow the instructions for creating a query-backed data source or object-backed data source, depending on your chosen storage technology.

Creating a Fingerprint Version

  1. Select a project and navigate to the Data Fingerprints tab.
  2. In the top right corner, click Add Fingerprint Version.
  3. Fill out the required Name field and opt to complete the Enter Documentation field.
  4. Click Create.

    Fingerprint Version

The saved fingerprint version will populate at the bottom of the Data Fingerprints tab.

Viewing a Fingerprint Version

  1. Select a project and navigate to the Data Fingerprints tab.
  2. Click a fingerprint version at the bottom of the tab.
  3. To view statistics about data that has changed, click the column name.

    Fingerprint Data

  4. Click the Split View button in the bottom right corner to view policy changes that have taken effect.

    Policy Differences

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.