Difference between revisions of "Draft: ATC/Current/SDK/Web chat lifecycle"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
 
Line 6: Line 6:
 
|Dimension=WebActions
 
|Dimension=WebActions
 
|ComingSoon=No
 
|ComingSoon=No
|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Web chat lifecycle
 
|sectionHeading=Web chat lifecycle
 
|anchor=WebchatLifecycle
 
|anchor=WebchatLifecycle
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
+
|structuredtext=The following diagram shows the stages that occur during the lifecycle of {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Chat_offers|display text=web chats}} after they are offered to customers. Subsequent sections provide details about specific states, including the events that can occur and the data that is available for use with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=WebActionMethods|display text=Events methods for web actions}}. The section, {{Link-SomewhereInThisVersion|manual=SDK|topic=Web_chat_lifecycle|anchor=Terminal|display text=Terminal states}}, explains how states ensure that customers do not repeatedly see the same offer to chat.
|image=
+
 
|structuredtext=The following diagram shows the stages that occur during the lifecycle of {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Chat_offers|display text=web chats}}. Subsequent sections provide details about specific states, including the events that can occur and the data that is available for use with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=WebActionMethods|display text=Events methods for web actions}}. The section, {{Link-SomewhereInThisVersion|manual=SDK|topic=Web_chat_lifecycle|anchor=Terminal|display text=Terminal states}}, explains how states ensure that customers do not repeatedly see the same offer to chat.
+
For information about how web chats are offered, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Overview_action_maps|anchor=AMOffered|display text=Offered action maps}}.
 +
 
 
[[File:Lifecycle.png]]
 
[[File:Lifecycle.png]]
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 23: Line 21:
 
|anchor=1ChatInvite
 
|anchor=1ChatInvite
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=[[File:1ChatInvite.png|frameless|346x346px]]
 
|structuredtext=[[File:1ChatInvite.png|frameless|346x346px]]
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
Line 67: Line 63:
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 74: Line 68:
 
|anchor=2ChatForm
 
|anchor=2ChatForm
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=[[File:2ChatForm.png|none|frameless|351x351px]]
 
|structuredtext=[[File:2ChatForm.png|none|frameless|351x351px]]
 
<br />
 
<br />
Line 89: Line 81:
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 96: Line 86:
 
|anchor=3ChatWindow
 
|anchor=3ChatWindow
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=[[File:3ChatWindowPreAgent.png|none|frameless|471x471px]]
 
|structuredtext=[[File:3ChatWindowPreAgent.png|none|frameless|471x471px]]
 
<br />
 
<br />
Line 117: Line 105:
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 124: Line 110:
 
|anchor=AgentConnected
 
|anchor=AgentConnected
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=[[File:4AgentConnected.png|none|frameless|471x471px]]
 
|structuredtext=[[File:4AgentConnected.png|none|frameless|471x471px]]
 
<br />
 
<br />
Line 139: Line 123:
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 146: Line 128:
 
|anchor=5ChatCompletion
 
|anchor=5ChatCompletion
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=[[File:5ChatCompletion.png|none|frameless|471x471px]]
 
|structuredtext=[[File:5ChatCompletion.png|none|frameless|471x471px]]
 
<br />
 
<br />
Line 162: Line 142:
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=Event types for web actions}}.
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 169: Line 147:
 
|anchor=Terminal
 
|anchor=Terminal
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=In the web chat lifecycle, certain states are considered ''terminal'', or final, states. If a customer navigates to a web page where an action map is set to trigger a web chat, the action map will not offer the web chat if it is already in a terminal state. This ensures that a customer does not receive the same offer to chat after the customer has already accepted the offer or has indicated that they are not interested in that particular chat offer.   
 
|structuredtext=In the web chat lifecycle, certain states are considered ''terminal'', or final, states. If a customer navigates to a web page where an action map is set to trigger a web chat, the action map will not offer the web chat if it is already in a terminal state. This ensures that a customer does not receive the same offer to chat after the customer has already accepted the offer or has indicated that they are not interested in that particular chat offer.   
  
Line 182: Line 158:
  
 
For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Trigger}}.
 
For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Trigger}}.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 189: Line 163:
 
|anchor=ReportMetricsEvents
 
|anchor=ReportMetricsEvents
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=The metrics used in the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_Map_Performance|display text=Action Map Performance report}} metrics correlate directly with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=event types for web actions}}. For more information about metrics for web chats, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Chat_offers|anchor=WCMonitor|display text=Monitor a web chat's performance}}.
 
|structuredtext=The metrics used in the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_Map_Performance|display text=Action Map Performance report}} metrics correlate directly with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=event types for web actions}}. For more information about metrics for web chats, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Chat_offers|anchor=WCMonitor|display text=Monitor a web chat's performance}}.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 18:26, July 31, 2020

This is a draft page; the published version of this page can be found at ATC/Current/SDK/Web chat lifecycle.
This topic is part of the manual Journey JavaScript SDK for version Current of Altocloud.

See the lifecycle of a web chat and the metrics that we capture at each state along the way. Lifecycle states are used in reporting and in determining the triggering behavior of action maps that use web chats.

Web chat lifecycle

The following diagram shows the stages that occur during the lifecycle of web chats after they are offered to customers. Subsequent sections provide details about specific states, including the events that can occur and the data that is available for use with the Events methods for web actions. The section, Terminal states, explains how states ensure that customers do not repeatedly see the same offer to chat.

For information about how web chats are offered, see Offered action maps.

Lifecycle.png

1. Web chat invitation

1ChatInvite.png

State Event Description Data collected
offered Web Actions Offered The customer's activity has qualified an action map, and a proactive invitation is offered. See Event types for web actions.
accepted Web Actions Accepted The customer accepts the invitation by clicking a button like, Yes, please. See Event types for web actions.
rejected Web Actions Rejected The customer rejects the invitation by either clicking X or a button like, No, but thank you. This is a terminal state. See Event types for web actions.
errored Web Actions Errored An error occurred in the widget that prevented the engagement from occurring.

Note: This event does not have a corresponding metric in the Action Map Performance Report.

See Event types for web actions.

In addition, the errorMessage field is available.

ignored Web Actions Ignored The customer has ignored the invitation by navigating away from or around it. This is a terminal state.

Note: This event does not have a corresponding metric in the Action Map Performance Report.

See Event types for web actions.


timed out Web Actions Timed Out The timeout period has been reached and the invitation has been rescinded. This is a terminal state.

Note: This event does not have a corresponding metric in the Action Map Performance Report. The timeout period is configurable via the widget.

See Event types for web actions.

2. Web chat form

2ChatForm.png


State Event Description Data collected
rejected Web Actions Rejected The customer cancels the form by either clicking X or a button like Cancel. This is a terminal state. See Event types for web actions.

3. Web chat window: before agent connects

3ChatWindowPreAgent.png


State Event Description Data collected
started Web Actions Started After the customer submits the form, a chat interaction is initated. See Event types for web actions.


abandoned Web Actions Abandoned The customer closes the chat window before an agent connects. This is a terminal state. See Event types for web actions.

4 Web chat window: after agent connects

4AgentConnected.png


State Event Description Data collected
engaged Web Actions Engaged An agent accepts the chat and is connected with the customer. This is a terminal state. See Event types for web actions.

5. Web chat completion

5ChatCompletion.png


State Event Description Data collected
Not applicable/Not tracked Not applicable/Not tracked Either the customer or the agent ends the chat.

Note: This event does not have a corresponding metric in the Action Map Performance Report.

See Event types for web actions.

Terminal states for web chats

In the web chat lifecycle, certain states are considered terminal, or final, states. If a customer navigates to a web page where an action map is set to trigger a web chat, the action map will not offer the web chat if it is already in a terminal state. This ensures that a customer does not receive the same offer to chat after the customer has already accepted the offer or has indicated that they are not interested in that particular chat offer.

Terminal states for web chats are:

  • Engaged
  • Rejected
  • Timed out
  • Ignored
  • Abandoned

For more information, see Trigger an action map.

Report metrics and events

The metrics used in the Action Map Performance report metrics correlate directly with the event types for web actions. For more information about metrics for web chats, see Monitor a web chat's performance.