Automated addition of column descriptions by the Atlan Bot
📝 Auto-column description via the Atlan Bot
How often do we find ourselves looking in despair at an empty column description field in our metadata? The pain is real!
We don't deny that adding column descriptions of multiple data tables each with 50-60 columns can be daunting. Atlan Bot is here to help!
The Bot will suggest column descriptions based on existing columns with similar names. The final decision to accept or deny the suggestion lies with the Admin and the Steward because obviously, they know the best! As soon as they approve it, the suggested description gets automatically added.
Let's see exactly how? 👀
🤖 How auto-column description works in Atlan
The Atlan Bot uses specific algorithms to detect and suggest column descriptions for your data tables.
It maps column headers of a column against existing column headers with already enriched column descriptions. It uses string search and Levenshtein scoring on all string permutations in column headers to suggest the best match for your newly added column assets.
For example, a column named "user_name" has a description "Name of the product users". When another column with an exact or highly similar column name like "user_name_all" is detected without a column description, the bot will suggest column description "Name of the product users".
Let's look at how you can trigger the bot to auto-suggest column names for the table of your choice.
▶️ How to trigger the bot to auto-suggest the column descriptions
STEP 1: Go to the dedicated data table page
Go to the Discover list, and click the name of the data table you want to auto-classify.
STEP 2: Go to the "Profile" tab
Click the third tab from the right, labeled "Profile".
STEP 3: Click "Atlan Actions"
A button is on the top right. As soon as you click it, a modal will open up which will ask you to select which bot you want to run. Click on "Auto-generate Column Descriptions".
Atlan Actions Modal
STEP 4: Click on "Run Now"
Once you choose the appropriate bot action, click on the "Run Now" blue button. The bot run will start.
STEP 5: Go to the "Manage Requests" page
Once your run is complete and successful, go to the "Manage Requests" page inside the "Access" section of the platform or the "Requests" page inside the "Settings" section of that asset. There you will see all the requests created so far. Choose the filter "Descriptions" and you will be able to see only the column-descriptions requests.
The Steward and Admin can approve and reject column description requests from this page.
👀 Note: Only when the column description request is accepted it will get automatically added to the column asset.
Want to know more about approval flows? Read the article on this topic below 👇