Skip to content

Commit 242f2e2

Browse files
committed
addressing Atit's feedback [netlify-build]
1 parent fe7246d commit 242f2e2

File tree

2 files changed

+46
-15
lines changed

2 files changed

+46
-15
lines changed

src/privacy/consent-management/configure-consent-management.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ Before you can configure consent in Segment, take the following steps:
3131
- **Category name**: Enter a name that describes your use case for the data sent to this destination. This field only accepts category names that are 20 characters or less.
3232
- **Category ID**: In OneTrust, this is a string of up to five alphanumeric characters, but other CMPs may have a different format. This field is case sensitive.
3333
- **Mapped destinations**: Select one or more of your destinations to map to this category. Category mappings apply to all instances of a destination.
34-
<br/><br/>**Optional**: Click **Add category** to create another category.
3534
5. Once you've finished setting up your category or categories, click **Save**.
3635

3736
> warning "Segment recommends mapping all destinations to a category"

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

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,21 @@ Before you can enforce consent stored in your warehouse, take the following step
3232
- **Category name**: Enter a name that describes your use case for the data sent to this destination. This field only accepts category names that are 20 characters or less.
3333
- **Category ID**: In OneTrust, this is a string of up to five alphanumeric characters, but other CMPs may have a different format. This field is case sensitive.
3434
- **Mapped destinations**: Select one or more of your Reverse ETL destinations to map to this category. Category mappings apply to all instances of a destination.
35-
<br/><br/>**Optional**: Click **Add category** to create another category.
3635
5. Once you've finished setting up your category or categories, click **Save**.
3736

3837
> warning "Segment recommends mapping all Reverse ETL destinations to a category"
3938
> 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.
4039
4140
To edit or disable consent categories, view the [Configure Consent Management](/docs/privacy/consent-management/configure-consent-management/) documentation.
4241

43-
## Step 2: Identify consent columns
42+
## Step 2: Add your Reverse ETL source
43+
44+
> success ""
45+
> If you've already added a [Reverse ETL source] to your workspace, you can proceed to [Step 3: Identify consent columns](#step-3-identify-consent-columns).
46+
47+
If you haven't already configured a Reverse ETL source in your workspace, follow the instructions in the [Reverse ETL: Create a source](/docs/connections/reverse-etl/#step-1-add-a-source) documentation to add your warehouse as a data source. When you've configured your Reverse ETL source, proceed to [Step 3: Identify consent columns](#step-3-identify-consent-columns).
48+
49+
## Step 3: Identify consent columns
4450

4551
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.
4652

@@ -50,39 +56,65 @@ After you set up consent categories in the Segment app, you must identify the co
5056
To add your first model:
5157
1. Navigate to Connections > Sources and select the Reverse ETL tab. Select your source and click **Add Model**.
5258
2. Click **SQL Editor** as your modeling method.
53-
3. Enter the SQL query that’ll define your model. Your model is used to map data to your Reverse ETL destinations.
59+
3. Create the SQL query that’ll define your model. Your model is used to map data to your Reverse ETL destinations.
5460
4. Choose a column to use as the unique identifier for each record in the Unique Identifier column field.
5561
The Unique Identifier should be a column with unique values per record to ensure checkpointing works as expected. It can be a primary key. This column is used to detect new, updated, and deleted records.
5662
5. Click **Preview** to see a preview of the results of your SQL query. The data from the preview is extracted from the first 10 records of your warehouse.
5763
6. Click **Next**.
5864
7. Enter your Model Name.
5965
8. Click **Create Model**.
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.
66+
9. Select **Add Mapping**.
67+
10. On the **Add Mapping** popup, select the destination you'd like consent data to flow to.
68+
11. Select an Action from the dropdown and click **Create Mapping**.
69+
12. Follow the steps in the Edit Mapping workflow and click **Save Mapping** to add your mapping.
6170

62-
To edit an existing Reverse ETL model:
71+
To update an existing Reverse ETL model to include consent enforcement:
6372
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
6473
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.
74+
3. Select the **Query Builder** tab to edit your query. When you're editing your query, include columns that store information about end user consent preferences. When you've finished making changes, click **Save Query**.
75+
4. Select **Add Mapping**.
76+
5. On the **Add Mapping** popup, select the destination you'd like consent data to flow to.
77+
6. Select an Action from the dropdown and click **Create Mapping**.
78+
7. Follow the steps in the Edit Mapping workflow and click **Save Mapping** to add your mapping.
79+
80+
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.
6781

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:
82+
You can store each consent category in its own column in your warehouse, or store your consent information in one single blob column. Segment requires your consent categories to be in their own column in your data model.
83+
84+
The following sample model maps consent categories from each column in your database:
6985

7086
``` sql
7187
select
7288
USERID,
89+
name,
90+
email,
91+
distinctid,
7392
Ads,
93+
Personalization,
94+
Analytics,
95+
96+
from CONSENT_PREFERENCES;
97+
```
98+
99+
The following sample model maps consent categories from one blob column in your database:
100+
101+
```sql
102+
select
103+
USERID,
104+
name,
105+
email,
106+
distinctid,
107+
CAST(CONSENT_OBJ:consent.cookie.Advertising as Boolean) as Ads,
74108
CAST(CONSENT_OBJ:consent.cookie.Personalization as Boolean) as Personalization,
75109
CAST(CONSENT_OBJ:consent.cookie.Analytics as Boolean) as Analytics,
76-
city,
77-
email,
78-
distinctid
110+
79111
from CONSENT_PREFERENCES;
80112
```
81113

82-
> info "Consent categories in the Segment app must match consent columns identified in your data warehouse before continuing"
83-
> 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.
114+
> warning "Failing to identify consent columns in your warehouse might lead to unintentional data loss"
115+
> If you create consent categories in the Segment app but fail to identify a column in your warehouse that stores consent for a category, then consent preference for that category will be considered to be false and **no data will flow to destinations mapped to the category**.
84116
85-
## Step 3: Connect your downstream destinations
117+
## Step 4: Connect your downstream destinations
86118

87119
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.
88120

0 commit comments

Comments
 (0)