ATC/Current/SDK/autotrackURLChange - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

2021-11-09T21:28:32Z

Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

2021-08-10T10:36:40Z

Published

Barbara.martin@genesys.com: Published

2021-04-28T18:29:48Z

Published

Barbara.martin@genesys.com: Published

2021-02-08T18:05:54Z

Published

Barbara.martin@genesys.com: Published

2020-12-16T19:01:38Z

Published

Barbara.martin@genesys.com: Published

2020-12-16T18:07:13Z

Published

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

2020-07-25T02:29:32Z

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

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

2020-07-15T11:59:37Z

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

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

2020-07-15T11:44:09Z

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

DannaShirley: Published

2020-07-08T10:04:43Z

Published

New page

{{Article
|Standalone=No
|DisplayName=autotrackURLChange
|TocName=autotrackURLChange
|Context=Learn how to customize tracking for Single Page Application (SPA) websites. Alternatively, use your preferred tag manager to customize and deploy the SPA tracking snippet. For more information, see {{Link-AnywhereElse|product=ATC|version=Current|manual=Event|topic=About_event_tracking}}. If you are just getting started, read {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet}}.
|Dimension=Modules
|ComingSoon=No
|Platform=PureEngage, PureConnect, PureCloud
|Prereq=
|Section={{Section
|sectionHeading=Description
|anchor=autoTrackURLChangeDesc
|alignment=Vertical
|Media=
|image=
|structuredtext=The <code>autotrackURLChange</code> module tracks activity on an SPA webpage when a user clicks through relative links or when software-driven activity changes the URL or browser history. {{NoteFormat|The <code>autotrackURLChange</code> module is automatically loaded when you load the SPA snippet.|}}To customize how <code>autotrackURLChange</code> tracks user activity, use these options:

*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackURLChange#isURLChange|display text=isUrlChange}}
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackURLChange#onUrlChange|display text=onUrlChange}}
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackURLChange#callback|display text=callback}}
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackURLChange|anchor=delay|display text=delay}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=isUrlChange
|anchor=isURLChange
|alignment=Vertical
|Media=
|image=
|structuredtext=Description: checks whether the URL has changed since the last check.

Type: function

Status: default implementation available; can be overwritten

Returns: Boolean

Arguments:
{{{!}} class="wikitable"
{{!}}-
{{!}}{{!}}'''Name'''
{{!}}{{!}}'''Description'''
{{!}}{{!}}'''Type'''
{{!}}{{!}}'''Status'''
{{!}}-
{{!}}{{!}}oldUrl
{{!}}{{!}}the previous URL before the change
{{!}}{{!}}string
{{!}}{{!}}required
{{!}}-
{{!}}{{!}}newUrl
{{!}}{{!}}the possibly changed URL
{{!}}{{!}}string
{{!}}{{!}}required
{{!}}}

===Example===
This example shows how to exclude tracking when a user clicks relative links on a webpage.

<source lang="Javascript">
ac('load', 'autotrackUrlChange', {
isUrlChange: function(oldUrl, newUrl) {
if (oldUrl !== newUrl) {
if (newUrl.includes(oldUrl)) {
return false;
}
return true;
}
return false;
}
}, function() { });
</source>
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=onUrlChange
|anchor=onUrlChange
|alignment=Vertical
|Media=
|image=
|structuredtext=Description: executes when the URL changes via a relative link or SPA routing functionality.

Type: function

Status: default implementation available; tracks pageviews via <code>ac('pageview')</code>; can be overwritten

Returns: void

Arguments:
{{{!}} class="wikitable"
{{!}}-
{{!}}{{!}}'''Name'''
{{!}}{{!}}'''Description'''
{{!}}{{!}}'''Type'''
{{!}}{{!}}'''Status'''
{{!}}-
{{!}}{{!}}newURL
{{!}}{{!}}the URL the user has changed to
{{!}}{{!}}string
{{!}}{{!}}required
{{!}}}
{{NoteFormat|By default, the tracking snippet tracks page views via <code>ac('pageview')</code>. If you override the default behavior using <code>onUriChange</code>, remember to manually include this call in the new function.}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=callback
|anchor=callback
|alignment=Vertical
|Media=
|image=
|structuredtext=When a module fully loads, callback is executed. No arguments are passed to the callback.

===Example===
Your SPA page may use routers or relative links to change the page URL without changing the page title. In this case, the default <code>ac('pageview')</code> call tracks all page views as occurring on the same page. Visit journey information that appears in Live Now and the agent UI does not reflect actual user behavior. To change this, customize the onUrlChange option as shown in the following example.

<source lang="Javascript">
ac('load', 'autotrackUrlChange', {
onUrlChange: function(newUrl) {
let customTitle = document.title;
if (newUrl.includes('marketing')) {
customTitle = customTitle + 'marketing';
}
if (newUrl.includes('contact-us')) {
customTitle = customTitle + 'contact-us';
}
// supply pageOverrides with location and custom title field
ac('pageview', {
location: window.location.href,
title: customTitle
});
}
}, function() { });
</source>
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=delay
|anchor=delay
|alignment=Vertical
|Media=
|image=
|structuredtext=Use this option to set a delay between the time when the SDK realizes there is a URL change and when it sends the <code>onUrlChange</code> function.

===Example===
This example sets a 1-second delay. This gives the application time to change the page title to match the current URL.
ac('load', 'autotrackUrlChange', { delay: 1000 });
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}

@@ Line 9: / Line 9: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
+|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
 |Status=No
 }}{{Section

@@ Line 3: / Line 3: @@
 |DisplayName=autotrackURLChange
 |TocName=autotrackURLChange
-|Context=Learn how to customize tracking for Single Page Application (SPA) websites. Alternatively, use your preferred tag manager to customize and deploy the SPA tracking snippet. For more information, see {{Link-AnywhereElse|product=ATC|version=Current|manual=Event|topic=About_event_tracking}}. If you are just getting started, read {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet}}.{{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.
+|Context=Learn how to customize tracking for Single Page Application (SPA) websites. Alternatively, use your preferred tag manager to customize and deploy the SPA tracking snippet. For more information, see {{Link-AnywhereElse|product=ATC|version=Current|manual=Event|topic=About_event_tracking}}. If you are just getting started, read {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet}}.
 |Dimension=Modules
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Description
 |anchor=autoTrackURLChangeDesc

@@ Line 56: / Line 56: @@
    isUrlChange: function(oldUrl, newUrl) {
      if (oldUrl !== newUrl) {
-       if (newUrl.includes(oldUrl)) {
+       if (oldUrl !== '' && newUrl.includes(oldUrl)) {
          return false;
+       }

@@ Line 3: / Line 3: @@
 |DisplayName=autotrackURLChange
 |TocName=autotrackURLChange
-|Context=Learn how to customize tracking for Single Page Application (SPA) websites. Alternatively, use your preferred tag manager to customize and deploy the SPA tracking snippet. For more information, see {{Link-AnywhereElse|product=ATC|version=Current|manual=Event|topic=About_event_tracking}}. If you are just getting started, read {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet}}.
+|Context=Learn how to customize tracking for Single Page Application (SPA) web sites. Alternatively, use your preferred tag manager to customize and deploy the SPA tracking snippet. For more information, see {{Link-AnywhereElse|product=ATC|version=Current|manual=Event|topic=About_event_tracking}}. If you are just getting started, read {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet}}.
 |Dimension=Modules
 |ComingSoon=No
-|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
+|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=Description
 |anchor=autoTrackURLChangeDesc
 |alignment=Vertical
-|Media=
+|structuredtext=The <code>autotrackURLChange</code> module tracks activity on an SPA webpage when a user clicks through relative links or when software-driven activity changes the URL or browser history. {{NoteFormat|The <code>autotrackURLChange</code> module is automatically loaded when you load the SPA snippet.|}}To customize how <code>autotrackURLChange</code> tracks user activity, use the following options:
 *{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackURLChange#isURLChange|display text=isUrlChange}}
@@ Line 20: / Line 17: @@
 *{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackURLChange#callback|display text=callback}}
 *{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackURLChange|anchor=delay|display text=delay}}
 |Status=No
 }}{{Section
@@ Line 27: / Line 22: @@
 |anchor=isURLChange
 |alignment=Vertical
-|Media=
+|structuredtext='''Description:''' Checks whether the URL changed since the last check.
-Type: function
+'''Type:''' Function
-Status: default implementation available; can be overwritten
+'''Status:''' Default implementation available; can be overwritten
-Returns: Boolean
+'''Returns:''' Boolean
-Arguments:
+'''Arguments:''' See the following table.
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 46: / Line 39: @@
 {{!}}-
 {{!}}{{!}}oldUrl
-{{!}}{{!}}the previous URL before the change
+{{!}}{{!}}Previous URL before the change.
 {{!}}{{!}}string
 {{!}}{{!}}required
 {{!}}-
 {{!}}{{!}}newUrl
-{{!}}{{!}}the possibly changed URL
+{{!}}{{!}}Possibly changed URL.
 {{!}}{{!}}string
 {{!}}{{!}}required
@@ Line 57: / Line 50: @@
 ===Example===
-This example shows how to exclude tracking when a user clicks relative links on a webpage.
+This example shows how to exclude tracking when a visitor clicks relative links on a webpage.
 <source lang="Javascript">
@@ Line 72: / Line 65: @@
 }, function() { });
 </source>
 |Status=No
 }}{{Section
@@ Line 79: / Line 70: @@
 |anchor=onUrlChange
 |alignment=Vertical
-|Media=
+|structuredtext='''Description:''' Runs when the URL changes through a relative link or SPA routing functionality.
-Type: function
+'''Type:''' Function
-Status: default implementation available; tracks pageviews via <code>ac('pageview')</code>; can be overwritten
+'''Status:''' Default implementation available; tracks pageviews through <code>ac('pageview')</code>; can be overwritten
-Returns: void
+'''Returns:''' Void
-Arguments:
+'''Arguments:''' See the following table.
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 98: / Line 87: @@
 {{!}}-
 {{!}}{{!}}newURL
-{{!}}{{!}}the URL the user has changed to
+{{!}}{{!}}URL that the visitor changed to.
 {{!}}{{!}}string
 {{!}}{{!}}required
 {{!}}}
-{{NoteFormat|By default, the tracking snippet tracks page views via <code>ac('pageview')</code>. If you override the default behavior using <code>onUriChange</code>, remember to manually include this call in the new function.}}
+{{NoteFormat|By default, the tracking snippet tracks page views via <code>ac('pageview')</code>. If you override the default behavior using <code>onUriChange</code>, remember to include this call in the new function manually.|}}
 |Status=No
 }}{{Section
@@ Line 110: / Line 97: @@
 |anchor=callback
 |alignment=Vertical
-|Media=
+|structuredtext=When a module loads, callback is executed. No arguments pass to the callback.
 ===Example===
-Your SPA page may use routers or relative links to change the page URL without changing the page title. In this case, the default <code>ac('pageview')</code> call tracks all page views as occurring on the same page. Visit journey information that appears in Live Now and the agent UI does not reflect actual user behavior. To change this, customize the onUrlChange option as shown in the following example.
+Your SPA page may use routers or relative links to change the page URL without changing the page title. In this case, the default <code>ac('pageview')</code> call tracks all page views as occurring on the same page. Visit journey information that appears in Live Now and the agent UI does not reflect actual visitor behavior. To change this behavior, customize the onUrlChange option as shown in the following example.
 <source lang="Javascript">
@@ Line 135: / Line 120: @@
 }, function() { });
 </source>
 |Status=No
 }}{{Section
@@ Line 142: / Line 125: @@
 |anchor=delay
 |alignment=Vertical
 |structuredtext=Use this option to set a delay between the time when the SDK realizes there is a URL change and when it sends the <code>onUrlChange</code> function.
 ===Example===
-This example sets a 1-second delay. This gives the application time to change the page title to match the current URL.
+This example sets a 1-second delay to give the application time to change the page title to match the current URL.
   ac('load', 'autotrackUrlChange', { delay: 1000 });
 |Status=No
 }}
 }}

@@ Line 6: / Line 6: @@
 |Dimension=Modules
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises, PureConnect, PureCloud
+|Platform=GenesysEngage-onpremises, PureConnect, GenesysCloud
 |Prereq=
 |Section={{Section

ATC/Current/SDK/autotrackURLChange - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: 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"

DannaShirley: 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"