Skip to content

Bulk Impact Report

The bulk impact report package allows to export the lineage impact report to different locations based on filter criteria applied by the user.

Configuration

Credentials

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

  • Atlan API Token: this is required to generate the dynamic dropdowns (see the Filters and Custom Metadata Filters screens)
  • Email Addresses: list of email addresses (comma separated) that will receive the assets export as csv attachment.

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.

  • Atlan API Token: this is required to generate the dynamic dropdowns (see the Filters and Custom Metadata Filters screens)
  • 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.

  • Atlan API Token: this is required to generate the dynamic dropdowns (see the Filters and Custom Metadata Filters screens)
  • Google Sheet Key: How do I find my Google Sheet Key?
  • Worksheet Name (a.k.a. Sheet TAB)
  • Service Account JSON (share the spreadsheet with your service user)
  • Atlan API Token: this is required to generate the dynamic dropdowns (see the Filters and Custom Metadata Filters screens)

Warning

The CSV file can be downloaded from the Argo UI.

Filters

This screen allows to apply filters on the asset population. Each filterable attribute has an operator and a value. The operator is always a dropdown menu while the value can be either a dropdown or a free text field. The package considers the filter only if both the operator and the value are filled. The only exceptions are the operators “Is Empty” and “Is Not Empty” where the value is not required (and ignored if filled). The available filters are:

  • Connector
  • Connection
  • Asset Type
  • Name
  • Certificate
  • Qualified Name
  • Tag
  • Description
  • Has Lineage
  • Announcement
  • Owner User
  • Owner Group

Custom Metadata Filters

This screen allows to apply filters on the asset population using custom metadata. Each filter has a custom metadata selector (dropdown menu), an operator and a value. The package considers the filter only if both the operator and the value are filled. The only exceptions are the operators “Is Empty” and “Is Not Empty” where the value is not required (and ignored if filled).

Mulitple values

If the custom metadata allows multiple values, use comma separated strings in combination with the "Is one of" or "Is not one of" operator to filter multiple values at the same time.

Output

This screen allows the selection of the attributes to export.

  • Lineage Direction: whether to export either Downstream or Upstream lineage impact report, default: Downstream

  • Custom Metadata Output

    The following predefined columns are exported:

    • Asset Name
    • Asset Type
    • Asset Qualified Name
    • Asset Guid
    • Lineage Position
    • Direct Dependencies
    • Impacted Asset Name
    • Impacted Asset Alias
    • Impacted Asset Type
    • Impacted Asset Qualified Name
    • Impacted Asset Guid
    • Impacted Asset Description
    • Impacted Asset Group Owners
    • Impacted Asset User Owners
    • Impacted Asset Tags
    • All custom metadata

    The following predefined columns are exported:

    • Asset Name
    • Asset Type
    • Asset Qualified Name
    • Asset Guid
    • Lineage Position
    • Direct Dependencies
    • Impacted Asset Name
    • Impacted Asset Alias
    • Impacted Asset Type
    • Impacted Asset Qualified Name
    • Impacted Asset Guid
    • Impacted Asset Description
    • Impacted Asset Group Owners
    • Impacted Asset User Owners
    • Impacted Asset Tags
    • The list of custom metadata can be selected from a dropdown menu.

  • Direct impact assets: Whether to add the list of assets directly linked to the impacted asset.

  • Zipped: whether to zip the output file. The option is ignored if Google Sheet is selected as destination.

  • Lineage depth: lineage depth extracted. If empty the full lineage is extracted.

What it does

The package performs the following steps:

  • Translate the UI input into an ElasticSearch query.
  • Retrieve from Atlan downstream/upstream assets of the selected assets.
  • Generate a csv file.
  • Send the generated csv file to the selected output.