Skip to content

You are viewing documentation for Immuta version 2022.4.

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

Subscribe to a Data Source

Audience: Data Users

Content Summary: Immuta provides a one-stop shop for all data across an organization through data sources, which are virtual exposures of data. This data is protected by policy rules written and applied to the data sources by Data Owners, so Data Users can view details about, comment on, and subscribe to these data sources without violating privacy regulations.

This guide delineates the processes of accessing and using data source features in the Immuta UI.

View My Data Sources

Immuta provides the My Data Sources view for users to quickly view data sources they are affiliated with.

  1. Click on the Data Source icon in the panel on the left.

    Data Source Sidebar

  2. By default, all data sources will be displayed.

    Data Sources All Tab

  3. To view only data sources you have access to, click on the My Data Sources tab.

    Data Sources Mine Tab

    Note: If no data sources are displayed, you are not subscribed to, an expert of, or an owner of any data sources.

  4. To view the details of a data source, simply click on the Data Source.

Subscribe to a Data Source

  1. Click the Get Access button from either this data sources view or the Data Source Overview tab, which can be accessed by clicking on the Data Source.

    Data Source Get Access Button

  2. If prompted, fill out the custom request form set up by the system admin and click Request Access.

    Data Source Get Access Modal

  3. A notification will be sent to the Data Owner(s) informing them of your request.

  4. Once reviewed, you will receive a notification with a response indicating if your request was accepted or denied.
  5. If accepted, the status displayed next to that data source will be updated to "Subscribed" and you will have access to the data source via your personal SQL connection. If not accepted, a reason will be provided in the notification details.

Bulk Access Requests

To request access to multiple data sources simultaneously,

  1. Filter data sources by connection string in the search bar.
  2. Click the connection string from the auto-completed results to navigate to the Search Results page.
  3. Select the data sources you would like to subscribe to by clicking the checkbox next to each relevant data source.

    Bulk Access Request

  4. Click the dropdown menu button in the top right corner of the page, and then select Request Access.

  5. Describe how you plan to use the data in the dialog box that appears, and then click Subscribe.

    Bulk Request Subscribe

Unsubscribe from a Data Source

If you no longer need access to a data source, click Unsubscribe in the upper right corner of the Data Source Overview tab.

Data Source Unsubscribe

Manually Run Health Jobs

If the data source is unhealthy or needs to have a fingerprint generated,

  1. Click the health indicator in the upper right-hand corner.
  2. Select Re-run on the job you want to run.

    Run Health Job

Note: To generate a fingerprint, the row count must be up-to-date.

View the Data Dictionary

To view the Data Dictionary,

  1. Navigate to the Data Dictionary tab.

    Data Source Dictionary

  2. When provided, the Data Dictionary will display in the center pane and include the column’s name, type, and comments. Masked columns will display a symbol next to their names.

View Data Source Queries

The Queries tab allows users to keep track of their personal queries, share their queries with others, sample public queries, and submit query debug requests.

To view queries,

  1. Navigate to the Queries tab.
  2. Click My Queries to see a list of the SQL queries you have run against the data source.

    Data Source My Queries

  3. Click Public to see a list of public query statements others have shared.

    Data Source Public Queries

  4. You can make your own queries public by clicking the slider icon under the Public header. Then, name and describe the query to make it public. You can also comment on public queries.

Generate Sample Data from Public Queries

  1. Navigate to the Queries tab and click Public Queries to access the list of public queries available.
  2. Click the <> icon in the Actions column of the query you would like to run.

    Sample Data

  3. Click Run Query at the top of the Query Editor page.

    Run Query

The results of the query, with policies enforced, will appear below the query.

Submit Query Debug Requests

  1. Navigate to the Queries tab.
  2. Click My Queries to access the list of queries you have run against the data source, and then click the Generate Debug Info icon in the Actions column of the query you would like to debug.
  3. In the dialog box that appears, complete the Select Project and Reason for Debugging the Query fields.
  4. Select the Owner who will receive the request, and then click Submit.

    Query Debug Request

View Data Source Metrics

To view data source metrics,

  1. Navigate to the Metrics tab.
  2. Click various time frames to view the history of views, queries, and records compared to the enterprise average.

    Data Source Metrics

  3. Hover over the graph to display the metric values.

    Data Source Metrics Hover

View and Comment on Data Source Discussions

Data Users have the ability to comment on or ask questions about the Data Dictionary columns and definitions, public queries, and the data source in general.

Comment on General Data Source Discussions

To comment on general data source discussions,

  1. Navigate to the Discussions tab.

    Data Source Discussions

  2. Click Open to review open discussions or Resolved to review resolved discussions.

  3. Click a discussion to view comments.

    Data Source Discussion Commentary

  4. Click New Discussion to create a new discussion.

    Data Source New Discussion

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

Comment on Dictionary Discussions

To comment on Data Dictionary discussions,

  1. Navigate to the Data Dictionary tab.
  2. Click the talk bubble icon to the right of the definition.

    Data Source Dictionary Discussion Button

  3. View discussions on the far right side of the Data Dictionary page.

  4. Click Resolved to review any resolved threads or Open to review all open threads.
  5. To reply to an existing thread, click on the comment, type in a reply, and then click the Save button.
  6. To start a new discussion, click New Discussion, type a new comment or question, and click the Save button.

    Data Source Dictionary New Discussion

  7. A notification will be sent to all subscribers of the data source, including the Data Owner and Experts so that they can review the thread and reply.

  8. Once created, Data Dictionary discussions can be continued under the Discussions tab.

Comment on Query Discussions

To comment on query discussions,

  1. Navigate to the Queries tab.
  2. Click Public.
  3. Click the talk bubble icon to the right of the query to review any open or resolved comments.

    Data Source Query Discussion Button

  4. Once created, query discussions can be viewed and continued under the Discussions tab.

    Data Source Query Discussions

View Data Source Contact Information

Contact information for Data Owners is provided for each data source, which allows other users to ask them questions about accessibility and attributes required for viewing the data.

To view this contact information, click the Contacts tab.

Data Source Contacts

Make an Unmasking Request

To request to unmask a value in a data source,

  1. Navigate to the Data Source Overview tab, click the dropdown menu in the top right corner, and select Make Unmasking Request.

    Unmask Request Dropdown

  2. In the modal that appears, select the column from the first dropdown menu, and then complete the Values to Unmask and the Reason for Unmasking fields.

    Unmask Request Modal

  3. Select the user to unmask the value from the final dropdown menu, and then click Submit.

A Tasks tab will then appear for your data source that details the task type and the status of your request. You may also view task information or delete the task from this page.

Request Status

View and Manage Tasks

After sending a Debug Query or Unmask request, a Tasks tab will appear on the Data Source Overview page listing the target and requesting users, the task type, and the state of the task.

To view information about a task,

  1. Navigate to the Tasks tab from the Data Source Overview page.
  2. Click the Task Info icon in the Actions column of the relevant task.

    Tasks Tab User

To delete a task,

  1. Navigate to the Tasks tab from the Data Source Overview page.
  2. Click Delete Task.