Skip to content

Managing Projects Tutorial

Audience: Data Owners

Content Summary: This page provides step-by-step instructions for creating and managing projects. For details about concepts related to projects, navigate to the Project Overview page.

Creating Projects

  1. Click the plus icon in the lower left corner, and then click the Projects icon.

    New Project Button

  2. The New Project modal will display with these required fields:

    • Name: Enter a name for your project in this field.
    • Purpose Restrictions: Click this field to select from the list of existing purposes or create a custom one.

    New Project Modal

  3. Click Affirm and Create.

Alternatively,

  1. Navigate to the My Projects page and click the New Projects button.
  2. The New Project modal will display with these required fields:

    • Name: Enter a name for your project in this field.
    • Purpose Restrictions: Click this field to select from the list of existing purposes or create a custom one.
  3. Click Affirm and Create.

Creating Custom Purposes

Depending on how the Data Governor has configured projects, purpose-based restrictions can be created either by the Governor or project owners.

To create purpose-based restrictions as a project owner,

  1. Navigate to the My Projects tab.
  2. Click New Project.
  3. Enter a name for your project, and then start typing the name of the custom purpose you want to create in the type-head list.
  4. If your purpose name displays in the dropdown menu as an option to select, click it. If the option to select your custom purpose does not appear in the dropdown list, then projects may not be configured for custom purposes. You will need to choose from the existing list of purposes created by the Data Governor.

    Project Custom Purpose Modal

  5. Click Affirm and Create to create the project with custom purposes.

A list of purposes associated with the project displays on the left side of the Project Overview tab.

Managing Project Documentation

Project Owners can edit the documentation of their project at any time. If no documentation is entered, the project name will display in this section of the Project Overview tab by default.

To add or edit project documentation,

  1. Navigate to the Project Overview tab.
  2. Click the edit icon in the top right corner of the Documentation section.
  3. Document the details of your project in the text box that appears, and then click Update.

    Project Documentation

    Note: Styling with Markdown is supported.

Managing Access

Enabling Project Equalization

  1. Add at least one project member and one data source with policies to create a baseline for the equalization.
  2. Navigate to the Policies tab.
  3. In the Project Equalization section, click the toggle button on the far right to On.

Project Equalization

Note: Only project owners can add data sources to the project if this feature is enabled.

After enabling this feature, you can opt to manage Required Authorizations and Validation Frequency.

Required Authorizations

When Project Equalization is enabled, Required Authorizations defaults to Immuta's recommended settings, but project owners can edit these settings by adding or removing parts of the authorizations. However, making these changes entails two potential disadvantages.

To edit authorizations,

  1. Click Edit Required Authorizations.
  2. In the Required Authorizations Builder, select either is a member of a group or possesses authorization from the user condition dropdown menu.

    • If you selected is a member of a group, select the appropriate group from the resulting dropdown.
    • If you selected possesses authorization, select the appropriate key and value from the subsequent dropdown menus.
  3. Click Save.

To view members' compliance status after changing the Required Authorizations,

  1. Navigate to the Members tab from the Project Overview page.

    Members Tab

  2. Click the Not In Compliance text to view the details about the user's status.

    Compliance Status

Users who are not in compliance will be unable to view data sources within the project until the compliance issues are resolved.

To revert authorizations to those recommended by Immuta,

  1. Click Edit Required Authorizations.
  2. Click Use Recommended Auths / Groups in the top right corner of the Required Authorizations Builder.
  3. Click Confirm.

Validation Frequency

To adjust how often user credentials are validated,

  1. Click Edit Validation Frequency.
  2. Enter an integer in the first field of the Validation Frequency modal that appears.
  3. Select Days or Hours in the next dropdown.
  4. Click Save.

    Validation Frequency

Disabling Project Equalization

  1. Navigate to the Policies tab.
  2. In the Project Equalization section, click the toggle button on the far right to Off.
  3. Click Yes, Turn Off in the confirmation window.

Subscription Policies: Making a Project Public

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

Subscription Policies

To make 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/Authorizations: Project will only be visible in search results for users with the specified groups/authorizations, 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 Authorizations

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

    Specific Groups or Authorizations

    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.

Subscription Policies: 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 a Project

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

To add a data source to a project,

  1. Navigate to the Project Overview tab.
  2. Click the Add Data Sources button beneath 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. You can click the delete icon to remove them.

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

Allow Masked Joins

Disabled by default, this feature allows masked columns to be joined within a project.

Masked Joins

Note: While this condition is allowed, only project owners can add data sources to the project.

To enable Masked Joins,

  1. Navigate to the Project Overview tab.
  2. Click the Allow Masked Joins toggle on.

Managing Project Tags

Adding Tags to a Project

  1. Select a project and navigate to the Project Overview tab.
  2. Scroll to the Tags section in the center pane and click the Add Tags button.
  3. Begin typing the tag name in the window that appears, and then select the tag from the dropdown menu. A list of chosen tags will populate at the bottom of this window.
  4. After selecting all relevant tags, click the Add button.

Removing Tags from a Project

  1. Navigate to the Project Overview tab.
  2. Scroll to the Tags section in the center pane and click the red "X" on the tag that you would like to remove.

    Remove Tags

  3. Click Confirm to delete the tag.

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 your 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 that appears.

  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 also 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 also 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 also be added to the project's activity pane.

Managing Discussions

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.

Resolving a Discussion Thread

  1. Navigate to the Discussions tab and click the Open button to view all open discussions.
  2. Click a discussion thread.
  3. Click the Mark Resolved button beneath the Enter Reply field.

    Resolve Discussion

This discussion thread will now be saved with other resolved threads, and users will still be able to reply to it by clicking the Resolved button on the Discussions tab.

Deleting a Discussion Thread or Reply

To permanently delete 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 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 a single reply,

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

Disabling a Project

Disabling a project hides it from all users except the project 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.

Deleting a Project

Deleting a project permanently removes if from Immuta. Projects must first be disabled before they can be deleted.

To delete a project,

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

    Project Delete Button

  3. Click Confirm.

Alternatively,

  1. Disable the Project and navigate to the Project Overview tab.
  2. Click the menu icon in the upper right corner and select Delete.
  3. Click Confirm.

The project is now removed from Immuta, and a notification will be sent out to all subscribers.

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.