Skip to content

Commit

Permalink
Merge pull request #7015 from segmentio/retl-2.0-feedback
Browse files Browse the repository at this point in the history
Reverse ETL 2.0 feedback
  • Loading branch information
forstisabella authored Sep 10, 2024
2 parents f03ac9b + a40b5d7 commit aaff16b
Show file tree
Hide file tree
Showing 7 changed files with 110 additions and 153 deletions.
52 changes: 0 additions & 52 deletions src/connections/destinations/catalog/actions-sprig-web/index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: StackAdapt Destination
hide-boilerplate: true
hide-dossier: true
id: 61d8859be4f795335d5c677c
hidden: true
redirect_from: '/connections/destinations/catalog/actions-stackadapt/'
---

Expand Down
16 changes: 8 additions & 8 deletions src/connections/reverse-etl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ redirect_from:
- '/reverse-etl/'
---

Reverse ETL (Extract, Transform, Load) extracts data from a data warehouse using a query you provide and syncs the data to your third party destinations.
Reverse ETL (Extract, Transform, Load) extracts data from a warehouse using a query you provide and syncs this warehouse data to your third party destinations.

Use Reverse ETL when you want to:
* **Enable your marketing teams**: Sync audiences and other data built in the warehouse to Braze, Hubspot, or Salesforce Marketing Cloud for personalized marketing campaigns.
* **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.
* **Elevate marketing campaigns**: Sync audiences and other data built in the warehouse to multi-channel marketing tools, like Braze, Hubspot, or Salesforce Marketing Cloud, to personalize marketing campaigns.
* **Enrich your customer profiles**: Sync enriched data to destinations like Mixpanel for a more complete view of the customer, or enrich Segment Profiles with data from your warehouse.
* **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.
* **Strengthen your conversion events**: Pass offline or enriched data to conversion APIs like Facebook, Google Ads, TikTok, or Snapchat.
* **Empower business teams**: Connect Google Sheets to a view in the warehouse to create up-to-date reports for other business teams.
* **Make warehouse data accessible to business teams**: Connect destinations like Google Sheets to a view in the warehouse to allow business teams to access up-to-date reports.

> info "Reverse ETL supports event and object data"
> Event and object data includes customer profile data, subscriptions, product tables, shopping cart tables, and more.
Expand All @@ -26,14 +26,14 @@ Use Reverse ETL when you want to:
href="/docs/connections/reverse-etl/setup"
icon="getting-started.svg"
title="Set up Reverse ETL"
description="Add a Reverse ETL source, set up a model, add a destination, and create mappings to transfer data from your warehouse to your downstream destinations."
description="Set up the infrastructure you need to sync data from your warehouse to your downstream destinations."
%}

{% include components/reference-button.html
href="/docs/connections/reverse-etl/manage-retl"
icon="reverse-etl.svg"
title="Manage Reverse ETL Syncs"
description="View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs."
description="View your sync history, reset your syncs, or subscribe to alerts."
%}
</div>

Expand All @@ -53,7 +53,7 @@ Learn more about the system that powers Reverse ETL, supported destinations, and
{% include components/reference-button.html
href="/docs/connections/reverse-etl/reverse-etl-catalog"
title="Destination catalog"
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."
description="View the destinations you can connect to your Reverse ETL sources."
%}
</div>

Expand All @@ -79,6 +79,6 @@ Learn more about the system that powers Reverse ETL, supported destinations, and
icon="projects.svg"
href="https://segment.com/customers/mongodb/"
title="Customer story: MongoDB"
description="Learn how MongoDB used Reverse ETL to connect the work of analytics teams to downstream marketing and sales tools to deliver just-in-time communicates that increased customer satisfaction and engagement."
description="Learn how MongoDB used Reverse ETL to connect the work of analytics teams to downstream marketing and sales tools to deliver just-in-time communications that increased customer satisfaction and engagement."
%}

92 changes: 8 additions & 84 deletions src/connections/reverse-etl/manage-retl.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,19 @@ title: Manage Reverse ETL Syncs
beta: false
---

View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs.
View your sync history, reset your syncs, or subscribe to alerts.

## Sync overview
On the Reverse ETL sync overview tab for your destination, you can see information about your recent Reverse ETL syncs at a glance, search for recent syncs, and quickly access the mappings and models that power Reverse ETL.
The Reverse ETL sync overview tab, located under **Connections > Destinations**, gives you an overview of your latest Reverse ETL syncs.

![A screenshot of the sync overview page, which includes one failed sync and three successful syncs.](images/sync-overview.png)

You can view the following information about each sync:
- **Latest sync**: The progress of your latest sync: syncs can either be **In progress**, **Successful**, or **Failed**. Also included is the timestamp of the sync start time.
- **Mapping**: The named mapping that powered the sync and a hyperlink to the mapping's overview page.
- **Model**: The name that you gave the SQL query used to withdraw information from your warehouse, with a hyperlink to the model overview page. Below the model name, you can see the warehouse source that Segment extracts information from.
- **Action**: The Action that your destination uses to map information from your warehouse to your downstream destination.
- **Mapping status**: The status of your mapping: either **Enabled** or **Disabled**.

You can also filter the sync overview table to return only the syncs that match your criteria.

You can filter for the following sync attributes:
- **Sync status**: The status of your sync: In progress, Successful, Partially successful, or Failed.
- **Start time**: Select a predefined time period, or create a custom date range.
- **Model**: The model connected to your sync.
- **Destination**: Select one or more of your connected destinations.
- **Mapping status**: The status of your mapping: either **Enabled** or **Disabled**.
- **Latest sync**: The status of your latest sync. Syncs can either be **In progress**, **Successful**, or **Failed**.
- **Mapping**: The named mapping.
- **Model**: The model that extracts data from your warehouse.
- **Action**: The action that your destination uses to map information from your warehouse to your downstream destination.
- **Mapping status**: The status of your mapping - either **Enabled** or **Disabled**.

## Sync history
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.
Expand All @@ -44,7 +35,7 @@ To check the status of your extractions:
> 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. --->

## Reset syncs
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. During the next sync, all records extracted by the model are sent to your destination, not just the records that changed since the last sync.
Reverse ETL uses the Unique Identifier column to detect data changes, like new, updated, and deleted records. If you encounter an error, you can reset Segment’s tracking of this column and force Segment to manually add all records from your dataset.

To reset a sync:
1. Select the three dots next to **Sync now**.
Expand Down Expand Up @@ -72,70 +63,3 @@ To subscribe to alerts:

> success ""
> 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.
## Supported object and arrays

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 as an [object](/docs/connections/reverse-etl/manage-retl/#object-mapping) or [array](/docs/connections/reverse-etl/manage-retl/#array-mapping).

### Object mapping
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.

Example:

```json
{
"product": {
"id": 0001,
"color": "pink",
"name": "tshirt",
"revenue": 20,
"inventory": 500
}
}
```

To send data to a mapping field that requires object data, you can choose between these two options:

Option | Details
------ | --------
Customize object | This enables you to manually set up the mapping fields with any data from the model. If the model contains some object data, you can select properties within the object to set up the mappings as well.
Select object | This enables you to send all nested properties within an object. The model needs to provide data in the format of the object.

> success ""
> Certain object mapping fields have a fixed list of properties they can accept. If the names of the nested properties in your object don't match with the destination properties, the data won't send. Segment recommends you to use **Customize Object** to ensure your mapping is successful.

### Array mapping
To send data to a mapping field that requires array data, the model must provide data in the format of an array of objects. An example is an `Order completed` model with a `Product purchased` column that’s in an array format.

Example:

```json
[
{
"currency": "USD",
"price": 40,
"productName": "jacket",
"purchaseTime": "2021-12-17 23:43:47.102",
"quantity": 1
},
{
"currency": "USD",
"price": 5,
"productName": "socks",
"quantity": 2
}
]
```

To send data to a mapping field that requires array data, you can choose between these two options:

Option | Details
------ | --------
Customize array | This enables you to select the specific nested properties to send to the destination.
Select array | This enables you to send all nested properties within the array.

> success ""
> 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.
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.
2 changes: 1 addition & 1 deletion src/connections/reverse-etl/reverse-etl-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Reverse ETL Catalog
beta: false
---

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.
Reverse ETL supports the Actions destinations listed in this catalog. Most destinations not listed here are supported through the [Segment Connections](#segment-connections-destination) destination.

> success ""
> Twilio Engage Premier Subscriptions users can use the [Segment Profiles](/docs/connections/destinations/catalog/actions-segment-profiles/) destination to enrich their warehouse data.
Expand Down
Loading

0 comments on commit aaff16b

Please sign in to comment.