Difference between revisions of "ATC/Current/SDK/Forms: track"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
DannaShirley (talk | contribs) (Published) |
||
| Line 4: | Line 4: | ||
|TocName=forms:track | |TocName=forms:track | ||
|Context=Learn how to use the<tt>forms:track</tt> method to capture when users complete web-based forms. | |Context=Learn how to use the<tt>forms:track</tt> method to capture when users complete web-based forms. | ||
| − | |Dimension= | + | |Dimension=DevTracking |
|ComingSoon=No | |ComingSoon=No | ||
|Platform=PureEngage, PureConnect, PureCloud | |Platform=PureEngage, PureConnect, PureCloud | ||
| + | |Prereq= | ||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
| + | |anchor= | ||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=The <tt>forms:track</tt> method tracks form submission and abandonment events. By default, forms tracking captures form data when a user submits or abandons a form. | |structuredtext=The <tt>forms:track</tt> method tracks form submission and abandonment events. By default, forms tracking captures form data when a user submits or abandons a form. | ||
| Line 17: | Line 21: | ||
See also {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API}}. | See also {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API}}. | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Signature | |sectionHeading=Signature | ||
| + | |anchor= | ||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=<tt>ac('forms:track', [selector], [options]);</tt> | |structuredtext=<tt>ac('forms:track', [selector], [options]);</tt> | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Arguments | |sectionHeading=Arguments | ||
| + | |anchor= | ||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=*[[#selector|selector]] | |structuredtext=*[[#selector|selector]] | ||
*[[#options|options]] | *[[#options|options]] | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=selector | |sectionHeading=selector | ||
| + | |anchor= | ||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=*Description: The CSS selector for the element or elements you want to track. | |structuredtext=*Description: The CSS selector for the element or elements you want to track. | ||
*Type: string | *Type: string | ||
*Status: optional | *Status: optional | ||
*Default: form | *Default: form | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 41: | Line 62: | ||
|anchor=options | |anchor=options | ||
|alignment=Vertical | |alignment=Vertical | ||
| + | |Media= | ||
| + | |image= | ||
|structuredtext=*Description: The activity or behavior that you want to track. | |structuredtext=*Description: The activity or behavior that you want to track. | ||
*Type: object | *Type: object | ||
| Line 84: | Line 107: | ||
{{!}}{{!}} | {{!}}{{!}} | ||
{{!}}} | {{!}}} | ||
| + | |structuredtextwide= | ||
| + | |FAQHeading= | ||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 10:12, June 10, 2020
This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.
Learn how to use theforms:track method to capture when users complete web-based forms.
Description
The forms:track method tracks form submission and abandonment events. By default, forms tracking captures form data when a user submits or abandons a form.
- Recorded form data includes the values of all input, select, and textarea fields.
- Recorded form data excludes the values of hidden, submit, and password fields, along with any fields that contain any of the sensitive input strings.
Important
In order for Altocloud SDK forms tracking to capture form data, each input needs to have a properly defined name attribute.See also Form Tracking API.
Signature
ac('forms:track', [selector], [options]);
Arguments
selector
- Description: The CSS selector for the element or elements you want to track.
- Type: string
- Status: optional
- Default: form
options
- Description: The activity or behavior that you want to track.
- Type: object
- Status: optional
- Default: {}
- Properties:
| Name | Description | Type | Status | Default | Arguments |
| captureFormDataOnAbandon | boolean | optional | true | ||
| captureFormDataOnSubmit | boolean | optional | true | ||
| transform | function | optional | formDataObject | ||
| traitsMapper | traitsMapper |
Comments or questions about this documentation? Contact us for support!