QuickSight

Stage	PROD
Dashboards
Charts
Owners
Tags
Datamodels
Lineage

In this section, we provide guides and references to use the QuickSight connector.

Configure and schedule QuickSight metadata and profiler workflows from the OpenMetadata UI:

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.

Ingest with Airflow

Configure the ingestion using Airflow SDK

Ingest with the CLI

Run a one-time ingestion using the metadata CLI

Requirements

OpenMetadata 0.12 or later

To deploy OpenMetadata, check the Deployment guides.

AWS QuickSight Permissions To execute metadata extraction and usage workflow successfully the IAM User should have enough access to fetch required data. Following table describes the minimum required permissions

#	AWS QuickSight Permission
1	DescribeDashboard
2	ListAnalyses
3	ListDataSources
4	ListDashboards
5	DescribeAnalysis
6	DescribeDataSet
7	ListDataSets
8	DescribeDataSource

Here is how to add Permissions to an IAM user.

Navigate to the IAM console in the AWS Management Console.
Choose the IAM user or group to which you want to attach the policy, and click on the "Permissions" tab.
Click on the "Add permissions" button and select "Attach existing policies directly".
Search for the policy by name or by filtering the available policies, and select the one you want to attach.
Review the policy and click on "Add permissions" to complete the process.

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

Metadata Ingestion

1. Visit the Services Page

The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.

To visit the Services page, select Services from the Settings menu.

Find Dashboard option on left panel of the settings page

2. Create a New Service

Click on the 'Add New Service' button to start the Service creation.

Add a new Service from the Dashboard Services page

3. Select the Service Type

Select QuickSight as the service type and click Next.

Select your service from the list

4. Name and Describe your Service

Provide a name and description for your service as illustrated below.

Service Name

OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other {connector} services that you might be ingesting metadata from.

Provide a Name and description for your Service

5. Configure the Service Connection

In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your dashboard service as desired.

Configure the service connection by filling the form

Connection Options

awsConfig
- AWS Access Key ID: Enter your secure access key ID for your Glue connection. The specified key ID should be authorized to read all databases you want to include in the metadata ingestion workflow.
- AWS Secret Access Key: Enter the Secret Access Key (the passcode key pair to the key ID from above).
- AWS Region: Enter the location of the amazon cluster that your data and account are associated with.
- AWS Session Token (optional): The AWS session token is an optional parameter. If you want, enter the details of your temporary session token.
- Endpoint URL (optional): Your Glue connector will automatically determine the AWS QuickSight endpoint URL based on the region. You may override this behavior by entering a value to the endpoint URL.
identityType: The authentication method that the user uses to sign in.
awsAccountId: QuickSight account ID is required to manage QuickSight users, data sources, and reports.
namespace: The Amazon QuickSight namespace that contains the dashboard IDs in this request ( To be provided when identityType is ANONYMOUS )

6. Test the Connection

Once the credentials have been added, click on Test Connection and Save the changes.

Test the connection and save the Service

7. Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions below

Configure Metadata Ingestion Page

Metadata Ingestion Options

Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
Dashboard Filter Pattern (Optional): Use it to control whether to include dashboard as part of metadata ingestion.
- Include: Explicitly include dashboards by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be excluded.
- Exclude: Explicitly exclude dashboards by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be included.
Chart Pattern (Optional): Use it to control whether to include charts as part of metadata ingestion.
- Include: Explicitly include charts by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all charts with names matching one or more of the supplied regular expressions. All other charts will be excluded.
- Exclude: Explicitly exclude charts by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all charts with names matching one or more of the supplied regular expressions. All other charts will be included.
Data Model Pattern (Optional): Use it to control whether to include data modes as part of metadata ingestion.
- Include: Explicitly include data models by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all data models with names matching one or more of the supplied regular expressions. All other data models will be excluded.
- Exclude: Explicitly exclude data models by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all data models with names matching one or more of the supplied regular expressions. All other data models will be included.
Database Service Name (Optional): Enter the name of Database Service which is already ingested in OpenMetadata to create lineage between dashboards and database tables.
Enable Debug Log (toggle): Set the 'Enable Debug Log' toggle to set the default log level to debug, these logs can be viewed later in Airflow.
Include Owners (toggle): Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
Include Tags (toggle): Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
Include Data Models (toggle): Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
Mark Deleted Dashboards (toggle): Set the 'Mark Deleted Dashboards' toggle to flag dashboards as soft-deleted if they are not present anymore in the source system.

8. Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.

Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.

If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.

After configuring the workflow, you can click on Deploy to create the pipeline.

Schedule the Ingestion Pipeline and Deploy

9. View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

View the Ingestion Pipeline from the Service Page

Troubleshooting

Workflow Deployment Error

If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.

You can then edit the Ingestion Pipeline and Deploy it again.
From the Connection tab, you can also Edit the Service if needed.

Edit and Deploy the Ingestion Pipeline