Difference between revisions of "ATC/Current/AdminGuide/Web tracking"

From Genesys Documentation
Jump to: navigation, search
(Published)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=Web tracking
 
|DisplayName=Web tracking
|Platform=PureEngage, PureConnect, PureCloud
 
 
|TocName=Web tracking
 
|TocName=Web tracking
 +
|Context=Configure how {{MINTYDOCSPRODUCT}} tracks your visitors as they move through your website.
 
|ComingSoon=No
 
|ComingSoon=No
|Context=Configure how {{MINTYDOCSPRODUCT}} tracks your visitors as they move through your website.
+
|Platform=PureEngage, PureConnect, PureCloud
 
|Prereq='''Prerequisites'''
 
|Prereq='''Prerequisites'''
  
Line 13: Line 13:
 
|sectionHeading=About web tracking
 
|sectionHeading=About web tracking
 
|anchor=AboutWebTracking
 
|anchor=AboutWebTracking
|Standalone=No
 
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext={{MINTYDOCSPRODUCT}} analyzes the paths your visitors take on your website to determine when to trigger action maps and to calculate visitors' outcome scores.
 
|structuredtext={{MINTYDOCSPRODUCT}} analyzes the paths your visitors take on your website to determine when to trigger action maps and to calculate visitors' outcome scores.
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Configure web tracking
 
|sectionHeading=Configure web tracking
 
|anchor=ConfigureWebTracking
 
|anchor=ConfigureWebTracking
|Standalone=No
 
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext={{NoteFormat|Before you begin, deploy the {{MINTYDOCSPRODUCT}} {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|display text=tracking snippet}}.|2}}
 
|structuredtext={{NoteFormat|Before you begin, deploy the {{MINTYDOCSPRODUCT}} {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|display text=tracking snippet}}.|2}}
Line 30: Line 25:
 
#Under '''Altocloud''', click '''Web Tracking'''.
 
#Under '''Altocloud''', click '''Web Tracking'''.
 
#Specify the [[#AllowedDomains|allowed domains]].
 
#Specify the [[#AllowedDomains|allowed domains]].
 +
#Specify any {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|anchor=ExcludeIPAddressesses|display text=excluded IP addresses}}.
 
#Specify the [[#ShortIDLength|short ID length]].
 
#Specify the [[#ShortIDLength|short ID length]].
 
#Specify any [[#ExcludeURLQueryParameters|URL query parameters]] that {{MINTYDOCSPRODUCT}} should ignore.
 
#Specify any [[#ExcludeURLQueryParameters|URL query parameters]] that {{MINTYDOCSPRODUCT}} should ignore.
Line 35: Line 31:
 
#Specify any [[#SiteSearchSettings|site search settings]].
 
#Specify any [[#SiteSearchSettings|site search settings]].
 
#Click '''Save.'''
 
#Click '''Save.'''
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Allowed domains
 
|sectionHeading=Allowed domains
 
|anchor=AllowedDomains
 
|anchor=AllowedDomains
|Standalone=No
+
|alignment=Vertical
|ComingSoon=No
 
|alignment=Horizontal
 
|image=AllowedDomains.png
 
|Media=Image
 
 
|structuredtext=Identify the website domains that you want to accept web traffic from.
 
|structuredtext=Identify the website domains that you want to accept web traffic from.
  
Line 54: Line 45:
 
#Type the domain you want to track.<br />
 
#Type the domain you want to track.<br />
 
#To add another domain, click '''Add more'''.<br />
 
#To add another domain, click '''Add more'''.<br />
|fullwidth=No
+
|Status=No
 +
}}{{Section
 +
|sectionHeading=Exclude IP addresses
 +
|anchor=ExcludeIPAddressesses
 +
|alignment=Horizontal
 +
|Media=GIF
 +
|image=ExIP1.gif
 +
|structuredtext=You can designate IP addresses for which {{MINTYDOCSPRODUCT}} should not generate web events. For example, you might not want to track visits from internal users.
 +
 
 +
{{NoteFormat|
 +
* This feature works in addition to whatever blocking your corporate IT department does to block external traffic from competitors, robo-spammers, and so on.
 +
*You can add up to 10 IP filters.
 +
* IP filtering works only when Altocloud processes web beacons. Therefore, you cannot use this setting to block {{MINTYDOCSPRODUCT}}'s tracking of custom events.|}}
 +
 
 +
To block an IP address:
 +
 
 +
#Click '''Add IP address'''.
 +
#In the '''Enter an IP filter''' box, type either a single IP address or use CIDR notation to specify a range of IP addresses.
 +
#*{{MINTYDOCSPRODUCT}} supports both IPv4 and IPv6 protocols. For IPv6, {{MINTYDOCSPRODUCT}} supports both the shorthand and expanded version.
 +
#*{{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Web_tracking|anchor=IPexamples|display text=IP examples}}
 +
#In the adjacent box, type a recognizable name for the IP address.
 +
#Click the check mark.
 +
 
 +
{{NoteFormat|To see the implied CIDR range of the IP address you entered, hover over it.|2}}
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=IP examples
 +
|anchor=IPexamples
 +
|alignment=Vertical
 +
|structuredtext====Valid IP addresses (IPv4)===
 +
Valid IPv4 CIDR input follows the format: <A valid IPv4 address>/<A number from 0-32>.
 +
{{{!}} class="wikitable"
 +
{{!}}-
 +
!Good examples
 +
!Bad examples
 +
{{!}}-
 +
{{!}}
 +
*10.10.10.10/8
 +
*10.10.10.10/16
 +
*10.10.10.10/24
 +
*10.10.10.10/32
 +
{{!}}
 +
*10.10.10.10/33 (the max for IPv4 is /32)
 +
*10.10.10.10/-1 (cannot be a negative number)
 +
*10.10.10.10/.10 (must be a whole number)
 +
*10.10.10.10/& (no special characters allowed)
 +
*10.10.10.10/8/16 (only 1 slash allowed)
 +
{{!}}}
 +
 
 +
===Valid IP addresses (IPv6)===
 +
Valid IPv6 CIDR input follows the format: <A valid IPv6 address>/<A number from 0-128>.
 +
{{{!}} class="wikitable"
 +
{{!}}-
 +
!Good examples
 +
!Bad examples
 +
{{!}}-
 +
{{!}}
 +
* ::1/32
 +
* ::1/64
 +
* ::1/128
 +
{{!}}
 +
* ::1/129 (the max for IPv6 is /128)
 +
* ::1/-1 (cannot be a negative number)
 +
* ::1/.10 (must be a whole number)
 +
* ::1/& (no special characters allowed)
 +
* ::1/128/64 (only 1 slash allowed)
 +
{{!}}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Short ID length
 
|sectionHeading=Short ID length
 
|anchor=ShortIDLength
 
|anchor=ShortIDLength
|Standalone=No
+
|alignment=Vertical
|ComingSoon=No
 
|alignment=Horizontal
 
|image=ShortIDPEPC.png
 
|Media=Image
 
 
|structuredtext={{MINTYDOCSPRODUCT}} assigns each visit a unique number that is based on a lengthy, automatically generated ID. In the Short ID field, indicate the number of digits that {{MINTYDOCSPRODUCT}} should use for each visit ID.   
 
|structuredtext={{MINTYDOCSPRODUCT}} assigns each visit a unique number that is based on a lengthy, automatically generated ID. In the Short ID field, indicate the number of digits that {{MINTYDOCSPRODUCT}} should use for each visit ID.   
  
Line 71: Line 124:
  
 
{{NoteFormat|To make it easier for agents and visitors to discuss the visitor's experience on your website, display the short ID on your site, as shown in the image. For more information on how to do this, see {{Link-SomewhereInThisProduct|version=Current|manual=SDK|topic=Integrate_short_ID}}.|2}}
 
{{NoteFormat|To make it easier for agents and visitors to discuss the visitor's experience on your website, display the short ID on your site, as shown in the image. For more information on how to do this, see {{Link-SomewhereInThisProduct|version=Current|manual=SDK|topic=Integrate_short_ID}}.|2}}
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Exclude URL query parameters
 
|sectionHeading=Exclude URL query parameters
 
|anchor=ExcludeURLQueryParameters
 
|anchor=ExcludeURLQueryParameters
|Standalone=No
+
|alignment=Vertical
|ComingSoon=No
 
|alignment=Horizontal
 
|image=ExcludeQueryParmPEPC.png
 
|Media=Image
 
 
|structuredtext=Specify any URL Query Parameters we should ignore. URL query parameters appear near the end of URLs. They can lead to overly-specific tracking data. They can also potentially expose personally identifiable information, which violates GDPR.
 
|structuredtext=Specify any URL Query Parameters we should ignore. URL query parameters appear near the end of URLs. They can lead to overly-specific tracking data. They can also potentially expose personally identifiable information, which violates GDPR.
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Keep URL fragments
 
|sectionHeading=Keep URL fragments
 
|anchor=KeepURLFrag
 
|anchor=KeepURLFrag
|Standalone=No
 
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=You can configure whether {{MINTYDOCSPRODUCT}} should use URL fragments to identify web pages.  
 
|structuredtext=You can configure whether {{MINTYDOCSPRODUCT}} should use URL fragments to identify web pages.  
Line 97: Line 142:
  
 
{{NoteFormat|Unless you want to track the URL fragments, do not enable this option.}}
 
{{NoteFormat|Unless you want to track the URL fragments, do not enable this option.}}
|fullwidth=Yes
 
|structuredtextwide={{{!}} class="wikitable"
 
{{!}}-
 
{{!}}{{!}}'''If you...'''
 
{{!}}{{!}}'''Then Altocloud...'''
 
{{!}}{{!}}'''Example'''
 
{{!}}-
 
{{!}}{{!}}Do not keep URL fragments
 
{{!}}{{!}}Ignores query parameters after the fragment.<br />
 
{{!}}{{!}}<tt><small><nowiki>website.com/products/product#?query=searchedstring</nowiki></small></tt>
 
 
 
is tracked as
 
 
<tt><small><nowiki>website.com/products/product</nowiki></small></tt><br />
 
{{!}}-
 
{{!}}{{!}}Use query strings before the fragment and do not choose to keep them
 
{{!}}{{!}}Tracks that query parameter but not the fragment.<br />
 
{{!}}{{!}}<tt><small><nowiki>website.com/products/product?query=searchedstring#some-fragment </nowiki></small></tt>
 
 
 
is tracked as
 
 
<tt><small><nowiki>website.com/products/product?query=searchedstring</nowiki></small></tt><br />
 
{{!}}-
 
{{!}}{{!}}Do keep URL fragments
 
{{!}}{{!}}tracks the query parameters after the fragment.
 
{{!}}{{!}}<tt><small><nowiki>website.com/products/product#?query=searchedstring</nowiki></small></tt>
 
 
 
is tracked as
 
 
<tt><small><nowiki>website.com/products/product#</nowiki></small></tt>
 
{{!}}}
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Site search settings
 
|sectionHeading=Site search settings
 
|anchor=SiteSearchSettings
 
|anchor=SiteSearchSettings
|Standalone=No
+
|alignment=Vertical
|ComingSoon=No
 
|alignment=Horizontal
 
|image=SiteSearch0131.png
 
|Media=Image
 
 
|structuredtext=Type the parameter for search terms on your website. For example, if “?term=Sale#search” is appended to the end of your URL when a customer searches for “Sale,” type “term” in this box.
 
|structuredtext=Type the parameter for search terms on your website. For example, if “?term=Sale#search” is appended to the end of your URL when a customer searches for “Sale,” type “term” in this box.
|fullwidth=No
 
 
|Status=No
 
|Status=No
}}{{Section
 
|sectionHeading=Filter IP addresses
 
|anchor=FilterIPAddresses
 
|Standalone=No
 
|ComingSoon=No
 
|alignment=Horizontal
 
|structuredtext=Placeholder block for AI-164
 
 
Filter out addresses that should not be included in {{MINTYDOCSPRODUCT}} tracking statistics (affects machine learning, reporting, pricing, etc.)
 
 
Example: you don't want to include internal traffic.
 
 
Note: This is in addition to whatever blocking your corporate IT department does to block external traffic from competitors, robo-spammers, etc.
 
 
You can block a single address.
 
 
To block a range of addresses, specify a range. For a large number of addresses, use CIDR notation.
 
 
Examples of CIDR notation
 
 
Warning about using CIDR (could exclude needed IP addresses)
 
 
Link to a site that explain/provides examples of CIDR notation
 
|fullwidth=No
 
|Status=Yes
 
 
}}
 
}}
 
}}
 
}}

Revision as of 14:15, January 28, 2020

Configure how Genesys Predictive Engagement tracks your visitors as they move through your website.

Prerequisites

About web tracking

Genesys Predictive Engagement analyzes the paths your visitors take on your website to determine when to trigger action maps and to calculate visitors' outcome scores.

Configure web tracking

Tip
Before you begin, deploy the Genesys Predictive Engagement tracking snippet.
  1. Click Admin.
  2. Under Altocloud, click Web Tracking.
  3. Specify the allowed domains.
  4. Specify any excluded IP addresses.
  5. Specify the short ID length.
  6. Specify any URL query parameters that Genesys Predictive Engagement should ignore.
  7. Indicate whether Genesys Predictive Engagement should keep URL fragments.
  8. Specify any site search settings.
  9. Click Save.

Allowed domains

Identify the website domains that you want to accept web traffic from.

Important
  • Include only domain and sub-domains labels. Do not include additional /paths after the domain.
  • Genesys Predictive Engagement validates your domain entries and displays an error message if any are incorrect.
  1. Under Allowed Domains, click Add first domain.
  2. Type the domain you want to track.
  3. To add another domain, click Add more.

Exclude IP addresses

You can designate IP addresses for which Genesys Predictive Engagement should not generate web events. For example, you might not want to track visits from internal users.

Important
  • This feature works in addition to whatever blocking your corporate IT department does to block external traffic from competitors, robo-spammers, and so on.
  • You can add up to 10 IP filters.
  • IP filtering works only when Altocloud processes web beacons. Therefore, you cannot use this setting to block Genesys Predictive Engagement's tracking of custom events.

To block an IP address:

  1. Click Add IP address.
  2. In the Enter an IP filter box, type either a single IP address or use CIDR notation to specify a range of IP addresses.
    • Genesys Predictive Engagement supports both IPv4 and IPv6 protocols. For IPv6, Genesys Predictive Engagement supports both the shorthand and expanded version.
    • IP examples
  3. In the adjacent box, type a recognizable name for the IP address.
  4. Click the check mark.
Tip
To see the implied CIDR range of the IP address you entered, hover over it.

IP examples

Valid IP addresses (IPv4)

Valid IPv4 CIDR input follows the format: <A valid IPv4 address>/<A number from 0-32>.

Good examples Bad examples
  • 10.10.10.10/8
  • 10.10.10.10/16
  • 10.10.10.10/24
  • 10.10.10.10/32
  • 10.10.10.10/33 (the max for IPv4 is /32)
  • 10.10.10.10/-1 (cannot be a negative number)
  • 10.10.10.10/.10 (must be a whole number)
  • 10.10.10.10/& (no special characters allowed)
  • 10.10.10.10/8/16 (only 1 slash allowed)

Valid IP addresses (IPv6)

Valid IPv6 CIDR input follows the format: <A valid IPv6 address>/<A number from 0-128>.

Good examples Bad examples
  •  ::1/32
  •  ::1/64
  •  ::1/128
  •  ::1/129 (the max for IPv6 is /128)
  •  ::1/-1 (cannot be a negative number)
  •  ::1/.10 (must be a whole number)
  •  ::1/& (no special characters allowed)
  •  ::1/128/64 (only 1 slash allowed)

Short ID length

Genesys Predictive Engagement assigns each visit a unique number that is based on a lengthy, automatically generated ID. In the Short ID field, indicate the number of digits that Genesys Predictive Engagement should use for each visit ID.

You should choose a short ID length that is long enough to be unique among all visitors that are currently active on your website. The more traffic your site gets, the longer your short ID should be. For example: if you always have less than 10,000 visitors at any time, a short ID length of 4 will suffice. If you could have more than 100,000 visitors at any one time, then you should choose a short ID length of 6.

Important
If you find that you need a longer short ID, you can increase the length at any time. Your changes will take effect immediately.
Tip
To make it easier for agents and visitors to discuss the visitor's experience on your website, display the short ID on your site, as shown in the image. For more information on how to do this, see [[ATC/Current/SDK/Integrate_short_ID|]].

Exclude URL query parameters

Specify any URL Query Parameters we should ignore. URL query parameters appear near the end of URLs. They can lead to overly-specific tracking data. They can also potentially expose personally identifiable information, which violates GDPR.

Keep URL fragments

You can configure whether Genesys Predictive Engagement should use URL fragments to identify web pages.

URL fragments appear after a URL. For example, in "altocloud.com#pagename", #pagename is a URL fragment.

While URL fragments can identify specific webpages, they can also potentially expose personally identifiable information, which violates GDPR. They can also result in an excess amount of tracking data.

Important
Unless you want to track the URL fragments, do not enable this option.

Site search settings

Type the parameter for search terms on your website. For example, if “?term=Sale#search” is appended to the end of your URL when a customer searches for “Sale,” type “term” in this box.

Comments or questions about this documentation? Contact us for support!