import themen from ‘theme/styles/styled-colors’; import * as theme from ‘react-syntax-highlighter/dist/esm/styles/hljs’; import SyntaxHighlighter from ‘react-syntax-highlighter’;
import Img from ‘theme/components/shared/Img’
A Glossary provides appropriate vocabularies for business users and it allows the terms (words) to be related to each other and categorized so that they can be understood in different contexts. These terms can be then mapped to assets like a Database, tables, columns etc. This helps abstract the technical jargon associated with the repositories and allows the user to discover/work with data in the vocabulary that is more familiar to them.
A term is a useful word for an enterprise. For the term(s) to be useful and meaningful, they need to grouped around their use and context. A term in Apache Atlas must have a unique qualifiedName, there can be term(s) with same name but they cannot belong to the same glossary. Term(s) with same name can exist only across different glossaries. A term name can contain spaces, underscores and dashes (as natural ways of referring to words) but no “.” or “@”, as the qualifiedName takes the following form term name
@glossary qualified name
. The fully qualified name makes it easier to work with a specific term.
A term can only belong to single glossary and it's lifecycle is bound to the same i.e. if the Glossary is deleted then the term gets deleted as well. A term can belong to zero or more categories, which allows scoping them into narrower or wider contexts. A term can be assigned/linked to zero or more entities in Apache Atlas. A term can be classified using classifications (tags) and the same classification gets applied to the entities that the term is assigned to.
A category is a way of organizing the term(s) so that the term‘s context can be enriched. A category may or may not have contained hierarchies i.e. child category hierarchy. A category’s qualifiedName is derived using it's hierarchical location within the glossary e.g. Category name
.parent category qualifiedName
. This qualified name gets updated when any hierarchical change happens, e.g. addition of a parent category, removal of parent category or change of parent category.
Apache Atlas UI has been updated to provide user-friendly interface to work with various aspects of glossary, including:
Most of glossary related UI can be found under a new tab named GLOSSARY, which is present right next to existing familiar tabs SEARCH and CLASSIFICATION.
Apache Atlas UI provides two ways to work with a glossary - term view and category view.
Term view allows an user to perform the following operations:
Category view allows an user to perform the following operations:
Users can switch between term view and category view using toggle provided in GLOSSARY tab.
<Img src={/images/markdown/terms_view.png
} width=“300px” />
<Img src={/images/markdown/category_view_1.png
} width=“300px” />
<Img src={/images/markdown/term_view_context.png
} width=“360px” />
<Img src={/images/markdown/term_delete_context.png
} width=“600px” />
Various details of a term can be viewed by clicking on the term name in the glossary UI. Each tabs under the details page provides different details of the term.
<Img src={/images/markdown/term_details.png
} />
Clicking on + next to classification label to add a classification to the term.
<Img src={/images/markdown/term_add_classification_1.png
} alt=“Add classification” width=“400px” />
<Img src={/images/markdown/term_add_classification_2.png
} alt=“Add classification - details” width=“400px” />
<Img src={/images/markdown/term_with_classification.png
} alt=“Classifications associated with term” width=“400px” />
Click on “Related Terms” tab when viewing term details. Clicking on + will allow linking a term with the current term.
<Img src={/images/markdown/terms_related_terms.png
} />
Click on + next to categories label to categorize a term. A modal dialog will be presented for choosing a category.
<Img src={/images/markdown/term_add_category.png
} width=“400px” />
When the toggle switch is on category, the panel will list down all glossaries along-with the category hierarchy. Here's a list of possible interactions under this view.
/images/markdown/category_view_2.png
} width=“300px” />Clicking on ellipsis (...) next to the category name will present a category context menu.
<Img src={/images/markdown/category_view_glossary_context.png
} width=“600px” />
<Img src={/images/markdown/category_view_category_context_1.png
} width=“600px” />
Once a category is selected, the details will be presented in the right pane.
<Img src={/images/markdown/category_details_with_terms.png
} width=“600px” />
Click on + next to the terms label to link a term under selected category.
<Img src={/images/markdown/category_add_term.png
} width=“600px” />
<Img src={/images/markdown/category_add_term_1.png
} width=“400px” />
<Img src={/images/markdown/category_add_term_2.png
} width=“400px” />
Terms can be assigned to an entity either from the results page or entity details page.
Click on + under “terms” column (if associating term from search page)
<Img src={/images/markdown/entity_search_add_term.png
} />
Click on + next to “terms” label (if viewing a specific entity details)
<Img src={/images/markdown/entity_details_add_term.png
} />
Both the actions will present the following modal, follow prompts on screen to complete term assignment.
<Img src={/images/markdown/entity_add_term_modal.png
} width=“400px” />
If a term has classification then the entity is has been assigned inherits the same.
<Img src={/images/markdown/term_details_with_classification.png
} />
<Img src={/images/markdown/entity_assigned_term_with_tag.png
} width=“600px” />
Apache Atlas basic-search API and UI have been updated to support term as a search criteria. This allows users to find entities associated with a given term. Basic search UI now includes a new input drop-down for term based searches.
<Img src={/images/markdown/term_search.png
} width=“300px” />
Following operations are supported by Atlas, the details of REST interface can be found here
NOTE:
NOTE: