Difference between revisions of "ATC/Current/SDK/Traits mapper"
(Published) |
(Published) |
||
(10 intermediate revisions by 3 users not shown) | |||
Line 3: | Line 3: | ||
|DisplayName=Map traits to link customer records | |DisplayName=Map traits to link customer records | ||
|TocName=Map traits | |TocName=Map traits | ||
− | |Context=Learn how to see more complete customer profiles in Live Now | + | |Context=Learn how to map multiple records for the same customer to see more complete customer profiles in Live Now. |
|ComingSoon=No | |ComingSoon=No | ||
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud | ||
|Section={{Section | |Section={{Section | ||
+ | |alignment=Vertical | ||
+ | |structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br /> | ||
+ | |Status=No | ||
+ | }}{{Section | ||
|sectionHeading=About traits mapping | |sectionHeading=About traits mapping | ||
|anchor=AboutTraits | |anchor=AboutTraits | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext=Traits are properties, such as | + | |structuredtext=Traits are properties, such as a customer's email address or phone number. {{MINTYDOCSPRODUCT}} gathers customer traits every time a customer visits a website that you track with the {{MINTYDOCSPRODUCT}} tracking snippet. It's possible to have multiple customer records for the same person. For example, when a customer visits your website multiple times and uses a different browser each time. Because {{MINTYDOCSPRODUCT}} creates a separate record for each instance, the separate customer records may contain only a subset of all the available customer traits. You can map the traits that the separate customer records contain to link the records. Then, you can see the complete customer information in Live Now. |
− | {{NoteFormat|When customer records | + | {{NoteFormat|When the traits mapper links customer records, it preserves the separate customer records. It doesn't consolidate them into a single customer record. Instead, the traits mapper updates all linked customer records with the current traits information.|}} |
− | After customer records | + | After linking customer records, the traits mapper updates all the records when new trait information becomes available. It overwrites existing or duplicate traits with the most current trait information. |
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
Line 24: | Line 28: | ||
|structuredtext=After you map traits, they appear here: | |structuredtext=After you map traits, they appear here: | ||
− | *Genesys Cloud > Admin menu > Live Now > {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Customer_details}} | + | *Genesys Cloud CX > Admin menu > Live Now > {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Customer_details}} |
− | *Agent user interface > Journey gadget > {{Link- | + | *Agent user interface > Journey gadget > |
+ | **{{Link-AnywhereElse|product=ATC|version=Current|manual=AgentGuide|topic=GenesysEngage|anchor=VisitorInfo|display text=Visitor information (Genesys Multicloud CX)}} | ||
+ | **{{Link-AnywhereElse|product=ATC|version=Current|manual=AgentGuide|topic=PureConnect|anchor=VisitorInfo|display text=Visitor information (PureConnect)}} | ||
|Status=No | |Status=No | ||
+ | }}{{Section | ||
+ | |sectionHeading=AI-381 Replace image in previous section | ||
+ | |alignment=Horizontal | ||
+ | |Media=Image | ||
+ | |image=TraitsMapper.png | ||
+ | |AltText=View mapped traits in user interface | ||
+ | |Status=Yes | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Map traits globally | |sectionHeading=Map traits globally | ||
|anchor=GlobalTraitsMapper | |anchor=GlobalTraitsMapper | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext=To start mapping traits, define a global traits mapper when you deploy the {{MINTYDOCSPRODUCT}} tracking snippet on your website. Specifically, when you call {{Link-SomewhereInThisVersion|manual=SDK|topic=Init}} to initialize the Journey JavaScript SDK, identify which attributes | + | |structuredtext=To start mapping traits, define a global traits mapper when you deploy the {{MINTYDOCSPRODUCT}} tracking snippet on your website. Specifically, when you call {{Link-SomewhereInThisVersion|manual=SDK|topic=Init}} to initialize the Journey JavaScript SDK, identify which attributes to treat as traits. See the following code example. |
+ | |||
+ | For more information, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper#TraitsTrackingMethods|display text = Methods that track events}} and {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper#MappableTraits|display text = Mappable traits.}} | ||
− | + | When {{MINTYDOCSPRODUCT}} gathers values for these attributes, they map as traits. | |
You can also {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper#LocalTraitsMapper|display text=map traits based on specific events.}} | You can also {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper#LocalTraitsMapper|display text=map traits based on specific events.}} | ||
Line 47: | Line 62: | ||
globalTraitsMapper: [ | globalTraitsMapper: [ | ||
{ | { | ||
− | "fieldName": " | + | "fieldName": "emailAddress", |
+ | "traitName": "email" | ||
+ | } | ||
+ | ] | ||
+ | }); | ||
+ | ac('pageview'); | ||
+ | </script> | ||
+ | </source> | ||
+ | |Status=No | ||
+ | }}{{Section | ||
+ | |sectionHeading=AI-381 Replace example in previous section | ||
+ | |alignment=Vertical | ||
+ | |structuredtext====Example=== | ||
+ | <source lang="JavaScript"> | ||
+ | <script> | ||
+ | (function(a,t,c,l,o,u,d){a['_genesysJourneySdk']=o;a[o]=a[o]||function(){ | ||
+ | (a[o].q=a[o].q||[]).push(arguments)},a[o].l=1*new Date();u=t.createElement(c), | ||
+ | d=t.getElementsByTagName(c)[0];u.async=1;u.src=l;u.charset='utf-8';d.parentNode.insertBefore(u,d) | ||
+ | })(window, document, 'script', 'https://apps.mypurecloud.com/journey/sdk/js/web/v1/ac.js', 'ac'); | ||
+ | ac('init', 'c232166f-0136-4557-8dce-c88339d17a4e', { | ||
+ | region: 'use1', | ||
+ | globalTraitsMapper: [ | ||
+ | { | ||
+ | "fieldName": "emailAddress", | ||
"traitName": "email" | "traitName": "email" | ||
}, { | }, { | ||
− | "fieldName": " | + | "fieldName": "company", |
− | "traitName": " | + | "traitName": "companyName" |
} | } | ||
] | ] | ||
Line 58: | Line 96: | ||
</script> | </script> | ||
</source> | </source> | ||
− | |Status= | + | |Status=Yes |
}}{{Section | }}{{Section | ||
|sectionHeading=Map traits for a specific event | |sectionHeading=Map traits for a specific event | ||
|anchor=LocalTraitsMapper | |anchor=LocalTraitsMapper | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext= | + | |structuredtext=You can map specific traits locally instead of globally for specific events. For more information, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper#TraitsTrackingMethods|display text = Methods that track events}} and {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper#MappableTraits|display text = Mappable traits.}} |
− | The complete set of map traits for a customer is the union of globally | + | The complete set of map traits for a customer is the union of globally and locally mapped traits. For example, suppose you map the email address field using the global traits mapper, but on one page you ask for the customer's phone number. Both the email address and the phone number map to the customer and both appear in the customer's Live Now profile. |
− | If the same data | + | If {{MintyDocsProduct}} captures the same data in two places, the most recent trait mapped appears in Live Now. Previous values for mapped traits are not preserved. |
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Examples of mapped traits | |sectionHeading=Examples of mapped traits | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext=The following examples show how attributes | + | |structuredtext=The following examples show how to map attributes as traits. Specifically: |
+ | |||
+ | *The attributes, "email" and "emailAddress" map to the trait "email." | ||
+ | |||
+ | <br /> | ||
+ | {{{!}} class="wikitable" | ||
+ | {{!}}+ | ||
+ | !<small>Attributes</small> | ||
+ | !<small>traitsMapper</small> | ||
+ | !<small>Traits</small> | ||
+ | {{!}}- | ||
+ | {{!}}<small>{</small> | ||
+ | |||
+ | <small> "email": "firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small> "comment": "This is great",</small> | ||
+ | |||
+ | <small> "section": "support"</small> | ||
+ | |||
+ | <small>}</small> | ||
+ | {{!}}<small>[</small> | ||
+ | <small> {"fieldName": "email"},</small> | ||
+ | |||
+ | <small>]</small> | ||
+ | {{!}}<small>{</small> | ||
+ | |||
+ | <small> "email": firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small>}</small> | ||
+ | {{!}}- | ||
+ | {{!}}<small>{</small> | ||
+ | <small> "emailAddress": "firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small> "comment": "This is great",</small> | ||
+ | |||
+ | <small> "section": "support"</small> | ||
− | + | <small>}</small> | |
− | + | {{!}}<small>[</small> | |
+ | <small> {</small> | ||
− | + | <small> "fieldName": "emailAddress",</small> | |
+ | |||
+ | <small> "traitName": "email"</small> | ||
+ | |||
+ | <small> }</small> | ||
+ | |||
+ | <small>]</small> | ||
+ | {{!}}<small>{</small> | ||
+ | |||
+ | <small> "email": firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small>}</small> | ||
+ | {{!}}} | ||
<br /> | <br /> | ||
|Status=No | |Status=No | ||
+ | }}{{Section | ||
+ | |sectionHeading=AI-381 Replace previous section | ||
+ | |alignment=Vertical | ||
+ | |structuredtext=The following examples show how to map attributes as traits. Specifically: | ||
+ | |||
+ | *The attributes, "email" and "emailAddress" map to the trait "email." | ||
+ | *The attributes, "company" and "companyName" map to the trait "companyName." | ||
+ | |||
+ | {{{!}} class="wikitable" | ||
+ | {{!}}+ | ||
+ | !<small>Attributes</small> | ||
+ | !<small>traitsMapper</small> | ||
+ | !<small>Traits</small> | ||
+ | {{!}}- | ||
+ | {{!}}<small>{</small> | ||
+ | <small> "email": "firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small> "companyName": "ABC corporation",</small> | ||
+ | |||
+ | <small> "comment": "Here is a comment",</small> | ||
+ | |||
+ | <small> "section": "support"</small> | ||
+ | |||
+ | <small>}</small> | ||
+ | {{!}}<small>[</small> | ||
+ | <small> {"fieldName": "email"},</small> | ||
+ | |||
+ | <small> {"fieldname": "companyName"}</small> | ||
+ | |||
+ | <small>]</small> | ||
+ | {{!}}<small>{</small> | ||
+ | <small> "email": firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small> "companyName": "ABC corporation"</small> | ||
+ | |||
+ | <small>}</small> | ||
+ | {{!}}- | ||
+ | {{!}}<small>{</small> | ||
+ | <small> "emailAddress": "firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small> "company": "ABC corporation",</small> | ||
+ | |||
+ | <small> "comment": "Here is a comment",</small> | ||
+ | |||
+ | <small> "section": "support"</small> | ||
+ | |||
+ | <small>}</small> | ||
+ | {{!}}<small>[</small> | ||
+ | <small> {</small> | ||
+ | |||
+ | <small> "fieldName": "emailAddress",</small> | ||
+ | |||
+ | <small> "traitName": "email"</small> | ||
+ | |||
+ | <small> }, {</small> | ||
+ | |||
+ | <small> "fieldname": "company",</small> | ||
+ | |||
+ | <small> "traitName": "companyName"</small> | ||
+ | |||
+ | <small> }</small> | ||
+ | |||
+ | <small>]</small> | ||
+ | {{!}}<small>{</small> | ||
+ | <small> "email": firstname.lastname@somemail.com",</small> | ||
+ | |||
+ | <small> "companyName": "ABC corporation"</small> | ||
+ | |||
+ | <small>}</small> | ||
+ | {{!}}} | ||
+ | |Status=Yes | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Methods that track events | |sectionHeading=Methods that track events | ||
|anchor=TraitsTrackingMethods | |anchor=TraitsTrackingMethods | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext=Traits mapping can occur whenever there is a tracked event on your website. Specifically, events | + | |structuredtext=Traits mapping can occur whenever there is a tracked event on your website. Specifically, {{MintyDocsProduct}} tracks events when you use the following methods: |
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Init}} | *{{Link-SomewhereInThisVersion|manual=SDK|topic=Init}} | ||
− | |||
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview}} | *{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview}} | ||
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Record}} | *{{Link-SomewhereInThisVersion|manual=SDK|topic=Record}} | ||
Line 96: | Line 252: | ||
|anchor=MappableTraits | |anchor=MappableTraits | ||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext= | + | |structuredtext====ID traits=== |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ===ID traits=== | ||
− | |||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
{{!}}- | {{!}}- | ||
Line 138: | Line 260: | ||
{{!}}{{!}}email | {{!}}{{!}}email | ||
{{!}}{{!}}JTS1715@gmail.com | {{!}}{{!}}JTS1715@gmail.com | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{{!}}} | {{!}}} | ||
===Phone traits=== | ===Phone traits=== | ||
− | |||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
{{!}}- | {{!}}- | ||
Line 170: | Line 279: | ||
{{!}}8179874321 | {{!}}8179874321 | ||
{{!}}} | {{!}}} | ||
− | |||
===Name traits=== | ===Name traits=== | ||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
Line 191: | Line 299: | ||
{{!}}{{!}}familyName | {{!}}{{!}}familyName | ||
{{!}}{{!}}Smith | {{!}}{{!}}Smith | ||
− | |||
− | |||
− | |||
{{!}}} | {{!}}} | ||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} |
Latest revision as of 10:17, March 8, 2024
Contents
- 1 About traits mapping
- 2 View mapped traits in the user interface
- 3 AI-381 Replace image in previous section
- 4 Map traits globally
- 5 AI-381 Replace example in previous section
- 6 Map traits for a specific event
- 7 Examples of mapped traits
- 8 AI-381 Replace previous section
- 9 Methods that track events
- 10 Mappable traits
Learn how to map multiple records for the same customer to see more complete customer profiles in Live Now.
About traits mapping
Traits are properties, such as a customer's email address or phone number. Genesys Predictive Engagement gathers customer traits every time a customer visits a website that you track with the Genesys Predictive Engagement tracking snippet. It's possible to have multiple customer records for the same person. For example, when a customer visits your website multiple times and uses a different browser each time. Because Genesys Predictive Engagement creates a separate record for each instance, the separate customer records may contain only a subset of all the available customer traits. You can map the traits that the separate customer records contain to link the records. Then, you can see the complete customer information in Live Now.
After linking customer records, the traits mapper updates all the records when new trait information becomes available. It overwrites existing or duplicate traits with the most current trait information.
View mapped traits in the user interface
After you map traits, they appear here:
- Genesys Cloud CX > Admin menu > Live Now > Customer summary (admin view)
- Agent user interface > Journey gadget >
Map traits globally
To start mapping traits, define a global traits mapper when you deploy the Genesys Predictive Engagement tracking snippet on your website. Specifically, when you call init to initialize the Journey JavaScript SDK, identify which attributes to treat as traits. See the following code example.
For more information, see Methods that track events and Mappable traits.
When Genesys Predictive Engagement gathers values for these attributes, they map as traits.
You can also map traits based on specific events.
Example
<script>
(function(a,t,c,l,o,u,d){a['_genesysJourneySdk']=o;a[o]=a[o]||function(){
(a[o].q=a[o].q||[]).push(arguments)},a[o].l=1*new Date();u=t.createElement(c),
d=t.getElementsByTagName(c)[0];u.async=1;u.src=l;u.charset='utf-8';d.parentNode.insertBefore(u,d)
})(window, document, 'script', 'https://apps.mypurecloud.com/journey/sdk/js/web/v1/ac.js', 'ac');
ac('init', 'c232166f-0136-4557-8dce-c88339d17a4e', {
region: 'use1',
globalTraitsMapper: [
{
"fieldName": "emailAddress",
"traitName": "email"
}
]
});
ac('pageview');
</script>
Map traits for a specific event
You can map specific traits locally instead of globally for specific events. For more information, see Methods that track events and Mappable traits.
The complete set of map traits for a customer is the union of globally and locally mapped traits. For example, suppose you map the email address field using the global traits mapper, but on one page you ask for the customer's phone number. Both the email address and the phone number map to the customer and both appear in the customer's Live Now profile.
If Genesys Predictive Engagement captures the same data in two places, the most recent trait mapped appears in Live Now. Previous values for mapped traits are not preserved.
Examples of mapped traits
The following examples show how to map attributes as traits. Specifically:
- The attributes, "email" and "emailAddress" map to the trait "email."
Attributes | traitsMapper | Traits |
---|---|---|
{
"email": "firstname.lastname@somemail.com", "comment": "This is great", "section": "support" } |
[
{"fieldName": "email"}, ] |
{
"email": firstname.lastname@somemail.com", } |
{
"emailAddress": "firstname.lastname@somemail.com", "comment": "This is great", "section": "support" } |
[
{ "fieldName": "emailAddress", "traitName": "email" } ] |
{
"email": firstname.lastname@somemail.com", } |
Methods that track events
Traits mapping can occur whenever there is a tracked event on your website. Specifically, Genesys Predictive Engagement tracks events when you use the following methods:
Mappable traits
ID traits
Trait | Example |
JTS1715@gmail.com |
Phone traits
Trait | Example |
homePhone | 3179871234 |
cellPhone | 3179871235 |
otherPhone | 3179712356 |
workPhone | 8179874321 |
Name traits
Trait | Example |
salutation | Mr. |
jobTitle | Manager |
givenName | John |
middleName | Thomas |
familyName | Smith |