Difference between revisions of "ATC/Current/SDK/Forms: track"
From Genesys Documentation
(Published) |
(Published) |
||
| Line 12: | Line 12: | ||
|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. | ||
| − | *Recorded form data '''includes''' the values of all input, select, and | + | *Recorded form data '''includes''' the values of all input, select, and text area fields. |
*Recorded form data '''excludes''' the values of hidden, submit, and password fields, along with any fields that contain any of the {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API|anchor=SensitiveFields|display text=sensitive input strings}}. | *Recorded form data '''excludes''' the values of hidden, submit, and password fields, along with any fields that contain any of the {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API|anchor=SensitiveFields|display text=sensitive input strings}}. | ||
| − | {{NoteFormat| | + | {{NoteFormat|For {{MintyDocsProduct}} SDK forms tracking to capture form data, each input requires a properly defined <tt>name</tt> attribute.|}} |
| − | + | For more information, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API}}. | |
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 32: | Line 32: | ||
|sectionHeading=selector | |sectionHeading=selector | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |structuredtext=*Description: | + | |structuredtext=*'''Description:''' CSS selector for the element or elements you want to track. |
| − | *Type: | + | *'''Type:''' String |
| − | *Status: | + | *'''Status:''' Optional |
| − | *Default: | + | *'''Default:''' Form |
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 41: | Line 41: | ||
|anchor=options | |anchor=options | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |structuredtext=*Description: | + | |structuredtext=*'''Description:''' Activity or behavior to track |
| − | *Type: | + | *'''Type:''' Object |
| − | *Status: | + | *'''Status:''' Optional |
| − | *Default: {} | + | *'''Default:''' {} |
| − | *Properties: | + | *'''Properties:''' See the following table. |
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
| Line 58: | Line 58: | ||
{{!}}{{!}}captureFormDataOnAbandon | {{!}}{{!}}captureFormDataOnAbandon | ||
{{!}}{{!}}<br /> | {{!}}{{!}}<br /> | ||
| − | {{!}}{{!}} | + | {{!}}{{!}}Boolean |
{{!}}{{!}}optional | {{!}}{{!}}optional | ||
{{!}}{{!}}true | {{!}}{{!}}true | ||
| Line 65: | Line 65: | ||
{{!}}{{!}}captureFormDataOnSubmit | {{!}}{{!}}captureFormDataOnSubmit | ||
{{!}}{{!}}<br /> | {{!}}{{!}}<br /> | ||
| − | {{!}}{{!}} | + | {{!}}{{!}}Boolean |
{{!}}{{!}}optional | {{!}}{{!}}optional | ||
{{!}}{{!}}true | {{!}}{{!}}true | ||
Revision as of 19:34, December 16, 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 text area 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
For Genesys Predictive Engagement SDK forms tracking to capture form data, each input requires a properly defined name attribute.For more information, see Form Tracking API.
Signature
ac('forms:track', [selector], [options]);
Arguments
selector
- Description: CSS selector for the element or elements you want to track.
- Type: String
- Status: Optional
- Default: Form
options
- Description: Activity or behavior to track
- Type: Object
- Status: Optional
- Default: {}
- Properties: See the following table.
| 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!