WID/Current/SDK/StatsService-combined - Revision history

Chrissyforrest: Published

2020-10-22T22:00:05Z

Published

Chrissyforrest: Published

2020-07-30T21:42:39Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:37:10Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:51:05Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

2020-06-02T17:17:01Z

Published

Chrissyforrest: Published

2020-06-02T17:09:35Z

Published

Chrissyforrest: Published

2020-05-22T16:38:26Z

Published

Show changes

Chrissyforrest: Published

2020-04-09T21:52:56Z

Published

WikiSysop at 13:49, January 17, 2020

2020-01-17T13:49:17Z

Mgionet: Published

2019-09-06T18:16:28Z

Published

New page

{{Article
|Standalone=No
|DisplayName=StatsService
|Role=Developer
|TocName=StatsService
|Platform=PureEngage
|ComingSoon=No
|Context=Learn how to fetch estimated wait time (EWT) details for a channel.
|Section={{Section
|Type=Structured
|sectionHeading=Overview
|alignment=Vertical
|structuredtext=StatsService exposes high-level API access to Genesys statistics services, allowing you to fetch estimated wait time (EWT) details for each channel, such as Chat or Callback, and display these details across the channels.
===Usage===
StatsService and the Channel Selector widget work together right out of the box to display Estimated Wait Time details across all channels. Using Channel Selector uses StatsService.

You can also use StatsService as a high-level API with bus commands and events and integrate in your own widget.
===Namespace===
The Stats Service plugin has the following namespaces tied up with each of the following types:
{{{!}} class="wikitable"
{{!}}-
!{{!}}Type
!{{!}}Namespace
{{!}}-
{{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=config|display text=Configuration}}
{{!}}{{!}}stats
{{!}}-
{{!}}{{!}}CXBus—{{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=commands|display text=API commands}} & {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=events|display text=API events}}
{{!}}{{!}}StatsService
{{!}}}

===Customization===
StatsService doesn't have any customization options. It is a plug-and-play plugin and works as is.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Configuration
|anchor=config
|alignment=Vertical
|structuredtext====Description===
StatsService shares the '''_genesys.widgets.stats''' configuration namespace and has connection settings to fetch EWT details from each channel.

===Example===
<pre> window._genesys.widgets.stats = { ajaxTimeout: 3000, ewt: { dataURL: 'http://10.0.0.121:7777/genesys/1/service/ewt-for-vq', apikey: 'n3exxxxxXREBMYjGxxxx8VA', apiVersion: 'v1', mode: 'urs2' } }; </pre>

{{AnchorDiv|configoptions}}
===Options===

{{{!}} class="wikitable"
{{!}}-
!{{!}}Name
!{{!}}Type
!{{!}}Description
!{{!}}Default
!{{!}}Required
!{{!}}Accepted Values
{{!}}-
{{!}}{{!}}ajaxTimeout
{{!}}{{!}}number
{{!}}{{!}}Number of milliseconds to wait before AJAX timeout
{{!}}{{!}}3000
{{!}}{{!}}n/a
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}ewt.apikey
{{!}}{{!}}string
{{!}}{{!}}Apigee Proxy secure token. If apiVersion is v3, this holds the x-api-key value.
{{!}}{{!}}n/a
{{!}}{{!}}Yes, if using Apigee Proxy. or v3 API.
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}ewt.dataURL
{{!}}{{!}}URL String
{{!}}{{!}}URL to the API endpoint for Estimated Wait Time (EWT)
{{!}}{{!}}Always
{{!}}{{!}}n/a
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}ewt.apiVersion
{{!}}{{!}}string
{{!}}{{!}}Version of EWT API.

'''Note:''' This value determines the version of EWT API in GMS/v3. That is:
'v1' - GMS EWT v1
'v2' - GMS EWT v2
'v3' - [https://developer.genesyscloud.com/reference/engagement/Estimated-Wait-Time/index.html EWT v3]

Only GET request type with virtual queue name as query parameters are supported.
{{!}}{{!}}'v1'
{{!}}{{!}}Yes, if using GMS EWT v2 or [https://developer.genesyscloud.com/reference/engagement/Estimated-Wait-Time/index.html EWT v3] dataURL
{{!}}{{!}}'v1', 'v2', 'v3'
{{!}}-
{{!}}{{!}}ewt.mode
{{!}}{{!}}string
{{!}}{{!}}EWT mode parameter for GMS/v3 API. This value will vary based on the above apiVersion.
{{!}}{{!}}Will vary based on the above apiVersion as shown below.

'urs2' for 'v1'
'ewt2' for 'v2'
'mode2' for 'v3'
{{!}}{{!}}n/a
{{!}}{{!}}
'urs','urs2' or 'stat' for 'v1'

'ewt1,'ewt2' or 'ewt3' for 'v2'

'mode1','mode2' or 'mode3' for 'v3'
{{!}}}
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Localization
|anchor=localize
|alignment=Vertical
|structuredtext=StatsService doesn't have any localization options.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=API Commands
|anchor=commands
|alignment=Vertical
|structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.

{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}

<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.command('StatsService.getStats');</source>
===configure===
Internal use only. The main App plugin shares configuration settings to widgets using each widget’s configure command. The configure command can only be called once at startup. Calling configure again after startup may result in unpredictable behavior.
====Example====
<source lang='javascript'>
oMyPlugin.command('StatsService.configure', {

ewt:{

apikey: '12345',
dataURL: 'http://localhost:8080/foo/bar'
},
ajaxTimeout: 10000

}).done(function(e){

// StatsService configured successfully

}).fail(function(e){

// StatsService failed to configure
});
</source>

====Options====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Option
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}ewt.apikey
{{!}}{{!}}string
{{!}}{{!}}API access token. Please contact your Genesys representative to obtain your API access token.
{{!}}-
{{!}}{{!}}ewt.dataURL
{{!}}{{!}}URL String
{{!}}{{!}}URL of GMS server
{{!}}-
{{!}}{{!}}ajaxTimeout
{{!}}{{!}}number
{{!}}{{!}}Number of milliseconds to wait before AJAX timeout.
{{!}}}

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When configuration options are provided and set
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When no configuration options are provided
{{!}}{{!}}'Invalid configuration'
{{!}}}

{{AnchorDiv|getStats}}
===getStats===
Ask the Genesys Stat server to fetch EWT details.
====Example====
<source lang='javascript'>
oMyPlugin.command('StatsService.getStats', {

group: 'EWT',
vqName: 'chat_ewt_test_eservices',
mode: 'urs2'

}).done(function(e){

// StatsService got stats successfully

}).fail(function(e){

// StatsService failed to get stats
});
</source>

====Options====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Option
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}group
{{!}}{{!}}string
{{!}}{{!}}Mention specific group name you would like to request like EWT, etc.
{{!}}-
{{!}}{{!}}vqname
{{!}}{{!}}string/array
{{!}}{{!}}Specify a single virtual queue name as a string or a list of virtual queue names as an array. EWT will be fetched only for these virtual queues specified here. If nothing is specified, EWT will be fetched for all the available virtual queues.
{{!}}-
{{!}}{{!}}mode
{{!}}{{!}}string
{{!}}{{!}}Specify EWT mode. This will vary based on {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=apiVersion}}. Refer to {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=mode}} configuration option for possible values.
{{!}}}

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When server returns EWT data
{{!}}{{!}}(AJAX Response Object)
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When server fail request fails
{{!}}{{!}}'EWT request failed due to unknown reason'
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When no EWT dataURL provided
{{!}}{{!}}'Invalid EWT configuration'
{{!}}}
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=API Events
|anchor=events
|alignment=Vertical
|structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.

{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}

<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.subscribe('StatsService.ready', function(e){});</source>
{{{!}} class="wikitable"
{{!}}-
!{{!}}Name
!{{!}}Description
!{{!}}Data
{{!}}-
{{!}}{{!}}ready
{{!}}{{!}}StatsService is initialized and ready to accept commands
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}updated
{{!}}{{!}}Latest Stats data is available
{{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=lookforewt|display text=EWT AJAX Response data}}
{{!}}-
{{!}}{{!}}error.ewt
{{!}}{{!}}An error occurred between the client and the server for EWT
{{!}}{{!}}{(AJAX data Response)}
{{!}}}
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Estimated Wait Time
|alignment=Vertical
|structuredtext=Estimated Wait Time (EWT) is displayed in the ChannelSelector, Callback and ClickToCall Widgets. These Widgets use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command to fetch EWT data from the GMS or GES server. These servers support multiple API versions and this document will explain how to configure the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=config|display text=StatsService}} plugin to use the version that you need.

Use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option to specify the API version. Each version value corresponds to a particular API of GMS/GES. For all possible version values and their mapping, refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=description}} section of the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option.

Sample configuration:
<source lang="JAVASCRIPT">
_genesys.widgets.stats.ewt.apiVersion = <version value>
</source>
===API Versions===
====v1====
If {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} is configured to '''v1''' (this is also the default value), the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.dataURL}} configured must be a valid GMS 8.5.1 EWT API url. If not, an incorrect EWT value might be displayed.

Depending on this API version, the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.mode}} configuration option can hold a set of predefined possible values for this version. They are 'urs', 'urs2' and 'stat', where 'urs2' is the default value if not specified.

'''Default Example'''

<source lang="JAVASCRIPT">
_genesys.widgets.stats = {
ewt: {
apiVersion: "v1"
dataURL: http://somedomain/genesys/1/service/ewt-for-vq
mode: "urs2"
}
}
</source>

For the above configuration, the StatsService plugin will construct the relevant dataURL as shown below.

<source lang="JAVASCRIPT">
http://somedomain/genesys/1/service/ewt-for-vq?name=vq1&aqt=urs2
</source>

'vq1' is added to the URL via the '''vqName''' option passed into the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command.
====v2====
If {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} is configured to '''v2''', the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.dataURL}} configured must be a valid GMS 8.5.2 EWT API url. If not, incorrect EWT may be displayed. For this apiVersion, the possible values for {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.mode}} are 'ewt1', 'ewt2' and 'ewt3'. 'ewt2' is the default value.

'''Example'''

<source lang="JAVASCRIPT">
_genesys.widgets.stats = {
ewt: {
apiVersion: "v2"
dataURL: http://somedomain/genesys/2/ewt
mode: "ewt2"
}
}
</source>

For the above configuration, the StatsService plugin will construct the relevant dataURL as shown below.

<source lang="JAVASCRIPT">
http://somedomain/genesys/2/ewt/ewt2?vq=vq1,vq2
</source>

'vq1' and 'vq2' are added to the URL via the '''vqName''' option passed into the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command.
====v3====
If {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} is set to '''v3''', the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.dataURL}} configured must be a valid [https://developer.genesyscloud.com/reference/engagement/Estimated-Wait-Time/index.html GES EWT API url]. If not, incorrect EWT may be displayed. For this apiVersion, the possible values for {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.mode}} are 'mode1', 'mode2' and 'mode3', where 'mode2' will be the default value if not specified.

'''Example'''

<source lang="JAVASCRIPT">
_genesys.widgets.stats = {
ewt: {
apiVersion: "v3"
dataURL: http://somedomain/engagement/v3/estimated-wait-time
mode: "mode2"
}
}
</source>

For the above configuration, the StatsService plugin will construct the relevant dataURL as shown below.

<source lang="JAVASCRIPT">
http://somedomain/engagement/v3/estimated-wait-time?virtual-queues=vq1,vq2&mode=mode2
</source>

'vq1' and 'vq2' are added to the URL via the '''vqName''' option passed into the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command.
{{AnchorDiv|lookforewt}}
===Where to look for EWT data===
When the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command is called, it fetches the EWT data from either GMS/GES server based on the configuration. This response data is included in the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=events|display text=updated event}} in a standard format as shown below. In this data format, the '''ewt''' section will contain the virtual queue name and the estimated wait time as a key value pair. The '''response''' section contains the original raw data from the server and may vary between each server API.

<source lang="JAVASCRIPT">
{
ewt: {

"VQ_GMS_Callback_Out": 9.999 // consolidated standardized EWT data for each virtual queue.
"VQ_GMS_Callback": 5.12
...
},
response: { // Original raw data from GMS.

"VQ_GMS_Callback_Out": {
"time": 1506021728,
"wt": 0,
"calls": 0,
"wcalls": 0,
"pos": 1,
"wpos": 1,
"aqt": 9.999,
"ewt": 9.999,
"hit": 0
},
"VQ_GMS_Callback": {
...
}
}
}
</source>
|advanced=No
|Status=No
}}
}}

@@ Line 131: / Line 131: @@
 |structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.
-{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
+{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
 <source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
@@ Line 269: / Line 269: @@
 |structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.
-{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
+{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
 <source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
@@ Line 299: / Line 299: @@
 |structuredtext=Estimated wait time (EWT) is displayed in the ChannelSelector and Callback widgets. These widgets use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command to fetch EWT data from the GMS or GES server. These servers support multiple API versions and this document will explain how to configure the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=config|display text=StatsService}} plugin to use the version that you need.
-Use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option to specify the API version. Each version value corresponds to a particular API of GMS/GES. For all possible version values and their mapping, refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=description}} section of the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option.
+Use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option to specify the API version. Each version value corresponds to a particular API of GMS/GES. For all possible version values and their mapping, refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=Description}} section of the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option.
 Sample configuration:

@@ Line 5: / Line 5: @@
 |Context=Learn how to fetch estimated wait time (EWT) details for a channel.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

@@ Line 15: / Line 15: @@
 |structuredtext=StatsService exposes high-level API access to Genesys statistics services, allowing you to fetch estimated wait time (EWT) details for each channel, such as WebChat or Callback, and display these details across the channels.
 ===Usage===
-StatsService and the Channel Selector widget work together right out of the box to display EWT details across all channels.
+StatsService and the Channel Selector widget work together right out of the box to display EWT details across all channels. Using the Channel Selector widget uses StatsService.
 You can also use StatsService as a high-level API with bus commands and events and integrate in your own widget.
@@ Line 32: / Line 32: @@
 {{!}}}
-=== Customization ===
+===Customization===
 StatsService doesn't have any customization options. It is a plug-and-play plugin and works as is.
 |structuredtextwide=

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
-|Prereq=
+|Role=Developer
 |Section={{Section
 |sectionHeading=Overview
 |alignment=Vertical
 |structuredtext=StatsService exposes high-level API access to Genesys statistics services, allowing you to fetch estimated wait time (EWT) details for each channel, such as WebChat or Callback, and display these details across the channels.
 ===Usage===
@@ Line 34: / Line 31: @@
 ===Customization===
 StatsService doesn't have any customization options. It is a plug-and-play plugin and works as is.
 |Status=No
 }}{{Section
@@ Line 41: / Line 36: @@
 |anchor=config
 |alignment=Vertical
 |structuredtext====Description===
 StatsService shares the '''_genesys.widgets.stats''' configuration namespace and has connection settings to fetch EWT details from each channel.
@@ Line 125: / Line 118: @@
 {{!}}-
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 132: / Line 123: @@
 |anchor=localize
 |alignment=Vertical
 |structuredtext=StatsService doesn't have any localization options.
 |Status=No
 }}{{Section
-|sectionHeading=API Commands
+|sectionHeading=API commands
 |anchor=commands
 |alignment=Vertical
 |structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.
@@ Line 277: / Line 262: @@
 {{!}}{{!}}'Invalid EWT configuration'
 {{!}}}
 |Status=No
 }}{{Section
-|sectionHeading=API Events
+|sectionHeading=API events
 |anchor=events
 |alignment=Vertical
 |structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.
@@ Line 311: / Line 292: @@
 {{!}}{{!}}{(AJAX data Response)}
 {{!}}}
 |Status=No
 }}{{Section
-|sectionHeading=Estimated Wait Time
+|sectionHeading=Estimated wait time
 |anchor=ewt
 |alignment=Vertical
 |structuredtext=Estimated wait time (EWT) is displayed in the ChannelSelector and Callback widgets. These widgets use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command to fetch EWT data from the GMS or GES server. These servers support multiple API versions and this document will explain how to configure the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=config|display text=StatsService}} plugin to use the version that you need.
@@ Line 328: / Line 305: @@
 _genesys.widgets.stats.ewt.apiVersion = <version value>
 </source>
-===API Versions===
+===API versions===
 ====v1====
 If {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} is configured to '''v1''' (this is also the default value), the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.dataURL}} configured must be a valid GMS 8.5.1 EWT API url. If not, an incorrect EWT value might be displayed.
@@ Line 334: / Line 311: @@
 Depending on this API version, the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.mode}} configuration option can hold a set of predefined possible values for this version. They are 'urs', 'urs2' and 'stat', where 'urs2' is the default value if not specified.
-'''Default Example'''
+'''Default example'''
 <source lang="JAVASCRIPT">
@@ Line 428: / Line 405: @@
+}
 </source>
 |Status=No
 }}
 }}

@@ Line 13: / Line 13: @@
 |Media=
 |image=
-|structuredtext=StatsService exposes high-level API access to Genesys statistics services, allowing you to fetch estimated wait time (EWT) details for each channel, such as Chat or Callback, and display these details across the channels.
+|structuredtext=StatsService exposes high-level API access to Genesys statistics services, allowing you to fetch estimated wait time (EWT) details for each channel, such as WebChat or Callback, and display these details across the channels.
 ===Usage===
-StatsService and the Channel Selector widget work together right out of the box to display EWT details across all channels. Using Channel Selector uses StatsService.
+StatsService and the Channel Selector widget work together right out of the box to display EWT details across all channels.
 You can also use StatsService as a high-level API with bus commands and events and integrate in your own widget.
 ===Namespace===
-The Stats Service plugin has the following namespaces tied up with each of the following types:
+The StatsService plugin has the following namespaces, tied to each of the following types:
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 32: / Line 32: @@
 {{!}}}
 === Customization ===
 StatsService doesn't have any customization options. It is a plug-and-play plugin and works as is.
 |structuredtextwide=
@@ Line 153: / Line 152: @@
 oMyPlugin.command('StatsService.getStats');</source>
 ===configure===
-Internal use only. The main App plugin shares configuration settings to widgets using each widget’s configure command. The configure command can only be called once at startup. Calling configure again after startup may result in unpredictable behavior.
+This is for internal use only. The main App plugin shares configuration settings to widgets using each widget’s configure command. The configure command can only be called once at startup. Calling configure again after startup may result in unpredictable behavior.
 ====Example====
 <source lang="javascript">
@@ Line 190: / Line 189: @@
 {{!}}{{!}}ewt.dataURL
 {{!}}{{!}}URL String
-{{!}}{{!}}URL of GMS server
+{{!}}{{!}}URL of GES server.
 {{!}}-
 {{!}}{{!}}ajaxTimeout
@@ Line 207: / Line 206: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}Configuration options are provided and set
+{{!}}{{!}}Configuration options are provided and set.
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}No configuration options are provided
+{{!}}{{!}}No configuration options are provided.
 {{!}}{{!}}'Invalid configuration'
 {{!}}}
@@ Line 247: / Line 246: @@
 {{!}}{{!}}group
 {{!}}{{!}}string
-{{!}}{{!}}Mention specific group name you would like to request like EWT, etc.
+{{!}}{{!}}Mention specific group name you would like to request, such as EWT, etc.
 {{!}}-
 {{!}}{{!}}vqname
@@ Line 267: / Line 266: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}Server returns EWT data
+{{!}}{{!}}Server returns EWT data.
 {{!}}{{!}}(AJAX Response Object)
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}Server fail request fails
+{{!}}{{!}}Server fail request fails.
 {{!}}{{!}}'EWT request failed due to unknown reason'
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}No EWT dataURL provided
+{{!}}{{!}}No EWT dataURL provided.
 {{!}}{{!}}'Invalid EWT configuration'
 {{!}}}
@@ Line 301: / Line 300: @@
 {{!}}-
 {{!}}{{!}}ready
-{{!}}{{!}}StatsService is initialized and ready to accept commands
+{{!}}{{!}}StatsService is initialized and ready to accept commands.
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}updated
-{{!}}{{!}}Latest Stats data is available
+{{!}}{{!}}Latest Stats data is available.
 {{!}}{{!}}{{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=lookforewt|display text=EWT AJAX Response data}}
 {{!}}-
 {{!}}{{!}}error.ewt
-{{!}}{{!}}An error occurred between the client and the server for EWT
+{{!}}{{!}}An error occurred between the client and the server for EWT.
 {{!}}{{!}}{(AJAX data Response)}
 {{!}}}
@@ Line 317: / Line 316: @@
 }}{{Section
 |sectionHeading=Estimated Wait Time
-|anchor=
+|anchor=ewt
 |alignment=Vertical
 |Media=
 |image=
-|structuredtext=Estimated wait time (EWT) is displayed in the ChannelSelector, Callback and ClickToCall Widgets. These Widgets use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command to fetch EWT data from the GMS or GES server. These servers support multiple API versions and this document will explain how to configure the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=config|display text=StatsService}} plugin to use the version that you need.
+|structuredtext=Estimated wait time (EWT) is displayed in the ChannelSelector and Callback widgets. These widgets use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=getStats|display text=getStats}} command to fetch EWT data from the GMS or GES server. These servers support multiple API versions and this document will explain how to configure the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=config|display text=StatsService}} plugin to use the version that you need.
 Use the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option to specify the API version. Each version value corresponds to a particular API of GMS/GES. For all possible version values and their mapping, refer to the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=description}} section of the {{Link-SomewhereInThisVersion|manual=SDK|topic=StatsService-combined|anchor=configoptions|display text=ewt.apiVersion}} configuration option.

@@ Line 2: / Line 2: @@
 |Standalone=No
 |DisplayName=StatsService
 |TocName=StatsService
 |Platform=PureEngage

WID/Current/SDK/StatsService-combined - Revision history

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop at 13:49, January 17, 2020

Mgionet: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"