You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/actions-acoustic/index.md
+35-35Lines changed: 35 additions & 35 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,39 +6,39 @@ hidden: true
6
6
---
7
7
{% include content/plan-grid.md name="actions" %}
8
8
9
-
[Acoustic Connect](https://acoustic.com/?utm_source=segmentio&utm_medium=docs&utm_Connect=partners){:target="_blank”}, provides multichannel marketing without all the hassle. Automate campaigns and messages across SMS, mobile push, group messaging, email, and social media based on real-time customer signals and intent across the customer journey.
9
+
[Acoustic Connect](https://acoustic.com/?utm_source=segmentio&utm_medium=docs&utm_Connect=partners){:target="_blank”} provides multichannel marketing without all the hassle. Automate campaigns and messages across SMS, mobile push, group messaging, email, and social media based on real-time customer signals and intent across the customer journey.
10
10
11
-
Trigger promotional and transactional messages based on customer preferences and behaviors to support onboarding, customer activation, cross-sell, and re-engagement strategies. Scale personalization and treat your customers as individuals with an automated view and understanding of the customer by pulling real-time behavior like intent so marketers do not have to manually segment users and audiences.
11
+
Trigger promotional and transactional messages based on customer preferences and behaviors to support onboarding, customer activation, cross-sell, and re-engagement strategies. Scale personalization and treat your customers as individuals with an automated view and understanding of the customer by pulling real-time behavior like intent so marketers don't have to manually segment users and audiences.
12
12
13
-
The Acoustic (Actions) Destination is maintained by Acoustic. For support, visit help.goacoustic.com
13
+
The Acoustic (Actions) Destination is maintained by Acoustic. For support, visit the [Acoustic Help Center](https://help.goacoustic.com/hc/en-us){:target="_blank"}.
14
14
15
15
## Getting started
16
16
17
17
1. From the Segment web app, click **Catalog**, then click **Destinations**.
18
18
2. Find the Destinations Actions item "Acoustic (Actions)" in the left navigation, and click it.
19
19
3. Click **Configure Acoustic (Actions)**.
20
-
4. Select an existing Source to connect to Acoustic (Actions).
20
+
4. Select an existing source to connect to Acoustic (Actions).
21
21
22
22
{% include components/actions-fields.html %}
23
23
24
-
### Edit Basic Settings
24
+
### Edit basic settings
25
25
26
-
For some configuration options you will need information from your Connect Org. and others will need the help of your Customer Success and/or Services resources. If you do not recognize the options here or need help, reach out to your Acoustic Customer Success or Services resource for help.
26
+
For some configuration options, you will need information from your Connect Org. Others will need the help of your Customer Success and/or Services resources. If you do not recognize the options here or need help, reach out to your Acoustic Customer Success or Services resource for help.
27
27
28
28
-**Name**: Enter a name to help you identify this destination definition in Segment.
29
29
30
-
-**Customer Prefix**: **Important** - It's recommended that you use your Acoustic Connect Org name and a dataflow tag, as in eg.,*CustomerAcme_Prod_* or *CustomerAcme_test1_* or *CustomerAcme_MktData3_*. Be sure to replace any spaces with an underscore and **be sure to end the string with an underscore '_'**.
30
+
-**Customer Prefix**: **Important** - Segment recommends that you use your Acoustic Connect Org name and a dataflow tag, like*CustomerAcme_Prod_* or *CustomerAcme_test1_* or *CustomerAcme_MktData3_*. Be sure to replace any spaces with an underscore and **be sure to end the string with an underscore '_'**.
31
31
32
32
> info ""
33
-
> You will want to work with your Acoustic Customer Success or Services resource to align this string with the Acoustic definition that defines your unique table for this data set.
33
+
> Work with your Acoustic Customer Success or Services resource to align this string with the Acoustic definition that defines your unique table for this data set.
34
34
35
35
-**S3 Bucket Access Point Alias**: The Alias of the Access Point created for your access to the S3 Bucket. Available from your Acoustic Customer Success or Services resource.
36
36
37
37
-**S3 Access Key**: S3 Access Key for the S3 bucket. Available from your Acoustic Customer Success or Services resource.
38
38
39
39
-**S3 Secret** S3 Secret credential for the S3 bucket. Available from your Acoustic Customer Success or Services resource.
40
40
41
-
-**S3 Region**: Should always be us-east-1 unless directed by Acoustic otherwise.
41
+
-**S3 Region**: Should always be `us-east-1` unless directed by Acoustic otherwise.
42
42
43
43
-**Version**: No Need to Edit - Provides a metatag to confirm the version currently in effect. The current version is shown as: "Last-Modified: 02.01.2024 10.30.43", "Version 1.7"
44
44
@@ -47,59 +47,59 @@ When all config options are defined and confirmed, as well as all Filter and Map
47
47
When enabled, Segment will send data to Acoustic (Actions) based on configuration in the Mappings tab.
48
48
49
49
> info ""
50
-
> Keep in mind, you can define multiple Destinations to send unique data to different Connect Tables, simply create the definition with a unique name and Customer Prefix to align the mapped data to the respective Connect table.
50
+
> You can define multiple destinations to send unique data to different Connect Tables, simply create the definition with a unique name and Customer Prefix to align the mapped data to the respective Connect table.
51
51
52
52
53
-
### Defining Filters
53
+
### Defining filters
54
54
55
-
The Destination dialog includes a Filter tab. If you have a significant volume of Events and data attributes from the Source you wish to use, a good first step would be to define Filter(s) to limit the data being sent to the Connection from the defined Source(s). Mapping is then used to define the specific set of attribute data and columns to be written to Acoustic.
55
+
The Destination dialog includes a Filter tab. If you have a significant volume of Events and data attributes from the source you wish to use, a good first step would be to define Filter(s) to limit the data being sent to the connection from the defined source(s). Mapping is then used to define the specific set of attribute data and columns to be written to Acoustic.
56
56
57
-
For example, for a Connection definition of an Audience source, a Traits.email or similar attribute filter would be necessary to assure only "Identify" Events with a valid value in the traits section (to be mapped to UniqueRecipientId) will be sent to the Acoustic Destination.
57
+
For example, for a Connection definition of an audience source, a `traits.email` or similar attribute filter would be necessary to assure only Identify Events with a valid value in the traits section (to be mapped to `UniqueRecipientId`) will be sent to the Acoustic Destination.
58
58
59
-
59
+
60
60
61
-
Keep in mind that the Acoustic (Actions) Destination ignores any Events that do not contain a valid UniqueRecipientId attribute, therefore a common filter would be to avoid sending any Events to the Connection that do not have a valid attribute to be mapped to UniqueRecipientId. In many cases this will be a valid email address but other Unique Id attribute, such as CustID, can be used.
61
+
Keep in mind that the Acoustic (Actions) Destination ignores events without a valid `UniqueRecipientId` attribute, therefore a common filter would be to avoid sending any events to the connection that don't have a valid attribute to be mapped to `UniqueRecipientId`. In many cases, this will be a valid email address but other Unique Id attribute, such as `CustID`, can be used.
62
62
63
63
64
64
65
65
66
-
### Defining Mapping:
66
+
### Defining mapping
67
67
68
-
The Destination dialog also contains a Mapping tab. The Acoustic (Action) Destination currently supports Segment Track and Identity Events along with all attributes of those events. In the Mapping dialog initial Mapping templates are included as an aid. All of the provided mapping fields are optional but you will need to use at least one, in addition to the required attributes, to map the data you want to write to Acoustic Connect.
68
+
The Destination dialog also contains a Mapping tab. The Acoustic (Action) Destination currently supports Segment Track and Identity Events along with all attributes of those events. In the Mapping dialog, initial Mapping templates are included as an aid. All of the provided mapping fields are optional, but you'll need to use at least one, in addition to the required attributes, to map the data you want to write to Acoustic Connect.
Keep in mind, Mapping provides the means to map Segment Event data to Connect Columns. The Value you map to a Key, is the Value of the Column with the same name as the Key in Connect. That is, if you map the Value of trait.firstName to the Key "firstname", the value mapped will show up in Connect in the column "firstname".
72
+
Mapping provides the means to map Segment event data to Connect Columns. The value you map to a key is the value of the column with the same name as the key in Connect. That is, if you map the value of `trait.firstName` to the Key "firstname", the value mapped will show up in Connect in the column "firstname".
73
73
74
-
To that, you will want to work with the Acoustic Services team to define a Connect Table that will **have all of the Columns you intend to map**. The details of this Table are also needed in the Destination's Settings dialog (see previous).
74
+
You'll want to work with the Acoustic Services team to define a Connect Table that will **have all of the columns you intend to map**. The details of this table are also needed in the Destination's Settings dialog.
75
75
76
-
Here we can see the mapping for UniqueRecipientID. UniqueRecipientId is required. The Acoustic (Actions) Destination will not accept any event that does not contain a UniqueRecipientId attribute.
76
+
Here we can see the mapping for `UniqueRecipientID`. `UniqueRecipientId` is required. The Acoustic (Actions) Destination will not accept any event that does not contain a `UniqueRecipientId` attribute.
77
77
78
-
Also, do not edit 'type' or 'timestamp' mappings. These are required and are pre-mapped for you. As noted above, even these Values will show up in the respective Columns as the Key names, that is, there will be a column in your table in Connect of 'type' and 'timestamp', each will hold the respective mapped Values of the Event data.
78
+
Avoid editing 'type' or 'timestamp' mappings. These are required and pre-mapped. As noted above, even these values will show up in the respective columns as the Key names, that is, there will be a column in your table in Connect of 'type' and 'timestamp', and each will hold the respective mapped values of the event data.
79
79
80
-
80
+
81
81
82
-
Following the required attributes are a series of helpful predefined mapping structures. Each of these are optional but at least one must be used to provide data beyond the required attributes previously noted.
82
+
Following the required attributes are a series of helpful predefined mapping structures. Each of these are optional, but at least one must be used to provide data beyond the required attributes previously noted.
83
83
84
-
The first is a simple, straightforward Key and Value mapping dialog. You can use this dialog to map each attribute provided by the Track or Identify Event data one by one. That is, you can map traits.firstname to "firstname", then another Key/Value of traits.lastname to "lastname", and on and on until you have mapped all that you want to store in Connect.
84
+
The first is a standard Key and Value mapping dialog. You can use this dialog to map each attribute provided by the Track or Identify event data one by one. That is, you can map `traits.firstname` to "firstname", then another Key/Value of `traits.lastname` to "lastname", and so on, until you have mapped all that you want to store in Connect.
85
85
86
-
86
+
87
87
88
-
The mapping sections that follow allow you to map whole sections or even the special use-case of an array of data that needs to be flattened in order to be useful, as in this example of flattening the properties.products array to individual attributes.
88
+
The mapping sections that follow allow you to map whole sections or even the special use-case of an array of data that needs to be flattened in order to be useful, as in this example of flattening the `properties.products` array to individual attributes.
89
89
90
-
90
+
91
91
92
-
Lastly, if it makes sense to do so you can map whole sections, which will provide all of the attributes of the section mapped through to Connect.
92
+
You can also map whole sections, which will provide all of the attributes of the section mapped through to Connect.
93
93
94
-
94
+
95
95
96
-
With the Mapping completed, be sure to click "Save".
96
+
With the Mapping completed, click **Save**.
97
97
98
-
With all configuration completed you will want to confirm data being written to the defined Table in Connect.
98
+
With all configuration completed, you'll want to confirm data being written to the defined Table in Connect.
99
99
100
-
### Delivery Report
100
+
### Delivery report
101
101
102
-
Additionally, if you see `Nesting Depth Exceeded` in your Delivery report, this indicates that an array of data is being sent through that is too deep, that is, has too many levels and cannot be flattened. If this is the case you will need to revisit mapping that data to a flatter structure, that is, the attribute has a simple value versus the complex value structure that is coming through. Complex values, many layered values, are not useable and will not be accepted.
102
+
Additionally, if you see `Nesting Depth Exceeded` in your Delivery report, this indicates that an array of data is being sent through that is too deep. In other words, the array has too many levels and cannot be flattened. In this case, you'll need to revisit mapping that data to a flatter structure, that is, the attribute has a simple value versus the complex value structure that is coming through. Complex values, many layered values, are not useable and will not be accepted.
103
103
104
-
104
+
0 commit comments