Manage project purposes

Requirement: You must own the project or have the GOVERNANCE or PROJECT_MANAGEMENT Immuta permission

Add a purpose to a project

1. Navigate to the Project Overview tab.

2. Click + Add Purposes.

3. Create a new purpose in the modal or select purposes from the dropdown menu.

4. Click Save, and then click I Agree.

Remove a purpose from a project

1. Navigate to the Project Overview tab.

2. Scroll to the purposes section and click Remove.

3. Click I Agree

Enable project equalization

See the Manage project equalization guide.

Enable masked joins

See the Enable masked joins guide.

Manage project documentation

Requirement: CREATE_PROJECT Immuta permission (and you must own the project)

1. Click the Project Overview tab.

2. Click the Edit button in the Documentation section.

3. Document the details of your project in the text box that appears, and then click Save.

Manage project tags

Requirement: CREATE_PROJECT (and you must own the project), GOVERNANCE, or PROJECT_MANAGEMENT Immuta permission

1. Select a project and navigate to the Project Overview tab.

2. Scroll to the Tags section 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.

Remove tags from a project

Requirement: CREATE_PROJECT (and you must own the project), GOVERNANCE, or PROJECT_MANAGEMENT Immuta permission

1. Navigate to the Project Overview tab.

2. Scroll to the Tags section and click on the tag that you want to remove to open its side sheet.

3. Click Remove.

4. Click Confirm to delete the tag.

Disable, enable, or delete a project

Requirements:

• CREATE_PROJECT (and you must own the project), GOVERNANCE, or PROJECT_MANAGEMENT Immuta permission to disable or enable a project

• CREATE_PROJECT Immuta permission to delete a project

Disable a project

1. Click the Data icon and select Projects in the sidebar.

2. Select the My Projects tab.

3. Click the more options icon next to the project and select Disable.

Enable a project

1. Click the Data icon and select Projects in the sidebar.

2. Select the My Projects tab.

3. Click the more options icon next to the project and select Enable.

Delete a project

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

1. Click the Data icon and select Projects in the sidebar.

2. Select the My Projects tab.

3. Click the more options icon next to the disabled project and select Delete.

4. Click Confirm.

Requirement: You must own the project

Edit a member role

1. On the Members tab, click the Role of the member whose role you want to change.

2. Select a different role: subscribed or owner.

Remove members from a project

1. On the Members tab, click the Deny button next to the user or group you want to remove.

2. Complete the Reasoning field in the window that appears, and then click Submit.

Requirement: CREATE_PROJECT Immuta permission

Create a new project

1. Navigate to the Projects tab under Data in the sidebar, and click the New Projects button.

2. Fill out the Basic Information:

   1. Enter a name for your project in the Project Name field.

   2. Opt to complete the Project Description field to help identify your project.

   3. Opt to enter project Documentation to provide context for members.

3. Select the purposes and any policy adjustments:

   1. Choose to select a purpose from the list of purposes or create a new purpose for the project.

   2. To create a new purpose, click Create Purpose and complete the prompts in the modal.

   Note that all purposes added to a project will need to be created or approved by a user with the GOVERNANCE or PROJECT_MANAGEMENT permission. Once purposes have been applied to a project, only these users can add data sources to the project.

4. Add a native workspace configuration: Select your workspace configuration from the Workspace Configuration dropdown menu: Databricks or Snowflake.

   • Databricks: Opt to edit the sub-directory in the Workspace Directory field (this sub-directory auto-populates as the project name) and enter the Workspace Database Name.

   • Snowflake: Name the Workspace Schema. By default, the schema name is based off of the project name, but you can change it here. Your project workspace will exist within this schema under Snowflake under the database configured by the application admin.

     1. Use the dropdown menu to select the Hostname. Projects can only be configured to use one Snowflake host.

     2. Select one or more Warehouses to be available to project members when they are working in the native workspace.

5. Add data sources to the project using the dropdown menu. Data sources can also be added after the project is created.

6. Click Affirm and Create.

Set the project subscription policy

Projects are private by default but can be made public and shared with other users by changing the subscription policies setting. Governors are the only users who can manage subscription policies for projects with purposes.

1. In the project, click the Policies tab.

2. Click Edit Subscription Policy.

3. Select the group of users who will have access:

   • Allow anyone: Selecting this option makes the project visible to everyone. Opt to require manual subscription by selecting the checkbox. This will require the users to manually subscribe to the project to gain access.

   • Allow anyone who asks (and is approved): Selecting this option makes the project visible in search results, but users must request access and be granted permission. This restriction supports multiple approving parties, so project owners can allow more than one approver or users with specified permission types to approve other users who request access to the project.

     1. Click Anyone or An individual selected by user from the first dropdown menu.

        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.

     2. Select the USER_ADMIN, GOVERNANCE, or AUDIT permission from the subsequent dropdown menu. You can add more than one approving party by selecting + Add Another Approver.

   • Allow users with specific groups/attributes: Selecting this option allows users with the specified groups and attributes to join the project.

     1. Choose whether to build the policy off user groups or user attributes:

        1. is a member of group: Type the group name and select the group.

        2. possesses attribute: Type the attribute and select it. Then select the value from the dropdown menu.

     2. Opt to + Add Another Condition. When adding another condition, choose how the conditions will be required. If you select or, only one of the conditions must apply to a user for them to subscribe to the project. 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 by selecting the Allow Project Discovery checkbox.

     4. Once saved, users with the proper authorizations will be automatically subscribed. Opt to require users to manually subscribe to the project by selecting the Require Manual Subscription checkbox.

   • Allow individually selected users: Selecting this option hides the project from the search results. Project owners must manually add and remove users, and the Private label will appear next to the project name.

4. Click Save to finish your policy.

Add users or groups to the project

1. In the project, click the Members tab.

2. Click the Add Members button.

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

4. Opt to add an expiration to the subscription by entering the number of days until the access will expire.

5. Select the role.

6. Click Add.

Current project members will receive notifications that new users have been added to the project. A similar entry will be posted to the project's activity pane.

Requirement: GOVERNANCE or PROJECT_MANAGEMENT Immuta permission

Create a purpose

1. Click Governance and select Purposes in the navigation menu.

2. Click + Add Purpose.

3. Complete the Purpose Name field, and opt to customize the acknowledgement statement or add a description.

4. Click Create.

Create sub-purposes

1. Click Governance and select Purposes in the navigation menu.

2. Open the dropdown menu and click View or Edit in the actions column of the purpose you want to add sub-purposes to.

3. Click Add Sub-Purposes.

4. Enter a name in the Enter nested purpose field in the 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 Edit in the Actions column at any time.

Add a purpose to an existing project

1. Click Data in the navigation menu and select Projects.

2. Go to the project overview page and click Add Purposes.

3. Select the purpose from the dropdown menu or click Create Purpose.

4. Complete the prompts in the modal and then click Save.

For the purpose to go into effect, it must be approved by a user with the GOVERNANCE or PROJECT_MANAGEMENT Immuta permission.

Customize acknowledgement statements

1. Click Governance and select Purposes in the navigation menu.

2. Open the dropdown menu and click Edit in the Actions column of the purpose you would like to customize.

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

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.

By default, sub-purposes will inherit the acknowledgment statements of their parent purposes. However, you can customize the acknowledgement statement for an individual sub-purpose as well by following the process above.

Manage purpose requests

1. Navigate to your user profile page and click the Requests tab.

2. Approve or deny the purpose request in the actions column.

Delete a purpose

1. Click Governance and select Purposes in the navigation menu.

2. Click the more actions icon in the Actions column of the purpose or sub-purpose you want to delete.

3. Select Delete, and then click Confirm to approve the deletion.

Any project that contained the deleted purpose will be treated as no longer compliant, so the project overview page will display a violation tag. Project owners can remediate the violation by removing the purpose from the project.

Requirements:

• If project equalization or masked joins is enabled, you must own the project.

• If a purpose has been added to and approved for the project, you must have the GOVERNANCE or PROJECT_MANAGEMENT Immuta permission.

• Otherwise, you must be a project member.

Add data sources to a project

1. Navigate to the Project Overview tab.

2. Click the Add Data Sources button.

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

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

5. Repeat this process to add additional data sources to the list. You can remove them using the more options icon.

6. Opt to re-equalize the project by clicking the toggle on.

7. When complete, click the Save button at the bottom of the list.

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

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

2. Click Add By Purpose.

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.

Bulk add data sources to a project

1. Set your current project to be the one you want new data sources in.

2. Navigate to the Data Sources page.

3. Select the checkboxes for the data sources you want in a project.

4. Select the bulk actions more options icon in the top right corner.

5. Click Add To Current Project.

Requirement: You must own the project

Equalize the project

1. Navigate to the project.

2. Click the Policies tab.

3. In the Project Equalization section, click the toggle button on the far right to On.

Add a purpose with noise reduction

1. Navigate to the project Overview tab.

2. Click the Add Purposes button in the center of the page.

3. Select the desired purpose(s) from the dropdown menu. The project must have one purpose with noise reduction for policy adjustments to function. Noise reduction is indicated by the policy adjustment amount highlighted in gray. If there is no policy adjustment shown, it is the default, none.

4. Click Save.

5. The purpose will be staged until a user with the GOVERNANCE or PROJECT_MANAGEMENT permission approves and activates it. If you have one of these permissions, the staging will be skipped.

6. After the purpose has been approved, click I Agree to agree to the terms of the purpose.

   Note: All members of the project must agree to the terms of the purpose; if they decline, they will be removed from the project.

Add data sources with k-anonymization policies

1. Navigate to the Policy Adjustment tab.

2. Select the data source from the dropdown menu. You will receive a No Adjustments Available message if there are no columns in the data sources that are associated with adjustable policies.

3. Select the columns from the dropdown menu.

Adjust column weights and percent null

1. In the priority ranking window, give weight from most to least important columns. The higher the weight the more usability will be provided, while still providing de-identification through the other columns.

3. After assigning the weight and ensuring that the remaining weight is zero, click the Adjust button.

4. Check that the percent NULL is appropriate for your usability. If you are content with the percent NULL, move on to the next step; if you are not satisfied with the percent NULL, repeat the previous steps until satisfied.

5. Click Apply after you have made the acceptable adjustments.

Keep fields in the clear

After you ensure that your data source has two columns with k-anonymization policies applied,

1. Navigate to your project and click the Overview tab.

2. Click Add Purposes and select a purpose with a Noise Reduction and Fields in Clear tags, or create a new purpose with Noise Reduction and Fields in Clear enabled.

3. Click Save, and then click I Agree.

4. Navigate to the Policy Adjustment tab.

5. Select the data source(s) and columns from the subsequent dropdown menus.

6. Select the Keep in the Clear checkbox next to columns to be kept in the clear.

7. Adjust the weight for the remaining columns. The Remaining Weight must equal 0.

8. Click Adjust and then Apply.

The values for the fields you selected will now be visible to users acting under the project.