Skip to content

Revert Identity Admin role #4636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions src/connections/reverse-etl/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Reverse ETL
beta: false
redirect_from:
redirect_from:
- '/reverse-etl/'
---

Expand All @@ -10,7 +10,7 @@ Reverse ETL (Extract, Transform, Load) extracts data from a data warehouse using
## Example use cases
Use Reverse ETL when you want to:
* Sync audiences and other data built in the warehouse to Braze, Hubspot, or Salesforce Marketing Cloud for personalized marketing campaigns.
* Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Profiles with data from the warehouse.
* Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Unify with data from the warehouse.
* Send data in the warehouse back into Segment as events that can be activated in all supported destinations, including Twilio Engage and other platforms.
* Pass offline or enriched data to conversion APIs like Facebook, Google Ads, TikTok, or Snapchat.
* Connect Google Sheets to a view in the warehouse for other business teams to have access to up-to-date reports.
Expand All @@ -27,7 +27,7 @@ Follow these 4 steps to set up Reverse ETL and learn what each component is abou
4. [Create Mappings](#step-4-create-mappings)

> info ""
> 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.
> 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.

### Step 1: Add a source
A source is where your data originates from. Traditionally in Segment, a [source](/docs/connections/sources/#what-is-a-source) is a website, server library, mobile SDK, or cloud application which can send data into Segment. In Reverse ETL, your data warehouse is the source.
Expand All @@ -40,7 +40,7 @@ To add your warehouse as a source:
1. Navigate to **Connections > Sources** and select the **Reverse ETL** tab in the Segment app.
2. Click **Add Reverse ETL source**.
3. Select the source you want to add. You can choose between BigQuery, Redshift, and Snowflake.
4. Follow the corresponding setup guide for your Reverse ETL source.
4. Follow the corresponding setup guide for your Reverse ETL source.
* [BigQuery Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup/)
* [Redshift Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/redshift-setup/)
* [Snowflake Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/snowflake-setup/)
Expand Down Expand Up @@ -85,7 +85,7 @@ If your destination is not listed in the Reverse ETL catalog, use the [Segment C
To add your first destination:
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
2. Click **Add Reverse ETL destination**.
3. Select the destination you want to connect to and click **Configure**.
3. Select the destination you want to connect to and click **Configure**.
4. Select the Reverse ETL source you want to connect the destination to.
5. Enter the **Destination name** and click **Create Destination**.
6. Enter the required information on the **Settings** tab of the destination.
Expand All @@ -95,7 +95,7 @@ To add your first destination:
After you’ve added a destination, you can create mappings from your warehouse to the destination. Mappings enable you to map the data you extract from your warehouse to the fields in your destination.

To create a mapping:
1. Navigate to **Conections > Destinations** and select the **Reverse ETL** tab.
1. Navigate to **Conections > Destinations** and select the **Reverse ETL** tab.
2. Select the destination that you want to create a mapping for.
3. Click **Add Mapping**.
2. Select the model to sync from.
Expand Down Expand Up @@ -123,15 +123,15 @@ After you've followed [all four steps](/docs/connections/reverse-etl/#getting-st
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.

To check the status of your extractions:
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
2. Select the destination you want to view.
3. Select the mapping you want to view.
4. Click the sync you want to view to get details of the sync. You can view:
* The status of the sync.
* Details of how long it took for the sync to complete.
* How many total records were extracted, as well as a breakdown of the number of records added, updated, and deleted.
* How many total records were extracted, as well as a breakdown of the number of records added, updated, and deleted.
* The load results - how many successful records were synced as well as how many records were updated, deleted, or are new.
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.
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.


### Edit your model
Expand All @@ -151,12 +151,12 @@ To edit your mapping:


## Record diffing
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.
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.

In order for Segment to compute the data changes within your warehouse, Segment needs to have both read and write permissions to the warehouse schema table. At a high level, the extract process requires read permissions for the query being executed. Segment keeps track of changes to the query results through tables that Segment manages in a dedicated schema (for example, `_segment_reverse_etl`), which requires some write permissions.
In order for Segment to compute the data changes within your warehouse, Segment needs to have both read and write permissions to the warehouse schema table. At a high level, the extract process requires read permissions for the query being executed. Segment keeps track of changes to the query results through tables that Segment manages in a dedicated schema (for example, `_segment_reverse_etl`), which requires some write permissions.

> warning ""
> There may be cost implications to having Segment query your warehouse tables.
> There may be cost implications to having Segment query your warehouse tables.

## Segment Connections destination
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/).
Expand All @@ -167,22 +167,22 @@ The Segment Connections destination enables you to mold data extracted from your
> The Segment Connections destination sends data to Segment’s Tracking API, which has cost implications. New users count as new MTUs and each call counts as an API call. For information on how Segment calculates MTUs and API calls, please see [MTUs, Throughput and Billing](/docs/guides/usage-and-billing/mtus-and-throughput/).

## Limits
To provide consistent performance and reliability at scale, Segment enforces default use and rate limits for Reverse ETL.
To provide consistent performance and reliability at scale, Segment enforces default use and rate limits for Reverse ETL.

### Usage limits
Reverse ETL usage limits are measured based on the number of records processed to each destination – this includes both successful and failed records. For example, if you processed 50k records to Braze and 50k records to Mixpanel, then your total Reverse ETL usage is 100k records.
Reverse ETL usage limits are measured based on the number of records processed to each destination – this includes both successful and failed records. For example, if you processed 50k records to Braze and 50k records to Mixpanel, then your total Reverse ETL usage is 100k records.

Processed records represents the number of records Segment attempts to send to each destination. Keep in mind that not all processed records are successfully delivered, for example, such as when the destination experiences an issue.
Processed records represents the number of records Segment attempts to send to each destination. Keep in mind that not all processed records are successfully delivered, for example, such as when the destination experiences an issue.

Your plan determines how many Reverse ETL records you can process in one monthly billing cycle. When your limit is reached before the end of your billing period, your syncs will pause and then resume on your next billing cycle. To see how many records you’ve processed using Reverse ETL, navigate to **Settings > Usage & billing** and select the **Reverse ETL** tab.
Your plan determines how many Reverse ETL records you can process in one monthly billing cycle. When your limit is reached before the end of your billing period, your syncs will pause and then resume on your next billing cycle. To see how many records you’ve processed using Reverse ETL, navigate to **Settings > Usage & billing** and select the **Reverse ETL** tab.

Plan | Number of Reverse ETL records you can process to destinations per month | How to increase your number of Reverse ETL records
---- | --------------------------------------------------------------------------- | ---------------------------------------------------
Free | 500K | Upgrade to the Teams plan in the Segment app by navigating to **Settings > Usage & billing**.
Teams | 1 million | Contact your sales representative to upgrade your plan to Business.
Business | 50 x the number of [MTUs](/docs/guides/usage-and-billing/mtus-and-throughput/#what-is-an-mtu) <br>or .25 x the number of monthly API calls | Contact your sales rep to upgrade your plan.
Teams | 1 million | Contact your sales representative to upgrade your plan to Business.
Business | 50 x the number of [MTUs](/docs/guides/usage-and-billing/mtus-and-throughput/#what-is-an-mtu) <br>or .25 x the number of monthly API calls | Contact your sales rep to upgrade your plan.

If you have a non-standard or high volume usage plan, you may have unique Reverse ETL limits or custom pricing.
If you have a non-standard or high volume usage plan, you may have unique Reverse ETL limits or custom pricing.

### Configuration limits

Expand All @@ -194,7 +194,7 @@ Model timestamp column name length | The maximum length for the timestamp column
Sync frequency | The shortest possible duration Segment allows between syncs. | 15 minutes

### Extract limits
The extract phase is the time spent connecting to your database, executing the model query, updating internal state tables and staging the extracted records for loading.
The extract phase is the time spent connecting to your database, executing the model query, updating internal state tables and staging the extracted records for loading.

Name | Details | Limit
----- | ------- | ------
Expand Down
2 changes: 1 addition & 1 deletion src/engage/audiences/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can also specify two different types of time-windows, `within` and `in betwe

### Custom Traits

You can also build Audiences based on custom traits. These traits can be collected from your apps when a user completes a form or signs up using an [Identify](/docs/connections/spec/identify) call. You can view these traits in the user explorer, as well.
You can also build Audiences based on custom traits. These traits can be collected from your apps when a user completes a form or signs up using an [Identify](/docs/connections/spec/identify) call. You can view these traits in the Profile explorer, as well.

### Computed Traits

Expand Down
2 changes: 1 addition & 1 deletion src/engage/journeys/faq-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Follow these best practices to test your journeys:
- While in the process of configuring a journey, use dev Spaces to model that journey without affecting production data.
- Connect a data warehouse to each step of the journey to test for success or failure of that step.
- For early version journeys, scaffold Send to Destination steps without connecting to your production advertising or messaging destinations.
- Verify individual users' progress through the Journey in the Profiles Explorer view.
- Verify individual users' progress through the Journey in the Profile explorer view.

## Frequently asked questions

Expand Down
2 changes: 1 addition & 1 deletion src/engage/journeys/journeys-logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Yes. To allow users to re-enter Journeys that they've exited, [enable re-entry](

### What happens to traits and audiences when I delete a Journey?

Deleting a Journey removes its underlying audiences from profile views in the Profiles Explorer. However, the Journey's True/False traits remain in the user's last recorded state.
Deleting a Journey removes its underlying audiences from profile views in the Profile explorer. However, the Journey's True/False traits remain in the user's last recorded state.

> info "Note"
> Cloning a Journey generates new, unique traits and sync keys. Deleting the original Journey won't impact any cloned Journeys.
Expand Down
8 changes: 4 additions & 4 deletions src/engage/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To configure and use Engage, you need the following:

1. **A Segment account and Workspace.**
2. **Events flowing into Connections** from your digital properties where most of your valuable user behavior occurs.
3. **Profiles identity admin access.** You must have edit access to identity resolution rules.
3. **Profiles Identity Admin access.** You must have edit access to identity resolution rules.
4. **Engage Administrator access.** You must be either be a workspace admin, or a workspace user with Engage admin access to set up audiences and computed traits. You can check your permissions by navigating to [Access Management](https://app.segment.com/goto-my-workspace/settings/access-management){:target="_blank"} in your workspace settings. See the [Segment Access Management documentation](/docs/segment-app/iam/) for more details.

## Step 1: Create a new Developer space
Expand Down Expand Up @@ -46,13 +46,13 @@ To learn more, visit [Connect production sources](/docs/unify/quickstart/#step-3

## Step 4: Check your profile data

Once the replay finishes, you can see the data replayed into Engage using the Profile Explorer. Visit the [Unify Onboarding Guide](/docs/unify/quickstart/#step-4-check-your-profile-data) for more info.
Once the replay finishes, you can see the data replayed into Engage using the Profile explorer. Visit the [Unify Onboarding Guide](/docs/unify/quickstart/#step-4-check-your-profile-data) for more info.

## Step 5: Create an Audience

You can build an audience using any source data that flows into your Engage space.
You can build an audience using any source data that flows into your Engage space.

In this step, use the Audience Builder UI to create an Audience using properties you're familiar with. For example, you might know the number of new website user signups in the last seven days, if you've connected your production website source to Engage.
In this step, use the Audience Builder UI to create an Audience using properties you're familiar with. For example, you might know the number of new website user signups in the last seven days, if you've connected your production website source to Engage.

To build your own audience:
1. Navigate to your Engage space.
Expand Down
6 changes: 3 additions & 3 deletions src/segment-app/iam/roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ The following roles are only available to Segment Business Tier accounts.
* Edit access to assigned source(s), source settings, connected streaming destinations, schema, transformations, the source's [write key](/docs/connections/find-writekey/) and live data in the debugger.
* **Scope:** Grants access to either: all current and future Sources, or only specific Sources, or Sources with a specific Label (BT only).

#### Profiles and Engage Admin
#### Unify and Engage Admin
* Edit access to Unify settings and if purchased, Engage Audiences, Traits, Journeys, Content, and settings.
* **Scope:** Grants access to either: all current and future Spaces, or a specific list of Spaces, or Spaces with a specific Label (BT only).


#### Profiles and Engage Read-only
#### Unify and Engage Read-only
* Read-only access to Unify settings and if purchased, Engage audiences, traits, journeys, and content. Cannot download PII or edit settings in Unify or Engage.
* **Scope:** Grants access to either: all current and future Spaces, or a specific list of Spaces, or Spaces with a specific Label (BT only).

#### Profiles Read-only, Engage User
#### Unify Read-only, Engage User
* Read-only access to Unify settings and if purchased, edit access to Engage audiences, traits, journeys, and content. Cannot download PII or edit settings in Unify or Engage.
* **Scope:** Grants access to either: all current and future Spaces, or a specific list of Spaces, or Spaces with a specific Label (BT only).

Expand Down
7 changes: 5 additions & 2 deletions src/unify/identity-resolution/externalids.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,12 @@ redirect_from:

## Default externalIDs

The Identity Graph creates or merges profiles based on externalIDs. ExternalIDs will become the Identities attached to a User Profile in the User Explorer:
The Identity Graph creates or merges profiles based on externalIDs. ExternalIDs will become the identities attached to a user profile in the Profile explorer.

![Example of external identities in the User Explorer](images/jane_doe_new_identities.png)
> success ""
> Navigate to **Unify > Profile explorer** to view identities attached to a profile, along with custom traits, event history, and more.

![Example of external identities in the Profile explorer](images/jane_doe_new_identities.png)

Segment automatically promotes the following traits and IDs in track and identify calls to externalIDs:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ redirect_from:
> note ""
> **NOTE:** Workspace owners, administrators, and users with the Identity Admin role can edit Identity Resolution Settings.

Segment creates and merges user profiles based on a space's Identity Resolution configuration. Segment searches for identifiers such as `userId`, `anonymousId`, and `email` on incoming events and matches them to existing profiles or creates new profiles. These identifiers display in the Identities tab of a User Profile in the User Explorer:
Segment creates and merges user profiles based on a space's Identity Resolution configuration. Segment searches for identifiers such as `userId`, `anonymousId`, and `email` on incoming events and matches them to existing profiles or creates new profiles. These identifiers display in the Identities tab of a User Profile in the Profile explorer.

![Identities tab of a profile in the User Explorer](images/jane_doe_new_identities.png)
> success ""
> Navigate to **Unify > Profile explorer** to view identities attached to a profile, along with custom traits, event history, and more.

![Identities tab of a profile in the Profile explorer](images/jane_doe_new_identities.png)

### Flat matching logic

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Before you connect a source to Unify, Segment recommends that you first review t

## ExternalIDs

Segment creates and merges user profiles based on externalIDs used as identifiers. You can view these externalIDs in the Identities tab of a User Profile in the User Explorer:
Segment creates and merges user profiles based on externalIDs used as identifiers. You can view these externalIDs in the Identities tab of a User Profile in the Profile explorer.

![ExternalIDs of a profile in the User Explorer](images/jane_doe_new_identities.png)
![ExternalIDs of a profile in the Profile explorer](images/jane_doe_new_identities.png)

By default, Segment promotes the following traits and IDs in track and identify calls to externalIDs:

Expand Down
Loading