Amazon QuickSight

This article outlines the integration with the Amazon QuickSight connector, enabling streamlined metadata management through features such as crawling and lineage building (Auto and Manual). It also ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category

Reporting Tools

Connector Version

Release6.3.x

Releases Supported (Available from)

Release6.3.0.1

Connectivity

[How the connection is established with Amazon QuickSight]

SDK

Verified Amazon QuickSight Version

1.12.768 ( AWS SDK v1 )

The Amazon QuickSight connector validates with the listed “Verified Amazon QuickSight Version” and supports other compatible Amazon QuickSight versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback

Connector Features

Feature

Availability

Crawling

✅

Profiling

Query Sheet

❌

Auto Lineage

✅

Manual Lineage

✅

Secure Authentication via Credential Manager

✅

Data Quality

DAM (Data Access Management)

Bridge

✅

'NA' indicates that the respective feature is 'Not Applicable.'

Metadata Mapping

The following objects are crawled from Amazon QuickSight and mapped to the corresponding UI assets.

Amazon QuickSight Object

Amazon QuickSight Attribute

OvalEdge Attribute

OvalEdge Category

OvalEdge Type

Domain

Report Group

Dashboard

Report

Dashboard

Analyses

Report

Analyses

Dataset

Report

Dataset

Sheet

Report

Sheet

Visuals

Visual

Report

Vertical Bar Chart
Horizontal Bar Chart
Stacked Bar/Column Chart
Clustered Bar/Column Chart
Line Chart
Area Chart
Stacked Area Chart
Pie Chart
Donut Chart
Nested Donut Chart
Combo Chart
Scatter Plot
Bubble Chart
Heatmap
Table
Pivot Table
Tree Map
KPI Visual
Gauge
Progress Bar
Geospatial Map
Filled Map (Choropleth)
Point Map

Set up a Connection

Prerequisites

The prerequisites to establish a connection:

Service Account User Permissions

It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.

👨‍💻 Who can provide these permissions? The Amazon QuickSight administrator grants these permissions, since users may not have sufficient access to assign them.

Objects

Access Permission

Connector Validation

Admin

Crawling

Admin

Dashboard

Admin

Analyses

Admin

Dataset

Admin

Sheets

Admin

Visuals

Admin

Connection Configuration Steps

Users must have the Connector Creator role to configure a new connection.

Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for QuickSight, and enter the required parameters.

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name

Description

Connector Type

By default, "QuickSight" is displayed as the selected connector type.

Authentication

The following two types of authentication are supported for Amazon QuickSight Server:

Role Based Authentication
IAM User Authentication

Field Name

Description

Credential Manager*

Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.

Supported Credential Managers:

OE Credential Manager
AWS Secrets Manager
HashiCorp
Azure Key Vault

License Add-On

Auto Lineage

Supported

Data Quality

Not Supported

Data Access

Not Supported

Select the Auto Lineage Add-On checkbox to build data lineage automatically.

Connector Name*

Enter a unique name for the Amazon QuickSight connection

(Example: "QuickSight_Prod").

Connector Environment

Select the environment (Example: PROD, STG) configured for the connector.

Connector Description

Enter the description related to the connector.

Cross-Account Role ARN

Enter the Amazon QuickSight IAM role ARN that grants cross-account access to the required AWS resources.

Filter by tags

Enter specific tag keys or key-value pairs to limit the metadata extraction to datasets or dashboards associated with those tags.

Database Region*

Enter the AWS region where the Amazon QuickSight account is hosted.

Default Governance Roles

Default Governance Roles*

Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.

Admin Roles

Admin Roles*

Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.

No of Archive Objects

No Of Archive Objects*

This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.

Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

Bridge

Select Bridge*

If applicable, select the bridge from the drop-down list.

The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.

After entering all connection details, the following actions can be performed:
- Click Validate to verify the connection.
- Click Save to store the connection for future use.
- Click Save & Configure to apply additional settings before saving.
The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl

To perform crawl and profile operations, users must be assigned the Integration Admin role.

The Crawl/Profile button allows users to select one or more schemas for crawling.

Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to crawl.
Click Run to collect metadata from the connected source and load it into the Data Catalog.
After a successful crawl, the information appears in the Data Catalog > Report / Report Column tab.

The Schedule checkbox allows automated crawling for a selected timeframe, from a minute to a year.

Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
The system will automatically execute the crawl operation at the scheduled time.

Other Operations

The Connectors page provides a centralized view of all configured connectors and their health status.

Managing connectors includes:

Connectors Health: Displays the current status of each connector, with a green icon for active connections and a red icon for inactive connections, helping monitor connectivity to data sources.
Viewing: Click the Eye icon next to the connector name to view connector details, including Reports, Report Columns, Sheets, Dashboards, Analyses, Datasets, and Visuals

Nine Dots Menu Options:

To view, edit, validate, build lineage, configure, or delete connectors, click on the Nine Dots menu.

Edit Connector: Update and revalidate the data source.
Validate Connector: Check the integrity of the connection.
Settings: Modify connector settings.
- Crawler: Configure data extraction.
- Access Instructions: Add notes on how data can be accessed.
- Business Glossary Settings: Manage term associations at the connector level.
- Lineage: Select server dialects for parsing and setting connector priority for table lineage.
- Others: Configure notification recipients for metadata changes.
Build Lineage: Automatically build data lineage using source code parsing.
Delete Connector: Remove a connector with confirmation.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

S.No.

Error Message(s)

Error Description & Resolution

Error while validating QUICKSIGHT connection Error while fetching account ID : The security token included in the request is invalid. (Service: Sts, Status Code: 403, Request ID: 3b581f47-458a-49b8-89bf-90aa1d8f4f90)

Error Description: The QuickSight connection validation failed because the AWS security token provided in the request is invalid or expired, preventing the account ID from being retrieved.

Resolution: Regenerate valid AWS access and secret keys, ensure they have the required STS permissions, and update the connector configuration with the correct credentials.

Error while validating connection: The system encountered an invalid or unsupported dataset type, or the specified dataset/resource was not found in the repository.

Error Description: The system encountered an invalid or unsupported dataset type, or the specified dataset/resource could not be found in the repository. Resolution: Verify that the dataset type is supported and ensure the referenced dataset or resource exists and is accessible.

Error while validating DASHBOARD METADATA connection: Failed to retrieve or compare Dashboard, Analysis, and Dataset counts due to incomplete or inaccessible metadata. Verify source connectivity and metadata access permissions before re-running the capture process.

Error Description: The system failed to retrieve or compare the count of Dashboards, Analyses, and Datasets between the source and the catalog due to incomplete or inaccessible metadata.

Resolution: Verify source connectivity and metadata access permissions, then re-run the capture process to ensure accurate synchronization of Dashboard, Analysis, and Dataset counts.

Error while validating Dashboard source connection: The system cannot proceed because dependent Analyses details are missing in the associated Dashboard source configuration.

Error Description: The system cannot proceed because the dependent Analyses details are missing in the associated Dashboard source configuration.

Resolution: Verify that all dependent Analyses are correctly linked and accessible in the metadata repository, then re-trigger the population process to update the Dashboard source description.

Error while validating connection: Shared folder path is missing or not specified in the 'Path' field of the report tab in Data Catalog.

Error Description: The system displays this error when the shared folder details are missing or not specified in the “Path” field of the report tab in Data Catalog.

Resolution: Enter the correct shared folder path in the “Path” type report tab and save the configuration to resolve the error.

Error while validating connection: Dataset nodes linked to relational data sources were detected in the lineage. Relational data types do not support Dataset nodes. Please review the lineage configuration.

Error Description: The system detected Dataset nodes linked to relational data sources in the lineage, which are not supported for relational types.

Resolution: Remove or exclude Dataset nodes from the lineage configuration to ensure compatibility with relational data types.

Error while tracking deleted analyses: The system failed to record details of deleted analyses during job execution. Verify job log configurations and ensure the “Track Deleted Analyses” option is enabled.

Error Description: The system failed to track or log details of deleted analyses during job execution.

Resolution: Verify job log configurations and enable the “Track Deleted Analyses” option to ensure deleted analyses are correctly recorded in job logs.

Error while building lineage for S3 source: The system failed to build or update lineage information during metadata extraction. Verify S3 connection credentials, bucket accessibility, and ensure the extraction job has required permissions to read S3 objects.

Error Description: The system failed to build or update lineage information for the Amazon S3 source during metadata extraction.

Resolution: Verify S3 connection credentials, bucket accessibility, and ensure the metadata extraction job has the required permissions to read S3 objects.

PreviousOracle BI NextCartoVista

Last updated 20 days ago

Was this helpful?