Synchronize SAP Datasphere Catalog

After you have prepared your Edge or Collibra Cloud site, you can configure and start the synchronization. To use the unified SAP Datasphere Catalog integration, you need:

Synchronizing SAP Datasphere Catalog is the process of integrating metadata from the systems connected to SAP Datasphere Catalog and making the metadata available in Collibra. You can either synchronize manually or automate the process by adding a synchronization schedule.

Before you synchronize, you have to configure the integration settings to specify the metadata that you want to integrate. Separate tabs on the Integration configuration page in Catalog allow you to include metadata from the following data sources:

Tip When configuring the integration, you are required to select a default domain, and optionally, configure domain mappings. If you want to create new target domains for the ingested assets, review the integration steps overview for guidance on required domain types.

Prerequisites

In your Collibra environment:

Steps

  1. On the main toolbar, click Products icon → Catalog.
    The Catalog homepage opens.
  2. Click Integrations.
    The Integrations page opens.
  3. Click the Integration configuration tab.
  4. In the Connection name column, locate the SAP Datasphere Catalog connection that you used when you added the SAP Datasphere capability and click the link in the Capabilities column.
    The synchronization configuration page opens.
  5. In the Synchronization configuration section, click Add configuration.
  6. Select a data source to configure the relevant integration settings:
  7. Click Save.
  8. Click Synchronize.
    A notification indicates the synchronization has started.
  1. On the main toolbar, click Products icon → Catalog.
    The Catalog homepage opens.
  2. Click Integrations.
    The Integrations page opens.
  3. Click the Integration configuration tab.
  4. Locate the SAP Datasphere Catalog connection that you used when you added the SAP Datasphere capability and click the link in the Capabilities column.
    The synchronization configuration page opens.
  5. In the Synchronization configuration section, click Add configuration.
  6. Select a data source to configure the relevant integration settings:
  7. Click Save.
  8. In the Synchronization Schedule section, click Add Schedule.
  9. Enter the information.
    FieldDescription
    RepeatThe interval when you want to synchronize automatically. The possible values are: Daily, Weekly, Monthly, and Cron expression.
    Cron

    The Quartz Cron expression that determines when the synchronization takes place.

    This field is only visible if you select Cron expression in the Repeat field.

    Every

    The day on which you want to synchronize, for example, Sunday.

    This field is only visible if you select Weekly in the Repeat field.

    Every first

    The day of the month on which you want to synchronize, for example, Tuesday.

    This field is only visible if you select Monthly in the Repeat field.

    At

    The time at which you want to synchronize automatically, for example, 14:00.

    • You can only schedule on the hour. For example, you can add a synchronization schedule at 8:00, but not at 8:45.
    • This field is only visible if you select Daily, Weekly, or Monthly in the Repeat field.
    Time zoneThe time zone for the schedule.
  10. Click Save

Integration settings

Each data source has its own configuration settings. Find the settings for the data source you selected in the synchronization steps below.

SAP Datasphere

Field Action Required?
SAP Datasphere System Name

Specify the SAP Datasphere system name.

  • The name you specify must be unique across all your SAP integration configurations in Collibra.
  • System names are not case-sensitive in SAP Datasphere Catalog.

To add another SAP Datasphere system to the integration, click + Add Item.

In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Metadata Extractions.
The Remote Systems page opens.

In the following example image, let's say you want the highlighted system. The name you need to specify is SAP Datasphere.

Yes

Default Domain

Specify the Collibra domain in which you want to integrate your tenant and space assets. Collibra will create a new domain per SAP space in the same community as the domain you specify.

Important Ensure that the domain you specify is not used for another SAP Datasphere synchronization. Any single Collibra domain can be the target domain of only one synchronization.

Yes

SAP Datasphere Space IDs

Use this filter to ingest assets only from one or more specified SAP Datasphere spaces.

If you don’t specify any IDs:

  • Assets from all spaces are integrated.
  • Separate domains are created for each SAP space, with the name of the space.

No

Space ID

Specify the space ID from which you want to ingest assets.

To specify more than one space, click + Add Space ID.

You can find the space IDs in the Space Management tab in SAP.

Yes

Enable Data Quality synchronization

Optionally, enable data quality scores from the SAP HANA JDBC driver for your SAP Datasphere Catalog assets.

  • This option is set to No by default.
  • Select Yes only if you want to view data quality scores for SAP Datasphere assets. If you enable Data Quality synchronization, you must also complete the following fields:
    • System: Select the same System asset that you used for SAP HANA JDBC ingestion.
    • Database: Enter the SAP HANA database name corresponding to your SAP Datasphere remote database.
    • Schema: Enter the SAP HANA schema name corresponding to your SAP Datasphere remote schema.

The additional configuration creates a second hierarchy for Table, Database View, and Column assets, pairing them through this hierarchy and enabling data quality scores when the SAP HANA JDBC driver is used to run the data quality capability.

Note If the remote objects in an SAP Datasphere space originate from multiple SAP HANA schemas, only assets matching the configured schema will display Data Quality scores correctly. Any assets from other schemas may result in the creation of an incorrect secondary hierarchy in Collibra. The automatic detection of the SAP HANA database and schema of remote objects in SAP Datasphere will be addressed in a future release.

No

SAP Analytics Cloud

Field Action Required?
SAP Analytics Cloud System Name

Specify the SAP Analytics Cloud system name.

  • The name you specify must be unique across all of your SAP integration configurations in Collibra.
  • System names are not case-sensitive in SAP Datasphere Catalog.

To add another SAP Analytics Cloud system to the integration, click + Add Item.

In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Metadata Extractions.
The Remote Systems page opens.

In the following example image, let's say you want the highlighted system. The name you need to specify is SAP Analytics Cloud - production.

Yes

SAP Analytics Cloud URL

Specify the SAP Analytics Cloud system URL.

Note The URL that you specify is used to create a direct link between Collibra and SAP Analytics Cloud. Collibra cannot verify that the URL you have specified is correct. If it is incorrect, the links to SAP Analytics Cloud, as included on SAC Story and SAC Data Model asset pages in Collibra, will be broken.

  1. In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Metadata Extractions.
    The Remote Systems page opens.
  2. Click the relevant system to open the details page.
  3. The URL you need is the one shown in the following example image.

Yes

Default Domain

Select a default domain. This is the domain in which assets are ingested if you don't configure one or more domain mappings, as described below.

Important Ensure that the domain you specify is not used for another SAP Datasphere synchronization. Any single Collibra domain can be the target domain of only one synchronization.

Yes

Domain include mappings

Use mappings to ingest assets from specified containers and folders into specified Collibra domains.

To add more than one mapping, click + Add Domain include mapping.

Tip For ideas on how to effectively configure mappings, see example mappings and results below.

No

Path

Specify the path to the SAP Analytics Cloud container or folder to be integrated.

  • Currently, you can only filter on system containers, meaning Public, Private, System, or one of the workspaces. To filter on Public, enter the path Public/*. This ingests everything in the Public container.
  • If you filter on a workspace, do not include "WORKSPACE" as part of the folder path. If you do, synchronization will fail.
  1. In SAP, on the SAP Datasphere homepage, click the Catalog tab and then click Monitoring.
    The Remote Systems page opens.
  2. Click the relevant system to open the details page.
  3. The path you need is the one in the Container Path column.

Yes

Domain

Select the domain in Collibra in which you want to ingest the metadata.

Important Ensure that the domain you specify is not used for another SAP Datasphere synchronization. Any single Collibra domain can be the target domain of only one synchronization.

No

Domain include mappings are essentially filters that allow you to specify the SAP Analytics Cloud containers and folders from which you want to ingest assets. You use the Path field to specify the path to the relevant containers (folders and workspaces), and the Domain dropdown list to select the domain in Collibra in which you want to ingest the assets.

Important considerations:

  • The System asset is always ingested in the default domain.
  • If you filter on a workspace, do not include "WORKSPACE" as part of the folder path. If you do, synchronization will fail.
  • Use the path <container name>/** to ingest everything in the container.

Examples

The following filter paths and results refer to the example data structure shown above.

Ingestion results

Ingestion results

Collibra automatically creates a domain for the folder that is one level above, in this case "container-1". That domain is created in the same community as the default domain.

Ingestion results

Collibra automatically creates a domain for the folder that is one level up, in this case "container-1". That domain is created in the same community as the default domain.

Important The following mappings are invalid because they intersect; specifically, "inner-folder-1" matches both mappings. Ensure that you don't configure intersecting mappings, as the results can vary depending on the order of processing.

  • First mapping: Container and everything two hierarchical levels down.
  • Second mapping: Everything in a specified subfolder.

Ingestion results

Important The following path is invalid. The backslash symbol (/) must be followed by a folder name or an asterisk (*). If the path is invalid, the SAP tenant is still ingested but none of the SAP Analytics Cloud metadata is.

Ingestion results

SAP Business Glossary

Field Action Required?
Default Domain

Select a default domain. This is the domain in which glossary terms are ingested if you don't configure one or more glossary mappings.

If you don't configure one or more glossary mappings, all terms from all glossaries are ingested in this domain.

Important Ensure that the domain you specify is not used for another SAP Datasphere synchronization. Any single Collibra domain can be the target domain of only one synchronization.

The + Add Item button is currently not relevant.

Yes

Glossary Mappings

Use mappings to ingest terms from specified glossaries into specified Collibra domains.

To add more than one mapping, click + Add.

No

Glossary

Specify the name of the glossary from which to ingest terms.

  • The name you specify must be unique across all your glossary mappings.
  • Glossary names are not case-sensitive in SAP Datasphere Catalog.

Yes

Domain

Specify the Collibra domain in which you want to integrate the glossary terms.

Important Ensure that the domain you specify is not used for another SAP Datasphere synchronization. Any single Collibra domain can be the target domain of only one synchronization.

No

SAP Data Products

Field Action Required
Ingest Data Products

Optionally, enable the ingestion of SAP Data Products.

  • This option is set to No by default.
  • Select Yes only if you also want to ingest SAP Data Products.

To ingest SAP Data Products, you must also configure the SAP Datasphere tab. The tabs can be configured in any order, but both must be completed before you run the synchronization. Otherwise, the capability fails.

No

Default Domain

Select a default domain. This is the domain in which SAP Data Products are ingested.

Yes

Activation keys

Provide an activation key for each SAP Data Provider whose data products you want to ingest. Add one key per Data Provider. For information on how to generate an activation key, go to the SAP Datasphere documentation.

  1. To add an activation key, click + Add Activation key.
  2. In Activation key, enter the activation key for the SAP Data Provider whose data products you want to ingest.

Yes

What's next

The synchronization job integrates the metadata.

After the synchronization: