Building and refreshing your ADL reports

Overview

This tutorial walks through how to build and refresh your Data Library reports using the ADL 2.0 - Refresh app in Alli Marketplace.

Important: Before proceeding with the app installation, ensure an instance of the app does not already exist under My Apps ➔ Apps. If it does, utilize it and modify as necessary.

1.) Navigate to Alli Marketplace and search for the ADL 2.0 - Refresh app under My Apps → Browse

2.) Install the app and fill out the required fields below:

TARGET

The data warehouse environment where you wish to build the reports. Current options include Redshift, BigQuery, and Snowflake.

To see which one(s) are enabled for your client:

Navigate to Settings ➔ Manage Client, and select the Settings tab.
Scroll down to Application Settings, and check the Data drop-down.

A client with Redshift and BigQuery enabled

If you’re expecting to see models shown on the Data Explorer page, please make sure the ADL apps for the DEFAULT DATABASE from the above screenshot have been created and completed.

For example, when DEFAULT DATABASE = Snowflake, an app with Target = Snowflake needs to be created and run.

When DEFAULT DATABASE is blank, it will be Redshift.

DBT_VARS

A JSON file containing settings that specify which platforms and reports to build for the customer. Follow the instructions below:

Generating the `dbt_vars.json` file

a.) Copy the contents below and paste it into a text editor:

JSON

{
  "alli_client_slug": "{alli_client_slug}",
  "data_library_googleads_enabled": "False",
  "data_library_googleads_searchterm_reporting_enabled": "False",
  "data_library_googleads_productgroup_reporting_enabled": "False",
  "data_library_googleads_inventory_reporting_enabled": "False",
  "data_library_googleads_audience_reporting_enabled": "False",
  "data_library_googleads_geo_reporting_enabled": "False",
  "data_library_googleads_performance_max_reporting_enabled": "False",
  "data_library_googlemerchantcenter_enabled": "False",
  "data_library_googleads_hourly_reporting_enabled": "False",
  "data_library_microsoftads_enabled": "False",
  "data_library_microsoftads_legacy_datasource_reporting_enabled": "False",
  "data_library_microsoftads_searchterm_reporting_enabled": "False",
  "data_library_microsoftads_productgroup_reporting_enabled": "False",
  "data_library_microsoftads_audience_reporting_enabled": "False",
  "data_library_microsoftads_hourly_reporting_enabled": "False",
  "data_library_applesearchads_enabled": "False",
  "data_library_applesearchads_searchterm_reporting_enabled": "False",
  "data_library_cm360_enabled": "False",
  "data_library_cm360_historical_reporting_enabled": "False",
  "data_library_dv360_enabled": "False",
  "data_library_dv360_trueview_reporting_enabled": "False",
  "data_library_dv360_inventory_reporting_enabled": "False",
  "data_library_dv360_geo_reporting_enabled": "False",
  "data_library_tradedesk_enabled": "False",
  "data_library_tradedesk_inventory_reporting_enabled": "False",
  "data_library_tradedesk_geo_reporting_enabled": "False",
  "data_library_yahoodsp_enabled": "False",
  "data_library_yahoodsp_inventory_reporting_enabled": "False",
  "data_library_yahoodsp_geo_reporting_enabled": "False",
  "data_library_amazondsp_enabled": "False",
  "data_library_amazondsp_inventory_reporting_enabled": "False",
  "data_library_bidtellect_enabled": "False",
  "data_library_criteo_enabled": "False",
  "data_library_vistar_enabled": "False",
  "data_library_taboola_enabled": "False",
  "data_library_facebookads_enabled": "False",
  "data_library_facebookads_geo_reporting_enabled": "False",
  "data_library_facebookads_legacy_datasource_reporting_enabled": "False",
  "data_library_facebookads_hourly_reporting_enabled": "False",
  "data_library_linkedinads_enabled": "False",
  "data_library_twitterads_enabled": "False",
  "data_library_pinterestads_enabled": "False",
  "data_library_pinterestads_historic_reporting_enabled": "False",
  "data_library_tiktokads_enabled": "False",
  "data_library_tiktokads_geo_reporting_enabled": "False",
  "data_library_tiktokads_hourly_reporting_enabled": "False",
  "data_library_snapchatads_enabled": "False",
  "data_library_snapchatads_geo_reporting_enabled": "False",
  "data_library_redditads_enabled": "False"
}

b.) Replace {alli_client_slug} with the Slug of your customer (you can find this by navigating to Manage Client ➔ Settings).

c.) Set the platforms you wish to enable by changing their values to "True". For example, to enable Google Ads, Facebook Ads, and Microsoft Ads, update the corresponding values:

JSON

  "data_library_googleads_enabled": "True",
  "data_library_facebookads_enabled": "True",
  "data_library_microsoftads_enabled": "True",

Before enabling a platform, ensure that the data for said platform has been properly onboarded – see Getting started with ADL | Onboarding-a-platform-to-Data-Library

d.) Save the file as dbt_vars_{alli_client_slug}.json, replacing {alli_client_slug} with your customer’s slug.

e.) Click Choose File under the DBT_VARS field in the app instance, and select the JSON file you just saved.

VERSION

The version of ADL to be used for the refresh (see https://agencypmg.atlassian.net/wiki/x/mIA0sw)

We recommend selecting the latest version, as it’s the most up-to-date and stable version of ADL available. PMG Data Engineering will also ensure that all ADL-enabled customers are upgraded to the latest version whenever a new one is released.

DEPLOYMENT

The DEPLOYMENT flag indicates whether to run a full deployment or just refresh data.

Value	Action	When to use
`True`	Drops and recreates all ADL objects from scratch Includes data tests	Upgrading to a new version of ADL Adding additional metrics to an existing ADL report
`False`	Data is refreshed for selected platforms and date ranges (see PLATFORMS_TO_REFRESH & REFRESH_DATE_RANGE fields) Excludes data tests	Scheduled refreshes (daily, hourly, etc)

PLATFORMS_TO_REFRESH

The platform(s) to be refreshed. All Platforms is selected by default and will refresh all platforms and report types enabled via the dbt_vars.json file.

For the first time setting up an ADL App for a new client, please make sure Platforms = All Platforms is selected, otherwise, the app will error out.

Selecting specific platforms for daily refreshes is not recommended, as it excludes other platforms. Choose only a specific platform for the following use cases:

Updating a platform-level report after additional metrics were added (make sure to set DEPLOYMENT to True, and set it back to False after deployment).
Ad-hoc refreshes to platform-level reports to account for (non-schema) updates in the raw data from actions like backfills and/or row deletions

REFRESH_DATE_RANGE

The range of data to be refreshed (default is Last 30 days). This applies to platforms with table-based reports like Google Ads, Microsoft Ads, Facebook Ads, and Pinterest Ads.

All other platforms include view-based reports, so data will always reflect the changes in the raw datasources regardless of the selected date range.

For optimal performance, set the range to the default Last 30 days for daily refreshes, and adjust as necessary.

3.) Set the app’s run schedule:

Go to SCHEDULES and click the + button.
We recommend the following schedule with DEPLOYMENT set to False:

4.) Before saving, name the app using the following format:

ADL 2.0 - Refresh - {Customer} - {Target} - {Platform} - {Cadence}

Customer: The name of the customer in Alli.
Target: The data warehouse (e.g., Redshift).
Platform: The platforms to refresh (e.g., All Platforms).
Cadence: The refresh schedule (e.g., Daily).

Example: ADL 2.0 - Refresh - Best Western - Redshift - All Platforms - Daily

5.) Click Save & Run to run the refresh app

6.) If successful, your ADL reports are now built and/or refreshed. To validate, see: How to find which platforms and reports are enabled in ADL.

Other Useful Resources

How to troubleshoot ADL Refresh app errors ADL 2.0 FAQs