DocumentationExperience Platform Federated Audience Composition

Configure your Federated databases federated-db

Last update: Wed Nov 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Experience Platform Federated Audience Composition allows Customer to build and enrich audiences from the third-party data warehouses and import the audiences to Adobe Experience Platform.

Learn how to ceate, configure, test and save the connection to your external database in this page. You can find below the list of supported databases and the detailed settings to configure for each of them.

Supported databases supported-db

With Federated Audience Composition, you can connect to the following databases. Configuration for each database is detailed below.

Amazon Redshift amazon-redshift

Use Federated databases to process information stored in an external database. Follow the steps below to configure access to Amazon Redshift.

  1. Under the Federated data menu, select Federated databases.

  2. Click Add federated database.

  3. Enter a Name to your Federate database.

  4. From the Type drop-down, select Amazon Redshift.

  5. Configure the Amazon Redshift authentication settings:

    • Server: Add the name of the DNS.

    • Account: Add the username.

    • Password: Add the account password.

    • Database: Name of your database if not specified in DSN. It can be left empty if specified in the DSN

    • Working schema: Name of the database schema to use for work tables. Learn more in Amazon documentation

      note note
      NOTE
      You can use any schema from the database, including schemas used for temporary data processing, as long as you have the required permission to connect to this schema.
      Distinct working schemas must be used when connecting multiple sandboxes with the same database.

  6. Select the Test the connection option to verify your configuration.

  7. Click Deploy functions button to create the functions.

  8. Once your configuration is done, click Add to create your Federate database.

Azure Synapse Analytics azure-synapse

Use Federated databases to process information stored in an external database. Follow the steps below to configure access to Azure Synapse Analytics.

  1. Under the Federated data menu, select Federated databases.

  2. Click Add federated database.

  3. Enter a Name to your Federate database.

  4. From the Type drop-down, select Azure Synapse Analytics.

  5. Configure the Azure Synapse Analytics authentication settings:

    • Server: Enter the URL of the Azure Synapse server.

    • Account: Enter the Username.

    • Password: Enter the account password.

    • Database (optional): Enter the name of your database if not specified in the DSN.

    • Options: The connector supports the options detailed in the table below.

  6. Select the Test the connection option to verify your configuration.

  7. Click Deploy functions button to create the functions.

  8. Once your configuration is done, click Add to create your Federate database.

Option
Description
Authentication
Type of authentication supported by the connector. Current supported value: ActiveDirectoryMSI. For more information, refer to Microsoft SQL documentation (Example connection strings n°8)

Google Big Query google-big-query

Use Federated databases to process information stored in an external database. Follow the steps below to configure access to Google Big Query.

  1. Under the Federated data menu, select Federated databases.

  2. Click Add federated database.

  3. Enter a Name to your Federate database.

  4. From the Type drop-down, select Google Big Query.

  5. Configure the Google Big Query authentication settings:

    • Service account: Enter the email of your Service account. For more information on this, refer to Google Cloud documentation.

    • Project: Enter the ID of your Project. For more information on this, refer to Google Cloud documentation.

    • Dataset: Enter the name of your Dataset. For more information on this, refer to Google Cloud documentation.

    • Key file Path: Upload your key file to the server. Only .json files are accepted.

    • Options: The connector supports the options detailed in the table below.

  6. Select the Test the connection option to verify your configuration.

  7. Click Deploy functions button to create the functions.

  8. Once your configuration is done, click Add to create your Federate database.

Option
Description
ProxyType
Type of proxy used to connect to BigQuery through ODBC and SDK connectors.
HTTP (default), http_no_tunnel, socks4 and socks5 are currently supported.
ProxyHost
Hostname or IP address where the proxy can be reached.
ProxyPort
Port number the proxy is running on, e.g. 8080
ProxyUid
Username used for the authenticated proxy
ProxyPwd
ProxyUid password
bqpath
Note that this is applicable for bulk-load tool only (Cloud SDK).
To avoid using PATH variable or if the google-cloud-sdk directory has to be moved to another location, you can specify with this option the exact path to the cloud sdk bin directory on the server.
GCloudConfigName
Note that this is applicable starting release 7.3.4 release and for bulk-load tool only (Cloud SDK).
The Google Cloud SDK uses configurations to load data into BigQuery tables. The configuration named accfda stores the parameters for loading the data. However, this option allows users to specify a different name for the configuration.
GCloudDefaultConfigName
Note that this is applicable starting release 7.3.4 release and for bulk-load tool only (Cloud SDK).
The active Google Cloud SDK configuration cannot be deleted without first transferring the active tag to a new configuration. This temporary configuration is necessary to recreate the main configuration for loading data. The default name for the temporary configuration is default, this can be changed if needed.
GCloudRecreateConfig
Note that this is applicable starting release 7.3.4 release and for bulk-load tool only (Cloud SDK).
When set to false, the bulk loading mechanism refrains from attempting to recreate, delete, or modify the Google Cloud SDK configurations. Instead, it proceeds with data loading using the existing configuration on the machine. This feature is valuable when other operations depend on Google Cloud SDK configurations.
If the user enables this engine option without a proper configuration, the bulk loading mechanism will issue a warning message: No active configuration found. Please either create it manually or remove the GCloudRecreateConfig option. To prevent further errors, it will then revert to using the default ODBC Array Insert bulk loading mechanism.

Snowflake snowflake

NOTE
Secure access to your external Snowflake data warehouse through private link is supported. Note that your Snowflake account must be hosted on Amazon Web Services (AWS) and located in the same region as your Federated Audience Composition environment. Please contact your Adobe representative for assistance in setting up secure access to your Snowflake account.

Use Federated databases to process information stored in an external database. Follow the steps below to configure access to Snowflake.

  1. Under the Federated data menu, select Federated databases.

  2. Click Add federated database.

  3. Enter a Name to your Federate database.

  4. From the Type drop-down, select Snowflake.

  5. Configure the Snowflake authentication settings:

    • Server: Enter your Server name.

    • User: Enter your Username.

    • Password: Enter your account password.

    • Database (optional): Enter the name of your database if not specified in the DSN.

    • Working schema (optional): Enter the name of the database schema to use for work tables.

      note note
      NOTE
      You can use any schema from the database, including schemas used for temporary data processing, as long as you have the required permission to connect to this schema.
      Distinct working schemas must be used when connecting multiple sandboxes with the same database.

    • Private key: Click the Private key field to select your .pem files from your locale folder.

    • Options: The connector supports the options detailed in the table below.

  6. Select the Test the connection option to verify your configuration.

  7. Click Deploy functions button to create the functions.

  8. Once your configuration is done, click Add to create your Federate database.

The connector supports the following options:

Option
Description
workschema
Database schema to use for work tables
warehouse
Name of the default warehouse to use. It will override the user’s default.
TimeZoneName
By default empty, which means that the system time zone app server is used. The option can be used to force the TIMEZONE session parameter.
For more on this, refer to this page.
WeekStart
WEEK_START session parameter. By default set to 0.
For more on this, refer to this page.
UseCachedResult
USE_CACHED_RESULTS session parameter. By default set to TRUE. This option can be used to disable Snowflake cached results.
For more on this, refer to this page.
bulkThreads
Number of threads to use for Snowflake bulk-loader, more threads mean a better performance for bigger bulk-loads. By default set to 1. The number can be adjusted, depending on the machine thread count.
chunkSize
Determines the file size of the bulk-loader chunk. By default set to 128MB. Can be modified for a more optimal performance, when used with bulkThreads. More concurrently active threads mean better performance.
For more on this, refer to Snowflake documentation.
StageName
Name of the pre-provisioned internal stage. It will be used in bulk load instead of creating a new temporary stage.

Vertica Analytics vertica-analytics

Use Federated databases to process information stored in an external database. Follow the steps below to configure access to Vertica Analytics.

  1. Under the Federated data menu, select Federated databases.

  2. Click Add federated database.

  3. Enter a Name to your Federate database.

  4. From the Type drop-down, select Vertica Analytics.

  5. Configure the Vertica Analytics authentication settings:

    • Server: Add the URL of the Vertica Analytics server.

    • Account: Add the Username.

    • Password: Add the account password.

    • Database (optional): Enter the name of your database if not specified in the DSN.

    • Working schema (optional): Enter the name of the database schema to use for work tables.

      note note
      NOTE
      You can use any schema from the database, including schemas used for temporary data processing, as long as you have the required permission to connect to this schema.
      Distinct working schemas must be used when connecting multiple sandboxes with the same database.

    • Options: The connector supports the options detailed in the table below.

  6. Select the Test the connection option to verify your configuration.

  7. Click Deploy functions button to create the functions.

  8. Once your configuration is done, click Add to create your Federate database.

The connector supports the following option:

Option
Description
TimeZoneName
By default empty, which means that the system time zone of the app server is used. The option can be used to force the TIMEZONE session parameter.

Databricks databricks

Use Federated databases to process information stored in an external database. Follow the steps below to configure access to Databricks.

  1. Under the Federated data menu, select Federated databases.

  2. Click Add federated database.

  3. Enter a Name to your Federate database.

  4. From the Type drop-down, select Databricks.

  5. Configure the Databricks authentication settings:

    • Server: Add the name of your Databricks server.

    • HTTP path: Add the path to your Cluster or Warehouse. Learn more

    • Password: Add the account access token. Learn more

    • Catalog: Add the field for the Databricks Catalog.

    • Working schema: Name of the database schema to use for work tables.

      note note
      NOTE
      You can use any schema from the database, including schemas used for temporary data processing, as long as you have the required permission to connect to this schema.
      Distinct working schemas must be used when connecting multiple sandboxes with the same database.

    • Options: The connector supports the options detailed in the table below.

  6. Select the Test the connection option to verify your configuration.

  7. Click Deploy functions button to create the functions.

  8. Once your configuration is done, click Add to create your Federate database.

The connector supports the following options:

Option
Description
TimeZoneName
By default empty, which means that the system time zone of the app server is used. The option can be used to force the TIMEZONE session parameter.
recommendation-more-help
fadff0d9-29d0-4d44-99a6-2499b0b7778b