Skip to content

Commit c493a6e

Browse files
stayseesongstayseesong
committed
edits
1 parent ea78775 commit c493a6e

File tree

1 file changed

+50
-73
lines changed
  • src/connections/destinations/catalog/actions-responsys

1 file changed

+50
-73
lines changed

‎src/connections/destinations/catalog/actions-responsys/index.md

Lines changed: 50 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,49 @@ id: 6578a19fbd1201d21f035156
55

66
[Responsys](https://www.oracle.com/marketingcloud/products/cross-channel-orchestration/){:target="_blank"} is a cloud-based marketing platform that enables businesses to deliver personalized customer experiences across email, mobile, social, display, and web. Responsys is part of the Oracle Marketing Cloud.
77

8-
This destination can be used with Connections Sources and with Engage Audiences. It supports the following actions:
8+
This destination can be used with Connections Sources and with Engage Audiences. It supports these actions:
99

1010
- **Send Audience as PET**: Sends an Audience to a Profile Extension Table (PET) in Responsys. This action is used with Engage Audiences.
1111
- **Send to PET**: Sends a record to a Profile Extension Table (PET) in Responsys. This action is used with Connections Sources.
1212
- **Upsert List Member**: Adds or updates a record in a Profile List in Responsys. This action is used with either Connections Sources or Engage Audiences.
1313

14-
This destination is maintained by Segment. For any issues with the destination, [contact the Segment Support team](mailto:[email protected]).
14+
Segment maintains this destination. For any issues with the destination, [contact the Segment Support team](mailto:[email protected]).
1515

16-
## Getting Started
16+
## Getting started
1717

18-
Before you enable Responsys in your destinations page, there are a few things in your Segment destination settings you must set up. Once the set up is complete, you'll be able to use `.identify()` and `.track()` calls to add records to **Profile Lists** and **Profile Extension Tables**.
18+
Before you enable Responsys in your destinations page, there are a few things in your Segment destination settings you must set up. Once the setup is complete, you'll be able to use identify and track calls to add records to **Profile Lists** and **Profile Extension Tables**.
1919

2020
1. From the Segment web app, click **Catalog**.
21-
2. Search for "Responsys" in the Catalog, select it, and choose which of your sources to connect the destination to.
22-
3. Under Settings, give the destination a name, and enter your Responsys "Username" and "Password". You can find these credentials in the Responsys dashboard under Account > User Management > Users.
23-
4. Optionally, you can provide and Source Write Key and its corresponding region to receive partial events from this destination, such as sync statuses and errors. For more information, see the [Source Write Key documentation](https://segment.com/docs/connections/sources/catalog/#destination-write-keys).
24-
5. Under **Responsys endpoint URL**, enter the URL of the Responsys API endpoint you want to send data to. This is typically in the format `
25-
https://<instance>-api.responsys.ocs.oraclecloud.com`. This is provided by your Responsys account manager.
26-
6. Under **List Name**, enter the name of the Profile List you want to send data to. A Profile List in Responsys is the equivalent of a Segment Unify Space. You can create a new Profile List in the Responsys dashboard under Data > Profile Lists, if needed.
27-
7. **Insert On No Match** toggle: If enabled, the destination will insert a new record into the Profile List if no match is found. If disabled, the destination will not insert a new record if no match is found.
28-
8. **First Column Match**: The first column in the Profile List that the destination will use to match records. This is typically the email address.
29-
9. **Second Column Match**: The second column in the Profile List that the destination will use to match records. This is typically the customer ID.
30-
10. **Update On Match** option: Controls how the existing record should be updated. The default is "Replace All".
31-
11. **Default Permission Status**: The default permission status for the record. This is typically "Opt Out". If set as "Opt In", every new profile added into a Profile List will be set to receive marketing communications. This can be overridden in mappings.
32-
12. **Profile Extension Table Name**: The name of the Default Profile Extension Table (PET) you want to send data to. A Profile Extension Table in Responsys is the equivalent of a Segment Audience (if used in Engage with the `Send Audience as PET` action), or of a traits extension table (if used with the `Send to PET` action). For either Actions, Segment creates the corresponding PET in Responsys if it doesn't already exist. This parameter can be overidden in mappings.
33-
13. Change any optional parameters as needed.
34-
14. Click **Save**.
35-
36-
Once you have entered these required settings, you are ready to integrate your Oracle Responsys account through the Segment platform!
21+
2. Search for **Responsys** in the Catalog and select it.
22+
3. Choose which of your sources to connect the destination to.
23+
3. Under Settings, give the destination a name, and enter your Responsys username and password. You can find these credentials in the Responsys dashboard under **Account > User Management > Users**. Optionally, you can provide the Source Write Key and its corresponding region to receive partial events from this destination, such as sync statuses and errors. For more information, see the [Source Write Key documentation](/docs/connections/find-writekey/).
24+
5. Configure your destination for these settings:
25+
26+
Setting | Details
27+
------- | --------
28+
Responsys endpoint URL | Enter the URL of the Responsys API endpoint you want to send data to. This is typically in the format `https://<instance>-api.responsys.ocs.oraclecloud.com`. This is provided by your Responsys account manager.
29+
List Name | Enter the name of the Profile List you want to send data to. A Profile List in Responsys is the equivalent of a Segment Unify Space. You can create a new Profile List in the Responsys dashboard under **Data > Profile Lists**, if needed.
30+
Insert On No Match | If enabled, the destination will insert a new record into the Profile List if no match is found. If disabled, the destination will not insert a new record if no match is found.
31+
First Column Match | The first column in the Profile List that the destination will use to match records. This is typically the email address.
32+
Second Column Match | The second column in the Profile List that the destination will use to match records. This is typically the customer ID.
33+
Update On Match | Controls how the existing record should be updated. The default is "Replace All".
34+
Default Permission Status | The default permission status for the record. This is typically "Opt Out". If set as "Opt In", every new profile added into a Profile List will be set to receive marketing communications. This can be overridden in mappings.
35+
Profile Extension Table Name | The name of the Default Profile Extension Table (PET) you want to send data to. A Profile Extension Table in Responsys is the equivalent of a Segment Audience (if used in Engage with the `Send Audience as PET` action), or of a traits extension table (if used with the `Send to PET` action). For either Actions, Segment creates the corresponding PET in Responsys if it doesn't already exist. This parameter can be overidden in mappings.
36+
37+
6. Click **Save**.
38+
39+
Once you have entered these required settings, you're ready to integrate your Oracle Responsys account through the Segment platform.
3740

3841
## Identify
3942

40-
There are two things you can do with Segment's `.identify()` calls in regards to Responsys:
43+
There are two things you can do with Segment's Identify calls in regards to Responsys:
4144

4245
1. Upsert records to a **Profile List**.
43-
2. Extend that record by upserting a corresponding record in a **Profile Extension Table**.
46+
2. Extend a record by upserting a corresponding record in a **Profile Extension Table**.
4447

45-
In case 2, the Profile Extension Table can either represent profiles' subscription statuses in an Audience, or it can represent additional traits about the profiles.
48+
In case #2, the Profile Extension Table can either represent profiles' subscription statuses in an Audience, or it can represent additional traits about the profiles.
4649

47-
If you just want to update records in a Profile List, you can use the following `.identify()` call:
50+
If you want to update records in a Profile List, you can use the following Identify call:
4851

4952
```js
5053
// analytics.js
@@ -63,64 +66,38 @@ analytics.identify('rick', {
6366
});
6467
```
6568

66-
**IMPORTANT**: In order to merge records properly, our destination requires that all `.identify()` contain at least `userId` or `traits.email`.
67-
68-
If mapping the above call any action, the destination will try to first find an existing record in the provided Profile List with a matching `userId` of `'rick'` and/or `email` of `'[email protected]'`. If a record is found, the destional will update the rest of the columns so long as you pass the information in the corresponding mapping. Our semantic [identify spec](/docs/connections/spec/identify) recommends the following mappings:
69-
70-
<table>
71-
<tr>
72-
<td>Segment Trait Name</td>
73-
<td>Responsys Profile List Column Names</td>
74-
</tr>
75-
<tr>
76-
<td>userId</td>
77-
<td>`CUSTOMER_ID_`</td>
78-
</tr>
79-
<tr>
80-
<td>email</td>
81-
<td>`EMAIL_ADDRESS_`</td>
82-
</tr>
83-
<tr>
84-
<td>phone</td>
85-
<td>`MOBILE_NUMBER_`</td>
86-
</tr>
87-
<tr>
88-
<td>address.street</td>
89-
<td>`POSTAL_ADDRESS_1_`</td>
90-
</tr>
91-
<tr>
92-
<td>address.city</td>
93-
<td>`CITY_`</td>
94-
</tr>
95-
<tr>
96-
<td>address.state</td>
97-
<td>`STATE_`</td>
98-
</tr>
99-
<tr>
100-
<td>address.postalCode</td>
101-
<td>`POSTAL_CODE_`</td>
102-
</tr>
103-
<tr>
104-
<td>address.country</td>
105-
<td>`COUNTRY_`</td>
106-
</tr>
107-
</table>
69+
> info ""
70+
> In order to merge records properly, this destination requires that all Identify calls contain at least `userId` or `traits.email`.
71+
72+
If mapping the above call for any action, the destination first tries to find an existing record in the provided Profile List with a matching `userId` of `'rick'` and/or `email` of `'[email protected]'`. If a record is found, the destination updates the rest of the columns as long as you pass the information in the corresponding mapping. Segment's semantic [Identify spec](/docs/connections/spec/identify) recommends the following mappings:
73+
74+
Segment Trait Name | Responsys Profile List Column Names
75+
------------------ | ------------------------------------
76+
userId | `CUSTOMER_ID_`
77+
email | `EMAIL_ADDRESS_`
78+
phone | `MOBILE_NUMBER_`
79+
address.street | `POSTAL_ADDRESS_1_`
80+
address.city | `CITY_`
81+
address.state | `STATE_`
82+
address.postalCode | `POSTAL_CODE_`
83+
address.country | `COUNTRY_`
10884

10985
#### Email and Mobile Permission Statuses
11086

111-
If you would like to keep track of users who are opting in or out of marketing communications in your apps and websites, make sure to map values of custom traits to Responsys `EMAIL_PERMISSION_STATUS_` or `MOBILE_PERMISSION_STATUS_` fields.
87+
If you want to keep track of users who are opting in or out of marketing communications in your apps and websites, make sure to map values of custom traits to Responsys `EMAIL_PERMISSION_STATUS_` or `MOBILE_PERMISSION_STATUS_` fields.
11288

113-
**NOTE:** The value of this custom trait key _must_ be a boolean. When the value is `true` that indicates the user wants to opt in and `false` indicates the user wants to opt out. Segment will transform that boolean into the appropriate Responsys accepted format (`I` or `O` are the defaults, and can be changed under Settings).
89+
> info ""
90+
> The value of this custom trait key _must_ be a boolean. When the value is `true` that indicates the user wants to opt in. When the value is `false`, this indicates the user wants to opt out. Segment will transform that boolean into the appropriate Responsys accepted format (`I` or `O` are the defaults. You can change these under **Settings**).
11491
11592
### Merging Records to a Profile Extension Table
11693

117-
If you would like to send records to a **Profile Extension Table (PET)**, through `Send to PET` action, this destination can either create the PET for you, or you can simply enter the name of any of your existing PETs. The match column name will be the `userId` and/or `email` (must send at least one), so be sure to include the `userId` or `traits.email` in your `.identify()` calls. If the PET already exists, please make sure that all the columns you are sending in the `.identify()` call are already present in the PET.
94+
If you want to send records to a **Profile Extension Table (PET)**, through `Send to PET` action, this destination can either create the PET for you, or you can simply enter the name of any of your existing PETs. The match column name will be the `userId` and/or `email` (you must send at least one), so be sure to include the `userId` or `traits.email` in your Identify calls. If the PET already exists, make sure that all the columns you are sending in the Identify call are already present in the PET.
11895

11996
#### Creating a Profile Extension Table through Segment:
12097

121-
All you have to do is enter the desired name of your PET, either in your Segment destination settings, or directly in your `Send to PET` action mapping.
98+
Enter the desired name of your PET, either in your Segment destination settings, or directly in your `Send to PET` action mapping.
12299

123-
Say the following is your first `.identify()` call after you've entered the PET name that does not exist yet in your Responsys Profile List:
100+
Say the following is your first Identify call after you've entered the PET name that does not exist yet in your Responsys Profile List:
124101

125102
```js
126103
// analytics.js
@@ -133,11 +110,11 @@ analytics.identify('rick', {
133110
});
134111
```
135112

136-
This would create a PET where its columns would be `NAME`, `AGE` and `GENIUS`. Since `email` is mapped already in your Profile List, we will not create a duplicate column in your PET. We will also automatically set the column type according to the value of the trait you've sent. Every corresponding column in a PET will have the `STR500` column type.
113+
This would create a PET where its columns would be `NAME`, `AGE` and `GENIUS`. Since `email` is mapped already in your Profile List, we won't create a duplicate column in your PET. We will also automatically set the column type according to the value of the trait you've sent. Every corresponding column in a PET will have the `STR500` column type.
137114

138115
#### Merging Records to Existing Profile Extension Table
139116

140-
If you already have a Profile Extension Table you'd like to use, simply enter the name of the list in your settings. Note that we will _only_ send traits with matching column names in your schema, meaning that we will drop any traits that are not pre-defined in your PET before sending the request.
117+
If you already have a Profile Extension Table you'd like to use, enter the name of the list in your settings. Note that we will _only_ send traits with matching column names in your schema, meaning that we will drop any traits that are not pre-defined in your PET before sending the request.
141118

142119
### Overriding Default Folder and List Names
143120

0 commit comments

Comments
 (0)