WID/Current/Developer/GWCDeployment - Revision history

WikiSysop at 14:30, June 9, 2022

2022-06-09T14:30:44Z

Chrissy.forrest@genesys.com: Published

2021-03-12T13:57:40Z

Published

Chrissy.forrest@genesys.com: Published

2021-02-03T20:56:38Z

Published

Chrissyforrest: Published

2020-10-27T21:27:07Z

Published

Chrissyforrest: Published

2020-07-30T21:49:14Z

Published

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

2020-07-25T02:38:13Z

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

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

2020-07-15T11:59:27Z

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

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

2020-07-15T11:50:19Z

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

Chrissyforrest: Published

2020-05-22T19:26:39Z

Published

Chrissyforrest: Published

2020-05-20T19:06:28Z

Published

Show changes

@@ Line 100: / Line 100: @@
 <script src-"widgets/widgets.config.js"></script>
 <script src="widgets/widgets.min.js"></script>
-<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles" href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
+<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
 </source>
@@ Line 137: / Line 137: @@
 |anchor=ReleaseshostedonContentDeliveryNetworkCDN
 |alignment=Vertical
-|structuredtext=Genesys Widgets are now available over CDN, providing optimized load times and instant access to new releases.
+|structuredtext=Genesys Widgets is now available over CDN, providing optimized load times and instant access to new releases.
 <pre>
@@ Line 157: / Line 157: @@
 *9.0.xxx.xx - (Major).(Minor).(Release candidate) - Specific release version
-For all the available released versions, refer to the {{#Widget:ExtLink|link=https://docs.genesys.com/Documentation/PSAAS/Public/RN/GW|displaytext=Widgets Release Note}}.
+For all the available released versions, refer to the {{#Widget:ExtLink|link=https://docs.genesys.com/Documentation/PSAAS/Public/RN/GW|displaytext=Widgets Release Notes}}.
 ===Choose region===
@@ Line 190: / Line 190: @@
 {{!}}Japan
 {{!}}<nowiki>https://apps.mypurecloud.jp/widgets/{version}/{path/to/file}</nowiki>
 {{!}}-
 {{!}}Seoul
@@ Line 267: / Line 270: @@
 <br />
 |Status=No
 }}
 }}

@@ Line 100: / Line 100: @@
 <script src-"widgets/widgets.config.js"></script>
 <script src="widgets/widgets.min.js"></script>
-<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles" href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
+<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles" href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
 </source>
@@ Line 112: / Line 112: @@
 ==Alternative deployment script==
-To simplify the deployment process while using tools like Google Tag Manager, you can use below script to embed Widgets.
+To simplify the deployment process while using tools like Google Tag Manager, you can use the below script to embed Widgets.
 <source lang="javascript">
@@ Line 154: / Line 154: @@
 *9.0 - (Major) - A version that is company-wide or
-*9.0.xxx - (Major).(Minor) - Minor version is product specific and is tied to each Widget’s iteration or
+*9.0.xxx - (Major).(Minor) - Minor version is product specific and is tied to each widget’s iteration or
 *9.0.xxx.xx - (Major).(Minor).(Release candidate) - Specific release version
@@ Line 160: / Line 160: @@
 ===Choose region===
-Widgets is available in a number of regions worldwide as shown below. Please choose the nearest or appropriate region URL based on where you are located.
+Widgets is available in a number of regions worldwide, as shown below. Choose the nearest or appropriate region URL based on where you are located.
 {{{!}} border="1"
@@ Line 256: / Line 256: @@
 |Status=No
 }}{{Section
-|sectionHeading=Checking Widgets Version
+|sectionHeading=Checking Widgets version
 |alignment=Vertical
 |structuredtext='''CXBus.command("App.info");'''

@@ Line 1: / Line 1: @@
 {{Article
 |Standalone=No
-|DisplayName=Genesys Widgets Deployment Guide
+|DisplayName=Genesys Widgets deployment guide
-|TocName=Genesys Widgets Deployment Guide
+|TocName=Genesys Widgets deployment guide
 |Context=This guide provides the steps required to instrument your website with Genesys Widgets.
 |ComingSoon=No
@@ Line 39: / Line 39: @@
 <source lang="javascript">
 <script src="widgets/cxbus.min.js"
 onload="javascript:CXBus.configure({debug:true,pluginsPath:
 'build/plugins/'});CXBus.loadFile('path/to/widgets.config.js')
 .done(function(){CXBus.loadPlugin('widgets-core')});"></script>
 </source>
@@ Line 102: / Line 100: @@
 <script src-"widgets/widgets.config.js"></script>
 <script src="widgets/widgets.min.js"></script>
-<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
+<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles" href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
 </source>
@@ Line 159: / Line 157: @@
 *9.0.xxx.xx - (Major).(Minor).(Release candidate) - Specific release version
-For all the available released versions, refer to the [https://docs.genesys.com/Documentation/PSAAS/Public/RN/GW Widgets Release Notes].
+For all the available released versions, refer to the {{#Widget:ExtLink|link=https://docs.genesys.com/Documentation/PSAAS/Public/RN/GW|displaytext=Widgets Release Note}}.
 ===Choose region===

@@ Line 60: / Line 60: @@
 {{NoteFormat|Whichever method you choose, you must ensure your configuration is in the page before you load '''widgets-core'''. Otherwise, '''widgets-core''' cannot read the configuration.}}
-{{NoteFormat|Refer to {{Link-SomewhereInThisManual|topic=GWCConfig|anchor=top|display text=Configuring Genesys Widgets}} for help.|}}
+{{NoteFormat|Refer to {{Link-SomewhereInThisManual|topic=GWCConfig|display text=Configuring Genesys Widgets}} for help.|}}
 ===On-demand lazy loading===
@@ Line 102: / Line 102: @@
 <script src-"widgets/widgets.config.js"></script>
 <script src="widgets/widgets.min.js"></script>
-<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
+<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
 </source>
@@ Line 109: / Line 109: @@
 {{NoteFormat|Whichever method you choose, you must ensure your configuration is in the page before you load '''widgets.min.js'''. Otherwise, '''widgets.min.js''' cannot read the configuration.}}
-{{NoteFormat|Refer to {{Link-SomewhereInThisManual|topic=GWCConfig|anchor=top|display text=Configuring Genesys Widgets}}for help.|}}
+{{NoteFormat|Refer to {{Link-SomewhereInThisManual|topic=GWCConfig|display text=Configuring Genesys Widgets}} for help.|}}
 {{AnchorDiv|alternative}}
@@ Line 200: / Line 200: @@
 Starting in the 9.0.006.02 release, all the released versions are accessible from the Genesys CDN URL. The sections below explain how to access the latest available released version or a specific released version using Genesys CDN.
-=====To get the latest released version under the 9.0 family=====
+To get the latest released version under the 9.0 family: https://apps.mypurecloud.com/widgets/9.0/widgets.min.js
-=====To get the last available released version under a specific (Major).(Minor) version (this also includes any hot fixes for that release).=====
+To get the last available released version under a specific (Major).(Minor) version (this also includes any hot fixes for that release): <nowiki>https://apps.mypurecloud.com/widgets/</nowiki>'''9.0.xxx'''/widgets.min.js
-=====To get a specific release/hot-fix version=====
+'''Example:''' <nowiki>https://apps.mypurecloud.com/widgets/</nowiki>'''9.0.006'''/widgets.min.js
-{{NoteFormat|Note that all older versions of Genesys Widgets may not be available in the CDN. All the released versions are available only starting with the 9.0.006.02 version.}}
+To get a specific release/hot-fix version: <nowiki>https://apps.mypurecloud.com/widgets/</nowiki>'''9.0.xxx.xx'''/widgets.min.js
 ===Versioning examples with scenarios===

@@ Line 5: / Line 5: @@
 |Context=This guide provides the steps required to instrument your website with Genesys Widgets.
 |ComingSoon=No
-|Platform=GenesysEngage-cloud, GenesysCloud
+|Platform=GenesysCloud, GenesysEngage-cloud
-|Prereq=
+|Role=Developer
 |Section={{Section
 |sectionHeading=Audience
 |anchor=Audience
 |alignment=Vertical
 |structuredtext=This document is for website developers who are in charge of website code. You must have knowledge of HTML, JavaScript, and CSS.
 |Status=No
 }}{{Section
 |sectionHeading=How can I deploy Genesys Widgets?
-|anchor=HowcanIdeployGenesysWidgets?
+|anchor=HowcanIdeployGenesysWidgets
 |alignment=Vertical
 |structuredtext=There are two deployment methods available:
@@ Line 30: / Line 24: @@
 {{AnchorDiv|lazy}}
 |Status=No
 }}{{Section
 |sectionHeading=Deploying Genesys Widgets (lazy loading)
-|anchor=DeployingGenesysWidgets(lazy loading)
+|anchor=DeployingGenesysWidgetslazyloading
 |alignment=Vertical
 |structuredtext={{NoteFormat|Lazy loading is the recommended method for Widgets. The ({{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=all-in-one}}) method is deprecated.|}}
 ===Files used===
@@ Line 61: / Line 51: @@
 #Loads '''cxbus.min.js'''. This makes the global CXBus instance available.
 #Configures CXBus to turn on debug logging and set the path to the Widgets plugin folder.
-#Load your configuration file, '''widgets.config.js'''. (This is an imaginary file. You must create it).
+#Loads your configuration file, '''widgets.config.js'''. (This is an imaginary file. You must create it).
 #Loads '''widgets-core''', the core Genesys Widgets library.
@@ Line 96: / Line 86: @@
 {{AnchorDiv|all}}
 |Status=No
 }}{{Section
 |sectionHeading=Deploying Genesys Widgets (all-in-one)
-|anchor=DeployingGenesysWidgets(all-in-one)
+|anchor=DeployingGenesysWidgetsallinone
 |alignment=Vertical
 |structuredtext={{NoteFormat|1=Lazy loading is the recommended method for Widgets. The ({{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=all-in-one}}) method is deprecated.|2=}}
 ===Files Used===
@@ Line 116: / Line 102: @@
 <script src-"widgets/widgets.config.js"></script>
 <script src="widgets/widgets.min.js"></script>
-<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
+<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
 </source>
@@ Line 148: / Line 134: @@
 {{AnchorDiv|CDN}}
 |Status=No
 }}{{Section
 |sectionHeading=Releases hosted on Content Delivery Network (CDN)
-|anchor=ReleaseshostedonContentDeliveryNetwork(CDN)
+|anchor=ReleaseshostedonContentDeliveryNetworkCDN
 |alignment=Vertical
 |structuredtext=Genesys Widgets are now available over CDN, providing optimized load times and instant access to new releases.
@@ Line 277: / Line 259: @@
 <br />
 |Status=No
 }}{{Section
 |sectionHeading=Checking Widgets Version
 |alignment=Vertical
 |structuredtext='''CXBus.command("App.info");'''
@@ Line 295: / Line 272: @@
 <br />
 |Status=No
 }}
 }}

@@ Line 25: / Line 25: @@
 |structuredtext=There are two deployment methods available:
-*{{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=lazy|display text=Lazy-Loading}}&mdash; The recommended method, Lazy-Loading breaks the JavaScript bundle apart into individual plugin files and loads them into the page only as you need them. This is the preferred method of deploying Genesys Widgets.
+*{{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=lazy|display text=Lazy loading}}&mdash; The recommended method, lazy loading breaks the JavaScript bundle apart into individual plugin files and loads them into the page only as you need them. This is the preferred method of deploying Genesys Widgets.
-*{{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=All-In-One}} (deprecated) &mdash;The All-In-One method is the "classic" method of deploying Genesys Widgets. In this method, you have one JavaScript file and one CSS file that contain all plugins and resources.
+*{{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=All-in-one}} (deprecated) &mdash;The all-in-one method is the "classic" method of deploying Genesys Widgets. In this method, you have one JavaScript file and one CSS file that contain all plugins and resources.
 {{AnchorDiv|lazy}}
@@ Line 34: / Line 34: @@
 |Status=No
 }}{{Section
-|sectionHeading=Deploying Genesys Widgets (Lazy-Loading)
+|sectionHeading=Deploying Genesys Widgets (lazy loading)
-|anchor=DeployingGenesysWidgets(Lazy-Loading)
+|anchor=DeployingGenesysWidgets(lazy loading)
 |alignment=Vertical
 |Media=
 |image=
-|structuredtext={{NoteFormat|Lazy loading is the recommended method for Widgets. The ({{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=All-In-One}}) method is deprecated.}}
+|structuredtext={{NoteFormat|Lazy loading is the recommended method for Widgets. The ({{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=all-in-one}}) method is deprecated.|}}
-===Files Used===
+===Files used===
 *'''widgets/cxbus.min.js'''
@@ Line 50: / Line 50: @@
 <source lang="javascript">
-<script src="widgets/cxbus.min.js" onload="javascript:CXBus.configure({debug:true,pluginsPath:'build/plugins/'});CXBus.loadFile('path/to/widgets.config.js').done(function(){CXBus.loadPlugin('widgets-core')});"></script>
+<script src="widgets/cxbus.min.js"
 </source>
@@ Line 67: / Line 70: @@
 {{NoteFormat|Whichever method you choose, you must ensure your configuration is in the page before you load '''widgets-core'''. Otherwise, '''widgets-core''' cannot read the configuration.}}
-{{NoteFormat|Refer to this article for help {{Link-SomewhereInThisManual|topic=GWCConfig|anchor=top|display text=configuring Genesys Widgets}}.}}
+{{NoteFormat|Refer to {{Link-SomewhereInThisManual|topic=GWCConfig|anchor=top|display text=Configuring Genesys Widgets}} for help.|}}
-===On-Demand Lazy-Loading===
+===On-demand lazy loading===
 Genesys Widgets is designed to load plugins into the page on-demand as you use the product. For example, if you call the command '''WebChat.open''', CXBus fetches the '''webchat.min.js''' plugin from the '''plugins/''' folder and loads it into the page. Any WebChat command triggers it to load. Likewise, WebChat calls WebChatService commands, thus CXBus loads '''webchatservice.min.js''' into the page as well.
-===Preloading Plugins===
+===Preloading plugins===
 In some cases, you might not want to load plugins on-demand, or the demand is to load them at startup. A good example is SideBar. You probably want this plugin to appear on the screen immediately so the customer can use it. To make this possible, you can specify which plugins you want to preload at startup in your configuration.
@@ Line 97: / Line 100: @@
 |Status=No
 }}{{Section
-|sectionHeading=Deploying Genesys Widgets (All-in-One)
+|sectionHeading=Deploying Genesys Widgets (all-in-one)
-|anchor=DeployingGenesysWidgets(All-in-One)
+|anchor=DeployingGenesysWidgets(all-in-one)
 |alignment=Vertical
 |Media=
 |image=
-|structuredtext={{NoteFormat|1=Lazy loading is the recommended method for Widgets. The ({{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=All-In-One}}) method is deprecated.}}
+|structuredtext={{NoteFormat|1=Lazy loading is the recommended method for Widgets. The ({{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=all-in-one}}) method is deprecated.|2=}}
 ===Files Used===
@@ Line 111: / Line 114: @@
 <source lang="javascript">
+<script src-"widgets/widgets.config.js"></script>
 <script src="widgets/widgets.min.js"></script>
-<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
+<link id="genesys-widgets-styles" data-origID="genesys-widgets-styles"  href="http://www.yourhost.com/path/to/widgets.min.css" type="text/css" rel="stylesheet"/>
 </source>
@@ Line 122: / Line 123: @@
 {{NoteFormat|Whichever method you choose, you must ensure your configuration is in the page before you load '''widgets.min.js'''. Otherwise, '''widgets.min.js''' cannot read the configuration.}}
-{{NoteFormat|Refer to this article for help {{Link-SomewhereInThisManual|topic=GWCConfig|anchor=top|display text=configuring Genesys Widgets}}.}}
+{{NoteFormat|Refer to {{Link-SomewhereInThisManual|topic=GWCConfig|anchor=top|display text=Configuring Genesys Widgets}}for help.|}}
 {{AnchorDiv|alternative}}
-==Alternative Deployment Script==
+==Alternative deployment script==
 To simplify the deployment process while using tools like Google Tag Manager, you can use below script to embed Widgets.
@@ Line 167: / Line 168: @@
 This value varies based on the deployment method you choose.
-{{NoteFormat|In the case where a CDN URL that you are trying to access is '''not found''', it means that either the release or the file you are looking for, is not yet available.|2}}
+{{NoteFormat|In the case where a CDN URL that you are trying to access is '''not found''', it means that either the release or the file you are looking for is not yet available.|2}}
 ===<version>===
@@ Line 178: / Line 179: @@
 For all the available released versions, refer to the [https://docs.genesys.com/Documentation/PSAAS/Public/RN/GW Widgets Release Notes].
-===Choose Region===
+===Choose region===
 Widgets is available in a number of regions worldwide as shown below. Please choose the nearest or appropriate region URL based on where you are located.
@@ Line 254: / Line 255: @@
 */9.0.007.05/
-===Deployment Methods===
+===Deployment methods===
-====Lazy Loading====
+====Lazy loading====
 '''Recommended approach:''' When using the lazy loading method, the base Genesys CDN URL must be prefixed in the {{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=lazy|display text=lazy loading deployment script}}. The <filenames> value is not needed in this scenario because they are auto-loaded from the base CDN configured. Here is what the deployment script looks like when using 9.0.006.02 release:
@@ Line 267: / Line 268: @@
 </source>
-====All-in-One====
+====All-in-one====
-'''Legacy approach (deprecated):''' When using the all-in-one deployment method, the values are the files mentioned in the {{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=All-In-One}} section. For example, if you would like to use widgets.min.js and widgets.min.css under 9.0.006.02 release, CDN URLs will look like this:
+'''Legacy approach (deprecated):''' When using the all-in-one deployment method, the values are the files mentioned in the {{Link-SomewhereInThisManual|topic=GWCDeployment|anchor=all|display text=all-in-one}} section. For example, if you would like to use widgets.min.js and widgets.min.css under 9.0.006.02 release, CDN URLs will look like this:
 <pre>

WID/Current/Developer/GWCDeployment - Revision history

WikiSysop at 14:30, June 9, 2022

Chrissy.forrest@genesys.com: Published

Chrissy.forrest@genesys.com: Published

Chrissyforrest: Published

Chrissyforrest: Published

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

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

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

Chrissyforrest: Published

Chrissyforrest: Published

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

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

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