Once an Edge connection with a Catalog JDBC ingestion capability is available, you can register the data source in Collibra.
This creates an initial structure in a selected community in Data Catalog, in which you can then synchronize the metadata.
Prerequisites
- You have enabled data source registration via Edge.
- You have set up a JDBC connection in Edge:
- You have added the Catalog JDBC ingestion capability to allow for the registration of the data source.
- Ensure the user in the Edge connection has the minimum user permissions to read the metadata from the source. For information, go to the connection properties.
- You have created a System asset.
- You have a global role with the Catalog global permission, for example, Catalog Author.
- You have a global role with the View Edge connections and capabilities global permission, for example, Edge integration engineer.
- You have a resource role with the Configure external system resource permission, for example, Owner.
Steps
-
On the main toolbar, click
→
Catalog.
The Catalog homepage opens. -
In the tab bar, click Integrations.
The Integrations page opens. - Click the Data Source Registration tab.
- In the row of the data source that you want to register, click Register.
The Register a Data Source dialog box opens.For some data sources, you can register multiple databases via the same JDBC connection. If a database is already registered, the name of the Database asset appears in the Data sources column.
- Enter the required information.
Field Description Community The name of the parent community in which you want to add the Database asset.
After you have registered the database, a new domain will be created in the community that you have specified.System
The name of the System asset to which you want to link the Database asset.
After you have registered the database, a 'Technology Asset groups / is grouped by Technology Asset' relation will be created between this System asset and the newly created Database asset.A Database asset should have only one relation of the type 'Technology asset groups / is grouped by Technology asset' to a System asset.
Owner
Tip By default, this field is called Owner, referencing the out-of-the-box Owner resource role. If you change the name of this out-of-the-box resource role, the updated name will be shown here instead.
The name of the owner of the new domain and Database asset. By default, the current user is selected.
After you have registered the database, a new domain and Database asset will be created specifically for the database in the community that you have specified. The user you select in this field will receive the responsibility for the domain. This ownership is then inherited by the Database asset.A Database asset must have an owner for synchronizations to run. The owner can be changed later on, but shouldn't be removed.
Database
Select the name of the database that you want to register via the JDBC connection. The drop-down list automatically shows one or more databases that exist in your data source.
You can refresh the list by clicking
.
After you have registered the database, the name visible in the drop-down list will be the name of the Database asset.Important considerations:
- Some data sources allow you to use one connection to register multiple databases. In that case, the drop-down list shows more than one name.
- Collibra maps Project ID in Google Bigquery, and Data Source in AWS Athena and AWS Glue to Database.
- For some data sources, such as CSV, you can see CDATA as an option. For information on changing the name, go to Customizing the database name for database-less data sources.
- If scalable ingestion is active in your environment, Collibra prevents you from registering a database that is already registered through a different Edge connection. In this case, the database name is grayed out in the drop-down list. To register the database again, first delete the existing Database asset.
- If you rename a database in the data source, the Edge synchronization process treats it as a new database. The existing Database asset is marked with the Missing from source status. You must create a new Database asset through a new data source registration.
Description A description of the data source.
- Click Register.
When the registration of your data source is complete:- A confirmation message appears.
- A Physical Data Dictionary domain containing a Database asset is created.
- A 'Technology asset groups / is grouped by Technology asset' relation is created between the Database asset and the System asset.Important
It’s recommended not to remove the relation between the Database asset and the System asset.
- The Database asset page opens and a list of available schemas is available on the Configuration tab page of the Database asset.
If you registered a database without schemas, a new Schema asset is automatically created with the same name as the database or with a name as defined in the Edge capability.
You can now configure and start the synchronization of the schemas in the database.