Skip to content

Enrichment Report

The Enrichment report generation for Glossary (aided with Metadata Completeness), Data Products, Usage report, tableau asset export report, Certificate report and Asset View Report.

Configuration

Credentials

On this screen the output (where the assets are extracted) is selected.

  • Email Addresses: list of email addresses (comma separated) that will receive the assets export as csv attachment.
  • Email Subject (Optional): subject of the email that will be sent by Atlan. If empty the default subject is used.
  • Email Body (Optional): body of the email that will be sent by Atlan. If empty the default body is used.

Warning

The max size for sending attachments is 25 MB. Please consider to use another output method if the generated file is bigger than 25 MB Or you can use zip method.

  • AWS Access Key
  • AWS Secret Key
  • S3 Bucket Name
  • S3 Folder Path: folder path with trailing slash - atlan/export/
  • Region: s3 bucket region

The following policy needs to be attached to the IAM User in order to allow Atlan to write into the S3 bucket:

IAM User policy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject"
            ],
            "Resource": "arn:aws:s3:::<bucket-name>/*"
        }
    ]
}
  • S3 Bucket Name
  • S3 Folder Path: folder path with trailing slash - atlan/export/
  • Region: s3 bucket region

Warning

Reach out to your Customer Success representative to create a cross-account bucket policy.

  • Google Sheet Key:
  • Worksheet Name (a.k.a. Sheet TAB)
  • Service Account JSON (share the spreadsheet with your service user)

Warning

The CSV file can be downloaded from the Atlan UI.

  • Project id: Google Cloud project id that contains the buckets. (Optional)
  • Service Account JSON key: follow this article to create a service account JSON key. (Optional) The following permissions have to be granted to the role assinged to the Service Account: storage.buckets.get, storage.objects.get and storage.objects.create.
  • Bucket name: name of the bucket where to upload the file.
  • GCS Folder Path: Bucket Path were file will be loaded.
  • If the Project id and Service Account Json key are not provided this load the file to tenant specific GCS bucket

Filters

This screen allows to apply filters based on the report you want to generate.

  • To generate the Glossary Summary Report, it's required that the Metadata Completeness Score feature is enabled within the platform settings. This ensures that the metadata collected meets a quality threshold for reporting purposes.
  • By default, the report provides basic information about each glossary present in the system, such as glossary name, description, and associated terms.
  • When the Advanced option is selected from the Options tab, the report includes additional details about the glossary's category structure. Users can also specify the depth (or hierarchical level) of category data they wish to include. This allows for deeper analysis and a more granular view of the metadata organization.
  • This report is dependent on the existence of at least one Data Product within the tenant. If no data products are present, the report can't be generated.
  • The report contains summarized information about each domain by default, such as domain name, associated data products, and their descriptions.
  • By selecting the Advanced option, users can extend the report to include information about subdomains. This is particularly useful for organizations that organize data products in a layered or nested structure. Additionally, the level of depth for subdomain information can be customized, allowing users to drill down as needed for more detailed reporting.
  • This report focuses on tracking user-driven updates to metadata across a defined time period. It supports auditing and monitoring of how metadata is curated and enriched over time.
  • The report captures changes made by users to a variety of metadata fields, including:
  • Certificates
  • Descriptions
  • Owners
  • Linked Terms
  • Tags
  • Readmes
  • Announcements
  • Custom metadata fields selected during report configuration
  • It helps in assessing user engagement and the accuracy and completeness of metadata maintenance activities.
  • The Tableau Catalog Report is an enhanced version of the standard Assets Export package, tailored specifically for Tableau-related assets.
  • In addition to the default asset export fields, this report includes two additional, Tableau-specific columns:
  • Hierarchy Displays the full project hierarchy, offering insight into the organizational structure of Tableau assets.
  • Workbook Shows the association of each asset with the corresponding Tableau workbook, enabling traceability and impact analysis.
  • This report is particularly useful for teams managing Tableau environments who need an in-depth view of asset lineage and ownership.
  • This report generates a log of any updates made to the certification status of assets by users. It covers all certification changes made from the time of the last successful workflow execution up to the start of the current workflow.
  • Certification updates are a key indicator of data trustworthiness and governance practices.
  • The report also provides an option to include specific custom metadata fields, allowing teams to tailor the output to their governance or compliance requirements.
  • The Asset View Report tracks the number of views each asset has received from users over a given time frame.
  • The reporting window spans from the last successful workflow execution to the current run, offering an up-to-date snapshot of asset engagement.
  • This report helps identify which assets are frequently accessed and potentially more valuable or critical for business operations.
  • The Unified Report is a comprehensive export that combines insights across multiple asset types including BigQuery, Tableau, DBT, and Glossary assets.
  • It includes records for all asset states: active, deleted, or purged.
  • The report reflects changes made from the last successful workflow run to the present date, providing a holistic view of asset activity and lifecycle.
  • It's especially useful for organizations seeking a broad overview of system-wide changes and usage trends across their data ecosystem.