# Adobe Analytics Destination

After you enable Adobe Analytics (formerly known as Omniture or Sitecatalyst) in Segment, you can start sending data from any of the Segment [libraries](/docs/segment/connections/sources/catalog/) to an Adobe report suite. When you send events from Segment's mobile SDKs or Cloud-mode libraries, Segment translates that data using a mapping that you configure, and then passes it to the Adobe Analytics [Data Insertion API](https://developer.adobe.com/analytics-apis/docs/1.4/guides/data-insertion/). For more information, you can browse the code on GitHub in the [@segment-integrations/analytics-kotlin-adobe-analytics](https://github.com/segment-integrations/analytics-kotlin-adobe-analytics) repository.

## Planning for Adobe Analytics

Adobe Analytics uses a slightly different approach to tracking than Segment, and it's important to understand the difference so you can effectively set up your integration. Segment uses a user-action data model, which uses different types of calls to track different activities of a user on a website or app. Adobe Analytics uses page views as the basic unit of activity, and variables like custom traffic variables (also called 'props'), eVars, list variables, and hierarchy variables to add details for more nuanced analysis.

For example, if one of your end users dismissed a welcome dialog in your app, Segment would generate a `Welcome Dialog Dismissed` event with properties that contain the user ID (`user123`) and the dialog name (`welcome-dialog`), while Adobe Analytics would model the same action as a pageView with variables that represent the dialog name, visitorID, and the event name, and an eVar ("dismissed").

Both Segment and Adobe Analytics have recommended standard data for tracking events. Segment has [the Spec](/docs/segment/connections/spec/), and Adobe uses predefined events. Segment automatically maps incoming event data and some product level properties to Adobe's predefined events, when the event data is in the correct [Segment Ecommerce Spec](/docs/segment/connections/spec/ecommerce/v2/) format. Video calls using the format described in this document are also automatically mapped. If you're using the Mobile SDKs, mobile lifecycle events are also automatically mapped. If you need to create Page and Track events that are outside the scope of the Ecommerce Spec, you need to map those in your Segment destinations settings UI.

Segment strongly recommends that you create a Tracking Plan for both your Segment and Adobe Analytics events before you send any events or properties to Adobe. This helps you map your Segment events to Adobe `events` and Segment properties to Adobe variables. If you decide to set up Adobe Analytics for mobile, you must set up this mapping in both the Segment settings and the Adobe Mobile Services dashboard, so it's good to stay consistent.

## Setting Up the Adobe Analytics SDK

Before you start sending data from your Kotlin application to Adobe Analytics, complete the following setup steps:

1. Enable the Segment-Adobe Analytics destination in your Segment workspace.
2. From your Adobe Mobile Services dashboard, check and customize the settings on the "Manage App Settings" tab.
3. Download these settings as the `ADBMobileConfig.json` file by clicking the **Config JSON** link at the bottom of the same tab. Follow the instructions in Adobe's [Core implementation and lifestyle](https://github.com/Adobe-Marketing-Cloud/mobile-services/blob/master/docs/android/getting-started/dev-qs.md) documentation.
4. Follow the instructions below for each mobile environment to add the Adobe Analytics dependency to your project.

> \[!NOTE]
>
> Mobile implementations use the `ADBMobileConfig.json` file to store the settings that you would otherwise enter in the Adobe Analytics destination settings in the Segment app. You can change these settings from the Manage App Settings tab in your Adobe Mobile Services dashboard, and can download the file from that same tab. This file includes the Report Suite ID, Timestamp Option, Tracking Server Secure URL, Tracking Server URL, and Use Secure URL for Server-side settings.

## Adding the dependency

To install the Segment-Adobe Analytics integration, add this line to your gradle file:

```text
implementation 'com.segment.analytics.kotlin.destinations:adobe-analytics:<latest_version>'
```

Or the following for Kotlin DSL

```text
implementation("com.segment.analytics.kotlin.destinations:adobe-analytics:<latest_version>")
```

## Using the Plugin in your App

Open the file where you set up and configured the Analytics-Kotlin library. Add this plugin to the list of imports.

```text
import com.segment.analytics.kotlin.destinations.adobeanalytics.AdobeAnalyticsDestination
```

Just under your Analytics-Kotlin library setup, call `analytics.add(plugin = ...)` to add an instance of the plugin to the Analytics timeline.

```text
    analytics = Analytics("<YOUR WRITE KEY>", applicationContext) {
        this.flushAt = 3
        this.trackApplicationLifecycleEvents = true
    }
    analytics.add(plugin = AdobeAnalyticsDestination(adobeAppID = "<WRITE YOUR ENVIRONMENT-FILE-ID>"))
```

Your events will now begin to flow to Adobe Analytics in device-mode.

## Sending data to Adobe Analytics

Segment strongly recommends that you create a tracking plan for both your Segment and Adobe Analytics events *before* you send any events or properties to Adobe. This helps you map your Segment events to Adobe `events` and Segment properties to Adobe `eVars` or `props`, since you'll have to do this in both the Segment settings UI and your Adobe Mobile Services dashboard.

## Sending Events

You can map Segment events in your `Events V2` settings to any event variable you already defined in your Adobe Analytics Mobile Services dashboard.

> \[!WARNING]
>
> Do not use the deprecated `Events` settings. These no longer forward events to Adobe.

Here's an example of how you might map Segment events to Adobe Analytics events connected in device mode:

![The Adobe Analytics settings page in Segment, with the Mappings section selected for EventsV2 Mobile with 'Clicked a Button' mapped to 'myapp.adobe.Clicked'.](https://docs-resources.prod.twilio.com/b212f1bf1c2b781499fb3676a37b7d17d0080ff55833221155854bc966d87ce9.png)

Here's an example of how you would implement the same mapping in Adobe's Mobile Services Dashboard:

![The Custom Metrics tab in Adobe's Mobile Services Dashboard, with one custom metric, Clicked a Button, defined.](https://docs-resources.prod.twilio.com/b834ff239e9c9865d92cc8d2e43485ec6dbfeec94cf8328967bcd4c90e620f4a.png)

## Sending Custom Properties

You can use the `Context Data Variables` settings to map Segment `properties` to any context data variable defined in your Adobe Analytics Mobile Services dashboard. This includes both Adobe `props` and `eVars`. You can see a list of the Adobe variable types in your Adobe Mobile Services dashboard.

![The Adobe Analytics settings page in Segment, with the Mappings section selected for Context Data Variables showing the color property mapped to myapp.adobe.color.](https://docs-resources.prod.twilio.com/28c8c85f97abee40238f8899df78cdbb4d3303e73d8deaf237ebd49c1acc95a1.png)

Here's an example of how you would implement the same mapping in Adobe's Mobile Services Dashboard:

![The Custom Variables tab in Adobe's Mobile Services Dashboard, with one custom variable, Color, defined.](https://docs-resources.prod.twilio.com/c7aa93e7eb47d1c05a13308d8fc3212fa97e660e3589425b1638e84d4c735a69.png)

| Segment Payload Field                                         | iOS Mapping Notation                          | Android Mapping Notation |
| ------------------------------------------------------------- | --------------------------------------------- | ------------------------ |
| `anonymousId`                                                 | `anonymousId`                                 | `.anonymousId`           |
| `messageId`                                                   | `messageId`                                   | `.messageId`             |
| `event`<br /> Track calls only                                | `event`                                       | `.event`                 |
| `name`<br /> Screen calls only                                | `name`                                        | `.name`                  |
| `context.traits.key`                                          | `traits.key`                                  | `.context.traits.key`    |
| `context.key`                                                 | `key`                                         | `.context.key`           |
| `context.arrayKey.key`<br /> for example: `context.device.id` | `arrayKey.key`<br /> for example: `device.id` | `.context.arrayKey.key`  |
| `properties.key`                                              | `key`                                         | `.key`                   |

## Adobe Lifecycle events

Segment implements Adobe Lifecycle Events automatically - you don't have to enable any additional settings! Lifecycle events gather important information such as app launches, crashes, session length, and more. See the [list of all Adobe lifecycle metrics and dimensions](https://experienceleague.adobe.com/en/docs/analytics/components/dimensions/lifecycle-dimensions) to learn more.

## Identify

When you make an Identify call, Segment sets the Adobe `visitorId` to the value of the user's Segment `userId`. The snippets below show what Segment does with this information.

```java
Config.setUserIdentifier("123");
```

## Screen

When you call Screen, Segment sends an Adobe `trackState` event, and passes the screen name and any properties you mapped to Adobe as context data values.

For example:

```java
Analytics.trackState("Home Screen", <properties mapped in contextData>);
```

## Track

When you call Track, Segment sends an Adobe `trackAction` event, and passes your event name and any properties you mapped to Adobe as context data values.

For example:

```java
Analytics.trackEvent("Clicked A Button", <properties mapped in contextData>);
```

## Reset

For example:

```java
Config.setUserIdentifier(null);
```

## Flush

For example:

```java
Analytics.sendQueuedHits();
```