Immuta Data Source User Guide

Audience: Data Users

Content Summary: Immuta provides a single application 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 by Data Owners, so that 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.

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

   

2. By default, all data sources are displayed.

   

3. To view only data sources you have access to, click on the My Data Sources 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, click on the Data Source.

Subscribing to a Data Source

1. Click the Get Access button from the All Data Sources tab. Alternatively, select the Data Source and click Get Access on the Data Source Overview tab.

   

2. Fill out the request form, and click Request Access.

   

3. A notification is 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 is updated to "Subscribed," and you have access to the data source via your personal SQL connection. If denied, a reason is 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 want to subscribe to by clicking the checkbox next to each relevant data source.

   

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.

   

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

Viewing the Data Dictionary

To view the Data Dictionary,

1. Navigate to the Data Dictionary tab.

   

2. When provided, the Data Dictionary displays in the center pane and includes the column’s name, type, tags, and comments. Masked columns display a red eye symbol next to their names.

Running Queries in the Query Editor

The Query Editor allows users to write, modify, and execute queries against data sources they are subscribed to.

Previewing Sample Data

1. Click the Query Editor icon in the left sidebar.

   

2. Select a data source in the Tables list.

3. Click the dropdown menu icon next to the data source, and select Preview Sample Data. Alternatively, click Preview Sample Data in the Table Schema panel.

   

4. View data in the Results panel.

   • Filter results by clicking the overflow menu next to the column name.
   • Rearrange and resize columns by clicking and dragging.
   • Run and export full results or export current results to .csv by clicking one of the corresponding download buttons in the top right corner of the table.

Writing and Executing Queries

1. Click the Query Editor icon in the left sidebar.
2. Write your query in the Query Editor panel.

3. Execute your query by clicking the Run Query button. Note: Clicking the this button only runs the currently highlighted query. Queries (or portions of queries) can be executed by manually highlighting the query (or portion of the query) and clicking Run Query.

   

4. View data in the Results panel.

   • Filter results by clicking the overflow menu next to the column name.
   • Rearrange and resize columns by clicking and dragging.
   • Export results to .csv by clicking the download button in the top right corner of the table.

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

   

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

   

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

Generating 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 Get Sample Data icon in the Actions column of the query you want to run.

   

A sample of data, with policies enforced, appears below the query.

Submitting 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 want to debug.
3. In the dialog box that appears, complete the Select Project and Reason for Debugging the Query fields.

4. Select an Owner to receive the request, and then click Submit.

   

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

   

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

   

Viewing and Commenting 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.

Commenting on General Data Source Discussions

To comment on general data source discussions,

1. Navigate to the Discussions tab.

   

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

3. Click a discussion to view comments.

   

4. Click New Discussion to create a new discussion.

   

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

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

   

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 and type in a reply. Then click the Reply button.

6. To start a new discussion, click New Thread, and type a new comment or question. Then, click the Comment button.

   

   A notification is sent to all subscribers of the data source, including the Data Owner and Experts so that they can review the thread and reply. 1. Once created, Data Dictionary discussions can be continued under the Discussions tab.

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

   

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

   

Viewing Data Source Contact Information

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

To view this contact information, click the Contacts tab.

Making an Unmasking Request

To request to unmask a value in a data source,

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

   

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.

   

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

A Tasks tab will 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.

Viewing and Managing 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.

   

To delete a task,

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