Event Attributes enable you to capture additional contextual information with events to help with analysis and decision-making.
For example, along with the button click event, additional attributes such as the URL, the title of the page where it was clicked, the text on the button, and various other attributes from the application can be captured to give context to the button click event.
Note:
Capturing Event Attributes is a Beta feature. To enable this feature, contact support@whatfix.com.
The following are the two steps to capture Event Attributes:
Create User Action
Capture related information from the element
Expand the following accordions for more details:
Create User Action
Use the following steps to create a User Action:
- Log in to your application, and then launch the Whatfix Studio.
Scroll down to the bottom, and then click User Action.
Click Create user action.
Select the desired UI element on the page that you want to track.
Review or edit the name of the User Action.
Info:
Choose a name that enables identification of the User action on the Whatfix Analytics dashboard. The choice aids in looking up usage later.
Click Edit User Action Detail
In the DETAILS tab, under Tags (Optional), type the name of the tag to select from the list.
Info:
If the tag does not exist, type the name of the tag and hit the Enter key to create a new tag.
Note:
Click the Back icon to go back to the User Action main page.
Under Configurations, select the User Action completion rule from the dropdown.
Info:
Select the option that you want your users to perform on the element. The User Action is marked as complete only when the selected rule is performed. For more information, see What are User Action Completion Rules?
Click Advanced Options.
Expand Display Rules, and then click + Add Rule.
Note:
The URL-based Display Rules (URL, URL Hostname, URL Path, URL Parameters, and URL Hash) ensure that the User Actions loading on the application are specific to that page.
The CSS-based Display Rules (Other Element on Page, Selected Element Is, and Selected Element Text) ensure that Whatfix can uniquely identify the element on which the User Action needs to be created.
For more information, see Visibility and Display Rule Conditions.
Set the desired Display Rules conditions.
Info:
For accounts that do not have Smart Context enabled, applying the Display Rule is mandatory.
Go back to the Configurations section.
Capture related information from the element
Once you've captured a User Action, Whatfix enables you to capture contextual information from the same element or other elements, which appear on the page.
Capture related information from the same element
Use the From the selected element toggle when the created User Action itself contains the information you want to track.
For example, the Edit icon in Salesforce list views is captured as a User Action. Enabling the From the selected element toggle tracks the specific Lead an end user edits, rather than just recording that an Edit action occurs.
Use the following steps to capture related information from the same element:
In the Collect Related Information section, enable the From the selected element toggle to capture the data from the User Action as an Event Attribute.
Info:
The first time you want to capture an Event Attribute, Whatfix shows a dialog box asking for your permission to activate the collection of Event Attributes. Select the checkbox and then click Activate Attribute Collection. The dialog box appears only once per user.
Select the Encrypt personally identifiable info (PII) checkbox to encrypt the Event Attribute.
Note:
For Page View-based User Actions, Whatfix does not enable you to capture related information from the same element. This is because the User Action involves no interaction with a UI element. However, you can still capture related information from the associated elements.
Capture related information from the associated element
Use the From the associated elements toggle when the information you want to track is displayed elsewhere on the page, not within the clicked element itself.
For example, clicking Save Opportunity is captured as a User Action. Enabling the From the associated elements toggle tracks additional details, such as Opportunity Stage and Opportunity Amount, which are displayed in separate fields on the page and not part of the Save button itself.
Use the following steps to capture related information from the associated element:
Enable the From the associated elements toggle, to capture additional information on the page.
Info:
The first time you want to capture an Event Attribute, Whatfix shows a dialog box asking for your permission to activate the collection of Event Attributes. Select the checkbox and then click Activate Attribute Collection. The dialog box appears only once per user.
Click Collect Information.
Select the desired element on the page that you want to track.
In the Captured information details dialog box, enter a name for the element.
Info:
The name of the Event Attribute you capture should be unique for a particular User Action.
Encrypt the information if it contains Personally Identifiable Info (PII).
Click Add and finish.
Info:
If you want to add more elements, click Add another element and then follow steps 3 and 4. Once you've added all the elements, click Add and finish.
Add up to 10 Event Attributes per User Action.
Add Capture Rules to define the unique identifier related to the element. Click Add Rule to add a Selected Element Is display condition.
Click Save Action.
Info
Access the User Action you create on the Whatfix Analytics Dashboard. The Event Attributes you capture are part of the specific User Action.
Use the following steps to access User Actions:
On the Whatfix Analytics dashboard, click Tracking.
Click Events.
The User Actions section contains the User Actions and the associated event attributes.
Use the Event Attributes in Trend Insights for further analysis.
