Skip to content

Commit c75100a

Browse files
authored
Merge branch 'master' into actions-amplitude-more
2 parents 5293e97 + 3d3fe74 commit c75100a

File tree

9 files changed

+429
-78
lines changed

9 files changed

+429
-78
lines changed

src/_data/catalog/destinations.yml

Lines changed: 182 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PLATFORM API. DO NOT EDIT
2-
# destination data last updated 2021-06-23
2+
# destination data last updated 2021-06-29
33
items:
44
- display_name: ActiveCampaign
55
slug: activecampaign
@@ -10886,7 +10886,6 @@ items:
1088610886
page_view: true
1088710887
track: true
1088810888
components:
10889-
- type: WEB
1089010889
- type: IOS
1089110890
- type: ANDROID
1089210891
- type: CLOUD
@@ -10898,18 +10897,18 @@ items:
1089810897
browserUnbundlingPublic: false
1089910898
connection_modes:
1090010899
device:
10901-
web: true
10900+
web: false
1090210901
mobile: true
1090310902
server: false
1090410903
cloud:
1090510904
web: true
1090610905
mobile: true
1090710906
server: true
1090810907
summary: >-
10909-
accepts cloud-mode data from all Segment source types. It can accept
10910-
device-mode data from both web and mobile sources.
10911-
cmode_type: all
10912-
case: '4'
10908+
accepts data in cloud-mode from all source types, and can accept data in
10909+
device-mode from mobile sources.
10910+
cmode_type: mixed
10911+
case: '9'
1091310912
settings:
1091410913
- name: mappedTopics
1091510914
display_name: Mapped Topics
@@ -18964,6 +18963,107 @@ items:
1896418963
regexp: ''
1896518964
description: Your Ramen organization id
1896618965
settings: []
18966+
- display_name: Recombee AI
18967+
slug: recombee-ai
18968+
name: catalog/destinations/recombee-ai
18969+
url: connections/destinations/catalog/recombee-ai
18970+
description: >-
18971+
Recombee is a Recommender as a Service that leverages real-time data to
18972+
provide the most accurate content and product recommendations for each user.
18973+
hidden: false
18974+
status: PUBLIC_BETA
18975+
previous_names:
18976+
- Recombee AI
18977+
logo:
18978+
url: >-
18979+
https://public-segment-devcenter-production.s3.amazonaws.com/a773a9ce-742b-440f-b7ba-304897735b8c.svg
18980+
mark:
18981+
url: >-
18982+
https://public-segment-devcenter-production.s3.amazonaws.com/74d56e01-9773-422b-b0cb-bf9233f1dfb3.svg
18983+
categories:
18984+
- Customer Success
18985+
- Email Marketing
18986+
- Marketing Automation
18987+
methods:
18988+
alias: true
18989+
group: false
18990+
identify: false
18991+
page_view: true
18992+
track: true
18993+
components: []
18994+
platforms:
18995+
browser: true
18996+
server: true
18997+
mobile: true
18998+
browserUnbundlingSupported: false
18999+
browserUnbundlingPublic: false
19000+
connection_modes:
19001+
device:
19002+
web: false
19003+
mobile: false
19004+
server: false
19005+
cloud:
19006+
web: false
19007+
mobile: false
19008+
server: false
19009+
summary: No connection mode information available.
19010+
cmode_type: none
19011+
case: '0'
19012+
settings:
19013+
- name: apiKey
19014+
display_name: API Key
19015+
type: STRING
19016+
deprecated: false
19017+
required: true
19018+
string_validators:
19019+
regexp: '^.{8,}$'
19020+
description: >-
19021+
Private token of the Recombee Database. Find it in the Settings section of
19022+
the Recombee Admin UI.
19023+
settings: []
19024+
- name: apiUri
19025+
display_name: API URI
19026+
type: STRING
19027+
deprecated: false
19028+
required: false
19029+
string_validators:
19030+
regexp: ''
19031+
description: >-
19032+
Specify the URI of the Recombee API that should be used. This is needed if
19033+
you are calling the Recombee cluster based in a specific region or you
19034+
were assigned a custom URI by the Recombee Support team. Otherwise, keep
19035+
this value unset.
19036+
settings: []
19037+
- name: databaseId
19038+
display_name: Database ID
19039+
type: STRING
19040+
deprecated: false
19041+
required: true
19042+
string_validators:
19043+
regexp: ''
19044+
description: ID of the Recombee Database into which the interactions will be sent.
19045+
settings: []
19046+
- name: itemIdPropertyName
19047+
display_name: Item ID Property Name
19048+
type: STRING
19049+
deprecated: false
19050+
required: false
19051+
string_validators:
19052+
regexp: ''
19053+
description: >-
19054+
Specify the name of the Segment event property from which the itemId will
19055+
be read.
19056+
settings: []
19057+
- name: trackEventsMapping
19058+
display_name: Track Events Mapping
19059+
type: MAP
19060+
deprecated: false
19061+
required: false
19062+
description: >-
19063+
Set which Recombee interactions will be sent on your custom Track events.
19064+
The value of the mapping is the name of your event, and the key is name of
19065+
the Recombee interaction (e.g. Bookmark).
19066+
settings: []
1896719067
- display_name: Refersion
1896819068
slug: refersion
1896919069
name: catalog/destinations/refersion
@@ -19269,13 +19369,6 @@ items:
1926919369
required: false
1927019370
description: Map your Segment properties to Responsys Columns
1927119371
settings:
19272-
- name: primaryKey
19273-
display_name: Set as Primary Key
19274-
type: BOOLEAN
19275-
deprecated: false
19276-
required: false
19277-
description: Mark this property as a Primary Key in Responsys.
19278-
settings: []
1927919372
- name: columns
1928019373
display_name: Segment Property Name
1928119374
type: STRING
@@ -19311,6 +19404,13 @@ items:
1931119404
- TIMESTAMP
1931219405
description: Enter the Responsys column type.
1931319406
settings: []
19407+
- name: primaryKey
19408+
display_name: Set as Primary Key
19409+
type: BOOLEAN
19410+
deprecated: false
19411+
required: false
19412+
description: Mark this property as a Primary Key in Responsys.
19413+
settings: []
1931419414
- name: mapEmail
1931519415
display_name: Map Email
1931619416
type: BOOLEAN
@@ -24953,6 +25053,74 @@ items:
2495325053
You can retrieve your API Key from your [Userpilot
2495425054
dashboard](https://app.userpilot.com/settings/setup).
2495525055
settings: []
25056+
- display_name: Variance
25057+
slug: variance
25058+
name: catalog/destinations/variance
25059+
url: connections/destinations/catalog/variance
25060+
description: Variance lets everyone in your company help drive growth.
25061+
hidden: false
25062+
status: PUBLIC_BETA
25063+
previous_names:
25064+
- Variance
25065+
logo:
25066+
url: >-
25067+
https://public-segment-devcenter-production.s3.amazonaws.com/86488d36-ec21-4938-a8b4-f362abc5c591.svg
25068+
mark:
25069+
url: >-
25070+
https://public-segment-devcenter-production.s3.amazonaws.com/58983f68-29cc-49bc-a25d-66ed8f748c85.svg
25071+
categories:
25072+
- CRM
25073+
- Marketing Automation
25074+
- Performance Monitoring
25075+
- Personalization
25076+
methods:
25077+
alias: true
25078+
group: true
25079+
identify: true
25080+
page_view: true
25081+
track: true
25082+
components: []
25083+
platforms:
25084+
browser: true
25085+
server: true
25086+
mobile: true
25087+
browserUnbundlingSupported: false
25088+
browserUnbundlingPublic: false
25089+
connection_modes:
25090+
device:
25091+
web: false
25092+
mobile: false
25093+
server: false
25094+
cloud:
25095+
web: false
25096+
mobile: false
25097+
server: false
25098+
summary: No connection mode information available.
25099+
cmode_type: none
25100+
case: '0'
25101+
settings:
25102+
- name: apiKey
25103+
display_name: API Key
25104+
type: STRING
25105+
deprecated: false
25106+
required: true
25107+
string_validators:
25108+
regexp: '^.{8,}$'
25109+
description: >-
25110+
Secret key from Variance. Found in the Integrations section under
25111+
connection settings.
25112+
settings: []
25113+
- name: webhookUrl
25114+
display_name: Webhook URL
25115+
type: STRING
25116+
deprecated: false
25117+
required: true
25118+
string_validators:
25119+
regexp: ''
25120+
description: >-
25121+
Webhook URL from Variance. Found in the Integrations section under
25122+
connection settings.
25123+
settings: []
2495625124
- display_name: Vero
2495725125
slug: vero
2495825126
name: catalog/destinations/vero

src/_data/products.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,11 @@ items:
114114
team: false
115115
business: true
116116
add-on: true
117+
- product_display_name: Data Residency
118+
slug: data-residency
119+
plan-note: "Data residency is available to customers on the Business Tier plan."
120+
plans:
121+
free: false
122+
team: false
123+
business: true
124+
add-on: false

src/connections/data-residency.md

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,22 @@
11
---
22
title: Data Residency
3-
beta: true
43
---
4+
{% include content/plan-grid.md name="data-residency" %}
55

6-
> info ""
7-
> **Note**: Data residency is in public beta, and its use is governed by the [(1) Segment First Access and Beta Terms and Conditions](https://segment.com/legal/first-access-beta-preview/) and [(2) Segment Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/).
8-
9-
10-
Segment offers customers the option to lead on data residency by providing regional infrastructure across Europe, Middle East, Africa and Asia Pacific. The default region for all customers is in Oregon, United States. The regional infrastructure has the same [rate limits and SLA](/docs/connections/rate-limits/) as the default region.
116

12-
## Enable Local Data Ingest and Storage
137

14-
This feature is in Public Preview. You can enable Local Data Ingest and Storage from the Regional Settings tab within your Workspace settings. Enabling the feature here makes the feature available to both client-side and server-side sources.
158

16-
![enable](images/enable-regional-ingest.png)
9+
Segment offers customers the option to lead on data residency by providing regional infrastructure across Europe, Middle East, Africa and Asia Pacific. The default region for all customers is in Oregon, United States. The regional infrastructure has the same [rate limits and SLA](/docs/connections/rate-limits/) as the default region.
1710

18-
## Local Data Ingest
11+
## Regional Data Ingestion
1912

20-
Local Data Ingest enables you to send data to Segment from both Client-side and Server-side sources through locally hosted API ingest points. The regional infrastructure can fail-over across locations within a region, but never across regions.
13+
Regional Data Ingestion enables you to send data to Segment from both Device-mode and Cloud-mode sources through regionally hosted API ingest points. The regional infrastructure can fail-over across locations within a region, but never across regions.
2114

2215
### Client-side sources
2316

24-
You can configure Segment's client-side SDKs for Javascript, iOS, Android, and React Native sources to send data to a regional host after you've updated the Ingest Region in that source's settings.
17+
You can configure Segment's client-side SDKs for Javascript, iOS, Android, and React Native sources to send data to a regional host after you've updated the Data Ingestion Region in that source's settings.
2518

26-
![ingest region](images/regional-ingest.png)
19+
![ingestion region](images/regional-ingest.png)
2720

2821
All regions are configured on a **per-source** basis. You'll need to configure the region for each source separately if you do not want to use the default region (Oregon). All Segment client-side SDKs read this setting and update themselves automatically to send data to new endpoints when the app is reloaded. You do not need to change code when you switch regions.
2922

@@ -36,16 +29,21 @@ When you send data from a server-side or project source, you can use the `host`
3629
3. Singapore — `in.ap1.segmentapis.com/v1`
3730
4. Sydney — `in.au1.segmentapis.com/v1`
3831

39-
## Local Data Storage
32+
## Regional Data Storage
4033

41-
Local Data Storage allows you to preserve your raw events in Amazon S3 buckets hosted regionally. These buckets are hosted by you, in your desired region.
34+
Regional Data Storage allows you to preserve your raw events in Amazon S3 buckets hosted regionally. These buckets are hosted by you, in your desired region.
4235

4336
> note ""
44-
> Configure Local Data Storage on new sources instead of enabling on an existing source to avoid deletion of historical data and a change in retention policy. Historical data that is expired due to a retention policy cannot be replayed at a time in the future. Historical data cannot be migrated from the US to your regional buckets.
37+
> Configure Regional Data Storage on new sources instead of enabling on an existing source to avoid deletion of historical data and a change in retention policy. Historical data that is expired due to a retention policy cannot be replayed at a time in the future. Historical data cannot be migrated from the US to your regional buckets.
38+
39+
You can enable Regional Data Storage from the Regional Settings tab within your Workspace settings. Enabling the feature here makes the feature available to both client-side and server-side sources.
40+
41+
> info ""
42+
> **Note**: Regional Data Storage is a Beta feature, and its use is governed by the [(1) Segment First Access and Beta Terms and Conditions](https://segment.com/legal/first-access-beta-preview/){:target="_blank"} and [(2) Segment Acceptable Use Policy](https://segment.com/legal/acceptable-use-policy/){:target="_blank"}.
4543
4644
### Pre-requisites
4745

48-
To begin with Local Data Storage, complete the following steps in your AWS account:
46+
To begin with Regional Data Storage, complete the following steps in your AWS account:
4947

5048
1. Create an S3 bucket in your preferred region
5149
2. Create a folder named `segment-logs` in the new bucket
@@ -142,13 +140,13 @@ To begin with Local Data Storage, complete the following steps in your AWS accou
142140
}
143141
```
144142

145-
### Local Data Storage configuration
143+
### Regional Data Storage configuration
146144

147-
After you configure the policy and roles, as defined above, navigate to the Regional Settings tab of the Settings page of the source for which you want to store data regionally, and find the Local Data Storage section.
145+
After you configure the policy and roles, as defined above, navigate to the Regional Settings tab of the Settings page of the source for which you want to store data regionally, and find the Regional Data Storage section.
148146

149147
![local storage](images/regional-data-source.png)
150148

151-
To complete the configuration of Local Data Storage:
149+
To complete the configuration of Regional Data Storage:
152150

153151
1. Enter the name of the S3 Bucket you created in the Pre-requisites section
154152
2. Add a regional label to help locate the bucket from AWS at a later date. For example, `us-west2-294048959147` or `country-REGION-AWS_ACCOUNT`
@@ -158,24 +156,24 @@ To complete the configuration of Local Data Storage:
158156
6. Identify the Source in the source-level archive retention periods list
159157
7. Set the Retention for this source to the suggested value of `7 days`* and click **Save**
160158

161-
The Local Data Storage bucket will take roughly one hour to receive data.
159+
The Regional Data Storage bucket will take around one hour to receive data.
162160

163-
* The data retention can be set to any value available in the portal. If you require less than 7 days of data stored in the Segment-owned Archives, please reach out to support.
161+
\* The data retention can be set to any value available in the portal. If you require less than 7 days of data stored in the Segment-owned Archives, please contact [Segment Support](https://segment.com/help/contact){:target="_blank"}.
164162

165-
### Deletion from Local Data Storage
163+
### Deletion from Regional Data Storage
166164

167-
Local Data Storage offers the same ability to delete end-user data when they revoke or alter their consent to have data collected, as long as they can be identified by a `userId`. For example, if an end-user invokes their Right to Object or Right to Erasure under the GDPR or CCPA, you can use these features to:
165+
Regional Data Storage offers the same ability to delete end-user data when they revoke or alter their consent to have data collected, as long as they can be identified by a `userId`. For example, if an end-user invokes their Right to Object or Right to Erasure under the GDPR or CCPA, you can use these features to:
168166
- block ongoing data collection for that user
169167
- delete all historical data about them from Segment's systems, connected S3 buckets and warehouses, and supported downstream partners
170168

171-
Contact [Segment Support](https://segment.com/help/contact/) to initiate a deletion and provide a valid `userId` for each user to be deleted. Deletion requests are run within the region, and have a 30 day SLA, but requires that the raw data is accessible to Segment in an unaltered state. Deletion from Local Data Storage is not available from the [Privacy Portal](/docs/privacy/user-deletion-and-suppression/#deletion-requests) or through the API.
169+
Contact [Segment Support](https://segment.com/help/contact/){:target="_blank"} to initiate a deletion and provide a valid `userId` for each user to be deleted. Deletion requests are run within the region, and have a 30 day SLA, but requires that the raw data is accessible to Segment in an unaltered state. Deletion from Regional Data Storage is not available from the [Privacy Portal](/docs/privacy/user-deletion-and-suppression/#deletion-requests) or through the API.
172170

173171
> note "Business Plan Customers"
174172
> If you use this feature to delete data, you cannot Replay the deleted data at the same time. For standard Replay requests, you must wait for any pending deletions to complete. You cannot submit new deletions requests for the period of time that Segment replays data for you.
175173
176-
### Replays from Local Data Storage
174+
### Replays from Regional Data Storage
177175

178-
Local Data Storage supports [Replays](/docs/guides/what-is-replay/#replays-for-tooling-changes) to both existing and new tools. To request a Replay, [contact Segment](https://segment.com/help/contact/) with the following:
176+
Regional Data Storage supports [Replays](/docs/guides/what-is-replay/#replays-for-tooling-changes) to both existing and new tools. To request a Replay, [contact Segment](https://segment.com/help/contact/){:target="_blank"} with the following:
179177
- Source ID
180178
- Date Range
181179
- Destination
@@ -184,4 +182,4 @@ Segment will initiate Replay jobs and update status as they progress.
184182

185183
### Debugging and support
186184

187-
The Segment Customer Success and Support Engineering teams do not have access to customer hosted regional buckets used for Local Data Storage and cannot provide event level debug support.
185+
The Segment Customer Success and Support Engineering teams do not have access to customer hosted regional buckets used for Regional Data Storage and cannot provide event level debug support.
228 KB
Loading

0 commit comments

Comments
 (0)