Difference between revisions of "WID/Current/SDK/Console-combined"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2")
(Published)
 
(3 intermediate revisions by 2 users not shown)
Line 5: Line 5:
 
|Context=Learn how to debug commands and events on the widget bus.
 
|Context=Learn how to debug commands and events on the widget bus.
 
|ComingSoon=No
 
|ComingSoon=No
−
|Platform=GenesysEngage-onpremises
+
|Platform=GenesysEngage-cloud
 +
|Role=Developer
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Overview
 
|sectionHeading=Overview
 +
|anchor=overview
 
|alignment=Vertical
 
|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]]
+
[[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 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. It is a great tool for getting to know the widget bus, the API for each widget, and debugging issues.
 
===Usage===
 
===Usage===
 
Launch WebChat manually by using the following methods:
 
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.
 
*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
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Configuration
 
|sectionHeading=Configuration
 +
|anchor=config
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext====Description===
 
|structuredtext====Description===
Line 51: Line 54:
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Localization
 
|sectionHeading=Localization
 +
|anchor=localize
 
|alignment=Vertical
 
|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}}
 
|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 72: Line 76:
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|sectionHeading=API Commands
+
|sectionHeading=API commands
 +
|anchor=commands
 
|alignment=Vertical
 
|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.
 
|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');
 
<source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
Line 104: Line 109:
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}resolved
 
{{!}}{{!}}resolved
−
{{!}}{{!}}When Console is successfully opened
+
{{!}}{{!}}Console is successfully opened
 
{{!}}{{!}}n/a
 
{{!}}{{!}}n/a
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}rejected
 
{{!}}{{!}}rejected
−
{{!}}{{!}}When Console is already open
+
{{!}}{{!}}Console is already open
 
{{!}}{{!}}'Already opened'
 
{{!}}{{!}}'Already opened'
 
{{!}}}
 
{{!}}}
Line 136: Line 141:
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}resolved
 
{{!}}{{!}}resolved
−
{{!}}{{!}}When Console successfully closed
+
{{!}}{{!}}Console successfully closed
 
{{!}}{{!}}n/a
 
{{!}}{{!}}n/a
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}rejected
 
{{!}}{{!}}rejected
−
{{!}}{{!}}When Console is already closed
+
{{!}}{{!}}Console is already closed
 
{{!}}{{!}}'Already closed'
 
{{!}}{{!}}'Already closed'
 
{{!}}}
 
{{!}}}
Line 173: Line 178:
 
{{!}}{{!}}open
 
{{!}}{{!}}open
 
{{!}}{{!}}boolean
 
{{!}}{{!}}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 191:
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}resolved
 
{{!}}{{!}}resolved
−
{{!}}{{!}}When Console configuration is provided
+
{{!}}{{!}}Console configuration is provided
 
{{!}}{{!}}n/a
 
{{!}}{{!}}n/a
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}rejected
 
{{!}}{{!}}rejected
−
{{!}}{{!}}When no configuration provided
+
{{!}}{{!}}No configuration is provided
 
{{!}}{{!}}'Invalid Configuration'
 
{{!}}{{!}}'Invalid Configuration'
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|sectionHeading=API Events
+
|sectionHeading=API events
 +
|anchor=events
 
|alignment=Vertical
 
|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.
 
|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');
 
<source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
Line 215: Line 221:
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}opened
 
{{!}}{{!}}opened
−
{{!}}{{!}}The Console widget has appeared on screen.
+
{{!}}{{!}}The Console Widget has appeared on screen.
 
{{!}}{{!}}n/a
 
{{!}}{{!}}n/a
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}closed
 
{{!}}{{!}}closed
−
{{!}}{{!}}The Console widget has been removed from the screen.
+
{{!}}{{!}}The Console Widget has been removed from the screen.
 
{{!}}{{!}}n/a
 
{{!}}{{!}}n/a
 
{{!}}}
 
{{!}}}

Latest revision as of 13:14, October 12, 2021

This topic is part of the manual Widgets API Reference for version Current of Widgets.

Learn how to debug commands and events on the widget bus.

Related documentation:

Overview

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.

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.

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)

Configuration

Description

Console option to open on initial loading.

Example

window._genesys.widgets.console = {open: true};

Options

Name Type Description Default Required
open boolean Set to true for console to open at start. false false

Localization

Important
For information on how to set up localization, please refer to Localize widgets and services.

Strings

{
	"ConsoleTitle": "CXBus Console",
	"Commands": "Commands",
	"Plugin": "Plugin",
	"ConsoleErrorButton": "OK",
	"Execute": "Execute",
	"Event": "Event",
	"SubscribeTo": "Subscribe to",
	"Unsubscribe": "Unsubscribe",
	"ReturnData": "Return Data",
	"EventsSubscriber": "Events Subscriber",
	"Watch": "Watch",
	"pluginNameEvent": "PluginName.Event",
	"ClearAll": "Clear All",
	"OptionsSample": "JSON Formatted Options {'option': value}"
}

API commands

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.

Important
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 Genesys Widgets Extensions for more information about extending Genesys Widgets.
var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.command('Console.open');

open

Opens the Console UI.

Example

oMyPlugin.command('Console.open').done(function(e){

	// Console opened successfully

}).fail(function(e){

	// Console failed to open
});

Resolutions

Status When Returns
resolved Console is successfully opened n/a
rejected Console is already open 'Already opened'


close

Closes the Console UI.

Example

oMyPlugin.command('Console.close').done(function(e){

	// Console closed successfully

}).fail(function(e){

	// Console failed to close
});

Resolutions

Status When Returns
resolved Console successfully closed n/a
rejected Console is already closed 'Already closed'


configure

Modifies the Console configuration options. See the Console configuration page.

Example

oMyPlugin.command('Console.configure', {

	open: false

}).done(function(e){

	// Console configured successfully

}).fail(function(e){

	// Console failed to configure
});

Options

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

Status When Returns
resolved Console configuration is provided n/a
rejected No configuration is provided 'Invalid Configuration'

API events

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.

Important
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 Genesys Widgets Extensions for more information about extending Genesys Widgets.
var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.subscribe('Console.ready', function(e){});
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
Retrieved from "https://all.docs.genesys.com/WID/Current/SDK/Console-combined (2025-06-19 23:07:27)"
Comments or questions about this documentation? Contact us for support!