Enriching and Managing Catalog Assets

To help catalog users quickly find and evaluate assets, enrich the assets by editing their names, adding both short and long descriptions, and adding relationships with terms, KPIs, and tags. You can also review the functional and publication status of the assets to ensure they're well-maintained and accessible.

Prerequisites

To enrich and manage any (published, unpublished, and excluded) asset in the catalog, 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 Object (–R–––--) - To view terms.

  • Catalog KPI Object (–R–––--) - To view KPIs.

  • Catalog Tag Hierarchy (–R–––--) - To view tag hierarchies and tags.

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.
To use SAP Business AI features for enriching catalog assets, it must be enabled in your tenant (see Enable SAP Business AI for SAP Datasphere) and you must also have a global role that grants you the following privilege:
  • Data Warehouse AI Consumption (–--–E--) - To use SAP Business AI features.

A combination of the Catalog Administrator global role, the DW AI consumer 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.

To be able to use the SAP Business AI feature to assign tags to assets, the option to expose the tag hierarchy for AI-generated content must be selected when the tag hierarchy is created (or edited).

You can edit and enrich assets that have a Current functional and have the Extracted status.

Changing the Asset’s Name and Summary Description

Context

The asset's name and summary description are the first pieces of information that users see when they search the catalog. These default values that are extracted from the source system might not be easy to understand and might not clearly convey the business value.

To help users better understand an asset and its usage, you can edit an asset's name and summary description. As a best practice, include words in the summary description that users might use to describe the asset. When users search for assets, the text in the name and summary is scanned during the search.

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 asset you want and select it. For more information, see Searching for Data Products and Assets in the Catalog.
  3. On the asset details page, find the header toolbar and choose Edit.
    The Edit Catalog Details dialog opens.

    Edit Catalog Details dialog for entering asset name and description, with Save and Cancel buttons.

  4. Change the asset's name to make it more understandable.
  5. Enter a custom summary description.

    If you leave the summary description empty and save the dialog, the description from the source system is the default that appears in the to all catalog users.

  6. Save your changes.

Results

The header of the asset details page is updated with the name and summary description you entered. Also, under the Catalog Activity heading, you can see the date the asset was enriched on and the name of the user who made the change.

When you go back to the catalog search page, you'll see the updated name and summary description in the search results.

Adding a Custom Description to an Asset

Context

The asset details page provides information about the asset that's extracted from the source system. To help users better understand the business value of an asset, you enrich an asset by adding a custom description.

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 asset you want and select it. For more information, see Searching for Data Products and Assets in the Catalog.
  3. Choose the Documentation tab.
  4. Choose Edit Content.
  5. Enter a custom description.

    Use the tools to enhance your description, 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.

  6. Save the description.

Results

The custom description is updated. In the header, the Catalog Activity section shows the date the asset was enriched on and the name of the user who made the change.

When users evaluate an asset, the extra information will help them make better informed decisions on whether the asset is suitable for their project.

Managing Term, KPI, and Tag Relationships

Context

Editing the names and descriptions of your assets is a basic way to curate content in the catalog. However, you can also create tags, glossary terms, and key performance indicators (KPIs) that help you classify the content in your organization and get all data workers and consumers speaking the same language.

Once you have these objects in place, you can use them to enrich any asset by assigning glossary terms, KPIs, and tags. You can also create object relationships for the asset’s detailed metadata (for example, columns, attributes, measures, dimensions, and properties specific to the data object).

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 asset you want and choose it. For more information, see Searching for Data Products and Assets in the Catalog.
  3. On the asset details page, assign a term or KPI to the asset in one of the following ways:
    Option Steps

    From the Semantic Enrichment tab

    1. Choose the Semantic Enrichment tab and select the object type (term or KPI) you want to assign to the asset.

      For example, choose Start of the navigation pathSemantic Enrichment Next navigation step  TermsEnd of the navigation path. Under the Semantic Enrichment tab section for terms, you can see which terms have already been assigned to the asset.

    2. To assign an object, do the following:

      • If no objects are assigned, choose the Assign button (for example Assign Term).

      • If you are adding more object relationships, choose the Manage button.

      For example, to add a term relationship to an asset that has two assigned terms, choose Manage.

      Terms section showing Manage and Delete buttons highlighted.

    3. Optional: To filter on different options for the terms or KPIs, such as glossaries, KPI categories, or favorite or recent objects, choose (Show filters). To change the view of the results, choose (Display as Table) or (Display as List).

    4. In the dialog, select the objects you want to add to the asset.

    5. Depending on the relationship you are adding, choose the Add to Related button.

      For example, in the dialog for adding terms, select the terms you want to add and then choose Add to Related Terms.

      Manage Terms dialog with one term selected to add to the Related Terms panel.

    6. When you're done, save your changes.

    From the Asset Details

    1. In the tabs, choose Start of the navigation pathOverview Next navigation step  DetailsEnd of the navigation path.

    2. Choose the metadata tab that you want to enrich and in the table, select a row.

    3. Choose Manage.

      Details section with a row selected and the Manage button highlighted.

    4. In the dialog, use the filter to select which object relationship you want to create, Terms or KPIs. Depending on the type of metadata row selected, you can create relationships for terms, KPIs, or both.

    5. Optional: To filter on different options for KPIs and terms, such as glossaries, KPI categories, or favorite or recent objects, choose (Show filters). To change the view of the results, choose (Display as Table) or (Display as List).

    6. Select the terms or KPIs you want to assign, and choose Add to Related Objects.

    7. When you're done, save your changes.

    The lists in the term or KPI sections are updated with the object relationships you assigned. If you added terms from multiple glossaries, each glossary has a tab.
  4. To assign a tag to the asset, choose Start of the navigation pathSemantic Enrichment Next navigation step  TagsEnd of the navigation path.
  5. Choose one of the options depending on whether there are existing tag relationships.
    • If no tags are assigned and you want to add tags, choose the Assign Tag button.

    • If there are tag relationships, and you want to edit or remove tags, choose the Manage button.

  6. In the Hierarchy list, expand the hierarchy that contains the tags that you want to assign and select the tags.
    If you need help, choose the Generate button to use the SAP Business AI feature, which goes through existing tag hierarchies that have been exposed for AI-generated content and assigns the most relevant tags. Tag relationships are added, not removed. AI-generated content may contain inaccuracies. Verify results before use.
  7. When you're done, save your changes.
    The list in the tag section is updated with the tag relationships you assigned. If you added tags from multiple hierarchies, each tag hierarchy has a tab.

Results

In the Semantic Enrichment tab, the sections are updated with the term, KPI, and tag relationships you assigned. When users search for assets in the catalog, the search scans these relationships.

To remove a relationship, choose the (Delete) button for the row.

Semantic Enrichment tab with the Terms, KPIs, and Tags sections visible.

For the asset details, the Related Objects column is updated with the number of objects assigned to the row. You can select the number to see which objects are assigned. In the dialog that appears, you can choose (Edit) to add or remove objects, or choose the link to view the term or KPI details.

Related Objects dialog open for a data column in a table details view, showing associated terms.

Reviewing Asset Statuses

The asset details page displays a variety of status labels specific to assets. You can review the functional and publication statuses of the catalog assets to decide what actions you need to take to keep them in good shape and available for your users. Assets have the Extracted status to indicate that the metadata for the underlying object has been extracted to the catalog.

Asset details page showing the functional, publishing, and extraction statuses.

On the catalog search page, you can filter your search results by using the Publication Status and Functional Status filter categories. If you're viewing the impact and lineage analysis diagram, you can see the publication and functional status of the assets.

Functional Status

The functional status label on an asset conveys important information that you can use to check the integrity of the asset in relation to its source system. This helps you decide what actions you may need to take to keep your catalog assets in good shape for your users.

Users with the Catalog User role are only able to see published assets that have a functional status of Current with the Published status. Users with the Catalog Administrator role can see assets for all functional states regardless of their publication status.

Review the following table for a description of the different functional states.

Asset Functional Status

If the functional status Is

Then

Find out more

Current

The asset is in sync with its source system metadata and is up to date.

If the asset is not published, you can enrich it and then publish it so all catalog users can discover it.

Enriching and Managing Catalog Assets

Publishing Content to the Catalog

Outdated

The asset is out of sync with its source system metadata and is no longer up to date.

Run a manual synchronization for this asset's source system.

Manually Synchronizing a System

Referenced Only

This asset is referenced and used by another asset in the catalog but has no extracted metadata in the catalog.

Open the Impact and Lineage Analysis diagram to see how this asset is referenced.

Catalog Asset Details

Understanding Different Methods for Extracting Metadata

Remotely Deleted

The underlying object on the source system has been deleted or moved to a location that the authorized user cannot access. However, the catalog asset is still referenced by another asset in the catalog.

Open the Impact and Lineage Analysis diagram to see how this asset is referenced.

Catalog Asset Details

Understanding Different Methods for Extracting Metadata

Unavailable

Metadata for the underlying object cannot be extracted and the asset is out of sync. The asset is not referenced by other assets and can safely be deleted from the catalog. An asset can become unavailable in one of the following situations:
  • The object on the source system has been deleted.

  • The object on the source system has been moved to a location that the authorized user cannot access.

  • The authorized user for metadata extraction has been changed and has different access permissions to the source system than the previous authorized user.

  • For a BW object, the InfoArea where the object is located is no longer selected for metadata extraction.

  • The source system's connection to the catalog has been deleted.

Assets that are unavailable are automatically deleted from the catalog after 90 days from the date they were last updated in the catalog. You can manually delete an individual asset on the asset details page by choosing (Delete) or you can manually delete several assets on the catalog search page.

Understanding Different Methods for Extracting Metadata

Publication Status

When the catalog synchronizes with a source system, the objects in the source system become available as assets in the catalog. Depending on what the asset’s publication status is, the asset can be available to all users who use the catalog or only to users with the Catalog Administrator role.

Review the following table for a description of the different publication states, including which actions change an asset to a new state.

Asset Publication Status

If the publication status Is

Then

Find out more

Excluded

The asset can be searched for and viewed by users that have the Catalog Administrator role. For source systems that have automatic publishing enabled, the asset is excluded from being automatically published.

You can publish an individual asset on the asset details page by choosing Start of the navigation pathPublish Actions Next navigation step  PublishEnd of the navigation path or you can publish several assets on the catalog search page.

You can unpublish an individual asset on the asset details page by choosing Start of the navigation pathPublish Actions Next navigation step  UnpublishEnd of the navigation path or you can unpublish several assets on the catalog search page.

Publishing Content to the Catalog

Searching for Data Products and Assets in the Catalog

Published

The asset can be searched for and viewed by all catalog users. For source systems that have automatic publishing enabled, the asset is automatically published.

You can unpublish an individual asset on the asset details page by choosing Start of the navigation pathPublish Actions Next navigation step  UnpublishEnd of the navigation path or you can unpublish several assets on the catalog search page.

You can exclude an individual asset from automatic publishing on the asset details page by choosing Start of the navigation pathPublish Actions Next navigation step  ExcludeEnd of the navigation path or you can exclude several assets on the catalog search page.

Publishing Content to the Catalog

Searching for Data Products and Assets in the Catalog

Unpublished

The asset can be searched for and viewed by users that have the Catalog Administrator role. For source systems that have automatic publishing enabled, the asset is automatically published and the status is updated to Publish.

You can publish an individual asset on the asset details page by choosing Start of the navigation pathPublish Actions Next navigation step  PublishEnd of the navigation path or you can publish several assets on the catalog search page.

You can exclude an individual asset from automatic publishing on the asset details page by choosing Start of the navigation pathPublish Actions Next navigation step  ExcludeEnd of the navigation path or you can exclude several assets on the catalog search page.

Publishing Content to the Catalog

Searching for Data Products and Assets in the Catalog