How to bulk upload terms in the glossary

🤓 Who can do this? Currently, only member users with edit access on glossaries and admin users in Atlan can start a bulk glossary upload — you may not have access yourself.

You can upload multiple terms into a glossary using the bulk upload option:

Download the template

You can access the template online through Google Sheets. An example term is also included in the online template:

Or to download the glossary bulk terms template from within Atlan:

  1. From the left menu, click Glossary.
  2. Under All Glossaries, click the glossary you would like to add terms to. (Terms can only be added to an existing glossary.)
  3. To the right of the glossary's name, click the three dot menu and then click Bulk upload terms.
  4. In the New Bulk Upload dialog, click Download sample template here.

A file named Glossary Atlan Bulk Terms Template.xlsx downloads. You can edit this file with your existing terms and definitions in Microsoft Excel or Google Sheets.

Populate the template

Populate the downloaded template following the template field structure. You can find the same details below in the comments embedded in the Glossary Atlan Bulk Terms Template.xlsx file.

Column explanations

🚨 Careful! Except for the terms, the objects must already exist: categories, users, groups, and tags.

Term Name

Enter the name of the term under the Term Name column.

  • This field is required.
  • If a term with the same name already exists in the glossary, it will be updated rather than created.
  • If this column is blank, the entire row will be ignored.
💪 Did you know? You can use bulk upload to bulk edit term information.

Description

Enter the definition of the term in the Description column.

Categories

Enter the categories to which to add the term in the Categories column.

  • The categories must already exist in Atlan.
  • Separate multiple categories by a comma.
  • Use the @ symbol as a separator between parent and child categories, to specify a subcategory.
  • If this column is blank, the term will be added directly to the glossary without being placed in any category.

User Owners

Enter the usernames of owners in the User Owners column.

  • The user(s) must already exist in Atlan.
  • Be sure to omit the @ symbol when adding the username.
  • Separate multiple usernames by a comma.

Group Owners

Enter the group names of owners in the Group Owners column.

  • The group(s) must already exist in Atlan.
  • Separate multiple group names by a comma.

Certification

Enter the certification status in the Certification column.

  • The value must be one of Verified, Draft, Deprecated, or No certificate.
  • Setting the value to No certificate will remove the certificate status.

Certification Message

Enter any additional information related to the certification in the Certification Message column.

Tags

Enter any tags to apply to the term in the Tags column.

  • The tag(s) must already exist in Atlan.
  • Separate multiple tags by a comma.
💪 Did you know? Tag propagation is disabled by default in Atlan. You can enable tag propagation to any assets linked to the term.

Example

Following is a simple example of a filled in template, pivoted for readability:

Column name Example value
Term Name* Monthly Active Users
Description The number of users who are active over a month, often abbreviated MAU.
Categories Metrics@Monthly, Metrics@Critical Metrics
User Owners jsmith,jdoe
Group Owners finance,ops
Certification Verified
Certification Message Agreed by governance council on May 10, 2021.
Tags PII, Confidential

Save as CSV or XLSX file

Before uploading the completed template to Atlan, save it as a CSV (.csv) or an XLSX (.xlsx) file.

You may also need to ensure the following:

  • Atlan requires the file to be comma-separated. If you are in a region where your preferred spreadsheet editor saves CSV or XLSX files with a separator other than a comma , you will need to modify your spreadsheet’s settings to use commas as separators.
  • If your file contains special characters — for example, ñ, ç, õ, and others — Atlan recommends uploading the completed template in an XLSX file to retain the special characters. If uploaded in a CSV file format, the bulk upload and decoding of special characters may fail.

Upload the file

To upload your CSV or XLSX file to Atlan:

  1. From the left menu, click Glossary.
  2. Under All Glossaries, click the glossary you would like to add terms to. (Terms can only be added to an existing glossary.)
  3. To the right of the glossary's name, click the three dot menu, and then click Bulk Upload Terms.
  4. Click Select a CSV or XLSX file to upload or drag and drop the file into the dialog.
  5. Click Start Upload.

Monitor the upload

To track the status of your upload, from the glossary:

  1. Open the Upload History tab.
  2. If there are errors in your file, you will see a message indicating the upload Needs Attention.
    1. Click the Results CSV button to download a copy of the file with notations on what the errors are.
    2. Update your file, save your changes, and upload the edited file following the steps above.
  3. If your upload is successful, you will see a message indicating Success.

That's it, your terms are now available in Atlan! 🎉

Related articles

Was this article helpful?
1 out of 1 found this helpful