Create and Manage Glossary Terms

Glossary terms provide a business definition for assets, terms, and KPIs.

Prerequisites

To manage glossary terms, you must have a global role that grants you the following privileges:
  • Data Warehouse General (-R------) - To access SAP Datasphere.

  • Catalog Asset (–RU––-M) - To edit an asset's name and short and long descriptions and add term, KPI, and tag relationships on the asset details page.

  • Catalog Glossary (–R–––--) - To view the list of glossaries.

  • Catalog Glossary Object (CRUD–-M) - To add, edit, and delete categories and terms for glossaries. Also, to publish or unpublish terms.

The Catalog Administrator global role and the DW Viewer role template (used directly as a global role) applied together, for example, grant these privileges. For more information, see Privileges and Permissions and Standard Roles Delivered with SAP Datasphere.

Create a Term

Context

When you create a term, make the definition as clear and complete as possible. Make sure the definition isn't so broad that it applies to all assets, nor too narrow that it applies to only a few assets.

The only required fields are Term Name and Definition, and any required custom attributes based on the reference template. You can add an optional description used as a short description of the term. When you add keywords, synonyms, term relationships, and categories, then you can more easily find and understand the term. Keywords can be descriptive names for the terms. For example, APY can be a keyword for the term Annual Percentage Yield. A synonym is a word or phrase that means nearly the same thing as the original term. For example, "deposit" is a synonym for "fund". Keywords and synonyms don't have to be terms defined in your glossary.

To make sure your term is available in all catalog views, it's best to create it using the SAP Business Data Cloud cockpit system. If you want the term to be available in just one specific formation, create it using the DSP system for that particular formation.

Procedure

  1. In the side navigation area, choose (Catalog & Marketplace)Start of the navigation path Next navigation step End of the navigation path (Search).
  2. On the catalog search page, choose (Create), and then choose Term.

    The Select Glossary dialog opens.

  3. Choose the glossary where you want to add a term.

    The New Term page opens.

  4. Enter a term name.
  5. Optional: In Summary, enter a short description of the term.
  6. Optional: Select one or more categories where you want the term added. Select up to 25 categories, and then choose OK.
  7. Optional: Enter up to 10 keywords or 10 synonyms by typing the words and pressing Enter after each word or phrase.
  8. Enter a definition. Use the tools to enhance your definition, such as applying text formatting (for example, color, bold, and bullet list), adding multimedia content (links to videos and images), and so on. Multimedia content that you add must be hosted elsewhere. This content isn't saved to the repository. When you add multimedia content, provide a link to the content that can be accessed from the browser when viewing the text. The content appears embedded in the text.
  9. Optional: Set any custom attributes as defined in the glossary in the attribute sections.
  10. Optional: To add related objects, choose Save and refer to Manage a Term Relationship for additional steps.
  11. Choose Save to view the completed term or choose Save and New to create another term.

Results

The newly created term is saved and by default is unpublished. Only users with the Catalog Administrator role can search for and see all unpublished terms. For each term, you can see visible status labels that show its functional and publication statuses. Review the following table for what actions you can do for the different term statuses.

Term Status

If the term status is

Then

Find out more

Current

The term does not have any issues. You can publish the term and define object relationships for it. If needed, you can edit the term, such as change its name, description, keywords, and more.

Manage a Term Relationship

Publishing Content to the Catalog

Edit a Term

Needs Repair

The term has a warning or error that needs to be fixed. The term cannot be published until it is fixed. You can view the errors under Status on the term page:

Edit a Term

Published

The term is visible to anyone who uses the catalog. You can unpublish an individual term on the term page by choosing Unpublish or you can unpublish several terms on the catalog search page.

Publishing Content to the Catalog

Unpublished

The term is visible only to users who have the Catalog Administrator role. You can publish an individual term on the term page by choosing Publish or you can publish several terms on the catalog search page.

Publishing Content to the Catalog

You can edit, delete, and publish a term by accessing catalog from the same system that was used when creating the term. For example, if you accessed the catalog from the SAP Business Data Cloud cockpit system and created the term, you must access the catalog from the same system to edit, delete, or publish the term.

Manage a Term Relationship

Context

You can add and remove term relationships to assets in one of the following ways:
  • On the term's details page, you can add and remove relationships to assets, KPIs, and other terms. To do this, you must access the term's details page from the same system that was used to create the relationship. For example, if you access the catalog from SAP Datasphere of a specific formation, you must use that same system to access the catalog when managing relationships.

  • From the asset details page, you can go to the Semantic Enrichment tab to add term relationships to assets. Also, if you want to add relationships to an asset's attributes, measures, and dimensions, select Start of the navigation pathOverview Next navigation step  DetailsEnd of the navigation path to add those relationships.

When the assets have relationships with terms, you can gain more insight into the meaning of your data. You can also assign a term to a KPI, or another term. The list of relationships can give a complete picture of the term's relevance to the business.

Procedure

  1. In the side navigation area, choose (Catalog & Marketplace)Start of the navigation path Next navigation step End of the navigation path (Search).
  2. On the catalog search page, use the filters or the search to find the term you want and select it. For more information, see Searching for Data Products and Assets in the Catalog.
  3. Choose the Related Objects tab.
  4. Choose the Manage Details button.

    The Manage Relationships dialog opens with a list of terms, KPIs, and assets.

  5. Optional: In the search bar, select either Assets, Terms, or KPIs from the dropdown list for the object you want to create a relationship.
  6. Optional: Enter all or part of the object name in the Search box to further refine the results.
  7. Optional: To filter on different options for assets, KPIs, and terms, such as glossaries, KPI categories, or favorite or recent objects, choose (Show filters). To sort the list alphabetically, choose (Sort). To change the view of the results, choose (Display as Table) or (Display as List).
  8. Select the checkbox next to one or more objects, and then choose the Add to Related Objects button.

    The objects are placed in categories in the Related Objects panel on the right.

  9. Optional: To delete a related object, choose the X next to the object in the Related Objects panel.
  10. Choose Save to return to the term.

Edit a Term

Context

You can edit a term by accessing the catalog from the same system that was used when creating it. For example, if you access the catalog from the SAP Business Data Cloud cockpit system to create a term, you must access the catalog from the same system to edit it.

Procedure

  1. In the side navigation area, choose (Catalog & Marketplace)Start of the navigation path Next navigation step End of the navigation path (Search).
  2. On the catalog search page, use the filters or the search to find the term you want and select it. For more information, see Searching for Data Products and Assets in the Catalog.
  3. Choose one or more options to edit the term.
    Option Description

    Edit

    At the top of the screen, choose Edit to open a dialog to change the name, summary, categories, keywords, and synonyms.

    Edit Definition

    In the Definition area, choose Edit Definition to change the term definition.

    Manage Details

    In the Related Objects area, choose Manage Details to add or delete relationships with this term. If the relationship is indirect, you must open that object to remove the relationship.

    Custom Attributes

    If the term has custom attributes, choose Edit in the area with your custom attribute name to make changes to those attributes.

  4. Choose Save.

Delete a Term

Context

You can delete a term by accessing the catalog from the same system that was used when creating it. For example, if you access the catalog from the SAP Business Data Cloud cockpit system to create a term, you must access the catalog from the same system to delete it.

Procedure

  1. In the side navigation area, choose (Catalog & Marketplace)Start of the navigation path Next navigation step End of the navigation path (Search).
  2. On the catalog search page, use the filters or the search to find the term you want. For more information, see Searching for Data Products and Assets in the Catalog.
  3. Select the checkbox next to the term you want to delete. You can delete multiple terms at the same time.
  4. Choose (Delete).
  5. Choose Delete on the Confirmation dialog.