Set up SAP Datasphere Catalog

Warning Since these tasks are performed outside of Collibra, it is possible that the content changes without us knowing. We strongly recommend that you carefully read the source documentation.

By setting up your SAP Datasphere Catalog environment, you can ensure that Collibra has the necessary permissions and connection details to successfully synchronize SAP metadata.

Complete these five steps in the following order to set up SAP Datasphere Catalog:

  1. Prepare SAP Datasphere Catalog.
  2. Optionally, synchronize SAP Analytics Cloud data in SAP Datasphere Catalog.
  3. Ensure that the assets you want to integrate are published.
  4. Configure a new OAuth client.
  5. Ensure that certain endpoints are allowed.

Prepare SAP Datasphere Catalog

To prepare SAP Datasphere Catalog:

  1. In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Metadata Extractions.
    The Remote Systems page opens.
  2. Above the list of systems, click +.

    The Create System dialog box appears.
  3. Enter the required information.

    FieldDescription
    System Type

    The type of system you want to synchronize. In this case, select Local SAP Datasphere or External SAP Datasphere.

    Note You can add as many SAP Datasphere systems as you want, but there can only be one local SAP Datasphere system.

    Name

    The name of your SAP Datasphere tenant.

    To find the name in SAP, go to Administration > Info as a System Administrator.

    UUID

    The UUID of your SAP Datasphere tenant.

    To find the name in SAP, go to Administration > Info as a System Administrator.

  4. Click Authenticate Now.
  5. Select the system you created and click Synchronize System.
  6. Optionally, edit the system and change the name.
    The name of the system will be the name of the SAP Tenant asset in Collibra.

(Optional) Synchronize SAP Analytics Cloud data in SAP Datasphere Catalog

You must complete this step if you want to include the metadata of one or more SAP Analytics Cloud systems in your integration.

    Note 
  • The user who owns the system in SAP Datasphere Catalog must have access to all the spaces that they want to synchronize in SAP Datasphere Catalog. To own a system:
    • You need the Catalog Admin permission in SAP Datasphere Catalog.
    • You must not be the System Owner.
  • SAP does not support connections between SAP Analytics Cloud and SAP Datasphere Catalog instances that are hosted in different cloud regions, for example, EU10 and EU30. To ensure compatibility and avoid connectivity issues, both SAP Analytics Cloud and SAP Datasphere Catalog instances must be deployed in the same cloud region.

To synchronize SAP Analytics Cloud data in SAP Datasphere Catalog:

  1. In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Metadata Extractions.
    The Remote Systems page opens.
  2. Above the list of systems, click +.
    The Create System dialog box appears.
  3. Enter the required information.
    FieldDescription
    System TypeThe type of system you want to synchronize. In this case, SAP Analytics Cloud.
    Name

    The system name of the SAP Analytics Cloud system you want to synchronize.

    To find the system name in SAP, on the SAP Analytics Cloud homepage, click System > About. In the About dialog box, you need the value in the System Name field.

    UUID

    The system UUID of the SAP Analytics Cloud system you want to synchronize.

    • To get the SAP Analytics Cloud tenant UUID, you must be the SAC tenant owner.
    • To find the system UUID, on the SAC homepage, click System > About. In the About dialog box, you need the value in the System UUID field.
  4. Click Authenticate Now.
    All SAP Analytics Cloud data is synchronized to SAP Datasphere Catalog.
  5. Click Create.
  6. Select the system you created and click Synchronize System.
  7. Optionally, edit the name of the system and give it a meaningful name.
    The name of the system will be the name of the SAP Tenant asset in Collibra.

Verify or publish assets for integration

Collibra Data Lineage can only ingest assets in SAP Datasphere Catalog that are published. Therefore, you need to ensure that all the assets in SAP Datasphere Catalog that you want to integrate in Collibra are published. You need at least one published asset for the APIs to work.

To ensure that the assets you want to integrate are published:

  1. In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Search.
    The search page opens.
  2. Ensure that the assets you want to integrate have the publication status Published. If they do, there's nothing more to do. If they don't, proceed to the next step.
    1. Expand the filter.
    2. In the Publication Status section, select Unpublished to show unpublished assets only.
    3. Select all the assets that you want to ingest in Collibra. You can only publish assets with the Functional Status set to Current.
    4. In the Publish Actions dropdown list, click Publish.
Tip 

You enable or disable the Auto Publish feature at the system level. By default, this feature is disabled.

  1. In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Metadata Extractions.
    The Remote Systems page opens.
  2. Select the system for which you want to enable auto-publication.
  3. Above the list of systems, click .
    The Edit System dialog box appears.
  4. Select the Enable Auto Publishing to the Catalog option.
  5. Click Save.
    Any unpublished assets in the system are automatically published.

Configure a new OAuth client

Note You need to be an Administrator in SAP Datasphere to perform this action.

To configure a new OAuth client in SAP:

  1. In SAP, toward the bottom of the SAP Datasphere homepage, click the System tab and then click Administration.
  2. In the tab pane, click App Integration.
  3. In the OAuth Clients section, below the Configured Clients, click the + Add an OAuth Client button.
    The New OAuth Client dialog box appears.
  4. Enter the required information.
    FieldDescription
    NameThe name of the new OAuth client. This can be anything, as long as it is unique.
    OAuth Client IDThe ID is generated when the OAuth client is created.
    Purpose

    In the dropdown list, select API Access.

    Access

    In the dropdown list, select Catalog User API.

    Authorization GrantIn the dropdown list, select Client Credentials.
    SecretThe secret is generated when the OAuth client is created.
    Token Lifetime

    The amount of time that the server login session remains open while Edge is communicating with SAP Datasphere Catalog.

    During the token lifetime, you need to build your Edge connection, configure your Edge capability, and start the integration. But after that, Collibra keeps the token alive.

    The maximum value is 1,440 minutes (1 day).

  5. Click Add.
  6. Copy the following information:
    • OAuth Token URL
    • OAuth Client ID
    • OAuth Secret

You will need this information when you configure your connection and capability in Collibra.

Allow connection endpoints

Note You need to be an Administrator in SAP Datasphere to perform this action.

Ensure that the following endpoints are allowed:

Endpoint Comments
*.hanacloud.ondemand.com  
*.k8s-hana.ondemand.com  
The token URL: <tenant>.authentication.usxx.hana.ondemand.com
Note In the URL, "uxxx" can also be "euxx".

To find the token URL:

  1. In SAP, toward the bottom of the SAP Datasphere homepage, click the System > tab and then click Administration.
  2. In the tab pane, click App Integration.
    The App Integration page opens. Under Token URL, you'll find the token URL.
System URL: <tenant>.usxx.hcs.cloud.sap
Note In the URL, "uxxx" can also be "euxx".

To find the System URL:

  1. In SAP, on the SAP Datasphere homepage, click the Catalog & Marketplace tab and then click Metadata Extractions.
    The Remote Systems page opens.
  2. Located under System Type, click the relevant local or external SAP Datasphere system.
    The details page opens. There you'll find the System URL.

What's next

You can create an SAP Datasphere connection to an Edge site.