|
|
| Line 1: |
Line 1: |
| | = Configuring Genesys Widgets= | | = Configuring Genesys Widgets= |
| − | __NOTOC__
| + | {{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/Developer/GWCConfig.}} |
| − | Genesys Widgets supports multiple widgets including Webchat, and [[GCB|Co-browse]]. You can configure all widgets and services in the same configuration object. When you add new Genesys products and services, you must update your Genesys Widgets configuration to enable those widgets.
| |
| − | | |
| − | After you [[GWCDeployment|deploy the Genesys Widgets]] on your website, configure the CX Widget by defining the '''global window._genesys''' Javascript object.
| |
| − | | |
| − | To include the JavaScript script, you can choose one of the following options:
| |
| − | | |
| − | *Place the script inline on your website; or
| |
| − | *Place it in a separate JavaScript file, and then include the file on your page.
| |
| − | | |
| − | The following example is a basic view of the global Genesys Widgets configuration object:
| |
| − | | |
| − | <source lang="javascript">
| |
| − | <script>
| |
| − | | |
| − | if(!window._genesys)window._genesys = {};
| |
| − | if(!window._gt)window._gt = [];
| |
| − | | |
| − | window._genesys.widgets = {
| |
| − | | |
| − | main: {},
| |
| − | webchat: {},
| |
| − | cobrowse: {},
| |
| − | };
| |
| − | | |
| − | </script>
| |
| − | | |
| − | // include widgets.min.js after defining your configuration options
| |
| − | | |
| − | </source>
| |
| − | | |
| − | | |
| − | The following example is a populated Widget configuration that includes configuration options for Webchat, and Co-browse (GCB):
| |
| − | | |
| − | {{NoteFormat|Your configuration options must be defined on the page '''before''' widgets.min.js is loaded. Failing to do so may result in errors.}}
| |
| − | | |
| − | {{NoteFormat|Note that Co-browse is optional.|2}} | |
| − | | |
| − | <source lang="javascript">
| |
| − | <script>
| |
| − |
| |
| − | if(!window._genesys)window._genesys = {};
| |
| − | if(!window._gt)window._gt = [];
| |
| − |
| |
| − | window._genesys.widgets = {
| |
| − | main: {
| |
| − |
| |
| − | theme: "dark",
| |
| − | lang: "en",
| |
| − | i18n: "http://HOST:PORT/path/to/languages/file.json",
| |
| − | customStylesheetID: "<ANY_ID_NAME>",
| |
| − | mobileMode: 'auto',
| |
| − | mobileModeBreakpoint: 600
| |
| − | },
| |
| − | webchat: {
| |
| − |
| |
| − | apikey: "0123456789", // Used for Apigee service only
| |
| − | dataURL: "http://HOST:PORT/path/to/chat/service",
| |
| − | userData: {},
| |
| − | proactive: {
| |
| − |
| |
| − | enabled: true,
| |
| − | idleTimer: 5,
| |
| − | cancelTimer: 30
| |
| − | },
| |
| − | chatButton: {
| |
| − |
| |
| − | enabled: true,
| |
| − | template: false,
| |
| − | openDelay: 1000,
| |
| − | effectDuration: 300,
| |
| − | hideDuringInvite: true
| |
| − | }
| |
| − | },
| |
| − | cobrowse: {
| |
| − |
| |
| − | src: "<COBROWSE_SERVER_URL>/cobrowse/js/gcb.min.js",
| |
| − | url: "<COBROWSE_SERVER_URL>/cobrowse"
| |
| − | }
| |
| − | };
| |
| − | </script>
| |
| − | </source>
| |
| − | | |
| − | <source lang="javascript">
| |
| − | // Lazy loading method of loading widgets
| |
| − | <script src="/path/to/cxbus.min.js" onload="javascript:CXBus.configure({debug:false, pluginsPath:'/path/to/plugins/'}); CXBus.loadPlugin('widgets-core');"></script>
| |
| − | </source>
| |
| − | | |
| − | <source lang="javascript">
| |
| − | // All-in-one method of loading widgets
| |
| − | <script id="genesys-cx-widget-script" src="/path/to/widgets.min.js"></script>
| |
| − | <link id="genesys-widgets-styles" href="/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
| |
| − | </source>
| |
| − | | |
| − | ==Main Configuration==
| |
| − | | |
| − | Genesys Widgets is a hub for multiple Genesys products and services. Some configuration options are set globally and therefore apply to all products and services running on the CX Widget platform. In the main application configuration you can configure options such as visual theme, language, and mobile support.
| |
| − | | |
| − | For detailed information on configuration options, see [[AppConfiguration|App Configuration Options]].
| |
| − | | |
| − | ==Widget Configuration Options==
| |
| − | | |
| − | *[[WebChatConfiguration|WebChat Configuration]]
| |
| − | *[[WebChatServiceConfiguration|WebChatService Configuration]]
| |
| − | *[[Co-browseConfiguration|CoBrowse Configuration]]
| |
| − | *[[ChannelSelector|Channel Selector Configuration]]
| |
| − | | |
| − | For a complete list of Widget configuration options, please see [[GWCWelcome|Genesys Widgets Reference]].
| |
| − | | |
| − | ==Launcher==
| |
| − | Launcher is a sample page which shows how Genesys Widgets are displayed on any host website. With this, you can:
| |
| − | | |
| − | <ul>
| |
| − | <li>View Genesys Widgets with your own configuration.</li>
| |
| − | <li>Copy the Configuration Script; for example, using the details you entered on the form, configuration script is generated in the '''Need Configuration Script''' section. You can copy this script and use it in your website to launch Widgets.</li>
| |
| − | <li>Starting in the 9.0.008.03 version, use launcher tool to test and configure between the different APIs services available in Genesys, namely under PureEngage, PureEngageCloud and PureCloud.</li>
| |
| − | </ul>
| |
| − | | |
| − | ===How to use Launcher===
| |
| − | '''Sidebar'''<br/>
| |
| − | To enable Sidebar plugin, select this check box in launcher. By default, Sidebar will be shown right side of the screen on Widgets startup. You can change these [[SideBar|configurations]] by using the options shown under this section. Provide the sidebar channel configuration in the corresponding text area according to the [[SideBar|Sidebar documentation]] or use the provided sample configuration links to prefill the sample data in the text area. Ensure that the channels defined here are enabled and configured as well.
| |
| − | | |
| − | '''Enable Live Assist (EWT)'''<br/>
| |
| − | Select the check box next to '''Enable Live Assist (EWT)''' to enable the ChannelSelector plugin. Enter the Stats URL followed by the virtual queue names to fetch the Estimated Wait Time details. Refer to the [[ChannelSelector|Channel Selector documentation]] for more information. To show Chat, SendMessage and CallUs channels in this plugin, please make sure that you select these plugins in this Launcher page.
| |
| − | | |
| − | '''WebChat'''<br/>
| |
| − | To enable it, select the check box next to the '''WebChat'''. Enter the mandatory field URL (marked with an asterisk). Other values are optional and self explanatory.
| |
| − | {{NoteFormat|Starting in the 9.0.008.03 version, WebChat supports PureEngage v3 API via transports configuration section. The same can be tested In the launcher tool using the WebChat [with Transport only] section under PureEngageCloud tab.}}
| |
| − | | |
| − | '''Co-browse'''<br>
| |
| − | To enable it, select the check box next to the '''Co-browse''' heading. Enter required fields (marked with an asterisk).
| |
| − | | |
| − | '''GWE'''<br/>
| |
| − | To enable it, select the check box next to the '''GWE''' heading. Enter required fields (marked with an asterisk).
| |
| − | | |
| − | '''Send Message'''<br/>
| |
| − | To enable it, select the check box next to the '''Send Message''' heading. Enter required fields (marked with an asterisk).
| |
| − | | |
| − | '''CallUs'''<br/>
| |
| − | Select the check box next to '''Call Us''' and provide the configuration data. Here, the '''Edit/Use Sample Config''' option is also provided and you can use this to prefill with the sample configuration and edit it for your own details. Ideally, call us is shown in the Live Assist widget or it can also be launched with bus command <tt>CallUs.open</tt>.
| |
| − | | |
| − | '''Callback'''<br/>
| |
| − | Select the check box next to '''Callback''' to include Callback and Calendar plugins. Enter the callback service provider URL field and other details as required. Ensure '''Enable Sidebar with Live Assist''' is selected.
| |
| − | | |
| − | '''Lazy Loading'''<br/>
| |
| − | Select the check box next to '''Enable Lazy loading''' to launch Widgets in the lazy load mode, otherwise they will be launched normally. At the minimum, Sidebar plugin show be enabled and configured with required channels to load it on Widgets startup.
| |
| − | | |
| − | Once all the necessary configuration details are entered, click on the '''Launch''' button to launch Widgets.
| |
| − | [[File:Launcher-PureEngage-9.0.008.03.png|thumbnail|center|Launcher tool for PureEngage API (click to enlarge)]]
| |
| − |
| |
| − | [[File:Launcher-PureEngageCloud-9.0.008.03.png|thumbnail|center|Launcher tool for PureEngageCloud API (click to enlarge)]]
| |
| − | | |
| − | | |
| | [[Category:V:PSAAS:Public]] | | [[Category:V:PSAAS:Public]] |
