You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/add-destination.md
+109-4Lines changed: 109 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,20 @@ There are two ways to add a destination to your deployment: using the Segment we
31
31
8. Click the toggle at the top of the Settings page to enable the destination.
32
32
33
33
> success ""
34
-
> If you have more than one instance of a destination, you can click **Copy Settings From Other Destination** to save yourself time entering the settings values.
34
+
> If you have more than one instance of the same destination, you can click **Copy Settings From Other Destination** to save yourself time entering the settings values.
35
+
36
+
#### Adding a destination to a specific Segment Source
37
+
38
+
You can also add a destination directly from the source's settings page in the Segment web app.
39
+
40
+
1. Before you start, log in to your account on the destination tool, and get the token or other credentials needed to access the tool. You'll use these to give Segment permission to send data to the tool.
41
+
2. Log in to the Segment web app, and select the workspace you want to work in, and navigate to the source you want to add the destination to.
42
+
3. From the source information page, click **Add Destination**.
43
+
4. Search for the destination you want to add, and click it in the results.
44
+
If there are multiple results for your search, you can click each result to read more about them until you find the one you're looking for.
45
+
5. In the panel that appears, click **Configure**.
46
+
6. On the next page, find the **Connection Settings** section, and enter the token or credentials for that destination tool.
47
+
7. Click the toggle at the top of the Settings page to enable the destination.
35
48
36
49
#### Adding a destination using the Config API
37
50
@@ -73,10 +86,102 @@ When you add a destination in Segment, you must tell Segment how to connect with
73
86
Each destination can also have destination settings. These control how Segment transforms the data you send to the destination, and can be used to adapt it to your configuration or enable or disable certain destination features.
74
87
75
88
76
-
<!-- TODO: Project Demux
77
-
## Multiple instances of the same destination
89
+
## Connecting one source to multiple instances of a destination
78
90
91
+
<!-- LR: 03/04/21 - hiding this for now since it's in limited rollout.
79
92
> note ""
80
93
> Multiple-destination support is available for all Segment customers on all plan tiers.
94
+
-->
95
+
96
+
97
+
> info ""
98
+
> Support for connecting to multiple instances of a destination is in public preview. To use this, you must agree to the [(1) Segment First Access](https://segment.com/legal/first-access-beta-preview/) and Beta Terms and Conditions and [(2) Segment Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/). The feature is being released to different tiers over time. If you see an error message that you can’t connect to multiple instances of the same destination, it is not available yet in your workspace but is coming soon.
99
+
100
+
Segment allows you to connect a source to multiple instances of a destination. You can use this to set up a single Segment source that sends data into different instances of your analytics and other tools.
101
+
102
+
For example, you might set up a single Segment source to send data both to separate instances of Google Analytics for each business unit in your organization, and to another instance for executive-level reporting. You could also use this to make sure that tooling instances for different geographic teams are populated with the same data from the same source.
103
+
104
+
You can also connect multiple instances of a destination to help you smoothly migrate from one configuration to another. By sending each version the same data, you can check and validate the new configuration without interrupting use of the old one.
105
+
106
+
107
+
> success ""
108
+
> If your organization is on a Segment Business tier plan, you can use [Replay](/docs/guides/what-is-replay/) to send historical data to new instances of a destination.
109
+
110
+
111
+
### Connect a source to more than one instance of a destination
112
+
113
+
To connect a source to more than one instance of a destination in the Segment web app, start by adding the first instance of the destination and giving it a unique name, [as described above](#adding-a-destination). To add another instance of the destination, follow either of those two methods and choose another unique name.
114
+
115
+
You must give each instance of the destination connected to the same source a unique name. Segment recommends that you use descriptive names rather than numbers, so other Segment users can understand which Segment destinations are linked to which tool instances. For example, you might use "Amplitude North America" and "Amplitude South America", instead of "Amplitude 1" and "Amplitude 2".
116
+
117
+
If you added the first instance of your destination before multi-instance destinations became available, that instance is automatically named for the destination with no other identifiers, for example "Amplitude". You cannot currently edit these first destinations' names.
118
+
Some destinations do not support having multiple instances connected to the same source. In that case, the option to add a second instance of that destination does not appear.
119
+
120
+
### Connect to more than one instance of a destination using the Config API
121
+
122
+
You can add multiple instances of a destination using the Segment Config API. See the Segment Config [API documentation](https://reference.segmentapis.com/?version=latest#39ce0439-0969-48c3-ba49-b22a46c41060). If a destination does not support multi-instance, the Config API throws an appropriate error.
123
+
124
+
125
+
### Multi-instance destinations and Device-mode
126
+
127
+
-**_Mobile_ sources cannot connect to multiple instances of a destination.**
128
+
-**You can connect a source to an unlimited number of instances of a destination if all of the instances use cloud-mode.** Destinations using cloud-mode receive data directly from the Segment servers.
129
+
-**Each source can only connect to one *device-mode* instance of a destination, in addition to unlimited cloud-mode instances.** A device-mode instance of a destination receives data directly from the user’s browser (instead of through the Segment servers), by bundling a copy of destination’s code with the Segment SDK. Segment can’t bundle multiple copies of the destination SDK and so it can’t send data to multiple instances of the destination from the browser.
130
+
-**You cannot connect a source to more than one instance of a destination that operates in device-mode only**. These destinations can only accept data from code directly on the user’s device, and Segment cannot include duplicates of that code for a single source.
131
+
132
+
For more information see [the compatible destination lists below](#multi-instance-compatible-destinations).
133
+
134
+
135
+
136
+
### Other multi-instance destination considerations
137
+
138
+
-**Destination Filters and multi-instance destinations:** Destination filters are specific to each source, and currently operate on *all* instances of a destination connected to that source. Support for destination filters for individual destination instances is coming soon.
139
+
140
+
-**Multiple Data Lakes:** Segment does not currently support connecting a single source to multiple instances of a data lakes destination. [Contact Segment Customer Success](https://segment.com/help/contact/) if this would be useful for your organization.
141
+
142
+
-**Protocols transformations and multi-instance support:** Protocols transformations are specific to each source, and operate the same on all instances of a specific destination. Segment does not currently support creating unique protocols transformations for each instance of a destination.
143
+
144
+
-**Integrations object considerations:** A common part of a Segment message is [the integrations object](https://segment.com/docs/guides/filtering-data/#filtering-with-the-integrations-object), which you can use to explicitly filter to which destinations the call is forwarded, as well as to specify options for different destination tools. If you use the integrations object to filter events or to send destination-specific options, Segment applies its values to all instances. For example:
145
+
146
+
```js
147
+
{
148
+
"integrations": {
149
+
"Mixpanel":false,
150
+
"Adobe Analytics": {
151
+
"marketingCloudVisitorId":"12345"
152
+
}
153
+
}
154
+
}
155
+
```
156
+
157
+
In this example:
158
+
159
+
- Events sent with this `Mixpanel` setting are **not** sent to instances of Mixpanel.
160
+
- Events sent to any Adobe Analytics destinations with this `Adobe Analytics` setting use the same `marketingCloudVisitorId` value specified.
161
+
162
+
163
+
### Multi-instance compatible destinations
164
+
165
+
The sections below list the most popular multi-instance Segment destinations. This list is not exhaustive. If you don’t see your favorite destination in these lists, [contact Segment Customer Success](https://segment.com/help/contact/).
166
+
167
+
##### Cloud-mode and device-mode
168
+
The following destinations can receive data from an unlimited number of sources in cloud-mode, and **up to one device-mode connection**.
The following destinations can receive data from an unlimited number of sources in cloud-mode, but do not support device-mode connections at all.
81
179
82
-
You can now connect a single Source to more than one instance of a destination. For example, if you have two different Google Analytics accounts for different parts of your business, but are using the same Library Source to track events, you might want to send that data to both Google Analytics accounts. This was not previously possible. -->
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/adobe-analytics/heartbeat.md
+17-7Lines changed: 17 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,27 +10,37 @@ Adobe Heartbeat is an Adobe Analytics add-on that allows you to collect video an
10
10
11
11
Before you start, complete these required steps.
12
12
13
-
First, connect your Adobe heartbeat server URL to Segment:
14
-
1. Find your Adobe Analytics heartbeat tracking server URL and copy it. If you don’t know where to find your heartbeat tracking server URL, contact your Adobe representative.
13
+
First, connect your Adobe Heartbeat Server URL to Segment:
14
+
1. Find your Adobe Analytics Heartbeat Tracking Server URL and copy it. If you don’t know where to find your Heartbeat Tracking Server URL, contact your Adobe representative.
15
15
2. Log in to your Segment workspace, and go to the Adobe Analytics settings.
16
16
If you have multiple sources sending to Adobe Analytics, click the one that you'll be using with Adobe Heartbeat. If you'll be using Heartbeat with more than one source, repeat these steps for each source.
17
17
3. Open the **Heartbeat Tracking Server URL** setting, and paste your server URL in the field. Click Save.
18
18
19
-
**Note**: If you don't specify a tracking server URL, Segment can't send your video events to Adobe Analytics.
19
+
**Note**: If you don't specify a Heartbeat Tracking Server URL, Segment can't send your video events to Adobe Heartbeat.
20
20
21
21
Next, enable Adobe's VisitorID service in your Adobe account. You must do this to track Heartbeat data. See Adobe's documentation for more on enabling the VisitorID service.
22
22
23
-
## Set up steps for mobile
24
-
25
-
Then, set up your mobile libraries:
23
+
## Set Up Steps for Mobile
26
24
27
25
For Android:
28
26
29
27
1. If you haven’t done so already, go to the Adobe Mobile Services UI and follow [these steps](https://docs.adobe.com/content/help/en/mobile-services/android/getting-started-android/requirements.html#section_044C17DF82BC4FD8A3E409C456CE9A46) to download the core `adobeMobileLibrary` and configure in your Android project. Add the `ABDMobileConfig.json` to your project from the downloaded SDK.
30
28
2. Download the latest version of the `MediaSDK.jar` file and [include it in your Android project using Adobe's documentation steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html).
31
29
3. Follow the [remaining set up steps](https://docs.adobe.com/content/help/en/media-analytics/using/sdk-implement/setup/set-up-android.html) to complete the installation.
32
30
33
-
For iOS: the Adobe Heartbeat SDK is already included with the Segment-Adobe-Analytics SDK. Ensure you have added the `ABDMobileConfig.json` for your iOS project from the Adobe Mobile Services UI.
31
+
For iOS: The Adobe Heartbeat SDK is already included with the Segment-Adobe-Analytics SDK when you add a Heartbeat Tracking Server URL. Ensure you have added the `ABDMobileConfig.json` for your iOS project from the Adobe Mobile Services UI.
32
+
33
+
## Set Up Steps for Web
34
+
35
+
The Adobe Heartbeat JS SDK is automatically included with the Segment-Adobe-Analytics integration when you add a Heartbeat Tracking Server URL.
36
+
37
+
Segment will map your video events to the Adobe methods as outlined below. In order to record video heartbeats to Adobe accurately on web, Adobe's SDK requires a playhead update **at least once per second** for main content. The "Video Content Playing" event updates the playhead using the `position` property. If you do not want to trigger this event every second, you can alternatively set the playhead to the window. This can be done by setting `window._segHBPlayheads` to the key-value pair of the current content's `session_id` and `position`:
0 commit comments