Difference between revisions of "ATC/Current/SDK/Display icons in the Journey gadget"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(10 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=Display icons in the Journey gadget
 
|DisplayName=Display icons in the Journey gadget
−
|Platform=PureEngage, PureConnect, PureCloud
 
 
|TocName=Display icons in the Journey gadget
 
|TocName=Display icons in the Journey gadget
 +
|Context=Learn how to use the SDK to display icons for tracked visitor behavior on the Journey map.
 +
|Dimension=DevTracking
 
|ComingSoon=No
 
|ComingSoon=No
−
|Context=Learn how to use the SDK to display icons for tracked user behavior on the Journey map .
+
|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 the icons
 
|sectionHeading=About the icons
−
|Type=Structured
 
 
|anchor=About icons
 
|anchor=About icons
 
|alignment=Horizontal
 
|alignment=Horizontal
 +
|Media=Image
 
|image=IconColors.png
 
|image=IconColors.png
−
|gif=No
+
|structuredtext=Use the <code>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record|display text=ac('record')}}</code> method to display a {{MINTYDOCSPRODUCT}} icon on the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Customer_journey_map}} when a visitor completes a tracked behavior.
−
|structuredtext=Use the <code>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record|display text=ac('record')}}</code> method to display an {{MINTYDOCSPRODUCT}} icon on the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Customer_journey_map}} when a user completes a tracked behavior:
 
  
 
===Available icons===
 
===Available icons===
Line 20: Line 24:
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Display_icons_in_the_Journey_gadget|anchor=FormIcons|display text=Form-related icons}}
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Display_icons_in_the_Journey_gadget|anchor=FormIcons|display text=Form-related icons}}
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Display_icons_in_the_Journey_gadget|anchor=JourneyIcons|display text=Journey-related icons}}
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=Display_icons_in_the_Journey_gadget|anchor=JourneyIcons|display text=Journey-related icons}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Code example
 
|sectionHeading=Code example
−
|Type=Unstructured
 
 
|anchor=IconExampleCode
 
|anchor=IconExampleCode
−
|freetext=[[File:ShoppingCartEx.png]]
+
|alignment=Vertical
 +
|structuredtext=[[File:ShoppingCartEx.png]]
  
−
This code example shows how to use <code>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record|display text=ac('record')}}</code> to display the {{Link-SomewhereInThisVersion|manual=SDK|topic=Display_icons_in_the_Journey_gadget|anchor=PurchaseIcons|display text=Product added}} icon in the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Customer_journey_map}} when a user adds a t-shirt to their shopping cart.<source lang="javascript">
+
This code example shows how to use <code>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record|display text=ac('record')}}</code> to display the {{Link-SomewhereInThisVersion|manual=SDK|topic=Display_icons_in_the_Journey_gadget|anchor=PurchaseIcons|display text=Product added}} icon in the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Customer_journey_map}} when a visitor adds a t-shirt to their shopping cart.<source lang="javascript">
 
ac('record', 'product_added', [optionalExtraDataObject]
 
ac('record', 'product_added', [optionalExtraDataObject]
−
ac('record', 'product_added', { name: 't-shirt', id: 'hkds9d8j', price: $45.45 });
+
ac('record', 'product_added', { name: 't-shirt', id: 'hkds9d8j', price: '$45.45' });
 
</source>
 
</source>
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Purchase-related icons
 
|sectionHeading=Purchase-related icons
−
|Type=Structured
 
 
|anchor=PurchaseIcons
 
|anchor=PurchaseIcons
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
 
 
|structuredtext=<br />
 
|structuredtext=<br />
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
Line 46: Line 47:
 
!Name
 
!Name
 
{{!}}-
 
{{!}}-
−
{{!}}[[File:Product added to cart.png|left|frameless|50x50px]]
+
{{!}}[[File:Product added to cart.png{{!}}left{{!}}frameless{{!}}50x50px]]
 
{{!}}Product added to cart
 
{{!}}Product added to cart
−
{{!}}The user added a product to their shopping cart.
+
{{!}}Visitor added a product to their shopping cart.
 
{{!}}"product_added"
 
{{!}}"product_added"
 
{{!}}-
 
{{!}}-
−
{{!}}[[File:Product removed from cart.png|left|frameless|50x50px]]
+
{{!}}[[File:Product removed from cart.png{{!}}left{{!}}frameless{{!}}50x50px]]
 
{{!}}Product removed from cart
 
{{!}}Product removed from cart
−
{{!}}The user removed a product from their shopping cart.
+
{{!}}Visitor removed a product from their shopping cart.
 
{{!}}"product_removed"
 
{{!}}"product_removed"
 
{{!}}-
 
{{!}}-
−
{{!}}[[File:Checkout successful.png|frameless|50x50px]]
+
{{!}}[[File:Checkout successful.png{{!}}frameless{{!}}50x50px]]
 
{{!}}Checkout complete
 
{{!}}Checkout complete
−
{{!}}The user completed the purchase of the items in their shopping cart.
+
{{!}}Visitor completed the purchase of the items in their shopping cart.
 
{{!}}"product_purchased"
 
{{!}}"product_purchased"
 
{{!}}}
 
{{!}}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Form-related icons
 
|sectionHeading=Form-related icons
−
|Type=Structured
 
 
|anchor=FormIcons
 
|anchor=FormIcons
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext={{NoteFormat|You can display the icons in this section using <code>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record|display text=ac('record')}} </code>or auto form tracking.|}}
−
|structuredtext={{NoteFormat|You can display the icons in this section via <code>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record|display text=ac('record')}} </code>or via auto form tracking.|}}
 
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
 
!Icon
 
!Icon
Line 76: Line 74:
 
!Name
 
!Name
 
{{!}}-
 
{{!}}-
−
{{!}}[[File:Form submitted.png|frameless|50x50px]]
+
{{!}}[[File:Form submitted.png{{!}}frameless{{!}}50x50px]]
 
{{!}}Form submitted
 
{{!}}Form submitted
−
{{!}}The user submitted a form.
+
{{!}}Visitor submitted a form.
 
{{!}}"form_submitted"
 
{{!}}"form_submitted"
 
{{!}}-
 
{{!}}-
−
{{!}}[[File:Form abandoned.png|frameless|50x50px]]
+
{{!}}[[File:Form abandoned.png{{!}}frameless{{!}}50x50px]]
 
{{!}}Form abandoned
 
{{!}}Form abandoned
−
{{!}}The user navigated away from a form before completing it.
+
{{!}}Visitor navigated away from a form before completing it.
 
{{!}}"form_abandoned"
 
{{!}}"form_abandoned"
 
{{!}}}
 
{{!}}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Miscellaneous icons
 
|sectionHeading=Miscellaneous icons
−
|Type=Structured
 
 
|anchor=MiscIcons
 
|anchor=MiscIcons
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
 
 
|structuredtext=<br />
 
|structuredtext=<br />
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
Line 101: Line 96:
 
!Name
 
!Name
 
{{!}}-
 
{{!}}-
−
{{!}}[[File:Search.png|left|frameless|50x50px]]
+
{{!}}[[File:Search.png{{!}}left{{!}}frameless{{!}}50x50px]]
 
{{!}}Searched
 
{{!}}Searched
−
{{!}}The user searched for the string shown in the tooltip.
+
{{!}}Visitor searched for the string shown in the tooltip.
 
{{!}}"search_performed"
 
{{!}}"search_performed"
 
{{!}}}
 
{{!}}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 21:28, November 9, 2021

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

Learn how to use the SDK to display icons for tracked visitor behavior on the Journey map.

Important
This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.

About the icons

Use the ac('record') method to display a Genesys Predictive Engagement icon on the Visit journey map (admin view) when a visitor completes a tracked behavior.

Available icons

Code example

ShoppingCartEx.png

This code example shows how to use ac('record') to display the Product added icon in the Visit journey map (admin view) when a visitor adds a t-shirt to their shopping cart.
ac('record', 'product_added', [optionalExtraDataObject]
ac('record', 'product_added', { name: 't-shirt', id: 'hkds9d8j', price: '$45.45' });

Purchase-related icons


Icon Tooltip text Description Name
Product added to cart.png
 Product added to cart Visitor added a product to their shopping cart. "product_added"
Product removed from cart.png
 Product removed from cart Visitor removed a product from their shopping cart. "product_removed"
Checkout successful.png Checkout complete Visitor completed the purchase of the items in their shopping cart. "product_purchased"

Form-related icons

Important
You can display the icons in this section using ac('record') or auto form tracking.
Icon Tooltip text Description Name
Form submitted.png Form submitted Visitor submitted a form. "form_submitted"
Form abandoned.png Form abandoned Visitor navigated away from a form before completing it. "form_abandoned"

Miscellaneous icons


Icon Tooltip text Description Name
Search.png
 Searched Visitor searched for the string shown in the tooltip. "search_performed"
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Display_icons_in_the_Journey_gadget (2025-06-23 20:25:14)"
Comments or questions about this documentation? Contact us for support!