Create an SAP Datasphere connection to an Edge site
In Collibra 2024.05, we launched a new user interface (UI) for Collibra Data Intelligence Platform! You can learn more about this latest UI in the UI overview.
Use the following options to see the documentation in the latest UI or in the previous, classic UI:
Before you begin
- You have set up your SAP Datasphere Catalog token.
- You have created and installed an Edge site.
- You have given the Edge Site role the required permissions.
- You have added a vault to your Edge site.
Note Edge doesn't allow more than one capability of the same type for a connection. If you have more than one SAP Datasphere tenant, duplicate your SAP Datasphere Catalog connection and create a capability per SAP Datasphere tenant.
Required permissions
- You are a System Owner in SAP Analytics Cloud.
- You have a global role that has the System administration global permission.
- You have a global role that has the Manage Edge sites global permission.
- You have a global role that has the Manage connections and capabilities global permission.
- You have a resource role with the Configure external system resource permission, for example, Owner.
- You have added a vault to your Edge site.
- If your data source connection requires a file from your vault, the file must be encoded into Base64 and stored as a regular secret in your vault.
Steps
- Open an Edge site.
-
On the main toolbar, click
, and then click
Settings.
The Collibra settings page opens. -
In the tab pane, click Edge.
The Sites tab opens and shows a table with an overview of the Edge sites. - In the Edge site overview, click the name of an Edge site.
The Edge site page appears.
-
On the main toolbar, click
, and then click
Settings.
-
In the Connections section, click Create Connection.
The Connection settings page appears. -
In the Connections section, click Create Connection.
The Create Connection dialog box appears. - Select SAP Datasphere Catalog connection.
- Enter the required information.
Field Description Required Connection settings This section contains general information about the connection. Name The name of the connection. The name can be anything, as long as it is unique.
Tip The name that you provide here is the name you have to select in the SAP Datasphere connection field, when adding the SAP Datasphere synchronization capability or the Technical Lineage for SAP Analytics Cloud capability to the Edge site.
Yes Description The description of the connection. No Connection provider The type of connection.
Select SAP Datasphere Catalog connection
Yes Connection parameters This section contains connection authentication information. SAP Datasphere Catalog URL The URL to the SAP Datasphere tenant where you have configured the SAP Datasphere Catalog.
Yes Token URL The token URL of your OAuth client.
Show me how to find the token URL- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, you'll find the token URL.
Yes Client ID The Client ID of your OAuth client.
Show me how to find the client ID- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, scroll down to the Configured Clients. Client IDs start with "sb".
Yes Client secret key The secret of your OAuth client. The secret key is used to generate a token to access the SAP Datasphere Catalog API.
Yes Field Description Required Name The name of the connection. The name can be anything, as long as it is unique.
Tip The name that you provide here is the name you have to select in the SAP Datasphere connection field, when adding the SAP Datasphere synchronization capability or the Technical Lineage for SAP Analytics Cloud capability to the Edge site.
Yes Description The description of the connection. No Vault The vault where you store your data source values. No SAP Datasphere Catalog URL The URL to the SAP Datasphere tenant where you have configured the Datasphere Catalog.
How to use your vault...To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the query value to identify the secret in your vault.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Engine Type Select one of the following:
- Key Value
- Database
Engine Path The engine path to your vault where the value is stored. Secret Path The secret path to your vault where the value is stored. Field The name of the field to your vault where the value is stored.
Note Only available if you selected Key Value in the Secret Engine Type field.
Role The role specified in the Database engine.
Note Only available if you selected Database in the Secret Engine Type field.
Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Vault Name The name of your Azure Key Vault in your Azure Key Vault service where the value is stored. Secret Name The name of the secret in your vault where the value is stored. Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Name The name of the secret in your vault where the value is stored. Field If the secret stored in your AWS Secrets Manager is a JSON value, for example
{"pass1": "my-password", "pass2": "my-password2"}
, then you need to specify the Field to point to the exact JSON value that should be used. For example,Secret Name: edge-db-customer; Field: pass
.Note If the secret stored in your AWS Secrets Manager is a plain string value, for example
my-password
, then you do not need to specify the Field.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the name of the secret in your vault where the value is stored.
Example
Yes Token URL The token URL of your OAuth client.
Show me how to find the token URL- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, you'll find the token URL.
Yes Client ID The Client ID of your OAuth client.
Show me how to find the client ID- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, scroll down to the Configured Clients. Client IDs start with "sb".
How to use your vault...To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the query value to identify the secret in your vault.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Engine Type Select one of the following:
- Key Value
- Database
Engine Path The engine path to your vault where the value is stored. Secret Path The secret path to your vault where the value is stored. Field The name of the field to your vault where the value is stored.
Note Only available if you selected Key Value in the Secret Engine Type field.
Role The role specified in the Database engine.
Note Only available if you selected Database in the Secret Engine Type field.
Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Vault Name The name of your Azure Key Vault in your Azure Key Vault service where the value is stored. Secret Name The name of the secret in your vault where the value is stored. Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Name The name of the secret in your vault where the value is stored. Field If the secret stored in your AWS Secrets Manager is a JSON value, for example
{"pass1": "my-password", "pass2": "my-password2"}
, then you need to specify the Field to point to the exact JSON value that should be used. For example,Secret Name: edge-db-customer; Field: pass
.Note If the secret stored in your AWS Secrets Manager is a plain string value, for example
my-password
, then you do not need to specify the Field.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the name of the secret in your vault where the value is stored.
Example
Yes Client secret key The secret of your OAuth client. The secret key is used to generate a token to access the SAP Datasphere Catalog API.
How to use your vault...To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the query value to identify the secret in your vault.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Engine Type Select one of the following:
- Key Value
- Database
Engine Path The engine path to your vault where the value is stored. Secret Path The secret path to your vault where the value is stored. Field The name of the field to your vault where the value is stored.
Note Only available if you selected Key Value in the Secret Engine Type field.
Role The role specified in the Database engine.
Note Only available if you selected Database in the Secret Engine Type field.
Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Vault Name The name of your Azure Key Vault in your Azure Key Vault service where the value is stored. Secret Name The name of the secret in your vault where the value is stored. Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Name The name of the secret in your vault where the value is stored. Field If the secret stored in your AWS Secrets Manager is a JSON value, for example
{"pass1": "my-password", "pass2": "my-password2"}
, then you need to specify the Field to point to the exact JSON value that should be used. For example,Secret Name: edge-db-customer; Field: pass
.Note If the secret stored in your AWS Secrets Manager is a plain string value, for example
my-password
, then you do not need to specify the Field.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the name of the secret in your vault where the value is stored.
Example
Yes - In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click Create.
What's next?
You can now add the SAP Datasphere capability to an Edge site.
Available vaults
You can use a vault to add your data source information to your Edge site connection. |
None
AWS Secrets Manager
Azure Key Vault
CyberArk Vault
Google Secret Manager
HashiCorp Vault
|
|
|
Steps
- Open an Edge site.
-
On the main toolbar, click
, and then click
Settings.
The Collibra settings page opens. -
In the tab pane, click Edge.
The Sites tab opens and shows a table with an overview of the Edge sites. - In the Edge site overview, click the name of an Edge site.
The Edge site page appears.
-
On the main toolbar, click
, and then click
Settings.
-
In the Connections section, click Create Connection.
The Connection settings page appears. -
In the Connections section, click Create Connection.
The Create Connection dialog box appears. - Select SAP Datasphere Catalog connection.
- Enter the required information.
Field Description Required Connection settings This section contains general information about the connection. Name The name of the connection. The name can be anything, as long as it is unique.
Tip The name that you provide here is the name you have to select in the SAP Datasphere connection field, when adding the SAP Datasphere synchronization capability or the Technical Lineage for SAP Analytics Cloud capability to the Edge site.
Yes Description The description of the connection. No Connection provider The type of connection.
Select SAP Datasphere Catalog connection
Yes Connection parameters This section contains connection authentication information. SAP Datasphere Catalog URL The URL to the SAP Datasphere tenant where you have configured the SAP Datasphere Catalog.
Yes Token URL The token URL of your OAuth client.
Show me how to find the token URL- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, you'll find the token URL.
Yes Client ID The Client ID of your OAuth client.
Show me how to find the client ID- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, scroll down to the Configured Clients. Client IDs start with "sb".
Yes Client secret key The secret of your OAuth client. The secret key is used to generate a token to access the SAP Datasphere Catalog API.
Yes Field Description Required Name The name of the connection. The name can be anything, as long as it is unique.
Tip The name that you provide here is the name you have to select in the SAP Datasphere connection field, when adding the SAP Datasphere synchronization capability or the Technical Lineage for SAP Analytics Cloud capability to the Edge site.
Yes Description The description of the connection. No Vault The vault where you store your data source values. No SAP Datasphere Catalog URL The URL to the SAP Datasphere tenant where you have configured the Datasphere Catalog.
How to use your vault...To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the query value to identify the secret in your vault.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Engine Type Select one of the following:
- Key Value
- Database
Engine Path The engine path to your vault where the value is stored. Secret Path The secret path to your vault where the value is stored. Field The name of the field to your vault where the value is stored.
Note Only available if you selected Key Value in the Secret Engine Type field.
Role The role specified in the Database engine.
Note Only available if you selected Database in the Secret Engine Type field.
Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Vault Name The name of your Azure Key Vault in your Azure Key Vault service where the value is stored. Secret Name The name of the secret in your vault where the value is stored. Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Name The name of the secret in your vault where the value is stored. Field If the secret stored in your AWS Secrets Manager is a JSON value, for example
{"pass1": "my-password", "pass2": "my-password2"}
, then you need to specify the Field to point to the exact JSON value that should be used. For example,Secret Name: edge-db-customer; Field: pass
.Note If the secret stored in your AWS Secrets Manager is a plain string value, for example
my-password
, then you do not need to specify the Field.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the name of the secret in your vault where the value is stored.
Example
Yes Token URL The token URL of your OAuth client.
Show me how to find the token URL- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, you'll find the token URL.
Yes Client ID The Client ID of your OAuth client.
Show me how to find the client ID- In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click App Integration.
- In the OAuth Clients section, scroll down to the Configured Clients. Client IDs start with "sb".
How to use your vault...To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the query value to identify the secret in your vault.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Engine Type Select one of the following:
- Key Value
- Database
Engine Path The engine path to your vault where the value is stored. Secret Path The secret path to your vault where the value is stored. Field The name of the field to your vault where the value is stored.
Note Only available if you selected Key Value in the Secret Engine Type field.
Role The role specified in the Database engine.
Note Only available if you selected Database in the Secret Engine Type field.
Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Vault Name The name of your Azure Key Vault in your Azure Key Vault service where the value is stored. Secret Name The name of the secret in your vault where the value is stored. Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Name The name of the secret in your vault where the value is stored. Field If the secret stored in your AWS Secrets Manager is a JSON value, for example
{"pass1": "my-password", "pass2": "my-password2"}
, then you need to specify the Field to point to the exact JSON value that should be used. For example,Secret Name: edge-db-customer; Field: pass
.Note If the secret stored in your AWS Secrets Manager is a plain string value, for example
my-password
, then you do not need to specify the Field.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the name of the secret in your vault where the value is stored.
Example
Yes Client secret key The secret of your OAuth client. The secret key is used to generate a token to access the SAP Datasphere Catalog API.
How to use your vault...To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the query value to identify the secret in your vault.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Engine Type Select one of the following:
- Key Value
- Database
Engine Path The engine path to your vault where the value is stored. Secret Path The secret path to your vault where the value is stored. Field The name of the field to your vault where the value is stored.
Note Only available if you selected Key Value in the Secret Engine Type field.
Role The role specified in the Database engine.
Note Only available if you selected Database in the Secret Engine Type field.
Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Vault Name The name of your Azure Key Vault in your Azure Key Vault service where the value is stored. Secret Name The name of the secret in your vault where the value is stored. Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the required information:
Name Description Secret Name The name of the secret in your vault where the value is stored. Field If the secret stored in your AWS Secrets Manager is a JSON value, for example
{"pass1": "my-password", "pass2": "my-password2"}
, then you need to specify the Field to point to the exact JSON value that should be used. For example,Secret Name: edge-db-customer; Field: pass
.Note If the secret stored in your AWS Secrets Manager is a plain string value, for example
my-password
, then you do not need to specify the Field.Example
To use your vault, do the following:- In the Value Type field, select Vault Key.
- Enter the name of the secret in your vault where the value is stored.
Example
Yes - In SAP, toward the bottom of the SAP Datasphere homepage, click System > Administration.
- Click Create.
What's next?
You can now add the SAP Datasphere capability to an Edge site.