Difference between revisions of "ATC/Current/SDK/Traits mapper"

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
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 by mapping multiple records for the same customer.
+
|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
Line 10: Line 10:
 
|anchor=AboutTraits
 
|anchor=AboutTraits
 
|alignment=Vertical
 
|alignment=Vertical
|structuredtext=Traits are properties, such as "email" and "gender" for a customer. {{MINTYDOCSPRODUCT}} gathers customer traits every time a customer visits a website that you track with the {{MINTYDOCSPRODUCT}} tracking snippet. In some cases, you may have multiple customer records for the same person. For example, if 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 of the traits information that is actually available for the customer. You can link these separate customer records by mapping the traits information they contain. After you do this, you'll be able to see the complete customer information in Live Now.
+
|structuredtext=Traits are properties, such as a customer's email or gender. {{MINTYDOCSPRODUCT}} gathers customer traits every time a customer visits a web site that you track with the {{MINTYDOCSPRODUCT}} tracking snippet. It's possible to have multiple customer records for the same person. For example, if a customer visits your web site 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 are linked, separate customer records are still preserved. They are not consolidated into a single customer record. Instead, all linked customer reords are updated with the current traits information.}}
+
{{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 are linked, the traits mapper updates all of the records when new trait information becomes available. Existing or duplicate traits are overwritten with the most current trait information.
+
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 31: Line 31:
 
|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 you want 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.}}
+
|structuredtext=To start mapping traits, define a global traits mapper when you deploy the {{MINTYDOCSPRODUCT}} tracking snippet on your web site. 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.  
  
Whenever {{MINTYDOCSPRODUCT}} gathers values for these attributes, they are automatically mapped as traits.
+
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 63: Line 65:
 
|anchor=LocalTraitsMapper
 
|anchor=LocalTraitsMapper
 
|alignment=Vertical
 
|alignment=Vertical
|structuredtext=In addition to {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper#GlobalTraitsMapper|display text=mapping traits globally,}} you can map specific traits locally 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.}}
+
|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 mapped traits and locally mapped traits. For example, suppose you map the email address field via the global traits mapper, but on one page, you ask for the customer's Facebook ID. In this case, both the email address and the Facebook ID are mapped to the customer and both appear in the customer's Live Now profile.  
+
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 Facebook ID. Both the email address and the Facebook ID map to the customer and both appear in the customer's Live Now profile.  
  
If the same data is captured in two places, the most recent trait mapped appears in Live Now. Previous values for mapped traits are not preserved.
+
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 that are mapped traits. Specifically:
+
|structuredtext=The following examples show how to map attributes as traits. Specifically:
  
*The attributes, "email" and "emailAdddress" are mapped to the trait "email."
+
*The attributes, "email" and "emailAdddress" map to the trait "email."
*The attributes, "gender" and "sex" are mapped to the trait "gender."
+
*The attributes, "gender" and "sex" map to the trait "gender."
  
 
[[File:TMExTraits.png|left|frameless|1451x1451px]]
 
[[File:TMExTraits.png|left|frameless|1451x1451px]]
Line 84: Line 86:
 
|anchor=TraitsTrackingMethods
 
|anchor=TraitsTrackingMethods
 
|alignment=Vertical
 
|alignment=Vertical
|structuredtext=Traits mapping can occur whenever there is a tracked event on your website. Specifically, events are tracked when you use the following methods:
+
|structuredtext=Traits mapping can occur whenever there is a tracked event on your web site. Specifically, {{MintyDocsProduct}} tracks events when you use the following methods:
  
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Init}}
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Init}}

Revision as of 18:36, December 16, 2020

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

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 or gender. Genesys Predictive Engagement gathers customer traits every time a customer visits a web site that you track with the Genesys Predictive Engagement tracking snippet. It's possible to have multiple customer records for the same person. For example, if a customer visits your web site 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.

Important
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 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 > Admin menu > Live Now > Customer summary (admin view)
  • Agent user interface > Journey gadget > [[ATC/Current/AgentGuide/Customer_details|]]

Map traits globally

To start mapping traits, define a global traits mapper when you deploy the Genesys Predictive Engagement tracking snippet on your web site. 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": "emailAdddress",
        "traitName": "email"
      }, {
        "fieldName": "sex",
        "traitName": "gender"
      }
    ]
  });
  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 Facebook ID. Both the email address and the Facebook ID 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 "emailAdddress" map to the trait "email."
  • The attributes, "gender" and "sex" map to the trait "gender."
TMExTraits.png


Methods that track events

Traits mapping can occur whenever there is a tracked event on your web site. Specifically, Genesys Predictive Engagement tracks events when you use the following methods:

Mappable traits

Demographic traits

Trait Example
gender male
birthDate 01012001

Company traits

Trait Example
companyName Genesys
dunsNumber 622286318
industry Technology
numberofEmployees 5025

ID traits

Trait Example
email JTS1715@gmail.com
facebookId JTSmith1715
messengerId John.Smith .1715
twitterId @JTS1715
telegramId 123456789

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
displayName John
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Traits_mapper (2024-07-28 01:16:58)"
Comments or questions about this documentation? Contact us for support!