You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/index.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -44,19 +44,6 @@ Many destinations can accept data from all types of sources, but some are only c
44
44
45
45
In June 2021, Segment released a new form of destinations called [Destinations Actions](/docs/connections/destinations/actions/). These destinations allow users to create *subscriptions*: sets of conditions in which data is sent to the destinations and data mappings, to format that data for the destination tool. Segment watches for data that matches the conditions you create (*triggers*) for the subscription, and when the conditions are met, uses an explicit mapping to transform the incoming data to an output format that your destination can use.
46
46
47
-
Some destinations offer a streamlined mapping experience, where you directly configure the sync behavior Segment uses to send data to destination rather than mapping fields from your warehouse to your destination. This offers you more granular control over the way data flows to your destination and gets data flowing into your destinations more quickly.
48
-
49
-
The following destinations support streamlined mappings:
1. Navigate to the overview page for your destination and select the Mappings tab.
54
-
2. Click **+ New Mapping**.
55
-
3. Define the behavior each sync should have by selecting a pre-built mapping or an Action, then click **Next**.
56
-
4. Define an event trigger, map required fields, and complete any optional setup steps. When you're finished configuring your mapping, click **Next**.
57
-
5. Enter a name for your mapping, then click **Save and enable**.
58
-
59
-
60
47
## Connection modes
61
48
62
49
{% include content/connection-modes-intro.md %}
@@ -120,6 +107,19 @@ The first place to look is the individual destination documentation. Each one in
120
107
121
108
In order to override the default, check the destination settings pane in the Segment web App either for a **Connection Mode** toggle or instructions on bundling any additional mobile components required.
122
109
110
+
## Sync modes
111
+
112
+
In September 2024, Segment released a new sync modes capability that allows users to define how changes in the source should be sent downstream to your destination. Depending on which destinations you set up in Segment, you may need to choose a sync mode for your data. This configuration determines how Segment updates destination based on the source data.
113
+
114
+
The available sync modes can vary based on the destination, integration type, and actions within the destination. For example, if you're syncing customer data, you might have the option to Insert, Update, or Upsert records.
115
+
116
+
Available sync modes include:
117
+
-**Update**: Modify existing records in the destination without adding new ones.
118
+
-**Insert**: Add new records without altering existing data.
119
+
-**Upsert**: Update existing records and add new ones, if necessary.
120
+
-**Add**: Add records to a list, segment, or journey.
121
+
-**Remove**: Remove records from a list, audience, or journey.
Copy file name to clipboardExpand all lines: src/connections/reverse-etl/setup.md
+16-35Lines changed: 16 additions & 35 deletions
Original file line number
Diff line number
Diff line change
@@ -91,15 +91,20 @@ To create a mapping:
91
91
2. Select the destination that you want to create a mapping for.
92
92
3. Click **Add Mapping**.
93
93
4. Select the model to sync from.
94
-
5. Select the **Action** you want to sync and click **Next**.
95
-
* Actions determine the information sent to the destination. The list of Actions will be unique to each destination.
96
-
6. Add the mapping's name. The initial name will default to the Action's name (for example, 'Track Event') but is completely customizable. It will allow you to identify the mapping amongst others.
97
-
7. In the **Select record to map and send** section, select which records to send to your destination after Segment completes extracting data based on your model. You can choose from:
98
-
* Added records
99
-
* Updated records
100
-
* Added or updated records
101
-
* Deleted records
102
-
8. Select a test record to preview the fields that you can map to your destination in the **Add test record** field.
94
+
5. In the Define sync behavior section, select the **Action** you want to sync.
95
+
* Actions determine the information sent to the destination. The list of Actions are unique to each destination.
96
+
6. Select which records to send to your destination after Segment completes extracting data based on your model.
97
+
* As of September 2024, some destinations have [sync modes](/docs/connections/destinations/#sync-modes), which let you specify how Segment should send data to the destination. Sync modes are unique to each destination.
98
+
* Destinations without sync modes let you select from the following options:
99
+
* Added records
100
+
* Updated records
101
+
* Added or updated records
102
+
* Deleted records
103
+
7. In the **Map fields** section, define how to map the record columns from your model to your destination. 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.
104
+
* If you’re setting up a Destination Action, some mapping fields might require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays) for more information.
105
+
<!---* _(Optional)_ Use the [Suggested Mappings](#suggested-mappings) feature to identify and match near-matching field names to streamline the field mapping process. -->
106
+
8. In the **Send test record section**, select a test record to preview the fields that you mapped to your destination. When you've verified that the records appear as expected, click **Next**.
107
+
9. Enter a name for your mapping. The name initially defaults to the Action's name, for example, `Track Event`, but you can make changes to this default name.
103
108
9. Select the Schedule type for the times you want the model’s data to be extracted from your warehouse. You can choose from:
104
109
***Interval**: Extractions perform based on a selected time cycle.
105
110
***Day and time**: Extractions perform at specific times on selected days of the week.
@@ -109,32 +114,8 @@ To create a mapping:
109
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.
110
115
* You can only choose to start the extraction at the top of the hour.
111
116
* Scheduling multiple extractions to start at the same time inside the same data warehouse causes extraction errors.
112
-
11. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
113
-
* 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.
114
-
* 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](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays).
115
-
12.*(Optional)* Send a test record to verify the mappings correctly send to your destination.
116
-
13. Click **Create Mapping**.
117
-
14. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**.
118
-
15. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
119
-
* 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.
120
-
121
-
To add multiple mappings from your warehouse to your destination, repeat steps 1-13 above.
122
-
123
-
Some destinations offer a streamlined mapping experience, where you directly configure the sync behavior Segment uses to send data to destination rather than mapping fields from your warehouse to your destination. This offers you more granular control over the way data flows to your destination and gets data flowing into your destinations more quickly.
124
-
125
-
The following destinations support streamlined mappings:
1. Navigate to the overview page for the destination attached to your Reverse ETL source and click **Add Mapping**.
130
-
2. Select the Reverse ETL model you would like to power your mapping and click **Next**.
131
-
3. Define the behavior each sync should have. For example, select the records you would like to sync, the way you would like to Segment to update data in your destination, and how Segment should respond when you delete a record in your warehouse.
132
-
4. Select a "key", or the unique value Segment should use to match records between your warehouse and your destination.
133
-
-_(Optional)_: Select one or more columns to sync to your downstream destination. This is not required, but can help you control the granularity of data that flows to your downstream destination.
134
-
-_(Optional)_: Send a test event downstream to verify that your records sync as expected.
135
-
7. When you're satisfied with your mappings, click **Next**.
136
-
8. On the Settings page, enter a name for your destination and set a sync schedule.
137
-
9. Click **Save and enable** to create your mapping.
117
+
118
+
To add multiple mappings from your warehouse to your destination, repeat steps 1-10 above.
0 commit comments