Skip to content

Commit d3dc5e2

Browse files
committed
Add updated Linked Events flow
1 parent 890b9a9 commit d3dc5e2

File tree

1 file changed

+36
-10
lines changed

1 file changed

+36
-10
lines changed

src/unify/linked-profiles/linked-events.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,19 +81,45 @@ The table below shows the data warehouses Linked Events supports. View the Segme
8181
| [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. |
8282
| [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. |
8383

84-
## Step 2: Add entities
8584

86-
After you connect your warehouse, use the Data graph overview page (**Unify > Data graph**) to view entities Segment has synced from your data warehouse, add a new entity, and view data warehouse settings.
85+
## Step 2: Build your Data Graph
8786

88-
To add a new entity:
89-
1. Click **Add entity**.
90-
2. Select the table(s) from your warehouse that you'll use as an entity.
91-
3. For each table you select, choose a primary key from the drop-down menu.
92-
- The primary key uniquely identifies rows in your table.
93-
4. Click **Add entities**.
87+
The [Data Graph](/unify/linked-profiles/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.
9488

95-
> success ""
96-
> If you don't see data you need, or have recently updated your warehouse, click **Refresh** to update the schema and tables list.
89+
### Deleting and editing entities and/or relationships from your Data Graph
90+
91+
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.
92+
93+
> warning ""
94+
> Deleting and/or editing entities and relationships to the Data Graph may lead to errors if these entities or relationships are referenced in existing Linked Audiences and Linked Events. Segment recommends creating a new Linked Audience or Linked Event. <br><br> Please note that while you can delete relationships or entities from the Data Graph, these relationships will still show up in the Linked Audience Builder and Linked Events.
95+
96+
### Defining entities
97+
98+
> warning ""
99+
> Snowflake schemas are case sensitive, so you'll need to reflect the schema, table, and column names based on how you case them in Snowflake.
100+
101+
An entity is a stateful representation of a business object. The entity corresponds to a table in the warehouse that represents that entity.
102+
103+
104+
| Parameters | Definition |
105+
| ----------- | --------------------------------------------------------------------- |
106+
| `entity` | A unique slug for the entity, which is immutable and treated as a delete if you make changes. The slug must be in all lowercase, and supports dashes or underscores (for example, `account-entity` or `account_entity`). |
107+
| `name` | A unique label which will display across Segment. |
108+
| `table_ref` | Define the table reference. In order to specify a connection to your table in Snowflake, a fully qualified table reference is required: `[database name].[schema name].[table name]`. |
109+
| `primary_key` | The unique identifier for the given table. Should be a column with unique values per row. |
110+
| (Optional) `enrichment_enabled = true` | Indicate if you plan to also reference the entity table for [Linked Events](/docs/unify/linked-profiles/linked-events/). |
111+
112+
113+
114+
```python
115+
# Define an entity and optionally indicate if the entity will be referenced for Linked Events (event enrichment)
116+
117+
entity "account" {
118+
table_ref = "cust.account"
119+
primary_key = "id"
120+
enrichment_enabled = true
121+
}
122+
```
97123

98124

99125
## Step 3: Add a Destination

0 commit comments

Comments
 (0)