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/data-graph/linked-events.md
+19-24Lines changed: 19 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,29 +4,26 @@ plan: unify
4
4
hidden: false
5
5
---
6
6
7
-
Use Linked Events to enrich real-time event streams with entities from your data warehouse to your destinations. Insert additional event context for downstream applications for richer data about each event.
7
+
Use Linked Events to enrich real-time event streams with entities from your data warehouse to your destinations. Insert additional event context for downstream applications for richer data about each event.
8
8
9
-
> info "Consent enforcement for Linked Events"
10
-
> You can use [Consent Management](/docs/privacy/consent-management/) to enforce consent in your downstream destinations for Linked Events stamped with the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object). You must enable Consent Management and have consent stamped on events from event streaming sources to use Consent Management. You cannot use Linked Events to enrich events with consent preferences that are stored in your warehouse.
11
-
12
-
On this page, you'll learn how to get started with Linked Events.
9
+
On this page, you'll learn how to get started with Linked Events. Linked Events supports Snowflake, BigQuery, Redshift, and Databricks.
13
10
14
-
> info "Linked Events warehouse support"
15
-
> Linked Events supports Snowflake, BigQuery, Redshift, and Databricks.
11
+
> info "Consent enforcement for Linked Events"
12
+
> You can use [Consent Management](/docs/privacy/consent-management/) to enforce consent in your downstream destinations for Linked Events stamped with the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object). You must enable Consent Management and have consent stamped on events from event streaming sources to use Consent Management. You cannot use Linked Events to enrich events with consent preferences that are stored in your warehouse.
16
13
17
14
## Use cases
18
15
19
16
With Linked Events, you can:
20
17
21
18
-**Add details to events for precise targeting**. Enable targeting by appending product events that only have `product_id` with full product SKU details from your warehouse.
22
-
-**Sync enriched data**. Add a loyalty ID to event payloads before sending it downstream to destinations such as Amplitude, Mixpanel, and more.
19
+
-**Sync enriched data**. Add a loyalty ID to event payloads before sending it downstream to destinations like Amplitude, Mixpanel, and more.
23
20
-**Reduce load times**. Enrich page view events with products and subscriptions connected to that view, and send that to Google Analytics 4 to lighten the front end and reduce page loading time.
24
21
25
22
## Prerequisites
26
23
27
24
To use Linked Events, you'll need the following:
28
25
29
-
1. A supported data warehouse.
26
+
1. A supported data warehouse. Linked Events supports Snowflake, BigQuery, Redshift, and Databricks.
30
27
2. Access to Unify in your workspace.
31
28
3. Access to the actions-based destination you'll be using with Linked Events so that you can validate your data.
32
29
@@ -37,9 +34,8 @@ To use Linked Events, you'll need the following:
37
34
38
35
The following Segment access [roles](/docs/segment-app/iam/roles/) apply to Linked Events:
39
36
40
-
**Entities Admin Access**: Entities Admins have the ability to view and edit entity models and connection details.
41
-
42
-
**Entities Read-only Access**: Entities Read-only users have the ability to view entity models.
37
+
-**Entities Admin Access**: Entities Admins have the ability to view and edit entity models and connection details.
38
+
-**Entities Read-only Access**: Entities Read-only users have the ability to view entity models.
43
39
44
40
To create models and enrich events in destinations, you need to be a `Workspace Owner` or have the following roles:
45
41
@@ -50,24 +46,24 @@ To create models and enrich events in destinations, you need to be a `Workspace
50
46
## Step 1: Set up your data warehouse and permissions
51
47
52
48
> info ""
53
-
> Linked Events uses Segment's [Reverse ETL](/docs/connections/reverse-etl/) infrastructure for pulling in data from your warehouse.
49
+
> Linked Events uses Segment's [Reverse ETL](/docs/connections/reverse-etl/) infrastructure to pull in data from your warehouse.
54
50
55
-
To get started, you'll need to set up your data warehouse and provide the correct access detailed in the set up steps below. Linked Events supports [BigQuery](/docs/unify/linked-profiles/setup-guides/bigquery-setup/), [Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/), [Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/), and [Redshift](/docs/unify/linked-profiles/setup-guides/redshift-setup/).
51
+
To get started, you'll need to set up your data warehouse and provide Segment the access detailed in the setup steps below. Linked Events supports [BigQuery](/docs/unify/linked-profiles/setup-guides/bigquery-setup/), [Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/), [Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/), and [Redshift](/docs/unify/linked-profiles/setup-guides/redshift-setup/).
56
52
57
53
## Step 2: Connect your warehouse to the Data Graph
58
54
59
55
> success ""
60
-
> Before getting started with the Data Graph, be sure to set up your warehouse permissions.
56
+
> Before getting started with the Data Graph, set up your warehouse permissions.
61
57
62
58
1. Navigate to **Unify > Data graph** and click **Add warehouse**.
63
-
2. Select a warehouse to connect from the [supported data warehouses](#supported-data-warehouses).
59
+
2. Select one of the [supported data warehouses](#supported-data-warehouses).
64
60
3. Connect your warehouse.
65
61
3. Click **Test Connection** to be sure your warehouse is connected.
66
62
4. After a successful test, click **Save**.
67
63
68
64
### Schema
69
65
70
-
Linked Events uses Reverse ETL to compute the incremental changes to your data directly within your data warehouse. The Unique Identifier column detects data changes, such as new, updated, and deleted records.
66
+
Linked Events uses [Reverse ETL](/docs/connections/reverse-etl/) to compute the incremental changes to your data directly within your data warehouse. The Unique Identifier column detects data changes, like new, updated, and deleted records.
71
67
72
68
For Segment to compute data changes in your warehouse, Segment requires both read and write permissions to the warehouse schema table. At a high level, the extract process requires read permissions for the query being executed. Segment tracks changes to the query results through tables that Segment manages in a dedicated schema (for example, `_segment_reverse_etl`), which requires some write permissions.
73
69
@@ -80,17 +76,17 @@ The table below shows the data warehouses Linked Events supports. View the Segme
|[Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/)| 1. Configure your snowflake database. <br> 2. Enter your credentials. <br> 3. Test the Connection. <br> 4. Click **Save**. |
79
+
|[Snowflake](/docs/unify/linked-profiles/setup-guides/snowflake-setup/)| 1. Configure your snowflake database. <br> 2. Enter your credentials. <br> 3. Test the connection. <br> 4. Click **Save**. |
84
80
|[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. |
85
81
|[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. |
86
-
|[Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/)| 1. Configure your Databricks catalog. <br> 2. Enter your credentials. <br> 3. Test the Connection. <br> 4. Click **Save**. |
82
+
|[Databricks](/docs/unify/linked-profiles/setup-guides/databricks-setup/)| 1. Configure your Databricks catalog. <br> 2. Enter your credentials. <br> 3. Test the connection. <br> 4. Click **Save**. |
87
83
88
84
89
85
## Step 3: Build your Data Graph
90
86
91
-
The Data Graph is a semantic layer that represents a subset of relevant business data that you'll use to enrich events in downstream tools. Use the configuration language spec below to add models to build out your Data Graph.
87
+
The Data Graph is a semantic layer that represents a subset of relevant business data that you'll use to enrich events in downstream tools. Use the configuration language spec below to add models and build out your Data Graph.
92
88
93
-
Each Unify space has one Data Graph. The current version is v0.0.6 but this may change in the future as Segment accepts feedback about the process.
89
+
Each Unify space has one Data Graph. The current version is v0.0.6, but this may change in the future as Segment accepts feedback about the process.
94
90
95
91
> warning ""
96
92
> Deleting entities and relationships are not yet supported.
@@ -160,8 +156,7 @@ To configure your sync schedule:
160
156
161
157
### Add entities
162
158
163
-
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.
164
-
- The entity match property is the property in the event that you want to match to the primary key.
159
+
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, or the property in the event that you want to match to the primary key.
165
160
166
161
After you’ve added an entity and match property, add your event enrichments.
167
162
@@ -178,7 +173,7 @@ In the Mappings tab, locate the **Select Mappings** section where you can enrich
178
173
4. Click **Save**.
179
174
180
175
#### Testing with Linked Events Enrichments
181
-
The [Event Tester and Mappings Tester](/docs/connections/test-connections/#) support testing enrichments from Linked Events, allowing you to verify that entity data is correctly attached to your events before they reach destinations. When you have Linked Events configured, these enrichments appear in your test payload, showing you exactly how profile traits will add to your events.
176
+
The [Event Tester and Mappings Tester](/docs/connections/test-connections/) support testing enrichments from Linked Events, allowing you to verify that entity data is correctly attached to your events before they reach destinations. When you have Linked Events configured, these enrichments appear in your test payload, showing you exactly how profile traits will add to your events.
182
177
183
178
When you test mappings with Linked Events Enrichments:
184
179
* You can view the enriched fields in the **Request** section of the test results.
0 commit comments