Difference between revisions of "ATC/Current/SDK/Forms: track"
From Genesys Documentation
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
| Line 6: | Line 6: | ||
|Dimension=DevTracking | |Dimension=DevTracking | ||
|ComingSoon=No | |ComingSoon=No | ||
| − | |Platform=GenesysEngage-cloud | + | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud |
| − | |||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|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 textarea fields. | *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 {{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|In order for | + | {{NoteFormat|In order for {{MintyDocsProduct}} SDK forms tracking to capture form data, each input needs to have a properly defined <tt>name</tt> attribute.|}} |
See also {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API}}. | See also {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API}}. | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Signature | |sectionHeading=Signature | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=<tt>ac('forms:track', [selector], [options]);</tt> | |structuredtext=<tt>ac('forms:track', [selector], [options]);</tt> | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Arguments | |sectionHeading=Arguments | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|structuredtext=*[[#selector|selector]] | |structuredtext=*[[#selector|selector]] | ||
*[[#options|options]] | *[[#options|options]] | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=selector | |sectionHeading=selector | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|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 | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
| Line 62: | Line 41: | ||
|anchor=options | |anchor=options | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
| − | |||
|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 107: | Line 84: | ||
{{!}}{{!}} | {{!}}{{!}} | ||
{{!}}} | {{!}}} | ||
| − | |||
| − | |||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 13:33, November 4, 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 Genesys Predictive Engagement 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!