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/unify/linked-profiles/linked-events.md
+29-31Lines changed: 29 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,12 +29,6 @@ Before getting started with Linked Events, you'll need:
29
29
2. Access to Unify in your workspace.
30
30
3. Access to the Destination you'll be using with Linked Events so that you can validate your data.
31
31
32
-
<!--
33
-
> success ""
34
-
> Segment recommends using a test table with under 1,000 rows. Using a copy of the production table allows Segment to keep the Primary Key and mimic real life use cases, but keep the scale low for quick testing.
35
-
36
-
-->
37
-
38
32
> info ""
39
33
> Segment stores and processes all data in the United States.
40
34
@@ -76,7 +70,7 @@ For Linked Events, the sync destination is an internal Segment data store. To tr
76
70
77
71
You can choose which database within your warehouse this data lives in.
78
72
79
-
> success ""
73
+
> info ""
80
74
> Linked Events syncs data from your warehouse approximately once every hour.
81
75
82
76
### Supported data warehouses
@@ -89,18 +83,20 @@ The table below shows the data warehouses Linked Events supports. View the Segme
89
83
|[BigQuery](/docs/unify/linked-profiles/setup-guides/bigquery-setup/)| 1. Add your credentials to the database that has tables with the Entities you want to enrich your event with. <br> 2. Test your connection. |
90
84
|[Redshift](/docs/unify/linked-profiles/setup-guides/redshift-setup/)| 1. Select the Redshift cluster you want to connect. <br> 2. [Configure](/docs/connections/storage/catalog/redshift/#networking) the correct network and security settings. |
91
85
92
-
## Step 2: Add models
86
+
## Step 2: Add entities
93
87
94
-
After you connect your warehouse, use the Data graph overview screen (**Unify > Data graph**) to view models Segment has synced from your data warehouse, add a new model, and view data warehouse settings.
88
+
After you connect your warehouse, use the Data graph overview screen (**Unify > Data graph**) to view entities Segment has synced from your data warehouse, add a new entity, and view data warehouse settings.
95
89
96
-
To add a new model:
97
-
1. Click **Add model**.
98
-
2. Select the table(s) from your warehouse that you'll use as a model.
90
+
To add a new entity:
91
+
1. Click **Add entity**.
92
+
2. Select the table(s) from your warehouse that you'll use as an entity.
99
93
3. For each table you select, choose a primary key from the drop-down menu.
100
94
- The primary key uniquely identifies rows in your table.
101
-
4. Click **Add model**.
95
+
4. Click **Add entities**.
96
+
97
+
> success ""
98
+
> If you don't see data you need, or have recently updated your warehouse, click **Refresh** to update the schema and tables list.
102
99
103
-
Once you've added a model, visit the Data graph overview page and select the model to view table columns, data type, and sync status information.
104
100
105
101
## Step 3: Add a Destination
106
102
@@ -110,47 +106,49 @@ To use Linked Events, you'll need to add a destination to send enriched events t
110
106
> For Linked Events, Segment supports [Destination Actions](/docs/connections/destinations/actions/).
111
107
112
108
113
-
## Step 4: Create an event enrichment
114
-
With Linked Events, you can select models and properties from your data warehouse, then add enrichments to map properties to your connected destination.
109
+
## Step 4: Enrich events with entities
110
+
With Linked Events, you can select entities and properties from your data warehouse, then add enrichments to map properties to your connected destination.
115
111
116
-
You can add data models and enrichments from the destination Mappings tab:
112
+
Add entities and enrichments from the destination Mappings tab:
117
113
118
114
1. Navigate to **Connections > Destinations > Event streams**
119
115
2. Select the destination you'd like to create an enrichment on.
120
116
3. From the Destination overview page, click **Mappings**.
121
117
4. Click **New Mapping**, and select the type of mapping you'd like to add.
122
118
- Click the **...** icon to edit an existing mapping.
123
119
5. In the "Select Events to Map and Send", define the [conditions](/docs/connections/destinations/actions/#conditions) under which the action should run.
124
-
6. Click **Load Sample Event**, then add your data models.
120
+
6. Click **Load Sample Event**, then add your entities.
125
121
126
-
### Add data models
122
+
### Add entities
127
123
128
-
After you load a sample event, you can add data models from the **Enrich events with data models** section. You’ll select a data model, then a model match property.
129
-
- The model match property is the property in the event that you want to match to the primary key.
124
+
After you load a sample event, you can add entities from the **Enrich events with entities** section. You’ll select an entity, then an entity match property.
125
+
- The entity match property is the property in the event that you want to match to the primary key.
130
126
131
-
After you’ve added a data model and match property, add your event enrichments.
127
+
After you’ve added an entity and match property, add your event enrichments.
132
128
133
129
### Add enrichments
134
130
135
131
Use enrichments to select the entity you wish to send to your downstream destination.
136
132
137
-
In the Mappings tab, locate the **Select Mappings** section where you can enrich source properties from the data models you've selected in the previous step.
133
+
In the Mappings tab, locate the **Select Mappings** section where you can enrich source properties from the entities you've selected in the previous step.
138
134
139
-
Select the property field that you'd like to enrich, then select the **Enrichments** tab. Next, select the properties you want to send to your destination.
135
+
1. Select the propery field that you'd like to enrich, then select the **Enrichments** tab.
136
+
2. Select the entity you want to send to your destination.
137
+
- You’ll have access to all rows/columns in your data warehouse associated with the property you've selected in the previous step.
138
+
3. Add the key name on the right side, which is what Segment sends to your destination.
140
139
141
-
You’ll have access to all rows/columns in your data warehouse associated with the match property you've selected in the previous step.
142
-
143
-
You can then add the key name on the right side, which is what Segment sends to your destination.
140
+
> warning ""
141
+
> At this time, Linked Events doesn't support a preview of enriched payloads.
144
142
145
143
### Test and save your Enrichments
146
144
147
-
After you’ve added Enrichments, you’ll want to test and save your enrichments.
145
+
After you’ve added Enrichments, test and save your enrichments.
148
146
149
-
5. Test the mapping with data from a sample event.
147
+
1. Test the mapping with data from a sample event.
150
148
- The edit panel shows you the mapping output in the format for the destination tool. You can change your mapping as needed and re-test.
151
-
6. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table.
149
+
2. When you're satisfied with the mapping, click **Save**. Segment returns you to the Mappings table.
152
150
153
-
> info ""
151
+
> warning ""
154
152
> At this time, when you select mappings or test events, you won’t see enrichment data. Enrichment data is only available with real events.
0 commit comments