Skip to content

Commit 8f7239f

Browse files
committed
grammer and voice activitation DOC-1
1 parent 4b342c5 commit 8f7239f

File tree

7 files changed

+96
-103
lines changed

7 files changed

+96
-103
lines changed

src/personas/identity-resolution/externalids.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ title: Identity Resolution ExternalIDs
33
---
44

55
> note ""
6-
> **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/).
77
88
## Default ExternalIDs
99

1010
The Identity Graph creates or merges profiles based on externalIDs. ExternalIDs will become the Identities attached to a User Profile in the User Explorer:
1111

1212
![](images/jane_doe_new_identities.png)
1313

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:
1515

1616
| External ID Type | Message Location in Track or Identify Call |
1717
| ------------------ | ------------------------------------------------------------------------------------------------------------- |
@@ -73,7 +73,7 @@ For example, the following user had anonymous_id and user_id promoted as identif
7373

7474
## Example
7575

76-
Let's say a new anonymous user visits your Pricing page:
76+
For example, a new anonymous user visits your Pricing page:
7777

7878
``` js
7979
analytics.page('Pricing', {
@@ -88,9 +88,9 @@ At this point, the Identity Graph will create a new user with external id (anony
8888

8989
![](images/identity_resolution_2.png)
9090

91-
Any new events received with the same external id (anonymous_id: `anon_123`) will be appended to same user `use_4paotyretuj4Ta2bEYQ0vKOq1e7`.
91+
Any new events received with the same external id (anonymous_id: `anon_123`) are appended to same user `use_4paotyretuj4Ta2bEYQ0vKOq1e7`.
9292

93-
Next, the user goes to a signup form and signs up:
93+
Next, the user goes to a sign up form and signs up:
9494

9595
``` js
9696
analytics.track('User Signup', {

src/personas/identity-resolution/identity-resolution-onboarding.md

Lines changed: 27 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,11 @@
11
---
22
title: Identity Resolution Onboarding
33
---
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-
124
> note ""
135
> **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).
146
15-
## Select Identity Resolution settings
16-
177
> 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.
199
2010
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:
2111

@@ -25,46 +15,38 @@ Segment creates and merges user profiles based a space's Identity Resolution con
2515

2616
When Personas receives a new event, Segment looks for any profiles that match any of the identifiers on the event.
2717

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:
2919

3020
**1: Create a new profile**
3121
When there are no pre-existing profiles that have matching identifiers to the event, Segment create a new user profile.
3222

3323
**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.
3525

3626
**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.
3828

3929
## Identity Resolution settings
4030

4131
Identity Admins should first configure Identity Resolution Settings page to protect the identity graph from inaccurate merges and user profiles.
4232

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.
4434

4535
![](images/first_screen.png)
4636

4737
### Out-of-the-Box
4838

4939
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.
5040

51-
![](images/out_of_the_box_1.png)
52-
53-
![](images/out_of_the_box.png)
54-
5541
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.
5642

5743
### Custom rules
5844

5945
If you are familiar with identity or have custom identifiers, Segment recommends that you select Custom Rules.
6046

61-
![](images/custom_rules_1.png)
47+
Segment redirects you to the Identity Resolutions Settings page where you can add Default Identifiers or Custom Identifiers.
6248

63-
Segment redirects youto the Identity Resolutions Settings page where you can add default or custom identifiers.
64-
65-
![](images/add_identifiers.png)
66-
67-
Find Segment's default 11 identifiers below.
49+
Segment's 11 default are:
6850

6951
| External ID Type | Message Location in Track or Identify Call |
7052
| -------------------- | ------------------------------------------------------------------------------------------------------------- |
@@ -105,15 +87,16 @@ Before sending data through, Segment also recommends that you add any default ha
10587

10688
#### Limit
10789

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+
![](images/anonymous-id.png)
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:
10994

11095
| Identifier | Limit |
11196
| --------------------- | ----- |
11297
| user_id | 1 |
11398
| all other identifiers | 5 |
11499

115-
![](images/user-id.png)
116-
117100
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:
118101

119102
| Identifier | Limit |
@@ -125,14 +108,12 @@ Specific cases may deviate from this default. For example, a case where a user c
125108
When you choose the limit on an identifier, ask the following questions about each of the identifiers you send to Segment:
126109

127110
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-
![](images/anonymous-id.png)
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**.
132113

133114
#### Priority
134115

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.
136117

137118
For example, consider a Personas space with the following Identity Resolution configurations:
138119

@@ -142,9 +123,11 @@ For example, consider a Personas space with the following Identity Resolution co
142123
| email | 5 | 2 |
143124
| anonymous_id | 5 | 3 |
144125

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]**.
146127

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`.
148131

149132
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:
150133

@@ -165,7 +148,7 @@ If a new android.id identifier appeared without first giving it explicit order,
165148
| anonymous_id | 4 |
166149
| ga_client_id | 5 |
167150

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.
169152

170153
![](images/edit-priority.png)
171154

@@ -177,24 +160,24 @@ When choosing the priority of your identifier, ask the following questions about
177160

178161
### Importing from an existing space
179162

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.
181164

182-
![](images/import.png)
165+
You can review the identifiers, priorities, limits, and blocked values before you complete the import.
183166

184-
## Connecting a source
167+
![](images/import.png)
185168

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

188-
![](images/connect_sources.png)
171+
After you configure Identity Resolution settings, the next step is to connect a [source](/docs/connections/sources/) to the Personas space.
189172

190-
## Creating an Audience
173+
## Create an Audience
191174

192175
After you connect a source, Personas creates user profiles based off of replayed and newly incoming data.
193176

194177
![](images/create_audience.png)
195178

196179
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.
197180

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.
199182

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

Comments
 (0)