Skip to content

Commit ad71fb8

Browse files
authored
Minor wording updates for style consistency
1 parent fee30af commit ad71fb8

File tree

1 file changed

+20
-16
lines changed
  • src/connections/destinations/catalog/actions-batch

1 file changed

+20
-16
lines changed

src/connections/destinations/catalog/actions-batch/index.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This destination is maintained by Batch. For any issues, [contact Batch Support]
1717
4. In the [Batch dashboard](https://dashboard.batch.com/){:target="_blank"}, copy your **Project Key** and **REST API Key**.
1818
5. Paste the **Project Key** and **REST API Key** into the Batch destination settings in Segment.
1919
6. Toggle **Enable Destination**. Segment will start sending data to Batch according to your **Mappings**.
20+
2021
![Basic settings destination](./images/basic_settings_destination.png "Basic settings destination")
2122

2223
{% include components/actions-fields.html %}
@@ -25,12 +26,11 @@ This destination is maintained by Batch. For any issues, [contact Batch Support]
2526

2627
## Profile attributes mapping
2728

28-
If you’re new to Identify, read the Segment spec: <https://segment.com/docs/connections/spec/identify/>
29+
If you’re new to the Identify call, see the [Segment spec](/docs/connections/spec/identify/) for more details.
2930

3031
When you call **Identify**, Segment maps `userId` to **`identifiers.custom_id`** and writes traits into **`attributes`**.
3132

32-
33-
### Example Identify (Segment input)
33+
### Example Identify call (Segment input)
3434

3535
```js
3636
analytics.identify("97980cfea0067", {
@@ -59,15 +59,17 @@ analytics.identify("97980cfea0067", {
5959
| `traits.email_marketing` | `attributes.$email_marketing` |
6060
| `traits.sms_marketing` | `attributes.$sms_marketing` |
6161
| `context.timezone` | `attributes.$timezone` |
62-
| `context.locale` → language (e.g. `fr`)| `attributes.$language` |
63-
| `context.locale` → region (e.g. `FR`) | `attributes.$region` |
62+
| `context.locale` → language (for example, `fr`)| `attributes.$language` |
63+
| `context.locale` → region (for example, `FR`) | `attributes.$region` |
64+
65+
**Notes**
6466

65-
**Notes**
6667
- `$email_marketing` / `$sms_marketing`: use `subscribed` / `unsubscribed`.
6768
- A locale like `fr-FR` is split into **language** (`fr`) and **region** (`FR`).
6869
- All other non‑reserved fields become **custom attributes** under `attributes` (strings, numbers, booleans, arrays of strings). Avoid arbitrary nested objects.
6970

70-
*For more details on the fields to be included, please refer to the Batch documentation → [API Profile](https://doc.batch.com/developer/api/cep/profiles/update){:target="_blank"}.*
71+
> info ""
72+
> For more details on the fields to be included, refer to the Batch [API Profile documentation](https://doc.batch.com/developer/api/cep/profiles/update){:target="_blank"}.
7173
7274

7375
### Resulting Batch profile payload (output)
@@ -99,13 +101,14 @@ To map additional traits into Batch profile attributes:
99101

100102
1. Open your destination → **Mappings****Edit Mapping**.
101103
2. Go to **Profile attributes****Add Mapping Field**.
102-
3. Choose a **source** (for example `traits.plan`) and set a **target** under `attributes` (for example `attributes.plan`).
104+
3. Choose a **source** (for example, `traits.plan`) and set a **target** under `attributes` (for example, `attributes.plan`).
103105
![Attributes mapping](./images/attributes_mapping.png "Attributes mapping")
104106
4. In **Step 4 – Send test record**, you can test your mapping before saving.
105107
![Test record](./images/test_record.png "Test record")
106108
5. **Save** and enable the mapping.
107109

108-
> Supported types: strings, numbers, booleans, arrays of strings. Avoid arbitrary nested objects.
110+
> info "Supported types"
111+
> Strings, numbers, booleans, arrays of strings are supported. Avoid arbitrary nested objects.
109112
110113
---
111114

@@ -115,8 +118,8 @@ If you want to integrate your entire Segment userbase into Batch using the **Ide
115118

116119
To do this:
117120

118-
1. **Contact Segment Support**[[email protected]](mailto:[email protected])
119-
2. **Request a historical replay** of your data
121+
1. **Contact Segment Support**[[email protected]](mailto:[email protected]).
122+
2. **Request a historical replay** of your data.
120123
3. Provide Segment with the following details:
121124
- **Start date and time**
122125
- **End date and time** (usually “now”)
@@ -132,9 +135,9 @@ Segment will then replay your historical data so Batch can import your full user
132135

133136
When you call **Track**, Segment uses your `userId` as Batch’s **`identifiers.custom_id`**. A **userId is required** to attribute the event to a profile.
134137

135-
Track spec: <https://segment.com/docs/connections/spec/track/>
138+
For more details on the Track call, see the [Track spec](/docs/connections/spec/track).
136139

137-
### Example Track (Segment input)
140+
### Example Track call (Segment input)
138141

139142
```js
140143
analytics.track("User Registered", {
@@ -171,6 +174,7 @@ analytics.track("User Registered", {
171174
```
172175

173176
Events are sent to Batch in near real time according to your destination mappings, and all event `properties` are included under `event.attributes`.
177+
174178
![Events mapping](./images/events_mapping.png "Events mapping")
175179

176180
---
@@ -180,15 +184,15 @@ Events are sent to Batch in near real time according to your destination mapping
180184
- Always send a stable `userId` → becomes `identifiers.custom_id`.
181185
- Native profile fields in `attributes`: `$email_address`, `$email_marketing`, `$phone_number`, `$sms_marketing`, `$language`, `$region`, `$timezone`.
182186
- Everything else → **custom attributes** under `attributes`.
183-
- Dates: use **ISO‑8601 UTC** (e.g., `1989-07-20T00:00:00Z`).
187+
- Dates: use **ISO‑8601 UTC** (for example, `1989-07-20T00:00:00Z`).
184188
- Configure additional mappings in **Mappings → Edit Mapping**.
185189
- Test with a read-back/export to verify types, encodings, and timezones.
186190

187191
---
188192

189193
## Integrating a computed trait
190194

191-
If you’re new to *Computed traits*, read the Segment spec: <https://segment.com/docs/unify/Traits/computed-traits/>
195+
For more details on computed traits, see the [Segment spec](/docs/unify/Traits/computed-traits).
192196

193197
To integrate a computed trait with Batch:
194198

@@ -198,7 +202,7 @@ To integrate a computed trait with Batch:
198202
- Otherwise, click **Add destination** and select **Batch (Actions)**.
199203
3. Open the **Engage** tab → **Audiences****Computed traits**.
200204
4. Click **Create computed trait**.
201-
5. Configure your **calculation method** (e.g., count, aggregation, last value).
205+
5. Configure your **calculation method** (for example, count, aggregation, last value).
202206
6. Click **Preview**, then **Next**.
203207
7. Select your **Batch destination**.
204208
8. Choose how to send the data:

0 commit comments

Comments
 (0)