Skip to content

Commit dc821ff

Browse files
committed
Merge branch 'retl-docs-refresh' into automatic-retry-handling
2 parents 7b49f3d + 184c1b1 commit dc821ff

File tree

10 files changed

+93
-100
lines changed

10 files changed

+93
-100
lines changed

src/_data/sidenav/main.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -183,15 +183,13 @@ sections:
183183
- path: /connections/reverse-etl
184184
title: Reverse ETL Overview
185185
- path: /connections/reverse-etl/setup
186-
title: Set up Reverse ETL
187-
- path: /connections/reverse-etl/mappings
188-
title: Reverse ETL Mappings
189-
- path: /connections/reverse-etl/observability
190-
title: Reverse ETL Observability
186+
title: Set Up Reverse ETL
187+
- path: /connections/reverse-etl/manage-retl
188+
title: Manage Reverse ETL Syncs
191189
- path: /connections/reverse-etl/system
192190
title: Reverse ETL System
193191
- path: /connections/reverse-etl/reverse-etl-catalog
194-
title: Reverse ETL Catalog
192+
title: Reverse ETL Destination Catalog
195193
- section_title: Reverse ETL Source Setup Guides
196194
slug: connections/reverse-etl/reverse-etl-source-setup-guides
197195
section:

src/connections/reverse-etl/index.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Reverse ETL
33
beta: false
4+
hide_toc: true
45
redirect_from:
56
- '/reverse-etl/'
67
---
@@ -9,10 +10,10 @@ Reverse ETL (Extract, Transform, Load) extracts data from a data warehouse using
910

1011
Use Reverse ETL when you want to:
1112
* **Enable your marketing teams**: Sync audiences and other data built in the warehouse to Braze, Hubspot, or Salesforce Marketing Cloud for personalized marketing campaigns.
12-
* **Enrich your customer profiles**: Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Unify with data from the warehouse.
13-
* **Activate data in Twilio Engage**: Send data in the warehouse back into Segment as events that can be activated in all supported destinations, including Twilio Engage.
13+
* **Enrich your customer profiles**: Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Unify with data from your warehouse.
14+
* **Activate data in Twilio Engage**: Send data in the warehouse back into Segment as events that can be activated in all supported destinations, including Twilio Engage destinations.
1415
* **Strengthen your conversion events**: Pass offline or enriched data to conversion APIs like Facebook, Google Ads, TikTok, or Snapchat.
15-
* **Empower business teams**: Connect Google Sheets to a view in the warehouse for other business teams to have access to up-to-date reports.
16+
* **Empower business teams**: Connect Google Sheets to a view in the warehouse to create up-to-date reports for other business teams.
1617

1718
> info "Reverse ETL supports event and object data"
1819
> Event and object data includes customer profile data, subscriptions, product tables, shopping cart tables, and more.
@@ -29,50 +30,49 @@ Use Reverse ETL when you want to:
2930
%}
3031

3132
{% include components/reference-button.html
32-
href="/docs/connections/reverse-etl/reverse-etl-catalog"
33+
href="/docs/connections/reverse-etl/manage-retl"
3334
icon="reverse-etl.svg"
34-
title="Destination catalog"
35-
description="View the 30+ destinations with native Reverse ETL support and learn how you can use the Segment Connections and Segment Profiles to send data to the rest of the Segment catalog."
35+
title="Manage Reverse ETL Syncs"
36+
description="View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs."
3637
%}
3738
</div>
3839

3940
## Learn more
4041

41-
Learn more about the system that powers Reverse ETL, the mappings that power the flow of data to your downstream destinations, and observability tools you can use to manage your syncs.
42-
42+
Learn more about the system that powers Reverse ETL, supported destinations, and frequently asked questions.
4343
<div class="flex flex--wrap gutter gutter--large">
4444
<div class="flex__column flex__column--12 flex__column--4@medium">
4545
{% include components/reference-button.html
46-
href="/docs/connections/reverse-etl/observability"
47-
title="Reverse ETL Observability"
48-
description="View the state of your Reverse ETL syncs and get alerted when things go wrong."
46+
href="/docs/connections/reverse-etl/system"
47+
title="Reverse ETL System"
48+
description="Reference material about system limits and how Segment detects data changes."
4949
%}
5050
</div>
5151

5252
<div class="flex__column flex__column--12 flex__column--4@medium">
5353
{% include components/reference-button.html
54-
href="/docs/connections/reverse-etl/mappings"
55-
title="Reverse ETL Mappings"
56-
description="Supported objects and arrays along with ways to manage your syncs."
54+
href="/docs/connections/reverse-etl/reverse-etl-catalog"
55+
title="Destination catalog"
56+
description="View the 30+ destinations with native Reverse ETL support and learn how to send data to the rest of the Segment catalog using Segment Connections."
5757
%}
5858
</div>
5959

6060
<div class="flex__column flex__column--12 flex__column--4@medium">
6161
{% include components/reference-button.html
62-
href="/docs/connections/reverse-etl/system"
63-
title="Reverse ETL System"
64-
description="Reference material about system limits and how Segment detects data changes."
62+
href="/docs/connections/reverse-etl/faq"
63+
title="Reverse ETL FAQ"
64+
description="Frequently asked questions about Reverse ETL."
6565
%}
6666
</div>
6767
</div>
6868

69-
## More Segment resources
69+
## More Reverse ETL resources
7070

7171
{% include components/reference-button.html
7272
icon="guides.svg"
7373
href="https://segment.com/blog/reverse-etl/"
74-
title="What is reverse ETL? A complete guide"
75-
description="In this blog from Segment, learn how reverse ETL helps businesses activate their data to drive better decision-making and greater operational efficiency."
74+
title="What is Reverse ETL? A complete guide"
75+
description="In this blog from Segment, learn how Reverse ETL helps businesses activate their data to drive better decision-making and greater operational efficiency."
7676
%}
7777

7878
{% include components/reference-button.html

src/connections/reverse-etl/mappings.md renamed to src/connections/reverse-etl/manage-retl.md

Lines changed: 52 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,60 @@
11
---
2-
title: Reverse ETL Mappings
3-
beta: false
2+
title: Manage Reverse ETL Syncs
3+
beta: false
44
---
55

6-
Learn which mapping fields support object and array values in your mappings and how you can reset or replay your syncs.
6+
View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs.
7+
8+
## Sync history
9+
Check the status of your data extractions and see details of your syncs. Click into failed records to view additional details on the error, sample payloads to help you debug the issue, and recommended actions.
10+
11+
To check the status of your extractions:
12+
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
13+
2. Select the destination you want to view.
14+
3. Select the mapping you want to view.
15+
4. Click the sync you want to view to get details of the sync. You can view:
16+
* The status of the sync.
17+
* Details of how long it took for the sync to complete.
18+
* How many total records were extracted, as well as a breakdown of the number of records added, updated, and deleted.
19+
* The load results - how many successful records were synced as well as how many records were updated, deleted, or are new.
20+
5. If your sync failed, click the failed reason to get more details on the error and view sample payloads to help troubleshoot the issue.
21+
22+
> info "Segment automatically retries events that were extracted but failed to load"
23+
> Segment retries events for 14 days following a total or partial sync failure. Before loading the failed records on a subsequent sync, Segment checks for the latest changes in your data to ensure the data loaded into your warehouse isn't stale. If the error causing the load failure is coming from an upstream tool, you can fix the error in the upstream tool to ensure the record loads on the next sync.
24+
25+
## Reset syncs
26+
You can reset your syncs so that your data is synced from the beginning. This means that Segment resyncs your entire dataset for the model.
27+
28+
To reset a sync:
29+
1. Select the three dots next to **Sync now**.
30+
2. Select **Reset sync**.
31+
3. Select the checkbox that you understand what happens when a sync is reset.
32+
4. Click **Reset sync**.
33+
34+
## Replays
35+
You can choose to replay syncs. To replay a specific sync, contact [[email protected]](mailto:[email protected]). Keep in mind that triggering a replay resyncs all records for a given sync.
36+
37+
## Alerting
38+
You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failures and partial successes.
39+
40+
To subscribe to alerts:
41+
1. Navigate to **Settings > User Preferences**.
42+
2. Select **Reverse ETL** in the **Activity Notifications** section.
43+
3. Click the Reverse ETL sync status that you'd like to receive notifications for. You can select one or more of the following sync statuses:
44+
- **Reverse ETL sync failed**: Receive a notification when your Reverse ETL sync fails.
45+
- **Reverse ETL sync partial success**: Receive a notification when your Reverse ETL sync is partially successful.
46+
4. Select one or more of the following alert options:
47+
- **Enable email notifications**: Enter an email address or alias that should receive alerts.
48+
- **Enable Slack notifications**: Enter a Webhook URL and Slack channel name.
49+
- **Enable in-app notifications**: Select this option to see an in-app notification.
50+
5. Click **Create alert**.
51+
52+
> success ""
53+
> If you opted to receive notifications by email, you can click **View active email addresses** to see the email addresses that are currently signed up to receive notifications.
754
855
## Supported object and arrays
956

10-
When you set up destination actions in Reverse ETL, depending on the destination, some [mapping fields](/docs/connections/reverse-etl/setup/#step-4-create-mappings) may require data to be in the form of an [object](/docs/connections/reverse-etl/mapping/#object-mapping) or [array](/docs/connections/reverse-etl/mapping/#array-mapping).
57+
When you set up destination actions in Reverse ETL, depending on the destination, some [mapping fields](/docs/connections/reverse-etl/setup/#step-4-create-mappings) may require data to be in the form of an [object](/docs/connections/reverse-etl/manage-retl/#object-mapping) or [array](/docs/connections/reverse-etl/manage-retl/#array-mapping).
1158

1259
### Object mapping
1360
You can send data to a mapping field that requires object data. An example of object mapping is an `Order completed` model with a `Products` column that’s in object format.
@@ -68,16 +115,4 @@ Select array | This enables you to send all nested properties within the array.
68115
> success ""
69116
> Certain array mapping fields have a fixed list of properties they can accept. If the names of the nested properties in your array don't match the destination properties, the data won't send. Segment recommends you to use the **Customize array** option to ensure your mapping is successful.
70117
71-
Objects in an array don't need to have the same properties. If a user selects a missing property in the input object for a mapping field, the output object will miss the property.
72-
73-
## Reset syncs
74-
You can reset your syncs so that your data is synced from the beginning. This means that Segment resyncs your entire dataset for the model.
75-
76-
To reset a sync:
77-
1. Select the three dots next to **Sync now**.
78-
2. Select **Reset sync**.
79-
3. Select the checkbox that you understand what happens when a sync is reset.
80-
4. Click **Reset sync**.
81-
82-
## Replays
83-
You can choose to replay syncs. To replay a specific sync, contact [[email protected]](mailto:[email protected]). Keep in mind that triggering a replay resyncs all records for a given sync.
118+
Objects in an array don't need to have the same properties. If a user selects a missing property in the input object for a mapping field, the output object will miss the property.

src/connections/reverse-etl/observability.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

src/connections/reverse-etl/reverse-etl-catalog.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@ title: Reverse ETL Catalog
33
beta: false
44
---
55

6-
Reverse ETL supports most of the Segment destination catalog - 30+ Actions destinations are natively supported, Segment Classic destinations are supported through the [Segment Connections](#segment-connections-destination) destination, and Twilio Engage Premier Subscriptions users can use the Segment Profiles destination to sync subscription data from warehouses to destinations.
6+
Reverse ETL supports the entire Segment destination catalog - 30+ Actions destinations are natively supported and all other destinations are supported through the [Segment Connections](#segment-connections-destination) destination.
77

8-
These destinations support [Reverse ETL](/docs/connections/reverse-etl/). If you don’t see your destination listed in the Reverse ETL catalog, use the [Segment Connections destination](/docs/connections/destinations/catalog/actions-segment/) to send data from your Reverse ETL warehouse to other destinations listed in the [catalog](/docs/connections/destinations/catalog/).
8+
> success ""
9+
> Twilio Engage Premier Subscriptions users can use the [Segment Profiles](/docs/connections/destinations/catalog/actions-segment-profiles/) destination to enrich their warehouse data.
10+
11+
The following destinations natively support [Reverse ETL](/docs/connections/reverse-etl/). If you don’t see your destination listed in the Reverse ETL catalog, use the [Segment Connections destination](/docs/connections/destinations/catalog/actions-segment/) to send data from your Reverse ETL warehouse to other destinations listed in the [catalog](/docs/connections/destinations/catalog/).
912

1013
<div class="destinations-catalog">
1114
<div class="flex flex--wrap waffle waffle--xlarge">

src/connections/reverse-etl/reverse-etl-source-setup-guides/azure-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To set up Azure as your Reverse ETL source:
6161
5. Navigate to **Connections > Sources** and select the **Reverse ETL** tab.
6262
6. Click **+ Add Reverse ETL source**.
6363
7. Select **Azure** and click **Add Source**.
64-
8. Enter the configuration settings for you Azure source based on the information from Step 3.
64+
8. Enter the configuration settings for your Azure source based on the information from Step 3.
6565
* Hostname:
6666
* Use `xxxxxxx.sql.azuresynapse.net` if you’re connecting to a dedicated SQL pool in Synapse workspace.
6767
* Use `xxxxxxx.database.windows.net` if you’re connecting to a dedicated SQL pool (formerly SQL DW)

src/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To set up Postgres with Reverse ETL:
3333
GRANT CREATE ON DATABASE "<enter database name here>" TO "segment";
3434
```
3535
4. Make sure the user has correct access permissions to the database.
36-
5. Follow the steps listed in the [Add a source](/docs/connections/reverse-etl/#step-1-add-a-source) section to finish adding Postgres as a source.
36+
5. Follow the steps listed in the [Add a source](/docs/connections/reverse-etl/setup/#step-1-add-a-source) section to finish adding Postgres as a source.
3737

3838
## Extra permissions
3939
* Give the `segment` user read permissions for any resources (databases, schemas, tables) the query needs to access.

src/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To set up Redshift with Reverse ETL:
2222
-- allows the "segment" user to create new schemas on the specified database. (this is the name you chose when provisioning your cluster)
2323
GRANT CREATE ON DATABASE "<enter database name here>" TO "segment";
2424
```
25-
4. Follow the steps listed in the [Add a source](/docs/connections/reverse-etl#step-1-add-a-source) section to finish adding Redshift as your source.
25+
4. Follow the steps listed in the [Add a source](/docs/connections/reverse-etl/setup/#step-1-add-a-source) section to finish adding Redshift as your source.
2626

2727
## Extra Permissions
2828
Give the `segment` user read permissions for any resources (databases, schemas, tables) the query needs to access.

0 commit comments

Comments
 (0)