Configure the Data Source Connection

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

After you install the Adobe Analytics OCF connector, you must configure the connection to the Adobe Analytics data source.

The various steps involved in configuring the Adobe Analytics data source connection setting are:

Provide Access

To set the data source visibility,go to the Access tab on the Settings page of your Adobe Analytics data source, set the data source visibility using these options:

  • Public Data Source — The data source is visible to all users of the catalog.

  • Private Data Source — The data source is 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 Data Source

To establish the connection to data source, you must:

Provide the JDBC URI

Important

We recommend that you provide the values in the corresponding fields on the General Settings page instead of the JDBC URI field in the Datasource Connection section. Leave this field empty if all the connection properties you need are available in the user interface.

Configure Authentication

For metadata extraction (MDE), profiling and sampling, the connector supports:

  • OAuth (Client Credentials)

Configure OAuth Authentication

  1. On the Settings page of your Adobe Analytics data source, go to the General Settings tab.

  2. In the Connector Settings section, provide the following details in the Datasource Connection section.

    Field

    Description

    Auth Type

    Select the auth profile that you created for OAuth in Alation from the dropdown.

    Authentication Profiles

    Select WQL or Reports or REST from the dropdown. SOAP connection type is not supported for OAuth.

    SSL Server Cert

    If you choose to encrypt using SSL, specify the certificate to be accepted from the server when connecting using TLS/SSL.

  3. Click Save.

OAuth Workflow

  1. Create an authentication profile in Alation. See Authentication Setup in Alation.

  2. Configure the connector to use OAuth authentication. See Configure OAuth Authentication.

  3. Alation redirects to the Adobe Analytics DataSource UI, where the user provide their credentials. This step handles the exchange of the authorization code for an access token.

  4. After the authentication is successful, Alation receives a Refresh Token and passes it to the Adobe Analytics connector.

  5. The Adobe Analytics connector uses this Refresh Token to make an API call to Adobe Analytics to obtain a new access token. This access token is then set in the Adobe Analytics connection property and persisted at the connection level.

  6. The test connection succeeds only when the above mentioned steps are accomplished and the token are valid.

Test the Connection

The connection test checks database connectivity.

After configuring authentication, test the connection.

To validate the network connectivity, go to General Settings > Test Connection of the Settings page of your Adobe Analytics data source and click Test.

A dialog box appears confirming the status of the connection test.

Note

Frequent use of Test Connection might result in app throttling. Use this option diligently.

Configure Additional Connection Settings

Apart from the mandatory configurations that you perform to connect to the data source on the General Settings tab, configure the following additional settings:

Note

In the General Settings tab, leave the Additional data source connection field blank and skip the Disable automatic lineage generation toggle as these options are not applicable to the Adobe Analytics OCF connector.

Configure Firewall Settings

  1. On the Settings page of your Adobe Analytics data source, go to the General Settings tab.

  2. In the Connector Settings section, provide the following details in the Firewall section.

    Parameter

    Description

    Firewall Type

    Specify the protocol the proxy-based firewall uses for traffic tunneling.

    • TUNNEL: Opens a connection to Adobe Analytics and traffic flows back and forth through the proxy.

    • SOCKS4: Sends data through the SOCKSv4 proxy as specified in the Firewall Server and Firewall Port.

    • SOCKS5: Sends data through the SOCKSv5 proxy as specified in the Firewall Server and Firewall Port.

    Firewall Server

    Specify the hostname, DNS name, or IP address of the proxy-based firewall.

    Firewall Port

    Specify the TCP port of the proxy-based firewall.

    Firewall User

    Specify the user name to authenticate with the proxy-based firewall.

    Firewall Password

    Specify the password to authenticate with the proxy-based firewall.

  3. Click Save.

Configure Proxy Settings

  1. On the Settings page of your Adobe Analytics data source, go to the General Settings tab.

  2. In the Connector Settings section, provide the following details in the Proxy section.

    Parameter

    Description

    Proxy Auto Detect

    Select the checkbox to use the system proxy settings. This takes precedence over other proxy settings, so do not select this checkbox to use custom proxy settings.

    Proxy Server

    Specify the hostname or IP address of a proxy to route HTTP traffic through.

    Proxy Port

    Specify the TCP port the Proxy Server proxy is running on.

    Proxy Auth Scheme

    Select the authentication type to authenticate to the Proxy Server from the drop-down:

    • BASIC

    • DIGEST

    • NONE

    • NEGOTIATE

    • NTLM

    • PROPRIETARY

    Proxy User

    Specify the user name to authenticate the ProxyServer.

    Proxy Password

    Specify the password of the Proxy User.

    Proxy SSL Type

    Select the SSL type when connecting to the ProxyServer from the drop-down:

    • AUTO

    • ALWAYS

    • NEVER

    • TUNNEL

    Proxy Exceptions

    Specify the list (separated by semicolon) of destination hostnames or IPs that are exempt from connecting through the Proxy Server.

  3. Click Save.

Configure Logging

To set the logging level for your Adobe Analytics OCF data source logs, perform these steps:

  1. On the Settings page of your Adobe Analytics OCF data source, go to General Settings > Logging configuration.

  2. 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 > Adobe Analytics OCF connector.

Configure Schema Settings

  1. On the Settings page of your Adobe Analytics data source, go to the General Settings tab.

  2. In the Connector Settings section, provide the following details in the Schema section.

    Parameter

    Description

    Browsable Schemas

    Specify the schemas as a subset of the available schemas in a comma-separated list. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

    Tables

    Specify the fully qualified name of the table as a subset of the available tables in a comma-separated list.

    Each table must be a valid SQL identifier that might contain special characters escaped using square brackets, double quotes, or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

    Views

    Specify the fully qualified name of the Views as a subset of the available tables in a comma-separated list.

    Each view must be a valid SQL identifier that might contain special characters escaped using square brackets, double quotes, or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Configure Miscellaneous Settings

  1. On the Settings page of your Adobe Analytics data source, go to the General Settings tab.

  2. In the Connector Settings section, provide the following details in the Misc section.

    Parameter

    Description

    Batch Size

    Specify the maximum size of each batch operation to submit.

    When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the request size that can be submitted.

    Setting BatchSize to 0 will submit the entire batch as specified.

    Connection LifeTime

    The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.

    The default is 0, indicating no limit to the connection lifetime.

    Include Summary Data

    Configure the data exposed for custom reports. By default, the summary records are not included.

    Max Rows

    Limit the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

    Other

    This field is for properties that are used only in specific use cases.

    Page size

    Specify the maximum number of rows to fetch.

    The provider batches read to Adobe Analytics to reduce overhead. Instead of fetching a single row from the broker every time a query row is read, the provider will read multiple rows and save them to the resultset. Only the first row read from the resultset must wait for the broker. Later rows can be read out of this buffer directly.

    This option controls the maximum number of rows the provider stores on the resultset. Setting this to a higher value will use more memory but requires waiting on the broker less often. Lower values will give lower throughput while using less memory.

    Pool Idle Timeout

    Specify the allowed idle time for a connection before it is closed. The default value is 60 seconds.

    Pool Max Size

    The maximum connections in the pool. The default is 100.

    Pool Min Size

    The minimum number of connections in the pool. The default is 1.

    Pool Wait Time

    The max seconds to wait for an available connection. The default value is 60 seconds.

    Pseudo Columns

    This property indicates whether or not to include pseudo columns as columns to the table.

    Skip Empty Rows

    Exclude empty records in report recordsets. This is recommended if you’re using Support Enhanced Break Down and querying a report with more than two breakdown levels.

    Support Enhanced Break Down

    Select this to use a breadth-first search algorithm to maximize the number of dimension records sent for breaking down per single request.

    Timeout

    Specify the value in seconds until the timeout error is thrown, canceling the operation.

    Use Connection Pooling

    Select this checkbox to enable connection pooling.

    User Defined Views

    Specify the file path pointing to the JSON configuration file containing your custom views.

  3. Click Save.

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.

Go to General Settings > Obfuscate Literals of the Settings page of your Adobe Analytics data source and 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.