Skip to content

Asset export (advanced)

The asset export (advanced) package allows to export a set of assets 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.
  • 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.

  • 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.

  • Atlan API Token: this is required to generate the dynamic dropdowns (see the Filters and Custom Metadata Filters screens)
  • Project id: Google Cloud project id that contains the buckets.
  • Service Account JSON key: follow this article to create a service account JSON key. 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.

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
  • Is Archived
  • Has Terms

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.

  • Importable: whether the export is used to feed the Asset Import package, default: No

    • Yes: ensures that appropriate details are included in the output in such a way that it can be used by the Asset Import package.

      • Timestamp format: whether to export the timestamp attributes in Unix or ISO 8601 format, default: Unix

    • No: it provides a more business friendly oriented output.

      The following predefined columns are exported:

      • Description
      • Alias
      • Usage Queries (last 30 days)
      • Usage Users (last 30 days)
      • User Owners
      • Group Owners
      • Linked Terms
      • Tags
      • Certificate Status
      • Announcement
      • Created By (in Atlan)
      • Last updated by (in Atlan)
      • Created (in Atlan)
      • Last Updated (in Atlan)
      • Connection Name
      • Last Queried
      • Last updated (on source)
      • Source updated by
      • Readme
      • Category (*)
      • Linked Assets (*)
      • Related Terms (*)
      • Glossary (*)
      • All custom metadata

      The columns to export can be selected from a dropdown menu.

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

Warning

  • Category, Linked Assets and Related Terms are exported only if Atlan Glossary Term is selected in the Asset Type filter.
  • Glossary is exported only if Atlan Glossary Term or Atlan Glossary Category are selected in the Asset Type filter.
  • awsArn is automatically added in the export if the list of assets includes at list a S3Bucket or a S3Object.

What it does

The package performs the following steps:

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