Asset export (basic) for glossaries App
The Asset export (basic) app extracts metadata for glossaries, categories, and terms from Atlan into CSV files. This enables you to back up glossary metadata, migrate it between environments, or prepare it for enrichment and re-import.
Exports can be delivered through direct download, email, or object storage (S3, GCS, ADLS).
This reference provides complete configuration details for glossary exports, including scope, options, and delivery mechanisms. You can also use the same Asset export (basic) app to export other types of metadata, such as enriched assets and data products. See their respective references for details.
The exported CSV file can also be reused in the Asset Import for glossaries app to load metadata back into Atlan.
Access
The Asset export (basic) app isn't enabled by default. To use this app, contact Atlan support and request it be added to your tenant. Once enabled, glossary exports can be set up and run by admins or users with workflow permissions.
Define export scope
This section defines which glossary objects are exported and how they're filtered.
Workflow name
Specifies the display name for the workflow in Atlan. This name is used to identify the export job in the UI and logs. Choose a name that clearly reflects the purpose or scope of the glossary export.
Example: If you're exporting terms for an entire Metrics glossary, you might set:
Metrics glossary export
Export scope
Glossaries only: When selected, only glossaries, categories, and terms are exported into a glossary CSV file. This is the best option if you are backing up or migrating your business glossary metadata.
The remaining details in this reference assume this scope has been selected.
To understand the other scopes available, see:
- Products only: When selected, only data domains, subdomains, and data products are exported. See Asset export (basic) for data products for details.
- Enriched only: When selected, only assets that have been enriched by users (such as with descriptions, owners, tags, terms, or custom metadata) are exported. See Asset export (basic) for enriched assets for details.
Include archived?
Controls whether archived glossaries, categories, or terms are included in the export. Archived objects are retained in Atlan for lineage and history but are excluded from active search and discovery.
- Yes: Both active and archived glossaries, categories, and terms are included. Useful for creating a complete historical backup of glossary metadata or migrating all glossary structures, including inactive ones.
- No: Only active glossaries, categories, and terms are included. Appropriate for exports intended for active business use or migration where only current, in-use glossary objects are required.
Example:
A glossary named Finance Glossary contains 100 terms, of which 10 are archived. With Yes, 100 terms are exported. With No, 90 active terms are exported.
Select delivery method
Defines how the exported results are delivered. By default, every export is available as a direct download from the workflow run. Additional delivery methods can be configured to suit operational or sharing needs.
Direct download
When selected, the exported CSV file is available for download directly from the workflow run in Atlan. This option is useful for ad-hoc or one-time exports where the file is immediately needed by the user who triggered the workflow.
The file can be accessed by opening the workflow run, navigating to the Outputs section, and downloading the generated CSV file. No additional configuration is required.
Email
When selected, the exported CSV file is delivered as an email attachment. This option is useful for distributing export results automatically to specific users or teams without requiring them to log in to the workflow interface.
The maximum email attachment size is 25 MB. If the generated file exceeds this limit, use object storage instead.
Email addresses
Specifies the list of recipients who receive the export as an email attachment. Provide multiple email addresses as a comma-separated list.
Example:
Object storage
Use this option to export the glossary CSV file to a cloud object store rather than providing it only as a local download or email attachment. Recommended for large exports and recurring scheduled exports.
Use this option to send the exported CSV to Amazon S3, Google Cloud Storage (GCS), or Azure Data Lake Storage (ADLS). Object storage is recommended for large exports, automated pipelines, or recurring runs where the destination bucket is managed outside Atlan.
For detailed information on configuring storage credentials, access methods, and required fields for each provider, see Object storage configuration for apps.
Glossaries CSV file
For details on the CSV file produced by the app, refer to the Asset Import for glossaries reference.