Difference between revisions of "ATC/Current/SDK/Forms: track"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
DannaShirley (talk | contribs) (Published) |
||
| Line 4: | Line 4: | ||
|Platform=PureEngage, PureConnect, PureCloud | |Platform=PureEngage, PureConnect, PureCloud | ||
|TocName=forms:track | |TocName=forms:track | ||
| − | |Context= | + | |ComingSoon=No |
| + | |Context=Learn how to use the<tt>forms:track</tt> method to capture when users complete web-based forms. | ||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
| Line 10: | Line 11: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
| + | |structuredtext=The <tt>forms:track</tt> method tracks form submission and abandonment events. By default, forms tracking captures form data upon submit or abandon. | ||
| + | |||
| + | *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 following sensitive input strings: | ||
| + | **pass | ||
| + | **billing | ||
| + | **creditcard | ||
| + | **cardnum | ||
| + | **^cc | ||
| + | **ccnum | ||
| + | **exp | ||
| + | **seccode | ||
| + | **securitycode | ||
| + | **securitynum | ||
| + | **cvc | ||
| + | **cvv | ||
| + | **ssn | ||
| + | **socialsec | ||
| + | **socsec | ||
| + | **csc | ||
| + | |||
| + | {{NoteFormat|In order for Altocloud 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}}. | ||
|fullwidth=No | |fullwidth=No | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Signature | |sectionHeading=Signature | ||
| Line 18: | Line 44: | ||
|structuredtext=<tt>ac('forms:track', [selector], [options]);</tt> | |structuredtext=<tt>ac('forms:track', [selector], [options]);</tt> | ||
|fullwidth=No | |fullwidth=No | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Arguments | |sectionHeading=Arguments | ||
| Line 23: | Line 50: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
| − | |structuredtext=* [[#selector|selector]] | + | |structuredtext=*[[#selector|selector]] |
| − | * [[#options|options]] | + | *[[#options|options]] |
|fullwidth=No | |fullwidth=No | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=selector | |sectionHeading=selector | ||
| Line 31: | Line 59: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
| − | |structuredtext=* Description: | + | |structuredtext=*Description: The element you want to track. |
| − | * Type: string | + | *Type: string |
| − | * Status: optional | + | *Status: optional |
| − | * Default: form | + | *Default: form |
|fullwidth=No | |fullwidth=No | ||
| + | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=options | |sectionHeading=options | ||
| Line 42: | Line 71: | ||
|alignment=Vertical | |alignment=Vertical | ||
|gif=No | |gif=No | ||
| − | |structuredtext=* Description: | + | |structuredtext=*Description: The activity or behavior that you want to track. |
| − | * Type: object | + | *Type: object |
| − | * Status: optional | + | *Status: optional |
| − | * Default: {} | + | *Default: {} |
| − | * Properties: | + | *Properties: |
| + | |||
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
{{!}}- | {{!}}- | ||
| Line 85: | Line 115: | ||
{{!}}} | {{!}}} | ||
|fullwidth=No | |fullwidth=No | ||
| + | |Status=No | ||
}} | }} | ||
}} | }} | ||
Revision as of 14:04, January 9, 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 upon submit or abandon.
- 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 following sensitive input strings:
- pass
- billing
- creditcard
- cardnum
- ^cc
- ccnum
- exp
- seccode
- securitycode
- securitynum
- cvc
- cvv
- ssn
- socialsec
- socsec
- csc
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 element 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!