Difference between revisions of "ATC/Current/SDK/autotrackIdle"
From Genesys Documentation
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
| Line 3: | Line 3: | ||
|DisplayName=autotrackIdle | |DisplayName=autotrackIdle | ||
|TocName=autotrackIdle | |TocName=autotrackIdle | ||
| − | |Context=Learn how to configure when {{MINTYDOCSPRODUCT}} detects inactivity on a webpage | + | |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-cloud | + | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud |
| − | |||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
|anchor=Description | |anchor=Description | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=The <code>autotrackIdle</code> module tracks when and where a user becomes inactive on a webpage. To use <code>autotrackIdle</code>, configure the idle events to track using the following options: | |
| − | |||
| − | |structuredtext=The <code>autotrackIdle</code> module tracks when and where a user becomes inactive on a webpage. To use <code>autotrackIdle</code>, | ||
*{{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}} | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 25: | Line 20: | ||
|anchor=Signature | |anchor=Signature | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<syntaxhighlight lang="javascript"> | |structuredtext=<syntaxhighlight lang="javascript"> | ||
ac('load', 'autotrackIdle', [config], [callback]); | ac('load', 'autotrackIdle', [config], [callback]); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 38: | Line 29: | ||
|anchor=Example | |anchor=Example | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|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 43: | ||
}); | }); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 61: | Line 48: | ||
|anchor=Config | |anchor=Config | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext='''Description:''' identifies an array of idle events to track. | |
| − | |||
| − | |structuredtext=Description: identifies an array of idle events | ||
| − | Type: object | + | '''Type:''' object |
| − | Properties: | + | '''Properties:''' See the following table. |
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
{{!}}+ | {{!}}+ | ||
| Line 76: | Line 61: | ||
{{!}}- | {{!}}- | ||
{{!}}idleAfter | {{!}}idleAfter | ||
| − | {{!}} | + | {{!}}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:''' | ||
{{!}}Number | {{!}}Number | ||
{{!}}optional | {{!}}optional | ||
{{!}}- | {{!}}- | ||
{{!}}eventName | {{!}}eventName | ||
| − | {{!}} | + | {{!}}String used as the event name when an element matching the selector is clicked. |
{{!}}String | {{!}}String | ||
{{!}}optional | {{!}}optional | ||
| Line 99: | Line 82: | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 106: | Line 87: | ||
|anchor=Callback | |anchor=Callback | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=When a module loads, callback is executed. No arguments pass to the callback. | |
| − | |||
| − | |structuredtext=When a module | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 17:48, December 16, 2020
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.
Description
The autotrackIdle module tracks when and where a user 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.
Comments or questions about this documentation? Contact us for support!