Configure Connection to Teradata Data Source¶
Alation Cloud Service Applies to Alation Cloud Service instances of Alation
Customer Managed Applies to customer-managed instances of Alation
After you install the Teradata OCF connector, configure the connection to the Teradata data source.
Follow these steps:
Provide Access¶
On the Access tab, set the data source visibility using these options:
Public Data Source—The data source will be visible to all users of the catalog.
Private Data Source—The data source will be visible to the users allowed access to the data source by Data Source Admins.
You can add new Data Source Admin users in the Data Source Admins section.
Connect to the Data Source¶
To connect to the data source, follow these steps:
Provide the JDBC URI¶
Before using the JDBC URI format, let’s understand the JDBC URI format and parameters for the Teradata OCF connector.
Teradata JDBC URI Format¶
Format¶
teradata://<hostname_or_ip>/DBS_PORT=<port>,COP=OFF,CHARSET=UTF8
Note
The default port number is 1025.
Example¶
teradata://192.0.2.10/DBS_PORT=1234,COP=OFF,CHARSET=UTF8
No additional parameters are required in the URI string when you are using an LDAP account for extraction, default sampling and profiling, and query log ingestion. In this case, the connector auto-appends the parameter LOGMECH=LDAP. However, when you are using an LDAP account for dynamic sampling or in Compose, you must explicitly append the parameter LOGMECH=LDAP to the JDBC URI.
Example¶
teradata://192.0.2.10/DBS_PORT=1234,COP=OFF,CHARSET=UTF8,LOGMECH=LDAP
To provide to the JDBC URI in the Alation UI, perform these steps:
From Alation version 2023.3.2.1 and connector version 1.3.0
On the Settings page of your Teradata data source, go to the General Settings tab.
In the Provide the JDBC URI section, enter the JDBC URI.
Follow the correct JDBC URI format (
teradata://<hostname_or_ip>/DBS_PORT=<port>,COP=OFF,CHARSET=UTF8).Note
Click the View history icon to view the history of recent URI values. The History: Recent URI Values list displays 100 URI entries. You can copy a URI from the list to reuse.
Click Save.
On the Settings page of your Teradata data source, go to the General Settings tab.
Go to the Connector Settings > Datasource connection section and enter the JDBC URI.
Follow the correct JDBC URI format (
teradata://<hostname_or_ip>/DBS_PORT=<port>,COP=OFF,CHARSET=UTF8).Click Save.
Configure Authentication¶
For metadata extraction (MDE), profiling, and query log ingestion, the Teradata OCF connector uses authentication via username and password of service account. The connector also supports LDAP authentication to use an LDAP server to establish JDBC connection.
To configure authentication, perform these steps:
From Alation version 2023.3.2.1 and connector version 1.3.0
On the Settings page of Teradata data source, go to the General Settings tab.
Enter the username and password for of the service account under the Authentication section.
To use LDAP authentication, turn on the Use LDAP Server toggle.
Click Save.
On the Settings page of your Teradata data source, click on the General Settings tab.
Go to the Connector Settings > Datasource connection section and enter the username and password of the service account.
To use LDAP authentication, turn on the Use LDAP Server toggle.
Click Save.
Test the Connection¶
The connection test checks database connectivity. Alation uses the JDBC URI to connect to the database and to confirm when the connection is established.
After specifying the JDBC URI and configuring authentication, test the connection.
To validate the network connectivity, go to General Settings > Test Connection of the Settings page of your Teradata data source and click Test.
A dialog box appears displaying the status of the connection test.
Configure Additional Connection Settings¶
Apart from the mandatory configurations that you perform to connect to the data source in the General Settings tab, you can configure the following additional settings:
Configure Additional Data Source Connections¶
Alation can associate objects in a data source with objects in another source in the catalog through lineage. For example, you can show lineage between your data source and BI sources that use its data.
Provide additional connection information for the data source to see lineage across multiple sources on the Lineage chart.
From Alation version 2023.3.2.1 and connector version 1.3.0
To enter additional data source connection details, go to General Settings > Advanced settings of the Settings page of your Teradata connector and enter the connection URL.
Use the following format:
<host>:<port>You can provide multiple values as a comma-separated list:
<host1>:<port1>,<host2>:<port2>For example:
192.0.2.10:1234,server.com:1234
On the Application Settings section of General Settings tab, provide the host and port information in the BI Connection Info field.
This parameter is used to generate lineage between the current data source and another source in the catalog, for example a BI source that retrieves data from the underlying database. The parameter accepts host and port information of the corresponding BI data source connection.
Use the following format: <host>:<port>
You can provide multiple values as a comma-separated list:
<host1>:<port1>,<host2>:<port2>
For example:
192.0.2.10:1234,server.com:1234
For more details, see Configure Cross-Source Lineage.
Enable or Disable Automatic Lineage Generation¶
You can enable or disable the lineage for the data source to be generated automatically during metadata extraction, query log ingestion, and from Data Definition Language queries run by users in Compose. By default, automatic lineage generation is enabled.
From Alation version 2023.3.2.1 and connector version 1.3.0
Go to General Settings > Advanced settings of the Settings page of your Teradata data source and enable or disable the Disable automatic lineage generation toggle.
Disable the Disable automatic lineage generation toggle when you want to automatically generate the lineage.
Enable this option when you do not want lineage to be automatically generated and prefer to create lineage manually or using an API.
On the Application Settings section of General Settings tab, disable the Disable automatic lineage generation toggle when you want to automatically generate the lineage.
Enable this option when you do not want lineage to be automatically generated and prefer to create lineage manually or using an API.
Enable or Disable Obfuscate Literals¶
You can hide literal values from queries ingested with query log ingestion and displayed on the Queries tab of a schema and table catalog objects.
On the General Settings tab enable or disable the Obfuscate literals toggle.
When enabled, literal values are substituted with placeholder values. Disable this option when you want literal values in queries to be visible to users.
By default, this option is disabled.
Configure Logging¶
To set the logging level for your Teradata OCF data source logs, perform these steps:
From Alation version 2023.3.2.1 and connector version 1.3.0
On the Settings page of your Teradata OCF data source, go to General Settings > Connector logs.
Select a logging level for the connector logs and click Save.
The available log levels are based on the Log4j framework.
On the Settings page of your Teradata OCF data source, go to Logging configuration section of General Settings tab.
Select a logging level for the connector logs and click Save.
The available log levels are based on the Log4j framework.
You can view the connector logs in Admin Settings > Server Admin > Manage Connectors > Teradata OCF connector.
Delete the Data Source¶
To delete the Data Source, refer Delete a Data Source.
Note
For Teradata OCF Connector version 1.3.0 and newer, the delete option will not be available on the Settings page of the data source.