Apache Atlas dashboard tour

The Apache Atlas dashboard provides a unified metadata management interface for the Classic and New React-based user experiences to perform entity searches, manage classifications, and visualize lineage graphs.

You can switch between the Classic and the New React-based redesigned user interface.

Figure 1. Switching between Classic and New UI

The Atlas user interface is a metadata dashboard with the following parts:

  • Search panel on the left.
  • Detail panel on the right where search results are displayed. You can drill into a specific entity to view its the details. Each detail page contains a header section and a series of tabbed panels, all of which are oriented to the metadata for that entity type.
Figure 2. Filtered search results

Searching

The new search panel automatically lists all available entity types, classifications and glossary terms. Clicking an item in one of the categories automatically lists all relevant members.

The Atlas user interface includes radio buttons that enable the following filtering options:
Entities
Displays empty service types
Classifications
Displays unused classifications
Glossary
Displays category or terms
Figure 3. Search panel in New UI

Entities and classifications can be collapsed to a flat tree, by clicking > Show flat tree.

The Classic search panel contains the following tabs for searching:
  • Search

    Select from existing lists of metadata types to narrow the search results. Switching to the Advanced search allows you to enter specific Atlas DSL search queries. Both Basic and Advanced searches can be saved for easy reuse in Favorite Searches.

  • Classifications

    Access predefined searches based on classifications

  • Glossary

    Search using predefined glossary terms

Figure 4. Search panel in Classic UI

Classifications

In the Classification option, selecting a classification displays all the entities that are marked with that classification. Locate a specific classification using the search box or browse the classification hierarchy that you defined during classification creation. The Classification tab displays all related assets, including processes.

Figure 5. Searching with classifications
Figure 6. Searching for a classification
Figure 7. Searching with classifications
Figure 8. Classification tab

Glossary

In the Glossary option, selecting a term displays all the entities that are marked with that term. Locate a specific term using the search box or browse terms by glossary. Use the category view to browse the hierarchy of your organization’s business glossary. Selecting a category displays its assigned terms in the display pane. When you select one of those terms, Atlas displays the associated entities.

Figure 9. Searching with the glossary
Figure 10. Glossary tab

Search results

When Atlas returns search results, the UI displays a paginated list of entities that match the search criteria. You can return to search options to further refine your search or use the available controls to change the search result presentation.

Figure 11. Search results
  1. View he search criteria set in the Search panel.
  2. Control which attributes of the entities are shown in the columns.
  3. Download the selected search results as a CSV file.
  4. By selecting the checkboxes, mark multiple entities for export or for applying classifications or terms.
  5. Add classifications by clicking the icon. By clicking the icon, view the rest of the classifications, that did not fit the screen.
  6. Add terms by clicking the icon. By clicking the icon, view the rest of the terms, that did not fit the screen.
Figure 13. Search results
  1. View the search criteria set in the Search panel.
  2. By selecting the checkboxes, remove the following entity types from the result list:
    • Sub-entities
    • Sub-classifications
    • Entities marked as deleted (historical entities)
  3. Control which attributes of the entities are shown in the columns.
  4. Download the selected search results as a CSV file.
  5. By selecting the checkboxes, mark multiple entities for export or for applying classifications or terms.
  6. Add classifications by clicking the icon. By clicking the icon, view the rest of the classifications, that did not fit the screen.
  7. Add terms by clicking the icon. By clicking the icon, view the rest of the terms, that did not fit the screen.

Viewing entity details

When you click a link for an entity in the search results, Atlas opens an entity detail page that includes the metadata collected for the entity. The detail page organizes the entity content in the following tabs:

Properties
The Properties tab includes the system metadata collected for this entity and any user-defined properties. It also contains a list of labels applied to the entity. Use values from any of the string data type properties to find this entity using free-text search.
Lineage
The Lineage tab displays a lineage graph for each entity. For data asset entities, the lineage graph displays when the entity functioned as an input or an output for an operation. For process entities, the lineage graph displays all input and output entities used by or produced by the operation.
Relationships
The Relationships tab lists the other entities associated with the current entity. You can view the related entities as a list or as a graph and use this tab to navigate among entities. The input and output relationship types include the entities that make up the lineage.
Classifications
The Classifications tab displays the classifications associated with this entity and are also displayed in the top section of the detail page. This tab allows you to add, update, or remove classifications from the entity.
Audits
The Audits tab records the changes that occur to entity metadata. It displays when Atlas updated the entity's metadata, including the following changes:
  • Classifications added or removed
  • Entity attributes updated
  • Labels added, updated, or removed
  • Relationships added, updated, or removed
  • Glossary terms added or removed
Schema
When the current entity is a table, the Schema tab is displayed and lists columns in the table. Use this tab to drill into a specific column or to add classifications to columns without opening the individual column detail page.