Skip to content

Commit 57712ac

Browse files
authored
Merge pull request #5509 from segmentio/DOC-739
RETL for Subscriptions
2 parents fd9eb0e + d0c547d commit 57712ac

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

src/connections/reverse-etl/index.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ There are four components to Reverse ETL: Sources, Models, Destinations, and Map
2121
![Reverse ETL overview image](images/RETL_Doc_Illustration.png)
2222

2323
Follow these 4 steps to set up Reverse ETL and learn what each component is about:
24-
1. [Add a Source](#step-1-add-a-source)
25-
2. [Add a Model](#step-2-add-a-model)
26-
3. [Add a Destination](#step-3-add-a-destination)
27-
4. [Create Mappings](#step-4-create-mappings)
24+
1. [Add a source](#step-1-add-a-source)
25+
2. [Add a model](#step-2-add-a-model)
26+
3. [Add a destination](#step-3-add-a-destination)
27+
4. [Create mappings](#step-4-create-mappings)
2828

2929
> info ""
3030
> The UI navigation and interface will look different from what's presented in the docs until Reverse ETL rolls out to all users for GA.
@@ -39,7 +39,7 @@ To add your warehouse as a source:
3939
4040
1. Navigate to **Connections > Sources** and select the **Reverse ETL** tab in the Segment app.
4141
2. Click **Add Reverse ETL source**.
42-
3. Select the source you want to add. You can choose between BigQuery, Redshift, and Snowflake.
42+
3. Select the source you want to add.
4343
4. Follow the corresponding setup guide for your Reverse ETL source.
4444
* [BigQuery Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup/)
4545
* [Databricks Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup/)
@@ -65,16 +65,9 @@ To add your first model:
6565
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.
6666
6. Click **Next**.
6767
7. Enter your **Model Name**.
68-
8. Select the Schedule type for the times you want the model’s data to be extracted from your warehouse. You can choose from:
69-
* **Interval**: Extractions perform based on a selected time cycle.
70-
* **Day and time**: Extractions perform at specific times on selected days of the week.
71-
9. Select how often you want the schedule to sync in **Schedule configuration**.
72-
* For an **Interval** schedule type, you can choose from: 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 6 hours, 8 hours, 12 hours, 1 day.
73-
* 15 minutes is considered real-time for warehouse syncs
74-
* For a **Day and time** schedule type, you can choose the day(s) you’d like the schedule to sync as well as the time. You can only choose to sync the extraction at the top of the hour.
75-
10. Click **Create Model**.
68+
8. Click **Create Model**.
7669

77-
To add multiple models to your source, repeat steps 1-10 above.
70+
To add multiple models to your source, repeat steps 1-8 above.
7871

7972
### Step 3: Add a destination
8073
Once you’ve added a model, you need to add a destination. In Reverse ETL, destinations are the business tools or apps you use that Segment syncs the data from your warehouse to.
@@ -112,12 +105,20 @@ To create a mapping:
112105
* Added or updated records
113106
* Deleted records
114107
5. Select a test record to preview the fields that you can map to your destination in the **Add test record** field.
115-
6. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
108+
6. Select the **Schedule type** for the times you want the data to be extracted from your warehouse. You can choose from:
109+
* **Interval**: Extractions perform based on a selected time cycle.
110+
* **Day and time**: Extractions perform at specific times on selected days of the week.
111+
7. Select how often you want the schedule to sync in **Schedule configuration**.
112+
* For an **Interval** schedule type, you can choose from: 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 6 hours, 8 hours, 12 hours, 1 day.
113+
* 15 minutes is considered real-time for warehouse syncs
114+
* For a **Day and time** schedule type, you can choose the day(s) you’d like the schedule to sync as well as the time. You can only choose to sync the extraction at the top of the hour.
115+
8. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
116116
* You map the fields that come from your source, to fields that the destination expects to find. Fields on the destination side depend on the type of action selected.
117117
* If you're setting up a destination action, depending on the destination, some mapping fields may require data to be in the form of an object or array. See the [supported objects and arrays for mapping](#supported-object-and-arrays).
118-
7. Click **Create Mapping**.
119-
8. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**.
120-
9. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
118+
9. *(Optional)* Send a test record to verify the mappings correctly send to your destination.
119+
9. Click **Save Mapping**.
120+
10. Select the destination you’d like to enable the mapping for under **Connections > Destinations > Reverse ETL**.
121+
11. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
121122
* If you disable the mapping state to the destination, events that match the trigger condition in the mapping won’t be sent to the destination.
122123

123124
To add multiple mappings from your warehouse to your destination, repeat steps 1-9 above.
@@ -157,6 +158,22 @@ To edit your mapping:
157158
2. Select the destination and the mapping you want to edit.
158159
3. Select the **...** three dots and click **Edit mapping**. If you want to delete your mapping, select **Delete**.
159160

161+
## Reverse ETL for Engage Premier Subscriptions
162+
[Engage Premier Subscriptions users](/docs/engage/user-subscriptions/) can use Reverse ETL to sync subscription data from warehouses to destinations.
163+
164+
To get started with using Reverse ETL for subscriptions:
165+
1. Navigate to **Engage > Audiences** and select the **Profile explorer** tab.
166+
2. Click **Manage subscription statuses** and select **Update subscription statuses**.
167+
3. Select **Sync with RETL** as the menthod to update your subscription statuses.
168+
4. Click **Configure**.
169+
5. In the Reverse ETL catalog, select the Reverse ETL source you want to use.
170+
6. Set up the source. Refer to the [add a source](#step-1-add-a-source) section for more details on how to set up the source.
171+
7. Add the **Segment Profiles** destination as your Reverse ETL destination. Refer to [add a destination](#step-3-add-a-destination) for more details to set up the destination.
172+
8. Once your destination is set, go to the **Mappings** tab of your destination and click **Add Mapping**.
173+
9. Select the model you want to use and then select **Send Subscriptions**.
174+
10. Click **Create Mapping**.
175+
11. Follow the steps in the [create mappings](#step-4-create-mappings) section to set your mappings.
176+
160177

161178
## Record diffing
162179
Reverse ETL computes the incremental changes to your data directly within your data warehouse. The Unique Identifier column is used to detect the data changes, such as new, updated, and deleted records.

0 commit comments

Comments
 (0)