Set Up the Demandbase Adobe Analytics Launch Extension

  • Updated

Context

The Demandbase Adobe Analytics Launch Extension works with Adobe Analytics to make Demandbase attributes available in your Adobe Analytics reports. The Launch Extension calls the Demandbase IP-API asynchronously to identify the company in real time.

How it Works

  1. The Launch Extension registers a load event so that Launch Data Elements can receive the data when it’s ready.
  2. In the Launch Extension, the Data Elements are then mapped to eVars. Each Data Element stores eight firmographic attributes delimited together. This provides each eVar with eight data points to convert into eight classification reports using the Classification Rule Builder.
  3. Once configured, the Launch Extension calls the Demandbase IP-API service and stores the data in the browser’s local storage.

Application.png

For more information, see FAQs: Adobe Launch Extension

Step 1: Prerequisites/Preparation

  1. Acquire your Demandbase API Key for Adobe from your Demandbase CSM.
  2. Install the Core, Adobe Analytics, and Demandbase Extensions from the Adobe Extensions page.
  3. Add the Adobe Analytics dev and production report suite ID to your Adobe Analytics Extension.
    Tip: You can request the suite IDs from your Adobe administrator.
  4. Create up to five eVars.
    Tip: We store eight attributes for each eVar and use Classification Reports to manage the data. To handle the 40 total attributes from Demandbase, limit the setup to a maximum of five eVars.
  5. Run Adobe Analytics prior to installing Demandbase. This best practice makes it easier to isolate issues during installation.
  6. Confirm Launch environment is ready and installed on your website.
  7. Confirm you have administrator access to Launch.
  8. Inform your Demandbase CSM. This ensures Demandbase Implementation resources are available to sign off on a properly configured integration.

Step 2: Create and Map the Data Elements

  1. Create the Data Elements.
    Important:
    • Create one Data Element to map to each eVar.
    • Name the Data Elements the same as your eVars for easy mapping.
  2. Map the Data Elements as follows:
    • Extension: Demandbase
    • Data Element Type: Select the corresponding element
    • Storage Duration: Session
      Screen_Shot_2019-06-17_at_1.02.15_PM.png

Step 3: Configure the Demandbase Extension

  1. In the API Configuration section, enter your API Key .
    Tip: Contact your Demandbase CSM for your API key.
    Capto_Capture_2018-11-07_10-48-36_AM.png
  2. Set the IP-API Call Timeout value.
    Tip: This is how long the extension waits for the Demandbase API to identify the visitor. Generally, longer timeout values allow for more data to be collected. See the FAQ section for more details.
  3. In the Default Values Configuration section, enter the default values to send to Adobe. The default values group similar data in order to reduce noise in reports where the data is not relevant.
    For example, in a Company Name Report that shows company traffic and names, setting the default value to Non-Company Visitor groups all non-company traffic. This reduces noise from undefined values in the Company Name Report.
    • Non-Company Visitor: Non-company IP’s from visitors to your website, such as residential or hotel restaurants.
    • Non-Target Account: Companies that are not in a target account list or Audience. For example, if you had a Prospect Watch List or custom attribute, companies not in this list will be grouped by Non-Target Account to keep reports clean.
    • Target Account but Attribute Unavailable: Companies not assigned a custom attribute value. In the Prospect Watch List example, if your custom attribute was account_status, but the value was NULL, the default value would be returned.
    • Unavailable Attribute: Companies with NULL or empty data attributes. For example, a stock-ticker NULL value would return the default value.
  4. In the Data Elements Configuration section, enter the values for each eVar in its data element tab (i.e dataElement1, dataElement2, etc). Each field (Attribute 1, Attribute 2, etc) is for a Demandbase data attribute selected from the list of API attributes available. Attribute 1 through 8 represent the order in which they are strung together in the eVar.
    • The first two data elements are prefilled, but you have the option to modify them. If you have no existing Demandbase Adobe integration, a best practice is to use the default setup. 
    • Existing customers should review the Attribute fields with watch_list_ values with your  Demandbase CSM and confirm the values are correct.
    • For additional attributes, select the company attributes you want to send to Adobe Analytics. See Reference: Firmographics Attributes Overview for Demandbase One.
      Tip: Enter the API Variable Names in the Attribute fields.
    • To use a watch list attribute/custom attribute (from a target account list), prefix the name with watch_list_. For example, for a watch list attribute campaign_id, use watch_list_campaign_id.
    • After entering eight attributes, proceed to the next data element tab and enter up to eight additional attributes.

Step 4: Configure the Demandbase Firing Rule

You'll need two sets of firing rules. The following steps use the Adobe Analytics Action from Launch. You can also use the Adobe Analytics Launch Extension directly to set eVars.

  1. Create a new rule with the name Page Load: Fire Demandbase.
  2. Add an event as follows:
    • Select Core Library Loaded (Page Top).
    • Event order: 1
  3. Add an action as follows:
    • Extension: Demandbase
    • Action Type: callDemandbaseIpApi
    • Name: Demandbase - callDemandbaseIpApi
      Capto_Capture_2018-11-07_10-52-16_AM.png
      Capto_Capture_2018-11-07_10-51-48_AM.png

Step 5: Set eVars and Fire the Beacon

  1. Create a new rule with the name Demandbase Complete: Fire Pageview.
  2. Add an event as follows:
    • Extension: Demandbase
    • Event Type: API Call Finished (Success, Fail, or Timeout)
    • Name: Demandbase - API Call Finished (Success, Fail, or Timeout)
    • Order: 50
      Tip: Since you’re firing this rule consecutively to the Demandbase API rule, it should have a higher order number.
      Capto_Capture_2018-11-07_10-50-28_AM.png
  3. Add an action to set eVars as follows:
    • Extension: Adobe Analytics
    • Action Type: Set Variables
    • Name: Adobe Analytics - Set Variables
    • In the Variables section, map the eVars to the data elements.
      Capto_Capture_2018-11-07_10-51-14_AM.png
      Capto_Capture_2018-11-07_10-51-01_AM.png
  4. Add an action to send the beacon as follows:
    • Extension: Adobe Analytics
    • Action Type: Send Beacon
    • Name: Adobe Analytics - Send Beacon
      Capto_Capture_2018-11-07_10-51-32_AM.png
      Capto_Capture_2018-11-07_10-50-11_AM.png

Step 6: Combine Events into One Rule and Send Only One Beacon *s.t() call*

Since firing your s.t() beacon multiple times is costly, you can combine the Demandbase event with your other events before firing. This ensures that all events are completed and Demandbase data is available before firing.

Tips:

  • To control the amount of time to wait for the Demandbase event, use the Extension timeout setting.
  • All events must be combined before you can use them under one Send Beacon Action.

Important: The custom code described in the following steps is required because Adobe Launch uses OR logic to combine events by default, and does not support combining events with AND logic.

  1. Modify the API call rule from Step 4: Configure the Demandbase Firing Rule.
    • Complete Step 4.
    • Add a new action as follows:
      • Extension: Core.
      • Action Type: Custom Code.
      • Language: Javascript.
    • Open the Editor and paste the following code snippet to keep track of the API event.
      window.demandbaseHasCompleted = false;
    • Select Keep Changes.
      step_6.1.8.png
  2. Modify the set eVars rule from Step 5: Set eVars and Fire the Beacon.
    • Complete Step 5.
    • For clarity, rename the rule to Demandbase Complete: Set Evars.
    • Remove the Adobe Analytics - Send Beacon action. A new rule with the action is created in another step to combine events.
    • Set event order for Demandbase - API Call Finished (Success, Fail, or Timeout) to 2. 
    • In the Conditions row, add a new Condition as follows:
      • Logic Type: Regular 
      • Extension: Core
      • Select Custom Core
    • Open the Editor and paste following code snippet to indicate the complete state of the API
      window.demandbaseHasCompleted=true;
      return window.demandbaseHasCompleted;
  3. Add a rule for an event.
    The following steps show a Page Bottom event as an example. Page Bottom is typically the best place to fire the beacon.

    • Create a new rule as follows:
      • Name: For example, Demandbase - page bottom completed
      • Event: Core - Page Bottom
      • Order: 3
      • Action: Custom Code
      • Select Javascript.
    • Open the Editor and paste the following code snippet:
      window.pageBottomFired = true;
    • Select Keep Changes.
      step_6.3.9.png
      Important: Repeat this step for each event you want to combine. If you want to use a custom event or another Core event, you need to create a rule as described in this step. Use the custom code to declare the status of the event in the DOM. For example, if you had a rule, MyCustomEvent (Rule) - In the Action custom code declare: window.myCustomEventIsComplete = true;
  4. Combine rule with the Demandbase event and send the beacon. 
    For example, combine the Demandbase API event with a Page Bottom core event.
    Important: If your rule has more than one event, each must have a corresponding Complete event (from step 3). If not done, some events can cause the rule to trigger before all events are completed.

    • Add Page Bottom event.
    • Order: 100
    • Add Demandbase - API Call Finished (Success, Fail, or Timeout) event
    • Order: 5
    • Conditions: Custom Code
    • Open the Editor and paste the following code snippet to combine the AND events.
      return !!window.pageBottomFired && !!window.demandbaseHasCompleted;
    • Select Keep Changes.
    • Action: Adobe Analytics - Send Beacon
      step_6.4.9.png
      The following screenshot shows the ending screen.
      final_final.png

Step 7: Set up Classification Reports

  1. Create the Classifications for each data element/eVar. For information on Conversion Classifications, see the Adobe documentation.
    Step_7.1.png
  2. Create the Classification Rules necessary to split out the data from the eVar and put them in the Classification reports.
    • Create 1 rule per eVar.
    • Use the following Regex for all rows: 
      ^([^:]*):([^:]*):([^:]*):([^:]*):([^:]*):([^:]*):([^:]*):([^:]*)$

Was this article helpful?

1 out of 1 found this helpful