DWC Data Catalog
DWC Data Catalog
Viewing the Documentation for an SAP Business Data Cloud Data Product. . . . . . . . . . . . . . . . . 69
Asset Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
The SAP Datasphere catalog is the central place to discover, enrich, classify, and publish high-quality, trusted
data and analytic assets and data products from across your enterprise.
Managing the vast amounts of data generated by and used within your organization is a challenge for any
business. It's not enough to access to your data, but rather find ways to unlock its value to advance the goals of
your business. A key part to a successful data strategy is to be able to ensure a single source of truth for your
data, while empowering people in your organization to use it in a self-service way.
Note
Data cataloging may not be available in SAP Datasphere tenants provisioned before version 2021.03. To
request the migration of your tenant, see SAP note 3268282 .
There are many challenges with getting value out of your data:
• It can be hard to know if a data asset or data product already exists in an organization.
• The meaning and intent of data assets or data products can be hard to discern without complete and
consistent documentation.
• Efforts to build data models or analytics can be duplicated, making it difficult to know the correct version to
consume.
• Data can become stale and unreliable for current use.
• It can be difficult for data creators to easily control which consumers have access to data.
An effective data governance strategy can address these challenges head-on. The SAP Datasphere catalog
helps you bring together all the data used by your organization into a governed, one-stop-shop experience for
anyone working with data in your organization.
Users with the Catalog Administrator role are responsible for the overall setup and data governance
implementation using the catalog. Their goal is to maintain an inventory of all data sources, build trust,
and make that trusted data available to users so that they can discover and consume data in a self-service
way. Depending on the amount of data and size of the organization, there could be one or several users to
administer the catalog. These users can apply governance to the data in the catalog:
• Connect: Add many different data source systems in the same landscape to the catalog and extract asset
metadata.
• Classify and enrich: Create and apply consistent business terms to an organization's data, and enrich the
data with descriptions, tags, and other information in one place.
These users can access a robust set of tools from the (Catalog) menu to perform these data governance
tasks.
Catalog users are data modelers looking for the single source of truth for certain domain data to build reusable
business models, or they are business modelers wanting to easily see which stories will be impacted by their
changes. Anyone who uses the catalog needs to find and understand data within an organization so they use it
to further the organization's business goals. By using the catalog, users can work with data in several ways:
• Discover: Search, filter, and explore the data items that are available in the catalog.
• Evaluate: View descriptions and other metadata about a particular data item to make an informed decision
about whether it's the item you want and how to use it. View its impact and lineage to see information
about its source, the transformations it goes through, its final state, and objects affected by changes made
to it.
• Use: After finding and evaluating a data item, users can do one of the following:
• Open the data asset to view the asset in its source system.
• Try the sample data from the marketplace data product.
• Use the data item as part of a data project to build something new.
The catalog brings together everyone into one seamless experience. Use it to map out a complete and
connected view of all your data sources, build and apply data governance standards and processes, and offer
trusted, self-service data discovery to all your users.
Now that you understand what the catalog is, what's next?
• If you want to learn more about the catalog, see Catalog Concepts [page 6].
• If you want a tour of the user interface (UI), see Catalog User Interface Overview [page 11].
If you have this role ... You can ... Find out more
Catalog User Use the catalog to find and use high- Finding and Accessing Data in the Cata-
quality data to consume in your data or
log
business models.
Evaluating and Accessing Catalog As-
sets
Catalog Administrator Use the catalog search and filter op- Find and Access Data in the Catalog
tions to find assets so you can enrich [page 15]
or publish them.
Catalog Administrator Set up governance for your data and Enriching, Classifying, and Publishing
analytic assets. [page 28]
Catalog Administrator or are a system Connect data sources to the catalog to Connecting and Monitoring Source Sys-
owner start extracting metadata. tems [page 77]
DW Administrator or are a system Give users access to the catalog. Standard Roles Delivered with SAP Da-
owner
tasphere
Learn about the major concepts related to the catalog and data governance.
Using the catalog to manage and govern the data landscape in your organization requires planning and
participation by different people in your organization. There are several key concepts that are important to
understand, and you’ll see these terms referenced throughout the help.
Assets
An asset is any data or analytic object made available in the catalog (for example, a local table or view
sourced from SAP Datasphere, or a story from SAP Analytics Cloud). Assets are the objects that you provide
governance around and publish to the catalog for users to discover, evaluate, and ultimately open and start
using for their work.
Catalog
The SAP Datasphere catalog is the central place to discover, classify, profile, understand, and prepare all the
data in your enterprise.
For an initial overview, see Governing and Publishing in Catalog [page 4], and to get a tour of the user interface
(UI), see Catalog User Interface Overview [page 11].
Data Providers
Data providers can be a person or a company that offer data products in the catalog. Data providers are
responsible for developing the data product, maintaining its lifecycle, and upgrading versions. They are also
responsible for licensing agreements and activation keys, data freshness, and API performance.
Data providers can create and manage data products on their own or they can work with a content aggregator.
Discovery
Discovery is the act of searching for and finding an asset of interest. The catalog home screen is the primary
entry point for users to discover the assets in the catalog that you've prepared and published. Search and
filters provide users easy-to-use methods of finding a data object or analytics content that they can then review
the details of and start using.
The business glossary provides a central and shared repository for defining terms and describing how and
where they are used in the business.
A business glossary can promote a common, consistent understanding of business terms within your
organization. The definitions provide context for the terms, and the term relationships provide additional
meaning. Term relationships are links to other terms and data assets. Aim to use the business glossary
Data governance is the set of processes, standards, roles, and measures by which an enterprise manages its
data assets. Having a well-defined data governance strategy allows your organization to ensure that the data
assets that employees use in their day-to-day work are:
• Well documented
• Consistent in their use of business language
• Securely accessed
• High-quality
• Trustworthy
The catalog pulls together key information about your data assets so you can make informed decisions about
which data to publish and determine who has access to use or view information about the data. The catalog
helps you to effectively implement your data governance strategy and improve data management across your
organization.
A key performance indicator (KPI) measures progress towards a result such as a goal or objective. A goal
or objective is the outcome that you want to achieve. Typically, goals use the SMART method of definition:
specific, measurable, achievable, relevant, and time bound. KPIs, on the other hand, are a metric that indicates
your progress in achieving the goal.
Use KPIs to provide an analytical basis for decision-making. Create relationships between KPIs and assets,
terms, and other KPIs, so that when you search for KPIs, you can find all the objects that are relevant to
successful goal results.
The Impact and Lineage Analysis diagram enables you to understand the lineage (also known as data
provenance) and impacts of a selected asset in the catalog. Impact and lineage contain information about
the source of the data, the transformations it goes through, its final state, and objects affected by changes
made to it.
• Lineage is displayed to the left of the object (or below it). It shows objects that the analyzed asset uses as
sources. It allows you to trace errors back to the root cause.
The Impact and Lineage Analysis diagram represents visually these movements and transformations from
source to destination.
Note
Marketplace data products are high-quality coherent data sets you can use with other data projects within SAP
Datasphere tenants in the same data region to help you make better business decisions. A single data product
contains a coherent set of data that can include business objects, entities, analytic data, and more.
Metadata
Metadata is the information about the asset itself: the name, description, source system where it originated
from, date when it was created on, and much more. Metadata should provide users with all the information
they need to make an informed decision about the utility of an asset they find in the catalog. Much of the
metadata comes from the underlying source system where the data resides and is made available to the
catalog through the extraction process. Users with the Catalog Administrator role can enrich an asset by
updating, enhancing, and adding to its metadata.
Certain metadata will be visible in the catalog home screen when users are searching for assets. Complete
metadata is available on the asset details page.
Metadata Extraction
Metadata extraction is the process of pulling information about assets from source systems to the catalog.
When users search for and find an asset, what they are seeing is the representation of that underlying data
After a source system is connected to the catalog, the catalog starts monitoring it. As objects are added,
edited, or deleted in the source system, the catalog detects these changes and automatically extracts new
or updated metadata in real time. However, there are certain conditions when you will need to manually
synchronize a system to extract metadata.
• After creating a connection to a source system that has existing data assets.
• After restoring a deleted source system to capture asset changes that occurred while it was deleted.
• After restoring a deleted space in an SAP Datasphere source system.
• After troubleshooting synchronization errors that appear in the extraction logs (for example, assets that
show missing metadata).
• After reauthenticating the source system user.
• After changing the authenticated system user’s access permissions on the source system or moving
content to different locations on the source system.
• After an application upgrade where the extraction status for a source system becomes Outdated on the
Remote Systems page.
Publishing
Publishing is the act of making assets visible and available to anyone who uses the catalog. Unpublished assets
are available only to users who administer the catalog. Before an asset is published to the catalog, a user with
the Catalog Administrator role can edit and enrich the metadata, apply appropriate classifications, and ensure
the overall quality of the asset.
Tags allow you to classify your data assets. Classification is the process by which you can organize your
assets into clear categories. The catalog provides a hierarchical tagging system that helps you to organize and
manage your tags. For example, let's say you have an inventory of bike products that you want to classify. You
could create a category called Bike Products and add these tags to your tag hierarchy:
• Bicycles
• Road
• Mountain
• Hybrid
• Comfort
• E-bikes
• Road
• City Cruiser
• Children's
Now that you understand the key catalog and data governance concepts, you’re ready to start planning for and
using the catalog. To get a tour of the user interface (UI) see Catalog User Interface Overview [page 11].
The catalog provides a variety of tools and features for both catalog consumers and administrators. Take a tour
of the user interface (UI) of the catalog and get familiar with where to find what you need.
(Catalog) is the main side navigation entry point to the catalog experience. For users with the Catalog User
role (1), this is the only side navigation option, and it opens the catalog home page.
Users with the Catalog Administrator role (2) have additional access to the Tag Hierarchies and Monitoring
pages to perform necessary administrative and data governance tasks.
Catalog Home
The catalog home is the central starting point to discover content in the catalog. All users with the Catalog
Administrator or Catalog User role can use the advanced search and filtering options to quickly find and access
published content. Users with the Catalog Administrator role have special actions they can perform from the
home page, including creating and managing glossaries, glossary terms, and KPIs.
(1) Search Lets you perform a free-text search across the entire catalog for content, such as data assets, data
products, data providers, business glossary terms, tags, data products, and key performance indica-
tors (KPIs).
As you type, the field will begin proposing objects and search strings. Select an object to open it
directly. Click on a string to start a search on it.
(2) Filter panel Lets you select filter options to narrow your search results. You can search initially within certain
collections, with further filter options to focus your search on the selected collection (for example,
select the Assets filter and then use further filter options to focus your search).
(3) Results The main area of the page that shows you the items that match your search and filter criteria.
(4) Action Toolbar Lets users with the Catalog Administrator role perform actions on selected items in the results view:
• Create: Create glossaries, glossary terms, KPIs, and their associated templates.
• Edit: Edit and manage glossaries, glossary terms, KPIs, and their associated templates.
• Publish Actions: Publish items to or unpublish items from the catalog. You can also choose to
exclude items from automatic publishing.
• (Delete): Delete items that have a functional status of Unavailable from the catalog.
(5) Display as Lets you switch between a grid view and list view to display search results. Users with the Catalog
Grid/List/Table Administrator role have a third option, Display as Table, when focused on the assets, terms, or KPIs
filters.
For help using the catalog home page to search and find data and analytics content you're interested in, see
Find and Access Data in the Catalog [page 15].
The catalog results area provides a preview of the object metadata. Depending on which tab you are on, you
can view the results by using these toggle buttons:
• (Display as Grid)
• (Display as List)
• (Display as Table)
You can view the object name, type, and description for all view types, and you can click the object name to be
taken to the object details page. Depending on your role as an administrator or user and the view type, you may
see additional details like the functional status, publication status, and more. For more information, see Find
and Access Data in the Catalog [page 15].
When you open an individual data item from the catalog home page, you're taken to a page that provides many
different types of information about it. This information can include extracted metadata, the name of the data
item, a summary description, and properties. For some items, you can also see an impact an lineage diagram
or data enrichments, such as glossary term, tag, and key performance indicator (KPI) relationships applied to
the asset.
You can use the information provided to evaluate and make an assessment on whether the data is the right one
you need for your business task at hand.
For help on reviewing the details for an item, see Evaluating and Accessing Catalog Assets and Evaluating and
Installing Marketplace Data Products [page 57].
The Tag Hierarchies page is where users with the Catalog Administrator role can create and manage all the tags
needed to consistently classify all assets in the catalog into clear categories. You can open this page from the
side navigation by selecting (Catalog) (Tag Hierarchies).
Key UI Highlights
Feature Description
(1) Search Lets you perform a free-text search in the tag hierarchies.
(2) Results The main area of the page that shows you the hierarchy, description, and details about the hierarchy.
(3) Edit Lets users with the Catalog Administrator role edit the hierarchy or tag.
(4) Create Tag Lets you create a tag or a child tag under an existing higher-level tag.
(5) Edit Tag Lets you change the name, description, or color of the tag.
For help on tags and tag hierarchies, see Enriching, Classifying, and Publishing [page 28].
Monitoring
The Remote Systems page is where users with the Catalog Administrator role connect the catalog to source
systems in your landscape and monitor metadata extractions to populate the catalog with assets. You can
open this page from the side navigation by selecting (Catalog) (Monitoring).
Discover data by searching and filtering results. Mark your favorite assets, terms, key performance indicators
(KPIs), listed marketplace data products, or data providers. For more information about these objects, see
Catalog Concepts [page 6].
The catalog provides an effective data governance strategy by bringing together an organized inventory of
business metadata and data assets to enable business and technical users to unlock the full potential of their
enterprise data. The catalog is a central place to discover, classify, understand, and prepare all the data in your
enterprise.
Use the catalog to find the single source of truth for your data domain to build reusable business models. With
the catalog, you can find which stories are impacted by your changes. It all begins by finding the data you need.
From the side navigation, click (Catalog) to access the catalog and start searching for assets. If you
are assigned the Catalog Administrator role, you can view all published or unpublished assets, terms, key
performance indicators (KPIs), listed marketplace data products, or data providers. If you are assigned the
Catalog User role, you can view published assets, terms, key performance indicators (KPIs), listed marketplace
data products, and data providers. You can use the search and filter options to narrow your search.
Note
Tip
If you can't find the asset you want, check the extraction logs for the source system to see if the asset failed
to synchronize. For more information, see Monitoring Data Source Extraction [page 100].
You can find objects globally by using the search bar and entering all or part of the characters in an asset, term,
key performance indicator, SAP data product, listed marketplace data product, or data provider.
Click (Search). The search results depend on whether you are assigned the Catalog User or Catalog
Administrator role. Administrators can view all assets, terms, KPIs, data products, and data providers. Users
can see the published terms, assets, KPIs, listed data products, and data providers that are in a current state.
Enter one or more characters in the Search field and press Enter (or click Search).
As you type, the field will begin proposing objects and search strings. Select an object to open it directly. Click
on a string to start a search on it.
Filter the search results based on selected criteria to limit the number of results.
There are tabs next to the Filter icon that you can use to narrow your results. The tabs shown are based on your
permissions:
Tab Description
Assets Shows only assets. An asset is any data or analytic object made available in the catalog.
Assets are the objects that you provide governance around and publish to the catalog for
users to discover, evaluate, and ultimately open and start using for their work.
Marketplace Data Products Shows only listed Marketplace data products that are created and used within SAP
Datasphere. Data products must be listed in Data Marketplace before they appear in the
catalog. A data product can be obtained through internal means or by acquiring free or
purchased data from a third-party provider, which can then be utilized within the product.
Data Providers Shows a list of providers that deliver data products to companies. A data provider
is a person or company that offers one or multiple data products through the Data
Marketplace.
Terms Shows only terms. Terms are contained in a business glossary and provide meaning to
your data. The business glossary provides a central and shared repository for defining
terms and describing how and where they are used in the business.
KPIs Shows only key performance indicators (KPIs). KPIs measure progress towards a result
such as a goal or objective. Use KPIs to track performance and provide an analytical basis
for decision-making.
Favorites Shows the assets, terms, KPIs, listed marketplace data products, and data providers that
have been marked as a favorite.
Recent Shows the assets, terms, KPIs, listed marketplace data products, and data providers that
have been recently viewed by you.
You can also open a side panel when you click (Show filters) to filter by these categories and more. Click
Show More to open a dialog with additional filter options.
After you use the search, you can apply filter options to narrow the results by assets, terms, and KPIs and the
different criteria in each of those categories. You can access the filter options by clicking (Show filters). Filter
by any of the categories listed in the Filter By area of the left panel.
For each filter category, you can select one or more values:
Assets that are a Local Table or View Type: Local Table, View
Assets that are a Local Table or View and on Type: Story, View
the system SAP Datasphere
System Type: SAP Datasphere
Note
When searching for assets using a string and applying the Container filter, you will not receive any results
for assets from an empty or deleted container. This means that an asset was in a container, but something
happened on the source system where the container was deleted or is now considered empty. However,
when no filters are applied, these assets appear in the search results with an Unavailable status.
For those filter options that are not related to date or time, you can create a custom filter with specific
conditions.
1. Click Show More at the bottom of a filter category to open the Filter Settings dialog. Some filters have a
Select Items and a Define Conditions tab.
2. On the Define Conditions tab, choose an operator and enter a value in the Filter Condition box.
3. Click the plus icon to create an alternative condition. Each condition in one category acts as an OR
operator, so that an object must meet one of the conditions to be included in the search results. If you
define one condition in two categories, then each category acts as an AND operator, so that both conditions
must be true for the object to be returned in the search results.
You can create advanced filter conditions for multiple filter categories. An object must meet one of the
conditions in each of the categories to be included in the search results.
Example
For example, if you are viewing terms and want to create a condition to filter on the keywords “investment”
and “stock”, you would click (Add). Then choose Contains all of these words. In the Filter Condition box,
enter investment. Click (Add) again. Choose Contains all of these words. In the Filter Condition box,
enter stock, and then click OK. The new condition is listed in the Keyword group in the filter panel, and the
filter results are automatically shown.
Depending on which tab you are on, you can view the results by using these toggle buttons:
• (Display as Grid)
• (Display as List)
• (Display as Table)
• Favorite
• View Details
• Delete (multiselect)
• Favorite
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Exclude (multiselect)
• Delete (multiselect)
• Favorite
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Delete (multiselect)
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Delete (multiselect)
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Exclude (multiselect)
• View Detail
• Delete (multiselect)
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Delete (multiselect)
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Delete (multiselect)
• Favorite
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Exclude (multiselect)
Available actions:
• Delete (multiselect)
• View Details
• Publish (multiselect)
• Unpublish (multiselect)
• Exclude (multiselect)
• Favorite • Favorite
• View Details • View Details
You can use the Datarade Data Finder website to search and request additional third-party data products from
various data providers. Access the Datarade website from the catalog by choosing the Data Products tab or the
Data Providers tab, and then clicking the Request Data from Datarade button.
Note
Clicking the Request Data from Datarade button takes you to the Datarade website. This site is external to
our product.
Users with the Catalog Administrator role or appropriate privileges can set up governance for assets using
hierarchical tags and business glossaries, create KPIs to measure progress towards company goals, and
publish assets, glossary terms, and KPIs to the catalog.
Tip
After an asset is enriched, the date the asset was enriched on and the name of the user who made the
change appears on Overview tab of the asset details page.
Enriching Metadata
You can improve the information of an asset by editing its name, adding a custom description, and creating
relationships with tags, terms, and KPIs. These improvements enrich the information about the asset so that
anyone who uses the catalog can evaluate the asset and determine if it's the one they need.
Prerequisites
Catalog assets are created by extracting metadata from the underlying data or analytic objects in your
connected source systems. This brings a lot of useful information into the catalog about an asset that can help
users understand what they are looking at. But often the information lacks the polish and consistency needed
for a usable experience. Names of source system assets may be too technical in nature for business users, or
not aligned with standard business language in your organization. Descriptions may not clearly communicate
the business value or be outright missing.
You can use the tools on an asset's information page to improve and supplement the information that will
curate a better discovery and evaluation experience for your users.
Note
If the status of an asset is Unavailable or Remotely Deleted, you cannot edit or enrich the asset.
Context
When assets are added to the catalog, the default names of objects and the description are from the source
system. The name might not be easy to understand and the description may not clearly communicate the
business value or be outright missing. To help users quickly determine whether the asset is the one they need,
you can edit the asset name so that it’s more useful and understandable and add a custom summary and
detailed description to give users a better idea of how the asset can be used.
When you add the summary and a custom description, it's important to include words that users might use
to describe the asset. When users search for assets, the text in the name, summary, and description are
scanned during the search.
Procedure
Note
Images must be hosted elsewhere and are not saved in the repository. When adding an image, you
provide a link to the image, which can be accessed from the browser when viewing the description. The
image will appear embedded in the description.
The name, summary, and custom description for the asset are updated in the catalog. When users search for
assets in the catalog, the search scans the name, summary, and description text.
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
Option Steps
From the Seman- 1. Click the Semantic Enrichment tab and select the object type (term or KPI) you want to
tic Enrichment assign to the asset.
tab
For example, select Semantic Enrichment Terms . 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, select the Assign button (for example Assign Term).
• If you are adding more object relationships, select the Manage button.
For example, to add a term relationship to an asset that has two assigned terms, select
Manage.
3. (Optional) To filter on different options for the terms or KPIs, such as glossaries, KPI catego-
ries, or favorite or recent objects, select (Show filters). To change the view of the results,
click (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, select the Add to Related button.
For example, in the dialog for adding terms, select the terms you want to add and then select
Add to Related Terms.
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 catego-
ries, or favorite or recent objects, click (Show filters). To change the view of the results,
click (Display as Table) or (Display as List).
6. Select the terms or KPIs you want to assign, and select 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.
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.
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 select
(Edit) to add or remove objects, or select the link to view the term or KPI details.
Tagging assets can help you understand your data and its relationships to other assets.
A tag hierarchy is a multilevel grouping of tags. The purpose for having tags and assigning them to assets is to
be able to search for all the assets that have been assigned that tag. Finding assets that have the same tags
could help you govern the data and make informed decisions about the assets.
Account
For example, you could have data with personal identifiable information (PII) such as bank account numbers
and government identification numbers. Therefore, you can create a tag hierarchy of tags like this:
• PII
• bank
• name
• birth date
• address
• account numbers
• government
Tagging the assets and data helps you to identify all the sources with similar content.
Note
Create a Hierarchy
Context
Procedure
After the hierarchy is created, you cannot edit the multiselect value.
6. (Optional) Enable Show in Filter Panel to view the hierarchy in the panel on the left. While it is convenient to
see the hierarchy in the filter panel, doing so can impact performance.
7. Click Save to create the hierarchy and close the dialog.
Context
Add tags to a hierarchy. Use these steps when you've created a hierarchy, and you want to immediately add
tags.
Procedure
Context
After looking at the details for an asset, you could think of additional tags that you want to include in the tag
hierarchy.
• To create a top-level (parent) tag, click (Create Tag) next to the Search box.
• To create a child tag, click the tag that you want it under, and then click (Create Child Tag).
Procedure
• To edit the name or description, type the new text in each option, and then click Save.
Note
• To delete the hierarchy and the tags within the hierarchy, click Delete. After the Delete Warning
appears, click Yes to confirm that you want to delete the hierarchy.
Procedure
• To edit the name or description, type the new text in each option. You can also select a new color for
the tag. Click Save.
• To delete the tag, click Delete.
On the Semantic Enrichment tab of the asset details page, you can add, edit, or remove tags.
Add tags to your assets. When you are done, you'll be able to search for all the assets that contain that tag. You
can add multiple tags from one or more hierarchies. However, if your hierarchy disabled the Multiselect value,
then you can add one tag from that hierarchy only.
After the tags have been added to an asset, you can edit the tag (for example, change the tag color or name
and description), or remove the tag from the asset. Removing the tag from the asset doesn't delete the tag
from the hierarchy.
Note
Procedure
• If no tags are assigned and you want to add tags, select the Assign Tags button.
• If there are tag relationships, and you want to edit or remove tags, select the Manage button.
5. In the Hierarchy list, choose the hierarchy that contains the tags that you want to use.
6. In the dialog, select the tags that you want to assign.
7. When you're done, save your changes.
Results
The list is updated with the tags you assigned. To remove a tag, select the (Delete) button for the row.
The business glossary provides a central and shared repository for defining terms and describing how and
where they're used in the business.
A business glossary can promote a common, consistent understanding of business terms within your
organization. The definitions provide context for the terms, and the term relationships provide additional
meaning. Term relationships are links to other terms, KPIs, and assets. Aim to use the business glossary
enterprise-wide or division-wide and make the terms as clear and understandable as possible. For example,
what does "Sales" mean to your organization? Is it currency exchanged for goods or services? Is it a discounted
price on a product? Both definitions are correct, and creating the correct definition for your organization helps
reduce ambiguity.
• The glossary template defines guidelines and the additional information that is required or optional when
the terms are defined.
• The categories group the terms.
• The defined terms provide clarity for the business.
When you create a glossary, you can choose a reference template or you can define the glossary without
a template. A reference template pulls the definition and custom attributes from an existing glossary. Any
changes in the definition or custom attributes are not changed in any other glossaries; rather, it is unique to
this glossary that you created. After you save the glossary, it appears in the list of reference templates for any
glossaries that are created in the future.
You can add all types of information in your term definition. For example, you can add links to external sites,
pictures, and different fonts.
You can create a set of custom attributes for a term. The attributes can be free text or validated using minimum
and maximum values or lookup tables. You can set the extra fields as required or optional. You can group
the input fields into separate tabs or together on one tab. Create labels for the fields that add context and
offer guidance for users when they create terms. For example, you can create a Quality Assurance group with
defined custom attributes that contain a Definition Date option and require that the option is defined. You can
also create an Approved attribute that is optional.
You can also define the category hierarchy. Subject matter experts create and define the terms, create term
relationships, and place them in the categories. Then they publish the term so everyone in the organization can
view the terms. When business users have questions about terms, they search the business glossary and find
the definition and term relationships.
Create categories to group your terms and definitions. Make clear definitions for your terms and include
keywords, synonyms, and relationships to provide additional context.
For example, a business can have these categories, terms, and definitions within a Finance category:
Interest Annual Percentage Percentage of the loan APY, interest, rate APR, Annual
Yield or savings amount Percentage Rate
including compounded
interest.
Interest Annual Percentage Percentage of the loan APR, interest, rate APY, Annual
Rate or savings amount Percentage Yield
including other fees
and costs.
Interest Compound Interest Money that is earned principal, interest compounded interest,
and added to an compounding,
account balance so accrued interest
the interest and
principal both earn
interest.
Funds Mutual Fund A mix of different investment, stocks, bond fund, retirement,
stocks or bonds. bonds
Funds Exchange-Traded A mutual fund traded ETF, stock, index mutual fund, index
Funds like stocks on a fund
stock exchange. ETF
typically follows the
performance of a
particular index such
as the S&P 500 Index.
You can create multiple business glossaries. Each business glossary can use a custom term template with its
own criteria for term definitions, or you can copy a reference template from an existing glossary. A reference
template copies the groups and the custom attributes in each group from an existing glossary. The changes
you make in your new glossary are then saved as its own glossary. The template changes do not affect any
other glossaries that use the template. The new glossary name appears as a reference template for another
new glossary in the future. After you have saved the glossary, you cannot choose a different reference template.
To learn more about defining a glossary and terms, see Using the Business Glossary [page 39].
Note
Create a Glossary
Procedure
• To use a blank term template, leave the Reference Template option blank.
• To use an existing template, choose it from the Reference Template list.
6. (Optional) Enter a definition with guidelines about what should be included in terms for this glossary.
This definition appears as default text for each new term, so you can provide a template or describe any
standards that term creators should follow.
7. (Optional) Click the Custom Attributes tab and create your attributes.
a. Click the Add Custom Attribute Group button.
b. (Optional) Click Add New Tab, and then enter a name for the group.
c. (Optional) Click Add Attribute.
d. Enter a name for the attribute.
e. (Optional) Enter a description.
f. Choose the data type. Some data types have additional options to complete.
Boolean N/A
Date N/A
• List of Values: Enter a list of integer values that the user can choose. If
multiple values are acceptable, click Multiselect.
• Range: Enter the Minimum and Maximum values that the user can
choose.
Note
For those data types with the Mulitselect option, you can initially set the Mulitiselect option to
off, and then change it to on if you change your mind. You can also change the validation type.
However, if you initially set the Multiselect option to on, then you cannot turn it off or change the
validation type after it is saved.
g. Choose whether you want the attribute in the Left or Right column in the Display Column option.
h. (Optional) Click Required if users must define the attribute before the term is valid.
i. Click OK to return to the template.
8. Click Save to return to the catalog. Updating custom attributes can change the state between Valid and
Needs Repair. Use the search functionality to find and fix those terms that have become invalid because
the validation type or required options changed.
Edit a Glossary
Procedure
Procedure
The business glossary categories are a hierarchical structure that contains the business terms. The business
terms can be included in multiple categories. For example, a financial business that has the categories of
Businesses Finance and Individual Finance can have the terms Customer ID and Budget in both categories.
Note
Prerequisites
Procedure
Procedure
• To edit the name or description, type the new text in each option, and then click Save.
• To delete the category and any child categories, click Delete.
6. Click Done to return to the catalog.
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.
When the assets have relationships with each other, you can gain more insight into the meaning of your data.
For example, you can create relationships from one term to another term. You can also assign a term to an
asset, KPI, or another term. The list of relationships can give a complete picture of the term's relevance to the
business.
Note
Create a Term
Procedure
Note
Images must be hosted elsewhere and are not saved in the repository. When adding an image, you
provide a link to the image, which can be accessed from the browser when viewing the definition. The
image will appear embedded in the definition.
9. (Optional) Define the term relationships to other objects such as other terms and assets. For more
information about setting relationships, see Manage a Term Relationship in this topic.
Edit a Term
Procedure
Context
On a term's page, you can add and remove relationships to assets, KPIs, and other terms. However, if you want
to add relationships to an asset's attributes, measures, and dimensions, use the asset details page.
Procedure
The Manage Relationships dialog opens with a list of terms, KPIs, and assets.
6. (Optional) In the search bar, select either Assets, Terms, or KPIs from the dropdown list for the object you
want to create a relationship.
7. (Optional) Enter all or part of the object name in the Search box to further refine the results.
8. (Optional) To filter on different options for assets, KPIs, and terms, such as glossaries, KPI categories, or
favorite or recent objects, click (Show filters). To sort the list aphabetically, click (Sort). To change
the view of the results, click (Display as Table) or (Display as List).
The objects are placed in categories in the Related Objects panel on the right.
10. (Optional) To delete a related object, click the X next to the object in the Related Objects panel.
11. Click Save to return to the term.
Tip
Use the asset details page to manage term relationships for an asset in one of the following ways:
• Select Semantic Enrichment Terms . If no terms are assigned, select Assign Terms. If you
are adding or removing terms, select the Manage button. If you want to remove a term, select the
(Delete) button for the row.
• Select Overview Details . Select the metadata tab that you want to enrich and in the table,
select a row. In the toolbar for the table, select Manage.
Publish the term so Catalog Users can view the term, or unpublish the term so they can't view the term.
Procedure
Note
Any unpublished terms that have an error cannot be published until the errors are corrected.
Delete a Term
Procedure
Related Information
A key performance indicator (KPI) measures progress towards a result such as a goal or objective.
A goal or objective is the outcome that you want to achieve. Typically, goals use the SMART method of
definition: specific, measurable, achievable, relevant, and time bound. KPIs, on the other hand, are a metric
that indicates your progress in achieving the goal.
A set of KPIs can track performance while providing an analytical basis for decision-making. For example, if
you have one KPI indicating success, and another KPI indicating underperformance, then you can decide to
allocate more attention or resources to examining the underperforming KPI to increase its chance for success.
Understanding how different types of measures and various metrics are used can increase knowledge and trust
in KPI use.
Note
The KPIs that you use to create a relationship to other assets do not perform any calculations on those
assets.
After you have found the source systems, you can create relationships and link them to this KPI. While defining
the KPI, you can specify that the calculation is "CRR=Number of customers at the beginning of a period /
number of those customers that remained customers at the end of a period". Then the detailed documentation
can include the steps for finding the source systems and creating a workflow to get the data necessary for
tracking each month.
You can create another KPI that can be related to this KPI in the Related Objects tab. For example, you can
have a KPI that tracks the number of new customers this year that uses the same source systems, does a
comparison, and then you create a table with the new customer information.
Note
Procedure
A dialog opens with all the KPI categories. Click the checkbox next to the categories that you want
associated with this KPI, and then click OK. You can select up to 25 categories.
5. (Optional) Enter up to 10 keywords by typing the words and pressing Enter after each word.
6. (Optional) On the Definition tab, choose the definition type.
7. (Optional) Select a type of measure.
8. (Optional) Select the unit of measure.
9. (Optional) Set one or more threshold ranges.
a. Click Add Range.
b. Choose a color and then assign a label for the value. For example, yellow could have a label of
"Warning". You can change the default value. For example, you can change the green value of "OK" to
"Pass".
c. Choose an operator from the table.
Operator Example
10. (Optional) Enter a calculation that represents the detailed definition. For example, the calculation could be
E=mc2 and the definition could be: E=energy, m=mass multiplied by c= the speed of light 2=squared.
11. 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 (images and links to videos), and so on.
Note
Images must be hosted elsewhere and are not saved in the repository. When adding an image, you
provide a link to the image, which can be accessed from the browser when viewing the definition. The
image will appear embedded in the definition.
Note
13. (Optional) Click the Relationships tab to define the KPI relationships to other objects such as other KPIs,
terms, and assets. For more information about setting relationships, see Manage a Key Performance
Indicator Relationship in this topic.
Note
14. (Optional) Use the additional tables to set any custom attributes as defined in the KPI template.
15. Click Save to view the completed KPI or click Save and New to create another KPI.
Context
On a KPI's page, you can add and remove relationships to assets and other KPIs. However, if you want to add
relationships to an asset's attributes, measures, and dimensions, use the asset details page.
Note
To delete a relationship with a term, open the term and follow the steps in the Create and Manage Glossary
Terms [page 44] topic.
Procedure
Note
Relationships can only be created on existing KPIs. If you're creating a KPI, you need to save the KPI
before managing the relationship.
The objects are placed in categories in the Related Objects panel on the right.
10. (Optional) To delete a related object, click the X next to the object in the Related Objects panel.
11. Click Save to return to the KPI.
Tip
Use the asset details page to manage KPI relationships for an asset in one of the following ways:
• Select Semantic Enrichment KPIs . If no KPIs are assigned, select Assign KPIs. If you are
adding or removing KPIs, select Manage. If you just want to remove a KPI, select the (Delete)
button for the row.
• Select Overview Details . Select the metadata tab that you want to enrich and in the table,
select a row. In the toolbar for the table, select Manage
Publish the KPI so that Catalog Users can view the KPI, or unpublish the KPI so they can't view the KPI.
Procedure
1. From the main catalog page, click the checkbox next to one or more KPIs that you want to publish or
unpublish. You can publish or unpublish multiple KPIs at the same time if you are performing the same
action. For example, you can't select a published and unpublished KPI and attempt to publish them.
2. Click the Publish Actions button, and then either choose Publish or Unpublish.
Edit a KPI
Context
You can make changes to the name, description, categories, keywords, and more.
Procedure
Option Description
Edit At the top of the screen, click Edit to open a dialog to change the name,
summary, categories and keywords.
Edit Definition In the Definition area, click Edit Definition to change the property type,
measure type, default unit or the calculation description. You can also add,
remove, or change the threshold values.
Edit Content In the Documentation area, click Edit Content to change the text. You can also
change the font, add or remove links and more.
Manage Details In the Related Objects area, click Manage Details to add or delete relation-
ships with this KPI. If the relationship is indirect, you must open that object to
remove the relationship.
Custom Attributes If you have custom attributes, click Edit in the area with your custom attrib-
ute name to make changes to those attributes.
3. Click Save.
Context
Deleting a KPI removes the relationships to and from other objects. The KPI is permanently removed from the
catalog.
Procedure
Related Information
The purpose of assigning categories to your KPI is for two reasons: to organize your KPIs and to help you find
the KPI while searching.
The KPI categories are separate from glossary categories, so you won't see any glossary category entries when
creating or editing your KPI categories. The KPI categories are in a hierarchical structure. For example, see the
following hierarchy:
• Customer Service
• Tickets closed in 12 hours
• Tickets closed in 48 hours
• Customer satisfaction
When you search on a category, you can find the number of KPIs associated with the category in the search
results. Categories can be assigned to multiple KPIs. If you assigned a child category to the KPI, but not the
top-level category, you could still find the KPI when you search on the top-level category name. For example,
Note
Create a top-level category 1. Click the Create Category button next to the Search categories box.
2. Enter a name and description (optional), and then click Save.
Create a child category 1. Click the category where you want a category within it.
2. Click Create child category in the same row you highlighted (next to the
pencil icon).
3. Enter a name and description (optional), and then click Save.
Edit a category 1. Click the Edit category button in the same row as the category that you
want to edit.
2. Edit the name or description, and then click Save.
Delete a category 1. Click the Edit category button in the same row as the category that you
want to edit.
2. Click Delete.
Define the elements to be included in all your key performance indicators (KPIs).
The KPI template generates consistency for those individuals who create KPIs. By defining the KPI template,
you determine the required elements and KPI standards. For example, you can create custom attributes so that
a KPI must be reviewed by one or more people and have a sign-off date.
Within the template you can create custom types, measurement types, and units of measure. For example,
you can have a measure type of "density" and a default unit of "grams per cubic centimeter" or "kilograms per
cubic meter".
In the KPI definition, you can give guidelines for measuring KPIs. It can have specifications per department. For
example, the customer service guidelines can say that the KPIs must reference customer satisfaction with the
incident.
After the KPI template is set, all KPIs use the one template. If someone edits the KPI template and adds a
required attribute after one or more KPIs have been created and published, then the KPIs have an error and
should be updated with the required template value. Catalog Users are still able to view the published KPI.
Any unpublished KPIs that have an error cannot be published until the errors are corrected. Use the search
functionality to find and fix those KPIs that have become invalid because the template required options have
changed.
Note
Procedure
Boolean N/A
Date N/A
Note
For those data types with the Mulitselect option, you can initially set the Mulitiselect option to off, and
then change it to on if you change your mind. You can also change the validation type. However, if you
initially set the Multiselect option to on, then you cannot turn it off or change the validation type.
11. Choose whether you want the attribute in the Left or Right column in the Display Column option.
12. (Optional) Click Required if users must define the attribute before the term is valid.
13. Click Save to return to the template or Save and Close to return to the catalog.
You can search and browse for marketplace data products. When you find a marketplace data product, you can
select it to view information about it to make sure it’s the right one for your business needs.
Prerequisites
• DW Viewer
• DW Modeler
• DW Integrator
You also must be assigned as a member user for one or more spaces and be a member of one or more
contexts.
Note
If a data product is delivered using the Open SQL delivery mode, you must have access to a space and an
Open SQL schema with credentials that you can share with the data provider.
From the (Catalog) home page, you can select the Marketplace Data Products filter to show only market
place data products. Marketplace data products are high-quality coherent data sets you can use with other
data projects within SAP Datasphere tenants in the same data region to help you make better business
decisions.
For each data product, you'll see the a preview of the data product, including its name, data type, and a short
summary. When you find a data product that might suit your needs, select it to view its details page that
provides many different types of information about it. This information can include a preview of its pricing
information, marketing description and images, terms of use, and more.
For example, when a data modeler reviews the details of a data product, they can review the pricing and
installation information, review the terms of use and other supplemental documents, and download and test a
sample dataset (if available).
Field Description
Name and Type Displays the data product name and type.
Status and Product Displays the lifecycle status of the data product and the number of times it was viewed.
Views
• A data product that is listed is active and available for public or limited visibility. Catalog users
can search for the data product.
• A data product that is delisted is inactive and no longer available for consumers. Consumers
who obtained the data product before it became inactive can still use it. However, support and
updates from the data provider might be limited or not available.
Provider Displays the name of the data provider and contact information.
Contexts Displays the context for the data product. Contexts control who has access to the data product.
For a user to be able to use a data product, they must belong to a context that is assigned to the
data product.
Access and Price Displays the license access type and the price for the data product.
• Open: The data product is free of charge and does not require a license key to activate it.
This data product can be part of public domain data or data provided by a commercial data
provider as give-away data. This data product is activated after accepting the data specific
terms of use.
• License Key: The data product requires a license key to activate it. The license key provides
authorization to access one or multiple data products. License keys can be used for commer-
cial data products, where the data provider sends the license key via email after closing the
commercial agreement, or for any other type of product that needs access authorization (for
example for scenarios where non-public data is exchanged without payment).
• On Request: The data product must be requested from the data provider before you can have
access to install it.
For data products that require you to purchase a license key, the price, currency code, and pricing
model are displayed.
Catalog Activity Displays the date when the data product was added to the catalog and when it was updated.
Toolbar The following tools are available for the data product.
Tabs Select a tab to view more information about the data product, such as an overview of the data
product's properties, sample data, terms of use, and more.
You can view the properties of the data product by selecting the Overview tab Properties .
• Data product properties are properties directly related to the data product, such as the name, shipment,
lifecycle status and delivery mode of the data product.
• Source properties are properties about the data provider or data aggregator.
For more information about properties not described here, see the documentation for the data product.
Business Name Displays the business name for the data product.
Data Shipment Displays how the data product will be delivered to your space. The shipment varies depending on
how the data provider offers the data product.
• Integrated Delivery: The data is copied directly into the selected space. After the data product
is activated, it is visible in the Repository Explorer, where it can be selected for use in an
SAP Datasphere project. For example, the data product can be used as a source in the Data
Builder. This type of data shipment is managed by Data Marketplace.
• External Delivery: The data is delivered by sharing files outside SAP Datasphere. This type of
data shipment is managed by the data provider.
• Open SQL: The data is delivered by using an Open SQL Schema. Consumers create an
OpenSQL Schema in the space and provide the information to the data provider using the
Data Inbox. Once the data product is activated, consumers can access the data through the
Data Builder and the provided schema appears as a source. This type of data shipment is
managed by the data provider.
Delivery Pattern Displays the update cycle of the data product. For example, a data product can be updated
biweekly, daily, monthly, quarterly, weekly, yearly, or other.
Size Category Displays the size of the data product, using the following ranges.
• A data product is active when it is listed and available for public or limited visibility.
• A data product is inactive when it is delisted, deactivated, deleted, or in draft. These data
products are not available for consumers. Consumers who obtained a previously active data
product before it became inactive can still use it. However, support and updates from the data
provider might be limited or not available.
Delivery Mode Displays whether new deliveries (for example, data updates) are offered by the data provider and
how these deliveries affect the existing data.
• Full Replication: Delivers multiple data updates. You can find the updated data under My Data
Products.
• Live Access: Delivers data within the same tenant without replication. Because the data view
is shared live with the target space, the data is always up-to-date and doesn’t require any
update. In the target space, under Shared Objects, you can find the views in the repository
corresponding to all other views shared with the space
• One-Time Replication: Delivers data only once without any additional corrections or updates.
This type of delivery is suited when the nature of the data doesn't require a refresh on the
consumer side. For example, a snapshot of historical facts such as: NYC Taxi Trip Data of
2020. If the consumer needs to receive data corrections, they can re-load the data through
My Data Products re-initialization.
Note
For data products that require a license key, the license validity is not effective for products
with live access delivery.
Delivery Pattern De- Displays the description of the delivery pattern for the data product.
scription
Visibility Displays who (public or private) can view the product details. Currently, only public data products
can be offered and can be seen by all users.
Additional Properties Displays the additional properties for the data product. These properties are hidden by default and
are visible after you select the Show More link.
• Data Category: Displays one or more categories where the data product can be used.
• Industry: Displays one or more industries where the data product can be used.
• SAP Application: Displays one or more SAP Applications where the data product can be used.
• Regional Coverage: Displays the countries and regions the data product is assigned for.
Content Aggregator Displays the content aggregator's name. A content aggregator is a company that manages one
or multiple data provider profiles and that creates the data product content on behalf of one or
multiple data providers. For more information, see Data Provider Vs Content Aggregator.
Data Provider Page Displays a link to the data provider profile page that provides additional information about the data
provider and other data products or product groups.
Data Provider Products Displays a link that shows the number of additional data products from the data provider.
You can view the details of the data product by selecting the Overview tab Details .
This section has tabs for sample data, available objects, and installations. Each tab has a table shows a preview
of up to 20 rows. If there are more than 20 rows, select Show All to see the rest of the rows for the tab in a
separate page.
Tab Description
Sample Data Review the contents of a sample dataset and download it if you think it might work for your needs.
Sample data is usually in JSON format, but can only be downloaded as a Microsoft Excel file. Some
data products offer free sample data that you can activate and then use for testing purposes.
Available Objects View a preview of all available dimensions and measures in the data product. The information
available for the dimensions and measures includes the name of the object, a description, the
attribute, delivery mode, and data filter.
Installations Review the installations for the data product. The information available includes the space name
where the data product is installed and the date it was installed on.
You can view supporting documentation for the data product by selecting the Documentation tab.
Pricing Displays the pricing information, the price with the currency code, and pricing model (one time or
monthly) for the data product. If you need to purchase a license key for the data product, you can
select the URL for License Key Purchase to purchase your own license.
Terms of Use Displays the terms of use for the data product. As a best practice, review the terms of use before
installing the data product. By installing the data product, you agree to the terms as outlined by
the data provider.
Attachments Displays a list of additional documents for the data product. These documents can include the
following types:
• Legal: Documents that outline the legal agreement between you and the data provider for
using the data product.
• Supplemental: Documents that describe the data available in the data product or provide
other information about the data product and its terms of use (for example, warranties and
refund policies).
Context
After you find the data product you want and have evaluated it, you might want to test a sample dataset to see
if it’s really what you need.
Procedure
3. When viewing the page for the data product, select Overview tab Details , and select the Sample
Data tab.
4. Select a dataset and review the preview of the sample data.
5. If the dataset is suitable, download it.
Open the file explorer on your computer to find the sample dataset and then use it where you need it. If it
passes all your tests and satisfies your business needs, you can go back to the data product and install it in the
space that you need it in.
Context
After you decide that the data product is what you need, you can install it in any space you have access to and
use in a data project.
Procedure
The data product is installed in the space you selected. You can go to the Repository Explorer to find the data
product and use it in a data project as a source. For example, in the Data Builder, you can create a graphical
view. For information on preparing data in the Data Builder, see Preparing Data in the Data Builder.
• Go to the My Data Products page to review and manage the data products you have installed. You can also
see when they were last updated and their delivery status. For more information, see Managing your Data
Products.
• Go to the My Licenses page to keep track of your licenses. For more information, see Managing your
Licenses.
• Go to the My Contexts page to manage the contexts you are member of. For more information, see
Managing your Contexts.
Prerequisites
To search for and view the details of a data product, you must be assigned one of the following:
To install and then use a data product, you also need to be assigned one of the following:
From the (Catalog) home page, you can select the SAP Business Data Cloud Data Products filter to show
only data products from other SAP apps or from third-party apps. SAP Business Data Cloud data products
For each data product, you'll see a preview of the data product, including its name, data type, and a short
summary. When you find a data product that might suit your needs, select it to view its details page that
provides many different types of information about it. This information includes properties about the data
product, detailed information about the APIs, and external resources that can provide information or examples
on how to use the data product.
For example, when a data modeler reviews the details of a data product, they can check out any of the external
resources to get information about how to use the data product. They can also review individual APIs and learn
how to extend them.
Field Description
Name and Type Displays the data product name and type.
Status and Version Displays the lifecycle, release, and functional statuses of the data product and the version number.
Catalog Activity Displays the date when the data product was added to the catalog and when it was updated in the
catalog.
Toolbar The following tools are available for the data product.
• Open Version History: Opens a dialog that shows the change history for the data product.
• (Add to Favorites): Adds frequently used data products to your favorites.
Tabs Select a tab to view more information about the data product, such as an overview of the data
product's properties, external references that give your more information on the data product, and
more.
You can view the properties of the data product by selecting the Overview tab Properties .
• Data product properties are properties directly related to the data product, such as the name, category,
entity types, and more.
• Source properties are properties about the data provider system and type.
For more information about properties not described here, see the documentation for the data product.
Business Name Displays the business name for the data product.
Input Ports Displays the inputs ports for the data product.
Entity types Displays the entity types for the data product.
ORD ID Displays the open resource discovery (ORD) identifier for the API.
Version Displays the latest version number of the data product. Select Open Version History to see all
version changes for the data product.
Changed On Displays the date and time when the data product was changed.
Extensibility Displays whether the data product is extensible and be enhanced. The data product can be
manually or automatically extensible or not extensible at all. If a data product is extensible, you
can select an API to view extensibility details.
Additional Properties Displays the additional properties for the data product. These properties are hidden by default and
are visible after you select the Show More link.
• Policy Level:
• Industry: Displays the industries the data product is relevant for.
• Tags: Displays tags that have been linked to the data product.
• Line of Business: Displays one or more business areas where the data product can be used.
Source Properties
Field Description
System Name Displays the name of the data provider's system. The provider system can be the name of an SAP
tenant not in the same landscape or third-party system.
Deployment Region Displays the regions where data product has been deployed.
Application Name- Displays the application namespace that identifies the data provider system.
space
You can view a list of APIs for the data product by selecting the Overview tab Details . This table provides
high-level information for each API. The information includes the API's name, description, and version, the APIs
protocol, supported use cases and more. Review the list to see which APIs best suit your needs. If there are
more than 20 rows, select Show All to see the rest of the rows for the tab in a separate page.
Description Displays a description for the use and purpose of the API.
Supported Use Cases Displays the API use cases, if provided. If you don't see this column, select (Select Columns) to
show it.
You can select an API to view its details page, where you can learn more about it. The API details page has a
similar layout to the data product details page, where information is separated into the following areas:
• API properties that include all the same high-level information of the API list plus other information, such
as its open resource discovery (ORD) identifier.
• Available objects in the API and their container path.
• Documentation that provides a more detailed description of the API, external links that can give you more
information on how to use it, and extensibility information.
You can view additional information for the data product by selecting the Documentation tab.
• Description: This tab provides a more detailed description of the data product.
• External Resources: This tab provides links to external resources that provides more information about the
data product and how to use it.
Context
After you decide that the data product is what you need, and have looked more closely at the APIs available
with it, you can install individual APIs that you think would suit your needs and use them in your data project.
Procedure
Tip
If you're reviewing the details of the API, you can select the Install button from the details page.
A notification is sent immediately, and this notification will update as the import process continues. After
the import completes, you will have two notifications.
• Select the first notification to see the imported entities listed in the (Repository Explorer).
• Select the second notification to view the import log messages.
If any entity could not be created, an error is given.
The imported entities are available for use in the (Business Builder) and the (Data Builder).
Next Steps
Related Information
When you publish assets to the catalog, you determine what content is available for catalog users to discover.
You can set source systems to automatically publish content, or you can be more involved and manually
publish individual assets from the asset details page or manually publish small groups of assets from the
catalog home page.
Prerequisites
Tip
Before publishing an asset to the catalog, you can improve its overall quality by editing its name, adding a
custom description, and enriching its metadata by managing its relationships to tags, glossary terms, and
KPIs. For information, see Editing and Enriching Catalog Assets [page 29].
Context
Organizations that don't need separate enrichment and publishing steps can choose to automatically publish
objects from the source system to the catalog.
Note
As a best practice before you enable automatic publishing for an existing source system, set the publication
status for any assets that you don't want to be automatically published to Excluded. Excluded assets are
not visible to catalog users and cannot be discovered. These assets will not be published until you change
the publication setting.
Procedure
4. Select Create to create the connection or select Save to save the changes to the existing connection.
Review the warning message that appears, and if you still want to enable automatic publishing, you can
finish creating the connection or saving the changes.
5. For newly created source system connections, run a manual synchronization. For existing source systems,
running a manual synchronization is optional.
For newly created source system connections, after the manual synchronization finishes, all objects are
published as assets to the catalog. Also, as part of the ongoing catalog monitoring of the source system,
all new objects that are added to the source system are automatically extracted and published. The publication
status of all assets automatically published to the catalog is set to Published.
For existing source system connections, the assets are updated immediately after the changes are saved.
• Objects that are newly created in the source system are published. The publication status of these assets
set to Published.
• Existing assets that have the Unpublished and Current statuses are published and their publication
statuses are updated to Published.
• Existing assets that have the Published status remain published and the publication status is unchanged.
• Existing assets that have the Exclude status remain hidden to catalog users and the publication status is
unchanged.
For any assets that you did not want published, search for the assets and set their publication status to
Excluded.
• On the catalog home page, select the checkboxes for several assets and then choose Publish Actions
Exclude.
• On the asset details page, select the Publish Actions, and select Exclude.
These assets remain in the catalog, but are hidden to users with the Catalog User role. You can see which
assets have the (Excluded) publication status by viewing the icons on its catalog preview or impact and
lineage analysis diagram or by reviewing the asset details page. To find all excluded assets, use the filters and
select the Excluded publication status.
Procedure
In Grid view, different visibility icons tell you what is published, and therefore visible to anyone who uses the
The status of the object changes to Published, and it can be discovered by anyone who uses the catalog.
The date and time when an asset is published can be found on the Overview tab of the asset details page
or in the header of the page for a term or KPI. Select one or more objects and click Publish Actions
Unpublish to change the state back to Unpublished and hide the object from being discovered by users.
Procedure
The status of the object changes to Published, and it can be discovered by all users in the catalog. The date
and time when an asset is published can be found on the Overview tab of the asset details page or in the
header of the page for a term or KPI. Click the Unpublish button to change the state back to Unpublished.
Asset Status
The asset details page displays a variety of status labels specific to assets. You can quickly see whether an
asset is published, unpublished, or excluded from publication. Also, additional functional status labels convey
important information that you can use to check the integrity of an asset in relation to its source system. The
functional status helps you decide what actions you may need to take to keep your catalog assets in good
shape for your users.
• You can filter your search results on the catalog home page by the Publication Status and Functional
Status filter categories.
• You can see the publish and functional status of an asset in the impact and lineage diagram.
Review the tables below for a description of the different asset states, including which actions change an asset
to a new state.
Note
Users with the Catalog User role are only able to see published assets that are in the Current state.
Assets in any other functional state are visible only to users with the Catalog Administrator role, regardless
of their publication status.
Functional Status
Status Description
Current The asset is in sync with its source system metadata and is up to date.
Extracted The asset has been successfully created by extracted metadata from the source system.
Outdated The asset is out of sync with its source system metadata and is no longer up to date.
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.
Remotely Deleted The underlying object on the source system has been deleted, but 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.
Unavailable The underlying object on the source system has been deleted. The asset is not referenced by
other assets and can safely be deleted from the catalog. Click the Delete ( (Delete)) button on
the asset details page to remove the asset from the catalog.
Publication Status
Status Description
Excluded For source systems that have automatic publishing enabled, the asset is excluded from being
automatically published. This asset is visible to only users with the Catalog Administrator role.
To include the asset for automatic publishing, change the publication status of the asset to
Unpublished or Published.
Published The asset is visible to anyone who uses the catalog. Click the Unpublish button on the asset page
to change the status to Unpublished.
Unpublished The asset is visible only to users with the Catalog Administrator role. Click the Publish button on
the asset page to change the status to Published.
Like catalog assets, terms and KPIs also have visible status labels. Aside from showing you whether a term
or KPI is published or unpublished, additional functional status labels indicate whether there are issues in the
term or KPI that you should investigate and fix before publishing and making it available to all users.
Needs Repair The term or KPI has a warning or error to be fixed. You
can view the errors under Status on the term or KPI page:
Published The term or KPI is visible to anyone who uses the catalog. Click the Unpublish button on the term
or KPI page to change the status to Unpublished.
Unpublished The term or KPI is visible only to users who have the Catalog Administrator role. Click the Publish
button on the term or KPI page to change the status to Published.
Related Information
Users with the Catalog Administrator role can open the Remote Systems page to create connections to a
variety of data sources in the same landscape. This page also includes tools for monitoring and managing data
sources, allowing metadata for objects to be extracted and added to the catalog assets.
Open the Remote Systems page from the side navigation by selecting (Catalog) (Monitoring). Once
you're on the page, you can connect the following data sources to the catalog and manually synchronize them
for the first time:
The following table provides a list of object types that can be added to the catalog:
On the Remote Systems page, you'll see the Systems table. The Systems table shows a list of all the data source
systems that are connected to the catalog and their statuses. You can use the toolbar to select a source system
from the table and manage it. Also, you can select the source system to view the system and synchronization
details, as well as the extraction summary and logs.
Column Description
System The user-defined name and universally unique identifier (UUID) of the source system.
Authenticated System The user that is logged on to the source system. Metadata that is extracted to the catalog is based
User on this user’s access permission on the source system. To reauthenticate this user or change to a
different user, select (Edit System).
System Type The source system that is connected to the catalog. For example, it can be a local or external SAP
Datasphere tenant, an SAP Analytics Cloud tenant, or an SAP Datasphere, SAP BW bridge system.
Extraction Status The extraction status of the source system. The status can be one of the following:
• Deleted: The connection for the source system has been deleted and will remain in the list
for up to 90 days after the date it was deleted. If needed within 90 days, you can select
the deleted source system to view its details page and then restore it. See Removing Data
Sources [page 97].
• Outdated: The source system is not synchronized and assets are out of date. This issue can
occur for any of the following reasons: the system connection was just added, the system was
restored, the system user was reauthenticated, or the system was restored from a backup.
To fix this status, select the source system and then select Synchronize System to manually
synchronize it.
• Synchronization failed: The last manual synchronization for the source system failed. It is un-
known how many assets encountered issues. For troubleshooting information, see Monitoring
Data Source Extraction [page 100].
• Synchronized: The source system successfully synchronized and all assets are up-to-date.
• Synchronized with errors: The source system successfully synchronized, but some assets had
issues during synchronization. You can see the number of assets with issues in the Errors
column. For troubleshooting information, see Monitoring Data Source Extraction [page 100].
• In progress: The synchronization for the source system is currently in progress.
Assets The total number of assets for the source system that are in the catalog. This count includes
all assets of any state (current, unavailable, and so on). For assets published in the catalog, the
updated metadata is available to users who have the Catalog User role. For unpublished or new
assets, users with the Catalog Administrator role can edit, enrich, and then publish them.
Errors The count of objects that failed during the last synchronization. The statuses for assets already in
the catalog are set to Outdated. New assets are not available in the catalog, but a record of the
failed metadata extraction is available on the extraction log. For troubleshooting information, see
Monitoring Data Source Extraction [page 100].
Last Configuration The date and time when the system connection details were last changed. The user's name who
Change made the change is also displayed. If you don't see this column, select (Select Columns) to
show it.
Last Synchronization The date and time of the last synchronization. This information also includes the type of synchro-
nization (manual or automatic) and the status. The status can be one of the following:
• Completed: The synchronization completed successfully and all available objects were up-
dated.
• Completed with errors: The synchronization completed successfully. However, some objects
encountered errors. For troubleshooting information, see Monitoring Data Source Extraction
[page 100].
• Failed: The synchronization was interrupted and could not finish. For example, this can hap-
pen when there is a power outage. For troubleshooting information, see Monitoring Data
Source Extraction [page 100].
• None: The synchronization has not been run. This status typically appears for a newly added
source system.
• In progress: The synchronization is currently in progress.
• Enabled: After each synchronization and each automatic extraction, all new objects in the
source system are automatically published as assets to the catalog and will be visible and
discoverable by all catalog users. Only objects that have been excluded are not automatically
published.
• Disabled: After each synchronization and each automatic extraction, new or unpublished
objects in the source system are not automatically published to the catalog. Users with the
Catalog Administrator role must manually publish them to the catalog.
For more information, see Publishing Content to the Catalog [page 71].
The tools in the Systems toolbar help you mange the source systems.
Tool Description
Search Use the free text search to find a system by its name.
Synchronize System Manually synchronize a connected source system and extract updated metadata.
Note
Manually synchronizing a source system might take considerable time and resources. You
should should manually synchronize a source system only in the following situations:
• After creating a connection to a source system that has existing data assets.
• After restoring a deleted source system to capture asset changes that occurred while it
was deleted.
• After restoring a deleted space in an SAP Datasphere source system.
• After troubleshooting synchronization errors that appear in the extraction logs (for exam-
ple, assets that show missing metadata).
• After reauthenticating the source system user.
• After changing the authenticated system user’s access permissions on the source sys-
tem or moving content to different locations on the source system.
• After an application upgrade where the extraction status for a source system becomes
Outdated on the Remote Systems page.
Note
SAP Datasphere, SAP BW bridge systems must always be manually synchronized.
Synchronize System is available only if the current logged-in user is the authenticated system
user.
Edit Configuration Select the InfoAreas that you want to synchronize with the catalog. Edit Configuration is available
for SAP Datasphere, SAP BW bridge when the current logged in user matches the authenticated
system user.
(Create System) Create a new connection to a source system for extracting metadata for assets in the catalog.
Make sure you have the following information:
• The tenant identifier for the source system. This is also known as the universally unique
identifier (UUID).
• Logon credentials of the dedicated user that is used for authenticating the source system and
monitoring and extracting changes to the assets.
When you create the connection, you can also enable automatic publishing of assets, so that
they can be visible and discoverable by all catalog users.
Note
For SAP Datasphere, SAP BW bridge systems, the current logged-in user must have an
account with the necessary permissions and access to spaces and the SAP BW bridge
connection.
For an SAP Datasphere or SAP Analytics Cloud system, you can make the following changes:
• Change the user-defined system name that identifies the system throughout the system
monitoring pages and extraction logs.
• Reauthenticate the source system user. You can reauthenticate the system user after you
restore a deleted system or need to update the system user.
• Set the source system to automatically publish assets to the catalog.
For SAP Datasphere, SAP BW bridge systems, Edit System is available if the current logged-in user
is not the authenticated system user. If the current user has the necessary permissions for the
system, they can select Edit System to become the authenticated system user. They can also set
the source system to automatically publish assets to the catalog.
(Delete System) Delete a system connection. Catalog assets for the system are not available in the catalog, but
they do remain stored for 90 days. Within this time, you can restore the connection and the assets
will be available in the catalog again. After 90 days, the connection and all assets are permanently
deleted.
(Download) Download the extraction log file for the source system. The information in the CSV-formatted file is
the same as on the Extraction Summary tab on the system's synchronization details page.
(Sort) Sort the table by choosing either Ascending or Descending sort order and then choosing the
column you want to sort by.
(Filter) Filter the table by the extraction status or last synchronization status. You can select a single
status to filter the table by or a combination of the three filter options.
(Select Columns) Select which columns you want to show in the table.
(Refresh Systems) Refresh the information in the Systems table, such as the timestamps and statuses for the last
manual or automatic synchronizations and the number of assets and errors.
Related Information
After a source system is connected to the catalog, the catalog detects changes to the objects in the source
system, extracts metadata for those objects, and then updates the corresponding assets in the catalog.
You can create multiple connections to the catalog for different source systems, such as SAP Datasphere and
SAP Analytics Cloud tenants. The source systems must be in the same landscape as the SAP Datasphere
tenant that hosts the catalog. Once connected, the source systems appear in the Systems table.
Note
The catalog does not automatically extract new or updated metadata from objects that are in an SAP
Datasphere, SAP BW bridge system. You must manually synchronize the catalog with this type of source
system to ensure all objects in the catalog are up to date.
The catalog detects the following changes to objects on the connected source systems and then updates the
catalog accordingly:
A new data object or story is cre- A new catalog asset is created and set to Unpublished status and the functional
ated. status is set to Current. Users with the Catalog Administrator role can enrich the
metadata and prepare the asset before publishing.
An existing data object or story is The existing catalog asset's metadata is updated with changes and the functional
updated with changes. status label Current is applied.
An existing data object or story is The catalog asset status label Unavailable is applied. Users with the Catalog
deleted. Administrator role can clean up and remove the asset from the catalog from its asset
details page or the catalog home page.
If the deleted object or story is referenced and used by another asset in the catalog,
the status label Remotely Deleted is applied.
Note
If an asset that you expect to be in the catalog is missing, check for any of the following issues:
• In the source system, check that the authenticated system user has the necessary permissions to
access the source object.
• On the Remote Systems page, check that the connected source system has an authenticated user.
• For a source object in SAP Datasphere, check that it has been saved and deployed. For more
information, see Saving and Deploying Objects.
• On the source system details page, review the Extraction Logs tab and search for the source object to
find its log entry.
Now that you understand how metadata extraction works, you can try adding additional source systems to
your catalog.
On the Remote Systems page, you can create a connection to the local or an external SAP Datasphere tenant.
Once connected, the catalog will start monitoring the source system for new, updated, or deleted assets.
Prerequisites
When creating the connection, you'll also need the tenant identifier and the login credentials for the user
account that is used for authenticating the source system.
Note
• The source systems that you connect to must be in the same landscape (or data center region) as the
SAP Datasphere tenant that hosts the catalog.
• For connections to source systems created before version 2023.24, a system user for each source
system must be authenticated. If users are not authenticated for the source systems, automatic
metadata extraction for those source systems will stop. For more information, see SAP Note:
3344922 .
When connecting to an SAP Datasphere tenant, you need to have the tenant identifier. This identifier is also
known as the Universally Unique Identifier (UUID).
• If you are connecting to the local tenant, this information is automatically entered.
• If you're the system owner for the external SAP Datasphere tenant, you can get the tenant identifier on
your own from the external tenant.
In the side navigation area, click (System) (About). In the dialog, find the Tenant field and copy
the identifier for use later.
When connecting to the tenant, you also need the login credentials for a user account that is used for
authenticating the source system and monitoring and extracting changes to the assets.
If this user does not already exist for the tenant, ask the system administrator for the source system to create
it. The objects that are monitored from the SAP Datasphere tenant are restricted to the objects that this user
can view. As a best practice and to avoid future extraction issues, this user should use an email address that
is specially created for the purpose of this connection or an existing email address for a shared mailbox (for
example, admin@company.com).
If you have the DW Administrator role for the source system, you can create the user on your own. For
information, see Managing Users and Roles.
The user must be a viewer in all spaces or a subset of spaces. In a scoped role that includes viewer privileges,
you (the DW Administrator) can assign the user to the spaces from which the user will extract metadata. You
can use the predefined scoped role DW Scoped Viewer or create a custom role that includes viewer privileges
and then create a scoped role based on the custom role. Review the following table as a guide for setting up the
user's permission access. For information, see Create a Scoped Role to Assign Privileges to Users in Spaces.
From all spaces Role: DW Viewer role Scoped Role: DW Scoped Viewer role for
all spaces
Space: Member of all spaces
From one or more specified spaces Role: DW Viewer role Scoped Role: DW Scoped Viewer role for
some spaces
Space: Member of some spaces
Procedure
For the local SAP Datasphere, the system name and tenant identifier are automatically entered. If needed,
you can change the system name.
Note
An SAP Datasphere tenant can be connected to only one catalog at a time. Also, after the local SAP
Datasphere tenant is connected, you can connect only external SAP Datasphere or SAP Analytics
Cloud tenants.
4. For an external SAP Datasphere, in the Name field, type a name to identify the source system and in the
UUID enter the tenant identifier for the source system.
5. (Optional) To automatically publish objects from the source system to the catalog every time the catalog
synchronizes with the source system, select the Enable Auto Publishing to the Catalog checkbox.
Note
If you enabled automatic publishing, all objects will be automatically published as assets to the catalog
after the first synchronization is run. For each subsequent manual synchronization, any new objects
will be automatically published. Also, as part of the ongoing catalog monitoring of the source system,
newly created objects in the source system will be automatically extracted and published to the
catalog. Once published, the assets are visible and discoverable by all catalog users.
A dialog with instructions on how to authenticate the user for the source system appears. Follow the
instructions in the dialog for authenticating the source system user.
a. In the Authenticate System User dialog, click (Copy) to copy the link for authenticating the system
user.
b. Open a private browsing window and paste the link in the address bar.
c. Log on to the source system.
d. After the source system user is authenticated and you see the confirmation message, close the private
browsing window.
e. When you are back on the Authenticate System User dialog, select Confirm Authentication.
7. Back on the Create System dialog, select Create.
Once added, the connection to the SAP Datasphere tenant appears in the Systems table, and the catalog starts
monitoring the source system for new, updated, or deleted assets. The catalog monitors the following object
types:
• Local Table
• Remote Table
• Graphical View
• SQL View
• Data Flow
• Intelligent Lookup
• Analytic Model
• Perspective
For a source system in the Systems table, you can select the source system and use a tool from the toolbar.
When you select (Edit System), you can perform these tasks: review the details of the source system,
including the system URL, change the user-defined system name, or reauthenticate the source system user. If
you reauthenticate the source system user, run a manual synchronization to make sure all assets are current.
You can also select the source system to open a details page that shows its system and synchronization details
and the extraction summary and extraction logs.
Next Steps
If the system already had existing objects before you connected it to the catalog and you want to add those
objects as assets to the catalog now, you'll need to manually synchronize the system. Select Synchronize
System from the toolbar to do this. For more information, see Manually Synchronizing a System [page 94].
If you're interested in monitoring the success or failure of individual extractions and troubleshooting common
errors that may happen during the extraction process, check out Monitoring Data Source Extraction [page
100] to learn more.
On the Remote Systems page, you can create a connection to an SAP Analytics Cloud tenant. Once connected,
the catalog will start monitoring the source system for new, updated, or deleted assets.
Prerequisites
When creating the connection, you'll also need the tenant identifier and the login credentials for the user
account that is used for authenticating the source system.
Note
• The source systems that you connect to must be in the same landscape (or data center region) as the
SAP Datasphere tenant that hosts the catalog.
• For connections to source systems created before version 2023.24, a system user for each source
system must be authenticated. If users are not authenticated for the source systems, automatic
metadata extraction for those source systems will stop. For more information, see SAP Note:
3344922 .
When connecting to an SAP Analytics Cloud tenant, you must have the tenant identifier.
• If you're a system administrator, but not a system owner, you can find the tenant identifier from the
Administration page.
1. Select (System) (Administration).
2. Select the Data Source Configuration tab.
3. In the SAP BTP Core Account, under the Account Information section, look for the Subaccount value
and copy the it for use later.
When connecting to the tenant, you also need the login credentials for a user account that is used for
authenticating the source system and monitoring and extracting changes to the assets.
If this user does not already exist for the tenant, ask the system administrator for the source system to create
it. The objects that are monitored from the SAP Analytics Cloud tenant are restricted to the objects that this
user can access. As a best practice and to avoid future extraction issues, this user should use an email address
that is specially created for the purpose of this connection or an existing email address for a shared mailbox
(for example, admin@company.com).
If you're a system administrator for the SAP Analytics Cloud tenant, you can create this user. Review the
following table as a guide for setting up the user's permission access to private, public, and workspace
locations. For information on creating users in SAP Analytics Cloud, go to the help: Create Users and
Understand Licenses, Roles, and Permissions.
Note
When no permissions are set for both Public Files and Private Files, no metadata is extracted to the catalog.
Private user folders: System/ Role: Set Manage permission for Private Role: Set Read permission for Private
Common/Users/<User_ID> Files Files
Note
If the system user creates content,
in a private location, that content
is extracted to the catalog because
the user by default has Read access
permission to content they create.
Public folder: System/Common/ Role: Set Manage permission for Public Role: Set Read permission for Public
Public Files Files
Note
If the system user creates content,
in a public location, that content is
extracted to the catalog because
the user by default has Read access
permission to content they create.
Workspace root folder: System/ Role: Set Manage permission for Public Role: Set Read permission for Public
<Workspace_Name> Files Files
Workspace user folder: Role: Set Manage permission for Private Role: Set Read permission for Private
System/<Workspace_Name>/ Files Files
Users/<User_ID> Folder: Give Read access permission on
some users' content
Procedure
Note
If you enabled automatic publishing, all objects will be automatically published as assets to the catalog
after the first synchronization is run. For each subsequent manual synchronization, any new objects
will be automatically published. Also, as part of the ongoing catalog monitoring of the source system,
newly created objects in the source system will be automatically extracted and published to the
catalog. Once published, the assets are visible and discoverable by all catalog users.
A dialog with instructions on how to authenticate the user for the source system appears. Follow the
instructions for authenticating the source system user.
a. In the Authenticate System User dialog, click (Copy) to copy the link for authenticating the system
user.
b. Open a private browsing window and paste the link in the address bar.
c. Log on to the tenant.
d. After the source system user is authenticated and you see the confirmation message, close the private
browsing window.
e. When you are back on the Authenticate System User dialog, select Confirm Authentication.
8. Back on the Create System dialog, select Create.
Results
Once added, the connection to the SAP Analytics Cloud tenant appears in the Systems table, and the catalog
starts monitoring the source system for new, updated, or deleted assets. The catalog monitors the following
object types:
• Story
• Model
• Insight
• Predictive Scenario
• Data Action
For a source system in the Systems table, you can select the source system and use a tool from the toolbar.
When you select (Edit System), you can perform these tasks: review the details of the source system,
including the system URL, change the user-defined system name, or reauthenticate the source system user. If
you reauthenticate the source system user, run a manual synchronization to make sure all assets are current.
You can also select the source system to open a details page that shows its system and synchronization details,
extraction summary, and extraction logs.
If the system already had existing objects before you connected it to the catalog and you want to add those
objects as assets to the catalog now, you'll need to manually synchronize the system. Select Synchronize
System from the toolbar to do this. For more information, see Manually Synchronizing a System [page 94].
If you're interested in monitoring the success or failure of individual extractions and troubleshooting common
errors that may happen during the extraction process, check out Monitoring Data Source Extraction [page 100]
to learn more.
On the Remote Systems page, you can create a connection to an SAP Datasphere, SAP BW bridge system.
After connecting, you can add the InfoAreas containing existing objects to the catalog and then run a manual
synchronization to populate it.
Prerequisites
When connecting to an SAP Datasphere, SAP BW bridge system, you'll also need the following:
• A user account for the SAP Datasphere, SAP BW bridge tenant you are connecting to.
• Access permission to the space where the SAP Datasphere, SAP BW bridge connection exists and
permission for the specific SAP Datasphere, SAP BW bridge connection. The objects that are monitored
from the SAP Datasphere, SAP BW bridge tenant are restricted to the objects that this user can view.
Note
Currently, only SAP Datasphere, SAP BW bridge connections on the local SAP Datasphere tenant can be
added.
Connecting to an SAP Datasphere, SAP BW bridge system, consists of the following tasks:
Procedure
All information for the SAP Datasphere, SAP BW bridge tenant is automatically entered and cannot be
edited. The user currently logged on to SAP Datasphere is used to authenticate the system. If no SAP
Datasphere, SAP BW bridge system appears, then it is already connected or you do not have permission to
access it.
4. (Optional) To automatically publish objects from the source system to the catalog every time the catalog
synchronizes with the source system, select the Enable Auto Publishing to the Catalog checkbox.
Note
If you enabled automatic publishing, all objects will be automatically published as assets to the catalog
after the first synchronization is run. For each subsequent manual synchronization, any new objects
will be automatically published. Once published, the assets are visible and discoverable by all catalog
users.
5. Select Create.
Results
Once added, the SAP Datasphere, SAP BW bridge system appears in the Systems table. To finish the setup,
select Edit Configuration and select the InfoAreas that have objects you want to include in the catalog.
Note
The (Edit System) tool is available only if user currently logged into SAP Datasphere is not the
authenticated system user for the selected SAP Datasphere, SAP BW bridge system. When the edit tool is
selected, the authenticated system user is automatically updated to the user who is currently logged in to
SAP Datasphere. You can then save the change, but no other changes can be made.
Context
After you create a connection to an SAP Datasphere, SAP BW bridge system, you must select at least
one InfoArea to synchronize with the catalog. The metadata from the objects in the selected InfoAreas are
extracted, and the objects are included as assets in the catalog. Use the Edit Configuration tool to open the
Extract Assets dialog, and then select the InfoAreas.
Panel Description
InfoAreas and Source The panel on the left has two tabs:
Systems
• Select the InfoAreas tab to navigate the list or use the search to find the InfoAreas that have
objects that you want to add to the catalog. The number beside each line shows the total
number of objects. When you select the checkbox for a line, the Selected value updates to
show the total of selected objects to include in the catalog. When you click an InfoArea, you
can see its contents.
• Select the Source Systems tab to see all source systems. This panel is read-only, so you can
see the objects inside each source system.
Contents Review the contents of the selected InfoArea or source system. The contents shows a preview of
the first 100 objects in the selected location at the top half of the panel and sub-containers in the
lower half.
Procedure
1. On the Systems table, select an SAP Datasphere, SAP BW bridge system and select Edit Configuration.
The Selected count at the top of the panel updates to show the total number of objects that will be included
in the catalog.
3. Select Save.
The metadata for the objects in the selected InfoAreas of the SAP Datasphere, SAP BW bridge system can be
extracted to the catalog. The following object types can be added to the catalog:
Next Steps
If the system already had existing objects before you connected it to the catalog and you want to add those
objects as assets to the catalog now, you'll need to manually synchronize the system. Use the Synchronize
System tool to do this. For more information, see Manually Synchronizing a System [page 94].
Note
The catalog does not automatically extract new or updated metadata from the source system. Make sure
the catalog is updated with the latest metadata by regularly running a manual synchronization.
If you're interested in monitoring the success or failure of individual extractions and troubleshooting common
errors that may happen during the extraction process, check out Monitoring Data Source Extraction [page
100] to learn more.
After you create a connection to a source system, you'll want to manually synchronize it with the catalog to
ensure that existing data objects from the new source system will be added as assets to the catalog. You may
also need to manually synchronize existing source systems for specific situations, such as troubleshooting
synchronization issues or reauthenticating the system user.
Prerequisites
To manually synchronize a source system, go to the Remote Systems, select a source system from the list, and
select Synchronize System from the toolbar.
Context
The catalog automatically extracts new or updated metadata from source systems in real time. However, on
occasion you might need to manually synchronize a source system to extract new or updated metadata and
new data objects.
Note
The catalog does not automatically extract new or updated metadata from objects that are in an SAP
Datasphere, SAP BW bridge system. To ensure these assets are up-to-date, you must run a manual
synchronization.
Because manually synchronizing a source system might take considerable time and resources, you should
manually synchronize a source system only in the following situations:
• After creating a connection to a source system that has existing data assets.
• After restoring a deleted source system to capture asset changes that occurred while it was deleted.
• After restoring a deleted space in an SAP Datasphere source system.
• After troubleshooting synchronization errors that appear in the extraction logs (for example, assets that
show missing metadata).
• After reauthenticating the source system user.
• After changing the authenticated system user’s access permissions on the source system or moving
content to different locations on the source system.
• After an application upgrade where the extraction status for a source system becomes Outdated on the
Remote Systems page.
Procedure
Tip
Synchronizing will take some time. You can continue to work on other tasks while it's running. After the
job is finished, you'll get a notification that you can see by selecting (Notifications). To check on the
status to see when the job is complete, select (Refresh Systems) to refresh the table.
After the synchronization finishes, the assets are available in the catalog where you can review them, edit their
names and descriptions, and provide other enrichments.
• If automatic publishing is not enabled for the source system connection, review and enrich the assets as
needed and then publish them so that catalog users can find and use them.
• If automatic publishing is enabled for a new source system connection, all objects are published as assets
to the catalog. The publication status of these assets set to Published.
• If automatic publishing is enabled for an existing source system connection, the assets are published as
follows:
• Objects that are newly created in the source system are published. The publication status of these
assets set to Published.
• Existing assets that have the Unpublished and Current statuses are published and their publication
statuses are updated to Published.
• Existing assets that have the Published status remain published and the publication status is
unchanged.
• Existing assets that have the Exclude status remain hidden to catalog users and the publication status
is unchanged.
For any assets that you did not want published, search for the assets and set their publication status to
Excluded. For more information, see Publishing Content to the Catalog [page 71].
Note
If you restore an SAP Datasphere space within 30 days of deleting it and then manually synchronize the
source system, all asset enrichments, such as links to terms and tags, are retained. However, if you restore
the space after 30 days, all asset enrichments are lost, and you will have to add them again.
Related Information
On the Remote Systems page, you can select a source system in the Systems table to delete its connection.
Once deleted, all its assets are removed from the catalog.
Prerequisites
You can open the Remote Systems page from the side navigation by selecting (Catalog)
(Monitoring). In the Systems table, you can view Extraction Status of table, including deleted connections.
These source systems are listed with the Deleted status.
Select the deleted source system to view the details about it. Details of deleted systems include the date it was
deleted, the system URL and UUID, and the number of days left until the system is permanently removed from
the System, table. The Restore button is available in the middle of the page.
Context
To remove a source system, delete the connection from the tenant to the catalog.
Note
Users are not notified when a connection to a source system is deleted. As a best practice, let users know
about the change before you delete the connection.
Results
In the Systems table, the source system has an extraction status of Deleted. All assets from the source system
are immediately removed from the catalog. However, they are stored for 90 days after the date of deletion,
during which you can restore connection to the source system.
After 90 days have passed and within 24 hours of the Days Until Asset Deletion becoming 0, all assets are
permanently deleted from the catalog and the source system is deleted from the Systems table. When the
connection to the source system has been permanently deleted, it cannot be restored.
If needed, you can add it back as a new source system with the same system information as before. However,
any enrichments that you had previously made (such as, edited the name or added relationships to glossary
terms or tags) will need to be made again.
Context
If necessary and before 90 days after the date of deletion have passed, you can restore the connection for a
source system that is marked for deletion.
Procedure
After the system is restored, the page refreshes and goes back to the Remote Systems page. On the
Systems table, the extraction status of the restored source system is changed to Outdated and the
authenticated system user is missing. All assets from the source system are restored to the catalog to
their previous state before deletion.
5. Select the checkbox for the source system and click (Edit System) .
6. In the Edit System dialog, select Authenticate Now and follow the instructions in dialog for authenticating
the source system user.
If the source system you're restoring is an SAP Datasphere, SAP BW bridge system, the user currently
logged in is automatically set as the authenticated system user, and you can save the change.
7. Back on the Remote Systems page, in the Systems table, select the checkbox for the source system and
select Synchronize System to manually synchronize the system.
Results
All assets from the source system are restored to the catalog and updated based on the system user's access
permission on the source system. Also, for any new assets that are created, you can edit and enrich them and
publish them.
Related Information
On the Remote Systems page, you can select a source system from the Systems table and view its system
details and synchronization details. You can also review the extraction summary for the assets and use the
system extraction logs to troubleshoot common errors.
Prerequisites
You can open the Remote Systems page from the side navigation by selecting (Catalog)
(Monitoring). In the Systems table, select a source system. The source system details page opens, and
you can see the system synchronization details in the following areas:
• Synchronization Overview
• Extraction Summary tab
• Extraction Logs tab
Synchronization Overview
The synchronization overview shows the most current synchronization information for the selected source
system. This information is the same as the information from the Systems table and also includes the source
system's URL and UUID.
Extraction Status The extraction status of the source system. The status can be one of the following:
• Deleted: The connection for the source system has been deleted and will remain in the list
for up to 90 days after the date it was deleted. If needed within 90 days, you can select
the deleted source system to view its details page and then restore it. See Removing Data
Sources [page 97].
• Outdated: The source system is not synchronized and assets are out of date. This issue can
occur for any of the following reasons: the system connection was just added, the system was
restored, the system user was reauthenticated, or the system was restored from a backup.
To fix this status, select the source system and then select Synchronize System to manually
synchronize it.
• Synchronization failed: The last manual synchronization for the source system failed. It is un-
known how many assets encountered issues. For troubleshooting information, see Monitoring
Data Source Extraction [page 100].
• Synchronized: The source system successfully synchronized and all assets are up-to-date.
• Synchronized with errors: The source system successfully synchronized, but some assets had
issues during synchronization. You can see the number of assets with issues in the Errors
column. For troubleshooting information, see Monitoring Data Source Extraction [page 100].
• In progress: The synchronization for the source system is currently in progress.
Extracted Assets The number of assets that failed to extract during the last synchronization. This number corre-
sponds to the Errors values on the Systems table.
Tip
Clicking the link for the number of failed assets updates the filtered view of the Extraction
Summary tab so that only the failed assets appear in the list. You can apply more filters as
needed or use the search to find the asset you want.
Authenticated System The user that is logged on to the source system. Metadata that is extracted to the catalog is based
User on this user’s access permission on the source system. To reauthenticate this user or change to a
different user, select (Edit System).
• Enabled: After each synchronization and each automatic extraction, all new objects in the
source system are automatically published as assets to the catalog and will be visible and
discoverable by all catalog users. Only objects that have been excluded are not automatically
published.
• Disabled: After each synchronization and each automatic extraction, new or unpublished
objects in the source system are not automatically published to the catalog. Users with the
Catalog Administrator role must manually publish them to the catalog.
Last Manual The date, time, and status when the last manual synchronization was run. To manually synchron-
Synchronization
ize a source system, select the source system and then click Synchronize System.
Tip
Clicking the link for the status updates the view of the Extraction Logs tab, so that the most
current extraction is selected and any assets that failed appears on the right side of the tab.
Last Automatic The date, time, and status when the last automatic synchronization for the source system was
Synchronization run.
System Type The source system that is connected to the catalog. For example, it can be a local or external SAP
Datasphere tenant, an SAP Analytics Cloud tenant, or an SAP Datasphere, SAP BW bridge system.
System UUID The universally unique identifier (UUID) of the source system.
The Extraction Summary tab shows a summary view of all assets that were extracted within the last 90 days.
You can use the free text search to find an asset by its name, sort the columns, or show and hide columns. Use
the Filter panel to limit the assets displayed.
The extraction summary shows the following information. Some of the columns appear by default, and you can
show the other columns as needed.
Column Description
Assets The name of the asset from the source system. The name is available if the asset already exists in
the catalog.
Asset Source ID The object identifier of the asset in the source system. If a synchronization error occurs for the
asset, you can use this identifier to find the asset in the source system.
Container Path The location path of the asset on the source system. This information is useful when the asset
name is not unique.
Status The synchronization status (completed or failed) of the asset. The synchronization for an asset
can fail or encounter an error for various reasons, including technical issues during extraction or
issues with access permissions.
For information on how to fix common synchronization errors, see the section Troubleshooting
Common Errors [page 105].
Error Message The error message indicates the reason the asset metadata was not extracted.
Operational Type The operational type of metadata extraction performed on the asset. The asset can be created,
updated, or deleted. If an issue occurred during extraction, the asset the operational type is Error.
Actions The actions available for the row. Select (View Extraction History) to see the extraction activity
for the asset in the last 90 days.
Extraction Type The type of synchronization that was run on the source system: Manual or Automatic.
For a list of supported types for a source system, see Connecting and Monitoring Source Systems
[page 77].
Error UUID The error universally unique identifier (UUID) that appears in the logs. You can search for this
identifier to find more details.
Error Details The reason why the asset encountered an error during synchronization.
When you find the asset you want, you can do the following:
• Select (View Extraction History) to get more information about the extraction activity for the asset in the
last 90 days. For assets that have an error operational type, you can use the history to troubleshoot the
issue.
• Select the asset name link to view its information page, where you can enrich or publish the asset.
The Extraction Logs tab displays all metadata extraction records. You can monitor and review extractions,
identify issues, and troubleshoot errors. These records are available for 90 days from the date the
synchronization task completed.
The Tasks panel shows the list of synchronization tasks that were run in the last 90 days. You can sort the table,
filter the tasks by the status, or show and hide columns.
End Date The date and time the task ended. For tasks still in progress, the end date is empty.
Status The status of the task can be completed, completed with errors, failed, or in progress.
Browsed The number of objects in the source system that were scanned. This number is based on the
access permissions of the authenticated system user and does not represent the total number of
objects in the source system. This column appears for SAP Datasphere and SAP Analytics Cloud
systems.
Staged The number of objects (new or updated) in the source system that have metadata that needs to
be extracted. Objects that have been deleted are not included in this count. This column appears
for SAP Datasphere and SAP Analytics Cloud systems.
Ingested The number of objects that the catalog queried for metadata extraction. There may be a time
delay between when the source system is queried and when metadata is extracted to and appears
in the catalog. This column appears for SAP Datasphere and SAP Analytics Cloud systems.
Run Mode The run mode (delta or full) for the synchronization. This column appears for SAP Datasphere,
SAP BW bridge systems.
Correlation ID Select (Copy to clipboard) to copy the correlation ID. You can then use the correlation ID to
search the extraction log for troubleshooting issues. This column appears for SAP Datasphere,
SAP BW bridge systems.
Summary Select (View Task Summary) to view a summary of the tasks for the selected line. This column
appears for SAP Datasphere, SAP BW bridge systems.
The Task Details panel shows the assets that failed to synchronize for the task that you selected. For these
assets, you can see the reason the synchronization failed. Use the free text search to find an asset by its name.
You can also sort the table, filter the tasks by the error message, or show and hide columns.
Error Message The error message of why the extraction failed. The error message can provide you with a starting
point for troubleshooting failed extractions.
For information on how to fix common synchronization errors, see the section Troubleshooting
Common Errors [page 105].
Totals The total of assets that were created, updated, deleted, or had an error appears below the list of
failed assets. These numbers are different from the browsed, staged, and ingested numbers in the
Tasks panel. These totals appear for SAP Datasphere and SAP Analytics Cloud systems.
• Created: The total number of assets that were created in the source system and added to the
catalog.
• Updated: The total number of assets that were edited in the source system and updated in
the catalog.
• Deleted: The total number of assets that were deleted from the catalog. An asset is consid-
ered deleted if it was deleted in the source system or moved from its original location to a
different location that cannot be accessed by the authenticated user. These assets will appear
in the catalog with the Unavailable status.
• Error: The total number of assets that experienced an error and failed to synchronize. You can
review error details in the list of failed assets.
Context
For help with common errors, refer to the following table to review possible causes and actions you can take to
resolve extraction issues.
Settings
Error Message Possible Cause and Resolution Category
Unable to extract asset This error can occur for several reasons. To identify the General
Unable to extract asset due This error can occur because of a power failure or network General
to network error
connectivity issues.
Unable to extract metadata This error can occur for several reasons. To identify the Metadata
Unable to extract metadata This error can occur when the authenticated source system Metadata
due to missing privilege
user is missing access permission for the asset on the
<privilege_name>
source system.
Unable to extract metadata This error can occur because the asset is missing required Metadata
due to missing required
metadata in the source system.
property <property_name>
To resolve this issue, try one of the following:
Unable to extract metadata This error can occur because of a power failure or network Metadata
due to network error
connectivity issues.
Unable to extract lineage This error can occur for several reasons. To identify the Lineage
Unable to extract lineage This error can occur when the authenticated source system Lineage
due to missing privilege
user is missing privileges to access the asset on the source
<privilege_name>
system.
Unable to extract lineage This error can occur because the asset is missing required Lineage
due to missing required
metadata in the source system.
property <property_name>
To resolve this issue, try one of the following:
Unable to extract lineage This error can occur because of a power failure or network Lineage
due to network error
connectivity issues.
Related Information
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering an SAP-hosted Web site. By using
such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.