Lens is used to define the expected action pattern required to perform some Activity within the hosting application. For example, to complete a simple login, a user performs a set of actions. Once the login page is loaded, a user typically:
1. Types in an email or user name in the Username field
2. Types in a password into the Password field.
3. Clicks the Login button.
To "remember" the course of a seemingly simple procedure the hollowing data should be collected:
- each user action is considered to be a system event,
- each element a user interacts with passes various properties to Apty with the aim of identifying this element in a unique way (id, class, its relationships with other page elements, etc.).
In essence, Activity is a combination of user's step by step actions in the system, which are registered by tracking events and properties identifying the elements a user interacts with. This article covers types of events and attributes collected by Apty to record an Activity with Lens.
Types of Events being captured
To register certain action performed by a user in the hosting application, Apty listens to specif types of events to be performed. Only 2 types of events are registered:
- on change: The "onchange" attribute fires the moment when the value of the element is changed., for example, when user starts typing in a value in the input field, changes selection of a drop-down list or marks a check-box to activate or deactivate the preference defined in the context).
Types of Element Attributes being collected
Once the event fires, Apty stores information about the element that user interacted with (clicked, provided input, or changed selection). The following element properties are captured by Apty:
|os||Gets the name of the operating system from which the hosting application has been accessed.|
|browser||Defines the browser used to access application.|
|language||Detects current language of the browser.|
|device||Detects the name of a device from which the hosing application is accessed.|
|browserVersion||States the version number of the browser that sent the current request.|
|deviceModel||The name of a device from which the hosting application has been accessed.|
|timezone||Specifies the time zone offset from UTC, in minutes, to use for the current session.|
|screenResolution||Width and height properties of the screen.|
|Event Details: general information about user actions relevant to the hosting application.|
|referred||A field that identifies the address of the webpage (i.e. the URI or IRI) which is linked to the resource being requested.|
|pageTitle||Defines the document's title that is shown in a browser's title bar or a page's tab.|
|isiFrame?||A boolean defining whether the event happened within the iFrame.|
|event||Represents user actions:|
|elementSelector||Represents the location of the actioned web element within the application’s DOM (document object model).|
|Element Details: general information about an element a user interacted with.|
|id||Uniquely identifies an element on the page.|
|timestamp / timezone||Date and time when a user interacted with an element.|
|alt/role/src/title, etc.||Attributes assigned to this element. The list of these attributes may vary depending on which of them were defined for this element.|
|children/parents/siblings||Define the position of the element in relation to others. For example, the "children" array will list all the elements that are nested in the given one.|
|tagName||The tagName read-only property of the element interface returns the tag name of the element on which it's called. For example, if the element is an <img>, its tagName property is "img".|
|label||If a given element has a label attached to it, it is going to be defined here.|
|url/urlPath||A path used to access this element.|
Types of KPIs
The following Key Performance Indicators are collected and processed to be further displayed at the Insights Dashboard.
- Average Session Time: Shows the statistical average of the time end users were engaged in one of the Activities.
- Error trend: The cumulative trend of increased or decreased amount of errors made by the users over the specified period of time.
- Active Users: The cumulative trend of increased or decreased amount of active users over the specified period of time.
- New Users:
A line graph showing the changing percentage of new users in the system. Click on any spot on the graph to see the exact number of new users on a specific day.
- Active Users:
A line graph showing the changing percentage of active users in the system. Click on any spot on the graph to see the exact number of active users on a specific day.
- Avg. Session: A line graph showing the changing percentage of average activity time (per session) in the system. Click on any spot on the graph to see the exact mean time for a user session on a specific day.
Error trend Widget
Top activity Completion Widget
Usage per Segment Widget
- Indicates total usage of all segments.
For more details about the Insights Dashboard, refer to this article.