Difference between revisions of "ATC/Current/SDK/autotrackIdle"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2")
m (Text replacement - "Genesys Cloud" to "Genesys Cloud CX")
 
(6 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
|DisplayName=autotrackIdle
 
|DisplayName=autotrackIdle
 
|TocName=autotrackIdle
 
|TocName=autotrackIdle
−
|Context=Learn how to configure when {{MINTYDOCSPRODUCT}} detects inactivity on a webpage, so you have more accurate page tracking information for use in segments and outcomes.
+
|Context=Learn how to configure when {{MINTYDOCSPRODUCT}} detects inactivity on a webpage. This configuration provides more accurate page tracking information for use in segments and outcomes.
 
|Dimension=Modules
 
|Dimension=Modules
 
|ComingSoon=No
 
|ComingSoon=No
−
|Platform=GenesysEngage-onpremises, PureConnect, GenesysCloud
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
−
|Prereq=
 
 
|Section={{Section
 
|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 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
 
|sectionHeading=Description
 
|sectionHeading=Description
 
|anchor=Description
 
|anchor=Description
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
+
|structuredtext=The <code>autotrackIdle</code> module tracks when and where a visitor becomes inactive on a webpage. To use <code>autotrackIdle</code>, configure the idle events to track using the following options:
−
|image=
 
−
|structuredtext=The <code>autotrackIdle</code> module tracks when and where a user becomes inactive on a webpage. To use <code>autotrackIdle</code>, use the following options to configure the idle events that you want to track:
 
  
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackIdle|anchor=Config|display text=Config}}
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackIdle|anchor=Config|display text=Config}}
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackIdle|anchor=Callback|display text=Callback}}
 
*{{Link-SomewhereInThisVersion|manual=SDK|topic=autotrackIdle|anchor=Callback|display text=Callback}}
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 25: Line 24:
 
|anchor=Signature
 
|anchor=Signature
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=<syntaxhighlight lang="javascript">
 
|structuredtext=<syntaxhighlight lang="javascript">
  
 
ac('load', 'autotrackIdle', [config], [callback]);
 
ac('load', 'autotrackIdle', [config], [callback]);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 38: Line 33:
 
|anchor=Example
 
|anchor=Example
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=<syntaxhighlight lang="javascript">
 
|structuredtext=<syntaxhighlight lang="javascript">
 
ac('load', 'autotrackIdle'); // This is for all one idle event config with defaults
 
ac('load', 'autotrackIdle'); // This is for all one idle event config with defaults
Line 54: Line 47:
 
});
 
});
 
</syntaxhighlight>
 
</syntaxhighlight>
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 61: Line 52:
 
|anchor=Config
 
|anchor=Config
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
+
|structuredtext='''Description:''' Identifies an array of idle events to track.
−
|image=
 
−
|structuredtext=Description: identifies an array of idle events that should be tracked.
 
  
−
Type: object
+
'''Type:''' Object
  
−
Properties:
+
'''Properties:''' See the following table.
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
 
{{!}}+
 
{{!}}+
Line 76: Line 65:
 
{{!}}-
 
{{!}}-
 
{{!}}idleAfter
 
{{!}}idleAfter
−
{{!}}The number of seconds of inactivity after which an event will fire.  
+
{{!}}Number of seconds of inactivity after which an event fires. The default is 60 seconds and the minimum is 30 seconds.
−
The default is 60 seconds.
+
'''Note:''' If you specify less than 30 seconds, 30 seconds is used.
−
 
 
−
'''Note:''' The minimum is 30 seconds. If you specify less than 30, then 30 seconds is used.
 
 
{{!}}Number
 
{{!}}Number
 
{{!}}optional
 
{{!}}optional
 
{{!}}-
 
{{!}}-
 
{{!}}eventName
 
{{!}}eventName
−
{{!}}A string that will be used as the event name when an element matching the selector is clicked.
+
{{!}}String used as the event name when an element matching the selector is clicked.
 
{{!}}String
 
{{!}}String
 
{{!}}optional
 
{{!}}optional
Line 99: Line 86:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 106: Line 91:
 
|anchor=Callback
 
|anchor=Callback
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
+
|structuredtext=When a module loads, callback is executed. No arguments pass to the callback.
−
|image=
 
−
|structuredtext=When a module fully loads, callback is executed. No arguments are passed to the callback.
 
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 21:28, November 9, 2021

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

Learn how to configure when Genesys Predictive Engagement detects inactivity on a webpage. This configuration provides more accurate page tracking information for use in segments and outcomes.

Important
This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.

Description

The autotrackIdle module tracks when and where a visitor becomes inactive on a webpage. To use autotrackIdle, configure the idle events to track using the following options:

Signature

ac('load', 'autotrackIdle', [config], [callback]);

Example

ac('load', 'autotrackIdle'); // This is for all one idle event config with defaults
 
ac('load', 'autotrackIdle', {
  idleEvents: [
    {}, // This is for all defaults
    { eventName: 'stuck_on_page' },
    { idleAfter: 60 },
    { eventName: 'idle_for_2_min', idleAfter: 120 },
  ]
}, function () {
    console.log('"autotrackIdle" has been loaded');
});

Config (optional)

Description: Identifies an array of idle events to track.

Type: Object

Properties: See the following table.

Name Description Type Status
idleAfter Number of seconds of inactivity after which an event fires. The default is 60 seconds and the minimum is 30 seconds.

Note: If you specify less than 30 seconds, 30 seconds is used.

Number optional
eventName String used as the event name when an element matching the selector is clicked. String optional

Example

{
  idleEvents: [
    {}, // This is for all defaults
    { eventName: 'stuck_on_page' },
    { idleAfter: 60 },
    { eventName: 'idle_for_2_min', idleAfter: 120 },
  ]
}

Callback (optional)

When a module loads, callback is executed. No arguments pass to the callback.

Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/autotrackIdle (2025-06-22 10:24:18)"
Comments or questions about this documentation? Contact us for support!