Warning Jobserver and all related Jobserver integrations are end of life starting October, 2024, with the exception of Public Sector customers using GovCloud or on-prem environments.
For information about using Catalog connectors on Edge, go to Overview of Catalog connectors.

Register a data source using your own driver

You can register a database as a data source using one of your own drivers.

Prerequisites

• You have a global role with the Catalog global permission, for example, Catalog Author.
• You have configured one or more Jobservers in Collibra Console. If there is no available Jobserver, the Register data source actions will be grayed out in the global create menu of Collibra Platform Self-Hosted.
• If you are using a Collibra Platform Self-Hosted environment with an on-premises Jobserver, both must have the same installer version. You can find the installer version of your Collibra Platform Self-Hosted environment at the bottom of the sign-in window of its Collibra Console, for example 5.9.2-0
• You have a resource role with the following resource permissions on the Schema community:
  • Asset > add
  • Attribute > add
  • Domain > add
  • Attachment > add

Steps

1. On the main toolbar, click → Catalog.
   The Catalog homepage opens.
2. On the main toolbar, click .
   The Create dialog box appears.
3. In the Create dialog box, click Register a Data Source Using Your Own Driver).
   
4. In the Register data source dialog box, click GenericAmazon RedShiftCloudera HiveHortonworks HiveHP VerticaIBM DB2Mapr HiveSQL ServerMySQLOraclepostgreSQLTeradata.
5. Do one of the following:
   • Click Select in the row of an existing driver to continue.
   • Add a new driver.

     1. Click Add Driver.
     2. Enter the required information.

        Field	Description
        JDBC Driver Version Name	The name of the JDBC driver. Tip As a best practice, we recommend you use a strict naming convention which includes the data source and a version number. For example: Google BigQuery 1.5 or MySQL 5.9.
        Driver files	This table contains a list of uploaded files. You can remove a driver file by clicking .
        Connection string	The JDBC connection string.
        Driver Class Name	The driver class name of the connection.
        Connection properties	This section contains the connection properties. Amazon Redshift Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes Cloudera Hive Connection properties Label Property Description Mandatory URL (hostname:port) host Address of the used database. Use the format hostname:port. Yes Principal principal The Kerberos principal identity. Yes Schema schema The name of your schema. Yes Hortonworks Hive Connection properties Label Property Description Mandatory URL (hostname:port) host Address of the used database. Use the format hostname:port. Yes Schema schema The name of your schema. Yes HP Vertica Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes IBM DB2 Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes MapR Hive Connection properties Label Property Description Mandatory URL (hostname:port) host Address of the used database. Use the format hostname:port. Yes Schema schema The name of your schema. Yes Microsoft SQL Server Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database databaseName The name of your database. Yes Schema schema The name of your schema. Yes MySQL Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Oracle DB Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes SID sid The Oracle System ID, which identifies a database on a system. Yes Schema schema The name of your schema. Yes PostgreSQL Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes Teradata Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes If you want to use Kerberos authentication, you also need the following connection properties. Label Property Description Mandatory Principal principal The Kerberos principal identity. Yes Kerberos realm realm The Kerberos realm name. Yes Login context name loginContextName You can find the value for this property in the jaas.conf file. The login context name that is used as the index to the configuration. Yes Jaas file name com.collibra.jobserver.dto.catalog.JdbcConnection.jaasConfig The name of the Jaas file. Yes Kerberos configuration file com.collibra.jobserver.dto.catalog.JdbcConnection.krbConfig The configuration file containing specific properties for Kerberos authentication. Yes If you want to use NTLM authentication, you also need the following connection properties. Connection properties Label Property Description Mandatory Security integratedSecurity must be value True. The security that enables the authentication Yes Authentication scheme authenticationScheme must be value NTLM. The used authentication scheme, which is NTLM. Yes If you want to use CyberArk authentication, you need the following connection properties. If you use one of the CyberArk connection properties, Data Catalog automatically uses CyberArk authentication. Label Property Description Mandatory Keystore file keystoreFile The name of the keystore file. The keystore must contain the client key and client certificate or certificate chain. If defaultTruststore is set to false, the keystore has to contain the trusted CA certificate needed to validate the server certificate offered by CyberArk. The value must have the following format: file://<keystore-file name.jks>. Example file://cyberark-keystore.jks Yes Keystore password keystorePass The password required to open the keystore. Yes Default truststore defaultTruststore The indication of the default truststore. The default value is set to False. False: The certificate is validated through the keystoreFile property. True: The certificate is validated through the default truststore from the Java JRE. This is recommended when CyberArk is set up to offer a server certificate that can be validated by a public CA (certification authority). No CyberArk address cyberarkAddress The host and port number through which the CyberArk server is accessible. The format of the address is hostname:port. Example my.cyberark.com:5502 Yes CyberArk application ID cyberarkAppId The application ID as defined in CyberArk. This ID should be provided by your network or system administrator. Yes CyberArk query cyberarkQuery The CyberArk query. This query should be provided by your network or system administrator. Yes

     3. Click Save & Continue.
   • Edit an existing driver.

     1. Click in the row of an existing driver.
     2. Enter the required information.

        Field	Description
        JDBC Driver Version Name	The name of the JDBC driver. Tip As a best practice, we recommend you use a strict naming convention which includes the data source and a version number. For example: Google BigQuery 1.5 or MySQL 5.9.
        Driver files	This table contains a list of uploaded files. You can remove a driver file by clicking .
        Connection string	The JDBC connection string. Warning Some connection properties can be added to the URL as name-value pairs separated by semicolons. We recommend you not to use this mechanism unless we specify differently in our documentation. Keep in mind that most properties in the URL are ignored. Instead, we recommend you to specify all connection properties in the below section of this dialog box.
        Driver Class Name	The driver class name of the connection.
        Connection properties	This section contains the connection properties. Amazon Redshift Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes Cloudera Hive Connection properties Label Property Description Mandatory URL (hostname:port) host Address of the used database. Use the format hostname:port. Yes Principal principal The Kerberos principal identity. Yes Schema schema The name of your schema. Yes Hortonworks Hive Connection properties Label Property Description Mandatory URL (hostname:port) host Address of the used database. Use the format hostname:port. Yes Schema schema The name of your schema. Yes HP Vertica Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes IBM DB2 Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes MapR Hive Connection properties Label Property Description Mandatory URL (hostname:port) host Address of the used database. Use the format hostname:port. Yes Schema schema The name of your schema. Yes Microsoft SQL Server Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database databaseName The name of your database. Yes Schema schema The name of your schema. Yes MySQL Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Oracle DB Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes SID sid The Oracle System ID, which identifies a database on a system. Yes Schema schema The name of your schema. Yes PostgreSQL Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes Teradata Connection properties Label Property Description Mandatory Hostname host The name of your device. Yes Port port The port number. Yes Database database The name of your database. Yes Schema schema The name of your schema. Yes If you want to use Kerberos authentication, you also need the following connection properties. Label Property Description Mandatory Principal principal The Kerberos principal identity. Yes Kerberos realm realm The Kerberos realm name. Yes Login context name loginContextName You can find the value for this property in the jaas.conf file. The login context name that is used as the index to the configuration. Yes Jaas file name com.collibra.jobserver.dto.catalog.JdbcConnection.jaasConfig The name of the Jaas file. Yes Kerberos configuration file com.collibra.jobserver.dto.catalog.JdbcConnection.krbConfig The configuration file containing specific properties for Kerberos authentication. Yes If you want to use NTLM authentication, you also need the following connection properties. Connection properties Label Property Description Mandatory Security integratedSecurity must be value True. The security that enables the authentication Yes Authentication scheme authenticationScheme must be value NTLM. The used authentication scheme, which is NTLM. Yes If you want to use CyberArk authentication, you need the following connection properties. If you use one of the CyberArk connection properties, Data Catalog automatically uses CyberArk authentication. Label Property Description Mandatory Keystore file keystoreFile The name of the keystore file. The keystore must contain the client key and client certificate or certificate chain. If defaultTruststore is set to false, the keystore has to contain the trusted CA certificate needed to validate the server certificate offered by CyberArk. The value must have the following format: file://<keystore-file name.jks>. Example file://cyberark-keystore.jks Yes Keystore password keystorePass The password required to open the keystore. Yes Default truststore defaultTruststore The indication of the default truststore. The default value is set to False. False: The certificate is validated through the keystoreFile property. True: The certificate is validated through the default truststore from the Java JRE. This is recommended when CyberArk is set up to offer a server certificate that can be validated by a public CA (certification authority). No CyberArk address cyberarkAddress The host and port number through which the CyberArk server is accessible. The format of the address is hostname:port. Example my.cyberark.com:5502 Yes CyberArk application ID cyberarkAppId The application ID as defined in CyberArk. This ID should be provided by your network or system administrator. Yes CyberArk query cyberarkQuery The CyberArk query. This query should be provided by your network or system administrator. Yes

     3. Click Save & Continue.
   • Delete an existing driver.

     1. Click in the row of an existing driver.
     2. Click Delete to confirm the deletion.
6. Configure the data source:
   

   Field	Description
   Schema Name	This name is used in CPSH as schema asset and must therefore be unique.
   Schema Description	The description of the schema. This is used as description of the schema asset.
   Owner	The owner of the registered data in CPSH.
   Process On	The jobserver used for ingesting.
   <Connection properties section>	The connection properties as defined in your JDBC driver. Label Description Hostname The name of your device. Port The port number. Database The name of your database. Schema The name of your schema. Label Description URL (hostname:port) Address of the used database. Use the format hostname:port. Principal The Kerberos principal identity. Schema The name of your schema. Label Description URL (hostname:port) Address of the used database. Use the format hostname:port. Schema The name of your schema. Label Description Hostname The name of your device. Port The port number. Database The name of your database. Schema The name of your schema. Label Description Hostname The name of your device. Port The port number. Database The name of your database. Schema The name of your schema. Label Description URL (hostname:port) Address of the used database. Use the format hostname:port. Schema The name of your schema. Label Description Hostname The name of your device. Port The port number. Database The name of your database. Schema The name of your schema. Label Description Hostname The name of your device. Port The port number. Database The name of your database. Label Description Hostname The name of your device. Port The port number. SID The Oracle System ID, which identifies a database on a system. Schema The name of your schema. Label Description Hostname The name of your device. Port The port number. Database The name of your database. Schema The name of your schema. Label Description Hostname The name of your device. Port The port number. Database The name of your database. Schema The name of your schema. If you want to use Kerberos authentication, you also need the following connection properties. Label Description Principal The Kerberos principal identity. Kerberos realm The Kerberos realm name. Login context name The login context name that is used as the index to the configuration. Jaas file name The name of the Jaas file. Kerberos configuration file The configuration file containing specific properties for Kerberos authentication. If you want to use NTLM authentication, you also need the following connection properties. Label Description Security The security that enables the authentication Authentication scheme The used authentication scheme, which is NTLM. If you want to use CyberArk authentication, you need the following connection properties. Label Description Keystore file The name of the keystore file. The keystore must contain the client key and client certificate or certificate chain. If defaultTruststore is set to false, the keystore has to contain the trusted CA certificate needed to validate the server certificate offered by CyberArk. The value must have the following format: file://<keystore-file name.jks>. Example file://cyberark-keystore.jks Keystore password The password required to open the keystore. Default truststore The indication of the default truststore. The default value is set to False. False: The certificate is validated through the keystoreFile property. True: The certificate is validated through the default truststore from the Java JRE. This is recommended when CyberArk is set up to offer a server certificate that can be validated by a public CA (certification authority). CyberArk address The host and port number through which the CyberArk server is accessible. The format of the address is hostname:port. Example my.cyberark.com:5502 CyberArk application ID The application ID as defined in CyberArk. This ID should be provided by your network or system administrator. CyberArk query The CyberArk query. This query should be provided by your network or system administrator.
   Login Information
   Store Credentials	Select this option to store the credentials to access the database. With a schema refresh, you can clear this option again.
   Username	Username to access the database. Note This field is ignored if your data source uses any other means of authentication, such as Cyberark, Kerberos, NTLM or any certificate-based authentication method.
   Password	Corresponding password to access the database. Note This field is ignored if your data source uses any other means of authentication, such as Cyberark, Kerberos, NTLM or any certificate-based authentication method.
   Schedule Data Refresh	Enable or disable a schedule to automatically refresh the data registration.
   Cron Expression	Schedule of the data refresh as a Cron pattern. If you create an invalid Cron pattern, Collibra Platform Self-Hosted stops responding.
   Time Zone	The time zone of the database.
   Store Data Profile	Option to perform data profiling on the registered data.
   Store Sample Data	Option to extract sample data from the registered data.
   Tables excluded from registration	Database tables that will not be ingested. Note  If required, you can exclude multiple tables. To do this, press Enter after typing a value and then type the next. You can use an asterisk (*) as wildcard to select multiple tables. For example, if you want to exclude the tables that all start with act_, you can enter act_*. The table names are case sensitive. You can add or remove tables from this list by refreshing the schema. The Table assets that are created after ingestion have an attribute type called Table Type that defines the type of table that is declared in the data source. For example, TABLE, VIEW,...

7. Click Save & Create.

What's next

The data source is registered and the data is automatically ingested. The ingestion of data is executed in a job. You can see this job in the list of activities.