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
> **NOTE:**This setup guide is intended for spaces created before September 27th, 2020. For spaces created after September 27th, 2020, please refer to the onboarding guide [here](/docs/personas/identity-resolution/identity-onboarding/).
6
+
> **NOTE:**The steps in this guide pertain to spaces created before September 27th, 2020. For spaces created after September 27th, 2020, please refer to the onboarding guide [here](/docs/personas/identity-resolution/identity-onboarding/).
7
7
8
8
## Default ExternalIDs
9
9
10
10
The Identity Graph creates or merges profiles based on externalIDs. ExternalIDs will become the Identities attached to a User Profile in the User Explorer:
11
11
12
12

13
13
14
-
We automatically promote the following traits and IDs in track and identify calls to externalIDs:
14
+
Segment automatically promotes the following traits and IDs in track and identify calls to externalIDs:
15
15
16
16
| External ID Type | Message Location in Track or Identify Call |
Copy file name to clipboardExpand all lines: src/personas/identity-resolution/identity-resolution-onboarding.md
+27-44Lines changed: 27 additions & 44 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,11 @@
1
1
---
2
2
title: Identity Resolution Onboarding
3
3
---
4
-
<!-- COMMENTS HERE
5
-
- Are all the images necessary? Concerned that they break up the flow of content too much, making important text more difficult to scan.
6
-
- Double-check to make sure code `style` is used correctly? Is it fields or values that get it?
7
-
- A heading says Select Identity Resolution settings, but this is not described in that section.
8
-
- "Merge Protection Rules" are mentioned as referenceable below, but not found in the doc.
9
-
- For Limits, we might want to mention in the examples that a time period is included with a numeric value.
10
-
-->
11
-
12
4
> note ""
13
5
> **NOTE:** The steps in this guide pertain to spaces created after **October 5th, 2020**. For spaces created before **October 5th, 2020**, please refer to[Identity Resolution Settings](/docs/personas/identity-resolution/identity-resolution-settings).
14
6
15
-
## Select Identity Resolution settings
16
-
17
7
> note ""
18
-
> **NOTE:** Workspace owners, Personas administrators, and users with the Identty Admin role can edit Identity Resolution Settings.
8
+
> **NOTE:** Workspace owners, Personas administrators, and users with the Identity Admin role can edit Identity Resolution Settings.
19
9
20
10
Segment creates and merges user profiles based a space's Identity Resolution configuration. Segment searches for identifiers such as `userId`, `anonymousId` and `email` on incoming events and matches them to existing profiles or creates new profiles. These identifiers display in the Identities tab of a User Profile in the User Explorer:
21
11
@@ -25,46 +15,38 @@ Segment creates and merges user profiles based a space's Identity Resolution con
25
15
26
16
When Personas receives a new event, Segment looks for any profiles that match any of the identifiers on the event.
27
17
28
-
Based on the existance of a match, one of three actions can occur:
18
+
Based on the existence of a match, one of three actions can occur:
29
19
30
20
**1: Create a new profile**
31
21
When there are no pre-existing profiles that have matching identifiers to the event, Segment create a new user profile.
32
22
33
23
**2: Add to existing profile**
34
-
When there is one profile that matches all identifiers in an event, Segment attempta to map the traits, identifiers and events on the call to that existing profile. If there is an excess of any identifier on the final profile, Segment defers to the merge protection rules outlined below.
24
+
When there is one profile that matches all identifiers in an event, Segment attempts to map the traits, identifiers and events on the call to that existing profile. If there is an excess of any identifier on the final profile, Segment defers to the Identity Resolution rules outlined below.
35
25
36
26
**3: Merge existing profiles**
37
-
When there are multiple profiles that match the identifiers in an event, Segment checks the merge protection rules outlined below, and attemts to merge profiles.
27
+
When there are multiple profiles that match the identifiers in an event, Segment checks the Identity Resolution rules outlined below, and attempts to merge profiles.
38
28
39
29
## Identity Resolution settings
40
30
41
31
Identity Admins should first configure Identity Resolution Settings page to protect the identity graph from inaccurate merges and user profiles.
42
32
43
-
During the space creation process, the first step is to choose an Identity Resolution configuration. If this is your first space, you have the option to choose a Segment-suggested Out-of-the-Box configuration or a custom Identity Resolution setup. All subsequent spaces have a third option of importing settings from a different space.
33
+
During the space creation process, the first step is to choose an Identity Resolution configuration. If this is your first space, you have the option to choose a Segment-suggested Out-of-the-Box configuration or a custom Identity Resolution setup. All other spaces have a third option of importing settings from a different space.
44
34
45
35

46
36
47
37
### Out-of-the-Box
48
38
49
39
For most first-time Personas users, Segment recommends that you use the out-of-the-box configuration and answer a short series of questions for a best-fit setup for your use-case.
50
40
51
-

52
-
53
-

54
-
55
41
If you have custom unique identifiers or do not have a canonical `user_id` are automatically redirected to the Identity Resolution Settings page to complete your setup.
56
42
57
43
### Custom rules
58
44
59
45
If you are familiar with identity or have custom identifiers, Segment recommends that you select Custom Rules.
60
46
61
-

47
+
Segment redirects you to the Identity Resolutions Settings page where you can add Default Identifiers or Custom Identifiers.
62
48
63
-
Segment redirects youto the Identity Resolutions Settings page where you can add default or custom identifiers.
64
-
65
-

66
-
67
-
Find Segment's default 11 identifiers below.
49
+
Segment's 11 default are:
68
50
69
51
| External ID Type | Message Location in Track or Identify Call |
@@ -105,15 +87,16 @@ Before sending data through, Segment also recommends that you add any default ha
105
87
106
88
#### Limit
107
89
108
-
Identity Admins can specify the total number of values allowed per identifier type on a profile during a certain period. This will vary depending on how companies define a user today. In most cases, companies rely on `user_id` to distinguish user profiles and Segment defaults to the following configurations:
90
+
Identity Admins can specify the total number of values allowed per identifier type on a profile during a certain period. For example, in the image below, the `anonymous_id` field has a limit of **5 Weekly**.
91
+

92
+
93
+
This will vary depending on how companies define a user today. In most cases, companies rely on `user_id` to distinguish user profiles and Segment defaults to the following configurations:
109
94
110
95
| Identifier | Limit |
111
96
| --------------------- | ----- |
112
97
| user_id | 1 |
113
98
| all other identifiers | 5 |
114
99
115
-

116
-
117
100
Specific cases may deviate from this default. For example, a case where a user can have more than one `user_id` but one email, like when `shopify_id` and an internal UUID define a user. In this case, an example configuration may be:
118
101
119
102
| Identifier | Limit |
@@ -125,14 +108,12 @@ Specific cases may deviate from this default. For example, a case where a user c
125
108
When you choose the limit on an identifier, ask the following questions about each of the identifiers you send to Segment:
126
109
127
110
1. Is it an immutable ID? An immutable ID, such as `user_id`, should have `1 ever` per user profile.
128
-
2. Is it a constantly changing ID? A constantly changing ID, such as `anonymous_id` or `ga_client_id`, should have a short sliding window, such as `5 weekly` or `5 monthly`, depending on how often your application automatically logs out the user.
129
-
3. Is it an ID that updates on a yearly basis? Most customers will have around 5 emails or devices at any one time, but can update these over time. For identifiers like `email`, `android.id` or `ios.id`, Segment recommends a longer limit like `5 annually`.
130
-
131
-

111
+
2. Is it a constantly changing ID? A constantly changing ID, such as `anonymous_id` or `ga_client_id`, should have a short sliding window, such as **5 weekly** or **5 monthly**, depending on how often your application automatically logs out the user.
112
+
3. Is it an ID that updates on a yearly basis? Most customers will have around 5 emails or devices at any one time, but can update these over time. For identifiers like `email`, `android.id` or `ios.id`, Segment recommends a longer limit like **5 annually**.
132
113
133
114
#### Priority
134
115
135
-
Segment considers the priority of an identifier once the limit of any identifier on the final profile is exceeded.
116
+
Segment considers the priority of an identifier once that identifier exceeds the limit on the final profile.
136
117
137
118
For example, consider a Personas space with the following Identity Resolution configurations:
138
119
@@ -142,9 +123,11 @@ For example, consider a Personas space with the following Identity Resolution co
142
123
| email | 5 | 2 |
143
124
| anonymous_id | 5 | 3 |
144
125
145
-
A profile already exists with user_id`abc123` and email`[email protected]`. A new event comes in with new user_id`abc456` but the same email`[email protected]`. If this event maps to this profile, the resulting profile would then contain two user_ids and one email. Given that user_id has a limit of 1, this exceeds the limit of an identifier. As a result, the priority of these identifiers is checked. Because email and user_id are the two identifiers on the event and email ranks lower than user_id, Segment demotes email as an identifier on the incoming event and tries again.
126
+
A profile already exists with `user_id`**abc123** and `email`**[email protected]**. A new event comes in with new `user_id`**abc456** but the same `email`**[email protected]**.
146
127
147
-
At this point, the event searches for any profiles that match just the identifier user_id `abc456`. Now there are no existing profiles with this identifier, so Segment creates a new profile is created with user_id `abc456`.
128
+
If this event maps to this profile, the resulting profile would then contain two `user_id` values and one `email`. Given that `user_id` has a limit of 1, this exceeds the limit of that identifier. As a result, Segment checks the priority of the `user_id` identifier. Because `email` and `user_id` are the two identifiers on the event and `email` ranks lower than `user_id`, Segment demotes `email` as an identifier on the incoming event and tries again.
129
+
130
+
At this point, the event searches for any profiles that match just the identifier user_id `abc456`. Now there are no existing profiles with this identifier, so Segment creates a new profile with user_id `abc456`.
148
131
149
132
By default, Segment explicitly orders user_id and email as rank `1` and `2`, respectively. All other identifiers are in alphabetical order beginning from rank `3`. This means that if the identifiers sent with events flowing into personas are user_id, email, anonymous_id and ga_client_id, the rank would be as follows:
150
133
@@ -165,7 +148,7 @@ If a new android.id identifier appeared without first giving it explicit order,
165
148
| anonymous_id | 4 |
166
149
| ga_client_id | 5 |
167
150
168
-
Thus, if you require an explicit order for all identifiers, configure this in the Identity Resolution settings page before sending in events.
151
+
If you require an explicit order for all identifiers, configure this in the Identity Resolution settings page before sending in events.
169
152
170
153

171
154
@@ -177,24 +160,24 @@ When choosing the priority of your identifier, ask the following questions about
177
160
178
161
### Importing from an existing space
179
162
180
-
This option is available to new spaces once the initial Dev space is created. Segment recommends this option when identity settings are validated as correct in the initial Dev space and should be copied into the Prod space.
163
+
This option is available to new spaces after you create an initial Dev space. Segment recommends this option when identity settings are validated as correct in the initial Dev space and should be copied into the Production space.
181
164
182
-

165
+
You can review the identifiers, priorities, limits, and blocked values before you complete the import.
183
166
184
-
## Connecting a source
167
+

185
168
186
-
After you configure Identity Resolution settings, the next step is to connect a source to the Personas space.
169
+
## Connect a source
187
170
188
-

171
+
After you configure Identity Resolution settings, the next step is to connect a [source](/docs/connections/sources/) to the Personas space.
189
172
190
-
## Creating an Audience
173
+
## Create an Audience
191
174
192
175
After you connect a source, Personas creates user profiles based off of replayed and newly incoming data.
193
176
194
177

195
178
196
179
The next step, which is important in the Dev space, is to create an audience to ensure that user profiles have populated correctly and that the identity resolution settings follow expected business logic.
197
180
198
-
For example, if there should be 100,000 distinct users who have a user_id, this would be a great way to validate that the identity resolution settings have calculated profiles correctly.
181
+
For example, if there should be 100,000 distinct users who have a `user_id`, this would be a great way to validate that the identity resolution settings have calculated profiles correctly.
199
182
200
-
Users can learn more about creating audiences and traits[here](/docs/personas/audiences.md).
183
+
For more information about how to create audiences and traits, see [Audiences](/docs/personas/audiences/).
0 commit comments