QuickSight Connector | Collate Dashboard Integration

• Requirements
• Metadata Ingestion
• Lineage
• Troubleshooting

​

Requirements

1. Navigate to the IAM console in the AWS Management Console.
2. Choose the IAM user or group to attach the policy to.
3. Click the “Permissions” tab.
4. Click the “Add permissions” button and select “Attach existing policies directly”.
5. Search for the policy by name or by filtering the available policies, and select the one you want to attach.
6. Review the policy and click “Add permissions” to complete the process.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "quicksight:DescribeDashboard",
                "quicksight:ListAnalyses",
                "quicksight:ListDataSources",
                "quicksight:ListDashboards",
                "quicksight:DescribeAnalysis",
                "quicksight:DescribeDataSet",
                "quicksight:ListDataSets",
                "quicksight:DescribeDataSource"
            ],
            "Resource": "*"
        }
    ]
}

​

Metadata Ingestion

​

Step 1: Add New Service

1. Navigate to Settings > Services and select Dashboard Services.
2. Click Add New Service.

​

Step 2: Select a Service and Connector

​

Step 3: Add Service Name and Description

• Enter a unique, descriptive Service Name. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other QuickSight services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

Step 4: Configure Connection Options

​

Select Ingestion Runner

​

Enter Connection Details

• AWS Access Key ID and AWS Secret Access Key: When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and authorize your requests (docs). Access keys consist of two parts: An access key ID (for example, AKIAIOSFODNN7EXAMPLE), and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). You must use both the access key ID and secret access key together to authenticate your requests. For more information, see how to manage your access keys.
• AWS Region: Each AWS Region is a separate geographic area in which AWS clusters data centers (docs). As AWS can have instances in multiple regions, Collate needs to know the region of the service you want to reach. The AWS Region is the only required parameter when configuring a connection. When connecting to services programmatically, Collate can extract and use the rest of the AWS configuration in different ways. For more information, see configuring your credentials.
• AWS Session Token (optional): If you are using temporary credentials to access your services, provide the AWS Access Key ID and AWS Secret Access Key. Temporary credentials also include an AWS Session Token. For more information, see Using temporary credentials with AWS resources.
• Endpoint URL (optional): To connect programmatically to an AWS service, you use an endpoint. An endpoint is the URL of the entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests. Find more information on AWS service endpoints.
• Profile Name: A named profile is a collection of settings and credentials that you can apply to an AWS CLI command. When you specify a profile to run a command, the settings and credentials are used to run that command. Multiple named profiles can be stored in the config and credentials files. You can inform this field if you’d like to use a profile other than default. Find more information about Named profiles for the AWS CLI.
• Assume Role Arn: Typically, you use AssumeRole within your account or for cross-account access. In this field you’ll set the ARN (Amazon Resource Name) of the policy of the other account. A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account. This is a required field if you’d like to AssumeRole. Find more information on AssumeRole.

• Assume Role Session Name: An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. By default, Collate uses the name OpenMetadataSession. For more information, see the Role Session Name.
• Assume Role Source Identity: The source identity specified by the principal that is calling the AssumeRole operation. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role. Find more information about Source Identity.
• identityType: The authentication method you use 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. Provide this when identityType is ANONYMOUS.

​

Test Connection

1. Click Test Connection to verify the credentials.
2. After the test succeeds, click Save.

​

Step 5: Configure Ingestion Options

​

How Filter Patterns Work

• Include: Add one or more comma-separated values. Each value uses one of the following match types. Collate ingests only assets whose names match at least one rule. Leave blank to include all assets.
• Exclude: Add one or more comma-separated values. Each value uses one of the following match types. Collate skips any asset whose name matches a rule. Leave blank to exclude nothing.

• contains: matches any name containing the value. For example, sales matches my_sales_data and sales_2024.
• starts with: matches names beginning with the value. For example, prod_ matches prod_db and prod_schema.
• ends with: matches names ending with the value. For example, _raw matches events_raw and logs_raw.
• is exactly: matches the exact name only. For example, analytics matches only analytics.
• matches regex: matches names using a regular expression. For example, ^prod_.*_v\d+$ matches prod_events_v1.

​

Filter Options

• Dashboard: Controls which dashboards Collate ingests from the source.
• Chart: Controls which charts within the ingested dashboards are included.

• Scan Mode: Choose between the following scan modes:
  • Scan all: Ingests every asset of that type the connector can access. This is the default.
  • Only specific: Enables include rules so only assets matching at least one rule are ingested.
• Exclude system toggle: Use this toggle to filter out system-reserved names defined by the connector for that asset type.
• Always exclude: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
• Preview: Shows a real-time summary of what will be in scope based on your current rules.
• Include rules: In Only specific mode, click + Add to define a rule. Added rules appear as chips. An asset is included if it matches any rule.

​

Step 6: Create & Deploy

​

Configure Metadata Agent and Schedule Ingestion

1. Navigate to Settings > Services and select the Dashboards service.
2. Select your service and click the Agents tab.
3. Click Add Agent and select Metadata from the dropdown. For some services, the dropdown is not available and clicking Add Agent takes you directly to the agent configuration page.
4. On the Configure Ingestion page, do the following and click Next.
   • Name this Ingestion: Enter a unique, recognizable name for this ingestion pipeline.
   • Agent Setup: Configure ingestion parameters. The following fields are available:

     Field	Default	Description
     Db Service Prefixes	—	List of database service name prefixes used to resolve lineage between dashboards and database assets. Accepted formats: DBService, DBService.Database, DBService.Database.Schema, DBService.Database.Schema.Table.
     Query Parser Type	Auto	Select the SQL parser used for lineage extraction from dashboard queries. Auto selects the best available parser automatically. SqlGlot is a high-performance parser with excellent dialect support; falls back to SqlParse on failure. SqlFluff is a comprehensive parser with strong dialect support; falls back to SqlParse on failure.
     Mark Deleted Dashboards	On	Soft-delete dashboards in Collate when they are removed from the source. Associated lineage is also deleted.
     Mark Deleted Data Models	On	Soft-delete data models in Collate when they are removed from the source. Associated lineage is also deleted.
     Mark Deleted Charts	On	Soft-delete charts in Collate when they are removed from the source.
     Include Data Models	On	Ingest data model metadata.
     Include Draft Dashboards	On	Ingest dashboards that are in draft state.
     Include Usage	On	Collect and ingest usage statistics for dashboards.

     
   • Filter Patterns: Apply include or exclude rules to scope which dashboards, charts, data models, and projects this agent ingests. These follow the same filter options described in Step 5.
   • Scope & Behaviour: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     Toggle	Default	Description
     Enable Debug Log	Off	Sets the ingestion log level to DEBUG. Useful for troubleshooting.
     Include Current Owners	Off	When enabled, replaces the current owner with a new owner from the source if the current owner is null. Recommended to keep enabled during the first metadata ingestion to capture owner information.
     Include Tags	On	Ingest tags from the source.
     Override Metadata	Off	When on, source values overwrite existing descriptions, tags, owners, and display names in Collate. When off, Collate only updates fields that have no existing value.
     Override Lineage	Off	When on, existing lineage is replaced with newly extracted lineage on each run.

     
5. On the Schedule Interval page, set when the agent runs:
   • Schedule: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   • On-Demand: No automatic schedule. Trigger the agent manually when needed.
   
6. Click Add to deploy the agent.

​

Lineage

​

Lineage

​

How to Set Up Lineage

1. Go to Settings > Services > Dashboards.
2. Click the dashboard service you’ve added.
3. Go to the Agents tab, then select Add Agent > Add Metadata Agent. If a metadata agent already exists, select the three-dot context menu (⋮) next to it and select Edit.
4. In the Configure Ingestion step, scroll down to the Lineage Information section.
5. Optionally enter one or more database service names in the Db Service Prefixes field to restrict table matching to specific services. If left blank, Collate searches across all ingested database services.

​

Troubleshooting