Adding endpoints to a new or existing data source definition

Last updated: Oct 03, 2024

View all the connections on the platform for the account and confirm if each connection has a data source definition assigned to it based on the connection's endpoints. If a data source definition has not been assigned to a connection, you can add the endpoints of that connection to a current data source definition or you can create a new data source definition.

Prerequisites

Review Prerequisite and requirements for data source definitions.
Confirm you have the required roles. Roles control which connections and connection details you can see in this tab as well as what actions you can do. This procedure requires the CloudPak Data Source Administrator role. For information see View the list of connections on the Connection assignments tab.
You must have access to the connection. If the connection does not have a data source definition assigned and you do not have access to the connection, consult the owner of the connection.

Procedure

Go to Data > Connectivity > Data source definitions. Click the Connection assignments tab.
Find the connection that has endpoints that you want to add to a data source definition. Connectors that do not match a supported data source type for data source definitions are identified with an information icon . If a connection is created in different projects or catalogs, the connection shows once for each occurrence.
- The connections are identified by Connection ID. To see the connection names and additional details, select the Additional filters , and select Show only: Connections that you have access to.
- To narrow the view to only connections that do not have data source definitions assigned to them, select the Additional filters Show only: Connections with no data source definition assigned.
- Use the All connectors list and the Find connection field to narrow down the list of connections. For example, you can use the filters, connectors list, and Find connection field to view all IBM Db2 connections that you have access to that do not have a data source definition assigned.
Expand the row for a connection, make note of its endpoints, and then click Add to data source definition.
The endpoint is added to the Selected endpoints panel.
Optional: Select one or more additional connections to add to the list in the Selected endpoints panel.

Important: All endpoints must be associated with the same data source.
Select one of two choices: Add to existing or Create new.

Add to existing

Important: When you add endpoints to an existing data source definition, you are editing the data source definition. Any change to a data source definition can affect data protection.

Select Add to existing.
Select a data source definition to add the endpoints to and click Select.
The endpoint information is prepopulated. You can edit the endpoints or add more endpoints for the data source.

Important:
- If you add the endpoints to a data source definition with an INACTIVE status, the asset will not be protected by the protection solution.
- The connection’s connector must match the data source type. For example, an IBM Db2 on Cloud connector is an IBM Db2 data source type. See Connectors that support data source definitions for the connectors and their associated data source types.
Review the Summary details and verify the changes. Click the Edit icon to return to any previous step or click Back to return to the Data source endpoints step.
Click Save.
Optional: In the success notification, click Add members to change the members of the asset or to change the public or private privacy setting.

The connections list is updated by a background job that runs whenever a data source definition is created, edited, or deleted. Click the Refresh icon to see the latest update.

The data source definition is assigned to all connections or connected data assets for the account across the platform with matching endpoints. Additionally, when users create new connections or connected data assets that have endpoints that match the data source definition, the data source definition is assigned to the connections or connected data assets.

Create new

Select Create new.
In the Overview step, enter a name and optional description for the data source definition. You cannot change the name after you create it.
Select a data source type.

Important: The connection’s connector must match the data source type. For example, an IBM Db2 on Cloud connector is an IBM Db2 data source type. See Connectors that support data source definitions for the connectors and their associated data source types.
Confirm the protection solution and click Next.
The endpoint information is prepopulated. You can edit the endpoints or add more endpoints for the data source.
Click Next.
Review the Summary details. Click the Edit icon to return to any previous step or click Back to return to the Data source endpoints step.
Click Create.
By default, a new data source definition is a private asset. In the success notification, click Add members to add members to the asset or to make the asset public. For example, if you have more than one person who is managing data source definitions.

The connections list is updated by a background job that runs whenever a data source definition is created, edited, or deleted. Click the Refresh icon to see the latest update.

The data source definition is assigned to all connections or connected data assets for the account across the platform with matching endpoints. Additionally, when users create new connections or connected data assets that have endpoints that match the data source definition, the data source definition is assigned to the connections or connected data assets.

Learn more

Parent topic: Creating a data source definition