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

Monique.gionet@genesys.com: Published

2021-10-12T13:14:06Z

Published

Chrissyforrest: Published

2020-10-26T20:09:08Z

Published

Chrissyforrest: Published

2020-07-29T13:48:35Z

Published

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

2020-07-25T02:37:48Z

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

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

2020-07-15T11:49:21Z

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

Chrissyforrest: Published

2020-04-09T22:15:36Z

Published

Chrissyforrest: Published

2020-01-27T20:42:29Z

Published

WikiSysop at 13:48, January 17, 2020

2020-01-17T13:48:53Z

Mgionet: Published

2019-09-06T18:16:29Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Console
|Role=Developer
|TocName=Console
|Platform=PureEngage
|ComingSoon=No
|Context=Learn how to debug commands and events on the widget bus.
|Section={{Section
|Type=Structured
|sectionHeading=Overview
|alignment=Vertical
|structuredtext=Use the Console Widget to debug commands and events on the widget bus. You can use dynamically populated lists to test, debug, or demo all of the commands. You can also create event watchlists that alert you when an event has fired.

[[File:Console_Main.png|600px|Console example]]

Console provides an easy-to-use interface for debugging the widget bus that compliments the standard command line methods. You can drag and drop the console anywhere on your screen and when you refresh the page or move to another one, Console reappears right where you left it, as you left it. It is a great tool for getting to know the widget bus, the API for each widget, and debugging issues.
===Usage===
Launch WebChat manually by using the following methods:
* Call the '''Console.open''' command
* Configure the settings to show Console when the browser window is opened.
* Create your own custom button or link to open Console (using the "Console.open" command)
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Configuration
|alignment=Vertical
|structuredtext====Description===
Console option to open on initial loading.

===Example===
<pre>
window._genesys.widgets.console = {open: true};
</pre>

===Options===

{{{!}} class="wikitable"
{{!}}-
!{{!}}Name
!{{!}}Type
!{{!}}Description
!{{!}}Default
!{{!}}Required
{{!}}-
{{!}}{{!}}open
{{!}}{{!}}boolean
{{!}}{{!}}Set to true for console to open at start.
{{!}}{{!}}false
{{!}}{{!}}false
{{!}}}
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Localization
|alignment=Vertical
|structuredtext=Console doesn't have any localization options.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=API 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('Console.open');</source>
===open===
Opens the Console UI.
====Example====
<source lang='javascript'>
oMyPlugin.command('Console.open').done(function(e){

// Console opened successfully

}).fail(function(e){

// Console failed to open
});
</source>

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When Console is successfully opened
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When Console is already open
{{!}}{{!}}'Already opened'
{{!}}}

===close===
Closes the Console UI.
====Example====
<source lang='javascript'>
oMyPlugin.command('Console.close').done(function(e){

// Console closed successfully

}).fail(function(e){

// Console failed to close
});
</source>

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When Console successfully closed
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When Console is already closed
{{!}}{{!}}'Already closed'
{{!}}}

===configure===
Modifies the Console configuration options. See the Console configuration page.
====Example====
<source lang='javascript'>
oMyPlugin.command('Console.configure', {

open: false

}).done(function(e){

// Console configured successfully

}).fail(function(e){

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

====Options====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Option
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}open
{{!}}{{!}}boolean
{{!}}{{!}}If setting is open: true, the console will automatically be open when widgets is launched and the console is ready.
{{!}}}

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When Console configuration is provided
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When no configuration provided
{{!}}{{!}}'Invalid Configuration'
{{!}}}
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=API 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('Console.ready', function(e){});</source>
{{{!}} class="wikitable"
{{!}}-
!{{!}}Name
!{{!}}Description
!{{!}}Data
{{!}}-
{{!}}{{!}}ready
{{!}}{{!}}Console is initialized and ready to accept commands.
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}opened
{{!}}{{!}}The Console widget has appeared on screen.
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}closed
{{!}}{{!}}The Console widget has been removed from the screen.
{{!}}{{!}}n/a
{{!}}}
|advanced=No
|Status=No
}}
}}

@@ Line 13: / Line 13: @@
 |structuredtext=Use the Console Widget to debug commands and events on the widget bus. You can use dynamically populated lists to test, debug, or demo all commands. You can also create event watch lists that alert you when an event has fired.
-[[File:Console_Main.png|500px|Console example]]
+[[File:Console_Main.png|500px|alt=the Console Widget in dark theme used for or debugging the widget bus]]
 Console provides an easy-to-use interface for debugging the widget bus that complements the standard command-line methods. You can drag and drop the console anywhere on your screen, and when you refresh the page or move to another one, Console reappears right where you left it. It is a great tool for getting to know the widget bus, the API for each widget, and debugging issues.

@@ Line 9: / Line 9: @@
 |Section={{Section
 |sectionHeading=Overview
 |alignment=Vertical
-|structuredtext=Use the Console Widget to debug commands and events on the widget bus. You can use dynamically populated lists to test, debug, or demo all of the commands. You can also create event watch lists that alert you when an event has fired.
+|structuredtext=Use the Console Widget to debug commands and events on the widget bus. You can use dynamically populated lists to test, debug, or demo all commands. You can also create event watch lists that alert you when an event has fired.
 [[File:Console_Main.png|500px|Console example]]
-Console provides an easy-to-use interface for debugging the widget bus that complements the standard command line methods. You can drag and drop the console anywhere on your screen, and when you refresh the page or move to another one, Console reappears right where you left it, as you left it. It is a great tool for getting to know the widget bus, the API for each widget, and debugging issues.
+Console provides an easy-to-use interface for debugging the widget bus that complements the standard command-line methods. You can drag and drop the console anywhere on your screen, and when you refresh the page or move to another one, Console reappears right where you left it. It is a great tool for getting to know the widget bus, the API for each widget, and debugging issues.
 ===Usage===
 Launch WebChat manually by using the following methods:
-*Call the '''Console.open''' command
+*Call the '''Console.open''' {{Link-SomewhereInThisVersion|manual=SDK|topic=Console-combined|anchor=commands|display text=command}}
 *Configure the settings to show Console when the browser window is opened.
-*Create your own custom button or link to open Console (using the "Console.open" command)
+*Create your own custom button or link to open Console (using the '''Console.open''' {{Link-SomewhereInThisVersion|manual=SDK|topic=Console-combined|anchor=commands|display text=command}})
 |Status=No
 }}{{Section
 |sectionHeading=Configuration
 |alignment=Vertical
 |structuredtext====Description===
@@ Line 52: / Line 54: @@
 }}{{Section
 |sectionHeading=Localization
 |alignment=Vertical
 |structuredtext={{NoteFormat|For information on how to set up localization, please refer to {{Link-AnywhereElse|product=WID|version=Current|manual=Developer|topic=GWCInternat}}.|1}}
@@ Line 73: / Line 76: @@
 |Status=No
 }}{{Section
-|sectionHeading=API Commands
+|sectionHeading=API 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}}
+{{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-AnywhereElse|product=WID|version=Current|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 196: / Line 200: @@
 |Status=No
 }}{{Section
-|sectionHeading=API Events
+|sectionHeading=API 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}}
+{{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-AnywhereElse|product=WID|version=Current|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 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Overview
@@ Line 13: / Line 14: @@
 [[File:Console_Main.png|500px|Console example]]
-Console provides an easy-to-use interface for debugging the widget bus that compliments the standard command line methods. You can drag and drop the console anywhere on your screen and when you refresh the page or move to another one, Console reappears right where you left it, as you left it. It is a great tool for getting to know the widget bus, the API for each widget, and debugging issues.
+Console provides an easy-to-use interface for debugging the widget bus that complements the standard command line methods. You can drag and drop the console anywhere on your screen, and when you refresh the page or move to another one, Console reappears right where you left it, as you left it. It is a great tool for getting to know the widget bus, the API for each widget, and debugging issues.
 ===Usage===
 Launch WebChat manually by using the following methods:
@@ Line 104: / Line 105: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When Console is successfully opened
+{{!}}{{!}}Console is successfully opened
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When Console is already open
+{{!}}{{!}}Console is already open
 {{!}}{{!}}'Already opened'
 {{!}}}
@@ Line 136: / Line 137: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When Console successfully closed
+{{!}}{{!}}Console successfully closed
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When Console is already closed
+{{!}}{{!}}Console is already closed
 {{!}}{{!}}'Already closed'
 {{!}}}
@@ Line 173: / Line 174: @@
 {{!}}{{!}}open
 {{!}}{{!}}boolean
-{{!}}{{!}}If setting is open: true, the console will automatically be open when widgets is launched and the console is ready.
+{{!}}{{!}}If setting is open: true, the console will automatically be open when Widgets is launched and the console is ready.
 {{!}}}
@@ Line 186: / Line 187: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When Console configuration is provided
+{{!}}{{!}}Console configuration is provided
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When no configuration provided
+{{!}}{{!}}No configuration is provided
 {{!}}{{!}}'Invalid Configuration'
 {{!}}}
@@ Line 215: / Line 216: @@
 {{!}}-
 {{!}}{{!}}opened
-{{!}}{{!}}The Console widget has appeared on screen.
+{{!}}{{!}}The Console Widget has appeared on screen.
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}closed
-{{!}}{{!}}The Console widget has been removed from the screen.
+{{!}}{{!}}The Console Widget has been removed from the screen.
 {{!}}{{!}}n/a
 {{!}}}

@@ Line 5: / Line 5: @@
 |Context=Learn how to debug commands and events on the widget bus.
 |ComingSoon=No
-|Platform=PureEngage
+|Platform=GenesysEngage-onpremises
 |Section={{Section
 |sectionHeading=Overview

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

Monique.gionet@genesys.com: Published

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

WikiSysop at 13:48, 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"