Skip to content

Commit 8192df2

Browse files
authored
Merge pull request #4004 from segmentio/Compute-status-bar
ROW 3.0 updates
2 parents 6d67952 + 534b365 commit 8192df2

15 files changed

+66
-28
lines changed

src/engage/audiences/account-audiences.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ A single account-level audience can incorporate any combination of the following
3939
- Account-level custom traits (set through a [group](/docs/connections/spec/group) call)
4040

4141

42-
To access account-level audience conditions, select Accounts in the dropdown.
42+
To access account-level audience conditions:
43+
1. Navigate to **Engage > Audiences**, and click **Create**.
44+
2. Select **Accounts** from the **Select Type** screen.
45+
3. From the **Configure** screen, select **Accounts** in the dropdown.
4346

4447
![Use this control to access account level audience conditions](/docs/engage/images/new-audience-type.png)
4548

src/engage/audiences/computed-traits.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,12 @@ User-level examples:
6666
- Favorite Blog Post
6767
- Top Purchase Category
6868

69-
![A most frequent product-viewed trait](../images/1525836239527.png)
70-
7169
Account-level examples:
7270
- Most frequent product viewed
7371
- Most active user
7472

75-
![A most frequent order-completed trait](../images/1542073415630.png)
73+
![A most frequent product-viewed trait](../images/1525836239527.png)
74+
7675

7776
### First
7877

@@ -96,13 +95,12 @@ User-level examples:
9695
- Last seen at
9796
- Last utm parameter
9897

99-
![The last event-seen trait builder](../images/1525836818177.png)
100-
10198
Account-level examples:
10299
- Last unsubscribe timestamp
103100
- Last user active
104101

105-
![An account-level last page-viewed trait](../images/1542073887657.png)
102+
![The last event-seen trait builder](../images/1525836818177.png)
103+
106104

107105
### Unique List
108106

@@ -124,13 +122,12 @@ User-level examples:
124122
- Unique products viewed count
125123
- Unique categories count
126124

127-
![The unique list count builder](../images/1525837374378.png)
128-
129125
Account-level examples:
130126
- Unique products viewed
131127
- Unique visitors count
132128

133-
![An account-level unique list trait](../images/1542074153487.png)
129+
![The unique list count builder](../images/1525837374378.png)
130+
134131

135132
## Conditions
136133

@@ -162,6 +159,10 @@ Learn more about [Computed trait generated events here](/docs/engage/using-engag
162159

163160
For account-level computed traits, you have the option to send either a [group](/docs/connections/spec/group/) call and/or [identify](/docs/connections/spec/identify/) call. Group calls will send one event per account, whereas identify calls will send an identify call for each user in the account. This means that even if a user hasn't performed an event, Segment will still set the account-level computed trait on that user. Because most marketing tools are still based at the user level, it is often important to map this account-level trait onto each user within an account. See [Account-level Audiences](/docs/engage/audiences/account-audiences) for more information.
164161

162+
## View compute status
163+
164+
After you create a computed trait, use the Overview page to view the current [compute status](/docs/engage/audiences#compute-statuses), number of users with the trait, connected destinations, and more. For real-time traits, click **Refresh Trait** to update the current number of users with the trait.
165+
165166
## Editing Realtime Traits
166167

167168
Engage supports the editing of real-time Traits, which allows you to make nuanced changes to existing Traits in situations where cloning or building from scratch may not suit your use case.
@@ -171,9 +172,10 @@ To edit a real-time Trait, follow these steps:
171172
1. In your Engage Space, select the **Computed Traits** tab.
172173
2. Select the realtime Trait you want to edit.
173174
3. Select the **Builder** tab and make your edits.
174-
4. Select **Save Computed Trait** to confirm your edits.
175+
4. Preview the results, then select **Save Computed Trait** to confirm your edits.
176+
177+
Engage then processes your Trait edits. While the edit task runs, the trait remains locked and you can't make further changes. Once Engage incorporates your changes, you'll be able to access your updated Trait.
175178

176-
Engage then processes your Trait edits. While the edit task runs, the trait remains locked and you can't make further changes. Once Engage has finished incorporating your changes, you'll be able to access your updated Trait.
177179

178180
> warning ""
179181
> It is not possible to edit a trait to convert it from real-time to batch, or vice-versa. If the computation type needs to be changed, you will need to recreate the trait with the appropiate conditions.

src/engage/audiences/index.md

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ You can also build Audiences based on custom traits. These traits can be collect
3434

3535
You can also use computed traits in an Audience definition. For example, you can create a `total_revenue` computed trait and use it to generate an audience of `big_spender` customers that exceed a certain threshold.
3636

37-
![Creating an Audience from a computed trait based on the user's number of Twitter followers](/docs/engage/images/audience_builder_computed.png)
3837

3938
### Funnel Audiences
4039

@@ -54,7 +53,7 @@ If you have a B2B business, you might want to build an Audience of accounts. You
5453

5554
See [Account-level Audiences](/docs/engage/audiences/account-audiences) for more information.
5655

57-
![Building an Audience of accounts where no user viewed their dashboard in the last 30 days](/docs/engage/images/1542075123519.png)
56+
5857

5958
## Send Audiences to Destinations
6059
With the help of Sources and Destinations in Segment's catalog, you can create and send Audiences and computed traits to third-party services.
@@ -88,6 +87,45 @@ Because a number of factors (like system load, backfills, or user bases) determi
8887

8988
As a result, **Segment recommends waiting at least 24 hours for an Audience to finish computing** before you resume working with the Audience.
9089

90+
From the Overview page, you can view Audience details including the current compute status and a progress bar for real-time and batch Audiences. Engage updates the progress bar and status for real-time computations approximately every 10 minutes.
91+
92+
> info ""
93+
> Engage only displays the progress bar and status updates when you create a new Audience or Trait.
94+
95+
> warning ""
96+
> Engage syncs the Overview page for an individual audience more frequently than the Engage Audiences page (**Engage > Audiences**). As a result, you might see temporary discrepancies in Audience details, such as user counts, between these two pages.
97+
98+
### Refresh real-time Audiences and Traits
99+
100+
For real-time computations, you can click **Refresh Audience** or **Refresh Trait** to update user counts, status, and compute progress.
101+
102+
### Compute statuses
103+
104+
Engage displays the following compute statuses for Audiences and Traits.
105+
106+
#### Real-time computations
107+
108+
| Computation status | Description |
109+
|---------------------------|---------------------------------------|
110+
| Preparing | Engage is preparing the computation. |
111+
| Computing | Engage is computing the Audience or Trait. |
112+
| Live | The Audience or Trait is live. Users will enter in real-time as they meet entry criteria. |
113+
| Disabled | The Audience or Trait is disabled. |
114+
| Failed | The computation was cancelled or failed to compute. Please contact [Segment support](https://segment.com/help/contact/){:target="_blank"}. |
115+
116+
117+
#### Batch computations
118+
119+
| Computation status | Description |
120+
|---------------------------|---------------------------------------|
121+
| Preparing | Engage is preparing the computation. |
122+
| Computing | Engage is computing the Audience or Trait. |
123+
| Live | The Audience or Trait is up-to-date, based on the most recent sync cadence. When you edit a batch Audience or Trait, Engage displays the compute status as `Live` and incorporates your edits in the next scheduled sync. |
124+
| Not Computing | Engage displays this status when there are no destinations connected or `Compute without connected destinations` isn't selected. |
125+
| Disabled | The Audience or Trait is disabled. |
126+
| Failed | The computation was cancelled or failed to compute. Please contact [Segment support](https://segment.com/help/contact/){:target="_blank"}. |
127+
128+
91129
## Real-time compute compared to batch
92130

93131
Real-time Compute allows you to update traits and Audiences as Segment receives new events. Real-time Compute unlocks exciting use cases:
@@ -96,22 +134,17 @@ Real-time Compute allows you to update traits and Audiences as Segment receives
96134
- **Instant Messaging:** Trigger messages in email, live chat, and push notifications instantly, to deliver immediate experiences across channels.
97135
- **Operational Workflows:** Supercharge your sales and support teams by responding to customer needs faster, based on the latest understanding of a user.
98136

99-
To create a new Audience:
100-
101-
1. Go to your **Computed Traits** or **Audiences** tab in Engage and select **New**.
102-
103-
2. Create your computed trait or Audience.
104-
105-
A lightning bolt indicates that the computation updates in real-time.
106-
107-
![A screenshot of the Audience preview in the Audience Builder](/docs/engage/images/1538693443980_image.png)
137+
To create a new Audience or Trait:
108138

109-
3. To preview your Audience, select **Select Destinations**, then select **Review & Create**.
139+
1. Go to your **Computed Traits** or **Audiences** tab in Engage and select **Create**.
110140

111-
By default, Segment queries all historical data to set the current value of the computed trait and Audience. You can uncheck **Historical Backfill** to compute values for the Audience or trait without using this data. With this disabled, the trait or Audience only uses the data that arrives after you created it.
141+
2. Configure and preview your Audience or Trait.
142+
- A lightning bolt next to `Realtime Enabled` indicates that the computation updates in real-time.
143+
- By default, Segment queries all historical data to set the current value of the computed trait and Audience. Backfill computes historical data up to the point of audience creation. You can uncheck **Include Historical Data** to compute values for the Audience or trait without historical data. With backfill disabled, the trait or Audience only uses the data that arrives after you create it.
112144

113-
Use the Audience Explorer to see users or accounts that enter the Audience. Segment displays the Audience as computing until at least one user or account enters.
145+
3. Select destinations to connect, then review and create your Audience or Trait.
114146

147+
While Engage is computing, use the Audience Explorer to see users or accounts that enter your Audience. Engage displays the Audience as computing in the Explorer until at least one user or account enters.
115148

116149
> warning ""
117150
> [Facebook Custom Audiences](/docs/connections/destinations/catalog/personas-facebook-custom-audiences/), [Marketo Lists](/docs/connections/destinations/catalog/marketo-static-lists/), and [Adwords Remarking Lists](/docs/connections/destinations/catalog/adwords-remarketing-lists) impose rate limits on how quickly Segment can update an Audience. Segment syncs at the highest frequency allowed by the tool, which is between one and six hours.
@@ -125,9 +158,9 @@ To edit a realtime Trait or Audience, follow these steps:
125158
1. In your Engage Space, select the **Computed Traits** or **Audiences** tab.
126159
2. Select the realtime Audience or Trait you want to edit.
127160
3. Select the **Builder** tab and make your edits.
128-
4. Select **Save Audience** to confirm your edits.
161+
4. Preview the results, then select **Create Audience** to confirm your edits.
129162

130-
Engage then processes your realtime Audience or Trait edits. While the edit task runs, the audience remains locked and you can't make further changes. Once Engage has finished incorporating your changes, you'll be able to access your updated Audience or Trait.
163+
Engage then processes your realtime Audience or Trait edits. While the edit task runs, the audience remains locked and you can't make further changes. Once Engage incorporates your changes, you'll be able to access your updated Audience or Trait.
131164

132165
> warning ""
133166
> If your audience includes historical data (Historical Backfill is enabled), editing an audience creates a new backfill task. The backfill task, and therefore the edit task, take longer to process if the audience is connected to a destination with rate limits. Rate-limited destinations dictate how fast Engage can backfill. View a list of [rate-limited destinations](/docs/engage/using-engage-data/#rate-limits-on-engage-event-destinations).

src/engage/images/1525835194991.png

-42.1 KB
Loading

src/engage/images/1525835663131.png

-82.3 KB
Loading

src/engage/images/1525836239527.png

-55.9 KB
Loading

src/engage/images/1525836568474.png

-36.1 KB
Loading

src/engage/images/1525836818177.png

-37 KB
Loading

src/engage/images/1525837083070.png

-40.3 KB
Loading

src/engage/images/1525837374378.png

-36.4 KB
Loading

0 commit comments

Comments
 (0)