Data Observability platform Help

Glossary

Business Glossary lets users define a list of business Terms that can be used to label different cataloged objects in the application. Terms can be organized into folders and with Relations between Terms.

The Glossary view can be accessed on the Catalog page under the Glossary tab.

Glossary

Create a Term

The "New Term" dialog can be opened from the left sidebar. Terms have a name, type, domain, owner, color and description.

CreateTerm

View Term's detailed info

Clicking on a row in the Terms list will open its detailed view. From there you can edit the Term's name, type, domain, owner, color and description. From detailed view you can also access term relations and attributes.

EditTerm

Edit Term's Relations

Term relations are accessed from term detailed view using the "Relations" button.

TermRelations

Organizing Terms into folders

Terms can be organized into folders using the following Relation Types:

Contains

Related Term will become a child Term of the opened Term.

Contained in

Related Term will become a parent Term of the opened Term.

View Term's Relations in a graph

The Relations tab contains a graph-representation of the Relations on the right. This graph supports panning and zooming. Clicking on a node in this graph will highlight the path from the opened Term and show the Relation types. Any node's child nodes can be collapsed or expanded with the +/- button to the right of a node. You can also search the relation graph by using the filters. You can also open term graph in full view, using the expand icon in top right corner.

RelationGraph

Open another Term from the Relations graph

Clicking on the arrow button in a node after the Term's name will open that Term's detailed view.

Term attributes can be accessed from term detailed view using "Attributes" button. Clicking on the button after the Object's name will open that Catalog Object.

GlossaryAttributes

Editing glossary custom values

CustomValues

Additionally, users can define custom Type, Domain or Relation type values, which can be used to group or filter terms.

EditCustomValues
  • Types - Default glossary type is 'Term', but users can define any custom type according to their need

  • Domains - By default, terms do not belong under any domain. Users can define domains based on their needs to filter terms in table or graph level.

  • Relation types - By default there are "Contains", "Related to" and "Synonym" relations. Users can define additional relations based on their needs.

Exploring Terms' folder structure

Terms that contain other Terms via the "Contains" Relation show two extra buttons in the Terms list view. The button to the left of the Term's name expands that folder's contents without navigating into the folder. The button on the right will navigate into the folder.

TermFolder

The current active directory is visible above the Term list. Clicking on parts of the directory will navigate into that directory. Clicking on the last part, e.g. the current directory will open that Term's detailed view.

TermSubfolder

Searching for Terms

The search in the top of Business Glossary finds Terms by the name or description. Search structure will display all found terms as root nodes and provides additional highlighting.

GlossarySearchResults
Last modified: 30 July 2024