Skip to content

Commit 4038e83

Browse files
committed
Add destinations procedure, "RETL" qa
1 parent 85c7aea commit 4038e83

File tree

1 file changed

+43
-17
lines changed

1 file changed

+43
-17
lines changed

src/privacy/consent-management/consent-in-retl.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Consent in Reverse ETL
33
plan: consent-management
44
---
55

6-
With Consent in RETL, you can enforce your end-users' consent preferences that are captured by your consent management platform (CMP) and stored in your warehouse.
6+
With Consent Management in Reverse ETL, you can enforce your end-users' consent preferences that are captured by your consent management platform (CMP) and stored in your warehouse.
77

88
To enforce consent stored in your warehouse, build a Reverse ETL mapping that identifies consent categories. You can create a new mapping or update your mapping to identify the columns that store information about end user consent preferences and then enforce these preferences in [Reverse ETL-supported Actions destinations](/docs/connections/reverse-etl/reverse-etl-catalog/) and the [Segment Connections destination](/docs/connections/destinations/catalog/actions-segment/).
99

10-
> info "Consent in Reverse ETL supports RETL destinations and Segment Connections"
10+
> info "Consent in Reverse ETL supports Reverse ETL-supported Actions destinations and Segment Connections"
1111
> At this time, Consent in Reverse ETL does not support enforcing consent in the Segment Profiles destination. To enforce consent data in your classic Segment destinations, use the [Segment Connections destination](/docs/connections/destinations/catalog/actions-segment/).
1212
1313
## Prerequisites
@@ -18,7 +18,7 @@ To enforce consent stored in your warehouse, build a Reverse ETL mapping that id
1818
Before you can enforce consent stored in your warehouse, take the following steps:
1919
- **Set up your third-party consent management tool and create consent categories**. Take note of your consent categories and the key or ID associated with each category.
2020
- **Know how your company uses each destination**. You need to know which destinations to map to each category.
21-
- **End-user consent stored in a warehouse that [Segment supports for RETL](/docs/connections/reverse-etl/#step-1-add-a-source)**. Segment supports Reverse ETL capabilities in Azure, BigQuery, Databricks, Postgres, Snowflake, and Redshift data warehouses. Other data warehouses are not supported.
21+
- **End-user consent stored in a warehouse that [Segment supports for Reverse ETL](/docs/connections/reverse-etl/#step-1-add-a-source)**. Segment supports Reverse ETL capabilities in Azure, BigQuery, Databricks, Postgres, Snowflake, and Redshift data warehouses. Other data warehouses are not supported.
2222

2323
## Step 1: Create consent categories in the Segment app
2424

@@ -38,9 +38,11 @@ Before you can enforce consent stored in your warehouse, take the following step
3838
> warning "Segment recommends mapping all Reverse ETL destinations to a category"
3939
> Segment assumes all destinations without a mapping do not require user consent and will receive all events containing a consent object. If a destination is mapped to multiple categories, a user must consent to all categories for data to flow to the destination.
4040
41+
To edit or disable consent categories, view the [Configure Consent Management](/docs/privacy/consent-management/configure-consent-management/) documentation.
42+
4143
## Step 2: Identify consent columns
4244

43-
After you set up consent categories in the Segment app, you must identify the columns in your data warehouse that store end user consent by creating a *model*, or SQL query that defines the set of data you want to synchronize to your Reverse ETL destinations. When building your RETL data model, Segment recommends that you store consent as a boolean `true` or `false` value and map one consent category to one column.
45+
After you set up consent categories in the Segment app, you must identify the columns in your data warehouse that store end user consent by creating a *model*, or SQL query that defines the set of data you want to synchronize to your Reverse ETL destinations. When building your data model, Segment recommends that you store consent as a boolean `true` or `false` value and map one consent category to one column.
4446

4547
> error "Creating a data model that does not include information about consent preferences results in no consent enforcement"
4648
> If you create consent categories in your workspace but fail to identify columns that contain consent preferences in your data model, events flow to all destinations in your workspace regardless of end user consent preferences.
@@ -55,31 +57,55 @@ To add your first model:
5557
6. Click **Next**.
5658
7. Enter your Model Name.
5759
8. Click **Create Model**.
58-
_(Optional): You can opt
60+
_(Optional)_: You can opt to map data from your model to your destination using Reverse ETL mappings. For more information, see the [Reverse ETL: Create mappings](/docs/connections/reverse-etl/#step-4-create-mappings) documentation.
61+
62+
To edit an existing Reverse ETL model:
63+
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
64+
2. Select the source and the model you want to edit.
65+
3. Select the **Query Builder** tab to edit your query. When you've finished making changes, click **Save Query**.
66+
_(Optional)_: You can select the **Settings** tab and click **Consent settings** to verify that the consent categories in your model match the consent categories you configured in your workspace.
67+
68+
You can either create a model with each consent category represented in its own column, or one single blob column that you parse out into individual consent categories. The following sample model maps a consent category to each column in your database:
69+
70+
``` sql
71+
select
72+
USERID,
73+
Ads,
74+
CAST(CONSENT_OBJ:consent.cookie.Personalization as Boolean) as Personalization,
75+
CAST(CONSENT_OBJ:consent.cookie.Analytics as Boolean) as Analytics,
76+
city,
77+
email,
78+
distinctid
79+
from CONSENT_PREFERENCES;
80+
```
5981

6082
> info "Consent categories in the Segment app must match consent columns identified in your data warehouse before continuing"
6183
> If you create consent categories in the Segment app but fail to identify a column for each category you created in Segment, you will not be able to proceed until you enable a destination mapped to a consent category not identified in the data model.
6284
63-
## Step 3: Events flow to your downstream destinations
64-
65-
After you set up categories in the Segment app and create a RETL model that extracts consent information, events begin to flow to your downstream destinations.
66-
67-
> info "Consent in Reverse ETL supports RETL destinations and Segment Connections"
68-
> At this time, Consent in Reverse ETL does not support enforcing consent in the [Segment Profiles destination](/docs/connections/destinations/catalog/actions-segment-profiles/).
85+
## Step 3: Connect your downstream destinations
6986

70-
### Segment Connections destination
71-
72-
Segment automatically adds the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object) to every event that's routed downstream to your Segment Connections destination. [Consent enforcement in Connections](/docs/privacy/consent-management/consent-in-segment-connections/) validates that only consenting data flows downstream to any classic Segment destinations connected to your Segment Connections instance.
87+
After you set up categories in the Segment app and create a SQL model that extracts consent information, connect your downstream destinations to complete the consent enforcement process.
7388

74-
### Reverse ETL Actions destinations
89+
> info "Consent in Reverse ETL supports Reverse ETL-supported Actions destinations and Segment Connections"
90+
> At this time, Consent in Reverse ETL does not support enforcing consent in the Segment Profiles destination. To enforce consent data in your classic Segment destinations, use the [Segment Connections destination](/docs/connections/destinations/catalog/actions-segment/).
7591
76-
Segment automatically filters out data from users who have not consented to the category mapped to your destination.
92+
To add your first destination:
93+
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
94+
2. Click **Add Reverse ETL destination**.
95+
3. Select the destination you want to connect to and click **Configure**.
96+
4. Select the Reverse ETL source you want to connect the destination to.
97+
5. Enter the **Destination name** and click **Create Destination**.
98+
6. Enter the required information on the **Settings** tab of the destination.
99+
7. Navigate to the destination settings tab and enable the destination. If the destination is disabled, then Segment won't be able to start a sync.
77100

78101
## Validate your consent mapping
79102

80-
You can validate that you successfully created your consent mapping in Segment Connections or supported Reverse ETL Actions destinations using the following methods:
103+
You can validate that you successfully created your consent mapping in Segment Connections or supported Reverse ETL Actions destinations using the following methods.
81104

82105
### Segment Connections destination
106+
107+
Segment automatically adds the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object) to every event that's routed downstream to your Segment Connections destination. [Consent enforcement in Connections](/docs/privacy/consent-management/consent-in-segment-connections/) validates that only consenting data flows downstream to any classic Segment destinations connected to your Segment Connections instance.
108+
83109
Open the Source Debugger for your Reverse ETL source and confirm that the [consent object](/docs/privacy/consent-management/consent-in-segment-connections/#consent-object) appears on every event and that the consent object has the categories you mapped in [Step 2: Identify consent columns](#step-2-identify-consent-columns).
84110

85111
<!--- ### Segment Profiles

0 commit comments

Comments
 (0)