Migrate to the Adobe Analytics 2.0 API analytics-2-migration

Adobe Analytics 1.4 APIs are reaching end-of-life. The Web Analytics connector that links your Campaign instance to Adobe Analytics relies on these APIs, so you need to upgrade to a build that uses the new Analytics 2.0 APIs to keep the integration running.

CAUTION
Upgrading re-imports the two built-in technical workflows that power the connector, webAnalyticsSendMetrics and webAnalyticsGetWebEvents (see the Web Analytics workflows reference for what each one does). Any customization you made on top of these workflows is overwritten by the re-import. Avoid modifying these built-in workflows directly — build your customization in a separate custom workflow instead, so future upgrades don’t overwrite it. The upgrade also updates the built-in Analytics JavaScript files: if any of your custom workflows reference these files, they will break and need to be adapted to the new code.

Are you impacted? are-you-impacted

You are impacted if your instance uses the Web Analytics external account for any of the following:

  • Sending email campaign indicators and attributes to Adobe Analytics as metrics.
  • Sending classification data to Adobe Analytics.
  • The remarketing flow (identifying converted contacts after a campaign).
  • A Web Analytics external account you plan to configure for the first time.

Not sure which of these apply to you? Check which of the technical workflows above are active on your instance, and review your Web Analytics external account configuration in Administration > Platform > External accounts (see Web Analytics external account).

How to migrate how-to-migrate

If you are on an Adobe-hosted instance, Adobe handles the SFTP provisioning, IP allow-listing, and key configuration for you as part of the upgrade — you only need to validate your use cases once the new build is live.

If you are on an on-premise or hybrid deployment, complete the following steps.

  1. Upgrade your Campaign environment to a build that includes the Adobe Analytics 2.0 changes. You can confirm which build you are running from Help > About… (see how to check your Campaign version).

  2. Review which of the use cases above apply to your instance, since the next step depends on it.

  3. If you use the remarketing flow, the webAnalyticsFindConverted workflow needs a dedicated SFTP channel to exchange data with Adobe Analytics 2.0. Set this up as follows; otherwise, skip to the next step.

    1. Provision an SFTP server for the instance using key-based authentication, following the same SFTP server best practices you’d apply to any other external SFTP integration. Adobe provides a sample SFTP setup script to help you get started.

    2. Register that server’s connection details in Adobe Analytics by running the script delivered with the new build:

      code language-none
      nlserver javascript -instance:<instance_name> -arg:host=<sftp_host_url>#user=<sftp_user> -file <path_to_the_file>/aaremarketingLocation.js
      

      Example:

      code language-none
      nlserver javascript -instance:test_mkt_stage2 -arg:host=test-mkt-stage1.campaign.adobe.com#user=test -file ./nl6/datakit/nms/eng/js/aaremarketingLocation.js
      
    3. Allow-list Adobe Analytics on your SFTP server, since remarketing exports are only ever initiated from a fixed set of Adobe IP ranges:

  4. Enable the FEATUREFLAG_USE_ANALYTICS_20_API feature flag on your instance by creating or setting the longvalue of the option to 1 in xtkOption, under Administration > Platform > Options in the Campaign Explorer tree. This step is required regardless of which use case above applies to you.

  5. Validate the migration by exercising each use case that applies to your instance (send a test campaign, check that indicators land in Analytics, and confirm remarketing data if applicable) before decommissioning any old connectivity.

Setting up a new Web Analytics external account setting-up-a-new-web-analytics-external-account

The following applies whether your instance is Adobe-hosted or on-premise/hybrid.

If you are configuring the Web Analytics external account for the first time rather than migrating an existing one, follow the external account setup steps and the connector getting-started guide.

Because Analytics 2.0 introduces new classification handling, you also need to create a classification set in Adobe Analytics before your external account can pick up your report suite’s classification data. This is a new step: create it after configuring your Conversion variables and Success events, and before configuring the external account in Campaign.

To create your classification set:

  1. From the Adobe Analytics top menu bar, select Components > Classification sets, then click New.

  2. In the Add New Classification Set dialog:

    • Enter a Name for the classification set.
    • Set the Type to Primary.
    • In Job notifications, choose who should be notified on success or failure of the classification set jobs, and provide the corresponding email addresses.
    • In Subscriptions, select your report suite and the conversion variable you created for the internal campaign name in the previous step.
  3. Click Save.

This classification set will be automatically discovered by Campaign when you configure your external account in the next step. For more information on classification sets, refer to the Adobe Analytics documentation.

Need help? need-help

If you run into issues during the migration, contact Adobe Customer Care.

recommendation-more-help
campaign-classic-help