This section provides information about the Tealeaf CX features that you use when you integrate your Android, iOS, and Webview applications with Tealeaf.
Work with client framework data in Tealeaf
After you integrate one of the Tealeaf client frameworks with your web application or mobile native application, you configure Tealeaf to capture and process the data. You configure data privacy, capture, events, and the Canister.
- Configure data privacy for client frameworks.
- Install and implement the Tealeaf framework for capture.
- Configure the Canister.
- Configure Tealeaf events.
Configure data privacy for client frameworks
Configure data privacy rules to mask any data captured from the client frameworks, such as passwords, that must not be submitted to Tealeaf for capture.
As part of any implementation through Professional Services, data privacy is configured and applied for any data that is submitted from a monitored client application. Before you enable capture of client framework data, verify that privacy configuration was properly enabled and configured.
Install and implement the framework for capture
After you integrated the framework with your application, you must configure the framework to capture the data and configure Tealeaf and process the data.
| To install and implement data capture for | Use this information |
|---|---|
| Native Android applications and for hybrid native Android and WebView applications. | Tealeaf for Android, standard and mobile editions |
| Native iOS application and for hybrid native iOS and WebView applications. | Tealeaf for iOS, standard and mobile editions |
| JavaScript™ WebView applications. | Tealeaf UI Capture |
Other Tealeaf configuration
You might need to configure the Canister safety limits for your deployment:
| Description | Applicability |
|---|---|
| To prevent runaway growth of active sessions in the Canister, Tealeaf imposes maximum limits on duration, data size, and number of hits for a session. If any of these limits is exceeded, the session is automatically closed in the Canister, even if the visitor is still using the application. Subsequent hits are recorded to a new session. | The Canister Safety limits apply to client framework sessions, including sessions from mobile native applications.
|
Configure Tealeaf events
There are three things to keep in mind about events:
- Tealeaf provides a set of events and event-related objects for use in capturing and processing data from client frameworks.
- Data that is submitted from a client framework is in the form of JSON-based messages. These messages are processed and stored as individual steps in the session data. The step-based events and hit attributes that you create from these messages perform like other Tealeaf objects, but they are configured in a different manner.
- You might find it useful to work through a complete scenario in which you create step-based events and hit attributes from client framework data and then integrate those event objects into your data from your browser-based web application.
Client framework versions and licenses
To use any Tealeaf client framework, you must have the Tealeaf cxImpact license. Tealeaf CX Mobile license is required for Android Logging Framework and iOS Logging Framework.
If you do not have CX Mobile
If you did not license CX Mobile and you have the UI Capture j2 Framework, you cannot display mobile-specific features and events during replay.
Versions of UI Capture for Ajax
Depending on the licenses that you acquired, the following versions of UI Capture are available and determine the method by which data is captured and submitted to Tealeaf for processing. These licenses and their supported methods also determine the type of applications that CX UI Capture for AJAX is able to monitor.
CX UI Capture for AJAX is only available to legacy users. New users must use Tealeaf UI Capture.
The JSON version of CX UI Capture for AJAX is the only one that is supported. For more information about support for the legacy XML version, contact Support.
| License | Method of capturing and submitting | Monitored applications |
|---|---|---|
| Tealeaf CX only | JSON | fixed desktop web applications |
| Tealeaf CX and Tealeaf CX Mobile | JSON | fixed desktop web applications mobile web browser applications |
Versions of Logging Frameworks
For the Tealeaf Logging Frameworks, the following versions are available for this release. Logging Frameworks require CX Mobile license.
Depending on the licenses that you acquired, the following versions of the Logging Frameworks are available and determine the method by which data is processed within Tealeaf.
| License | Method of processing hits | Description |
|---|---|---|
| Tealeaf CX Mobile only | Hit-splitting | When data captured from the Logging Frameworks is processed in the Windows™ pipeline, messages are split into separate, individual hits and added to the session data.
Hit-splitting is considered the legacy method of processing client framework data. It is likely to be deprecated in a future release. This method requires the deployment of a specific session agent in the Windows pipeline to split hits |
| Tealeaf CX and Tealeaf CX Mobile | JSON | Data is captured from the client frameworks and submitted in a compact JSON format. This data is made available in a more readable format through Browser-Based Replay, from which you can create step-based events and attributes for tracking purposes.
This method is the current version of processing client framework data. No additional configuration is required. |
Configuration for client frameworks
You must complete several tasks to configure Tealeaf for client frameworks. Some of the tasks are done on the client frameworks and some on the server.
The following steps describe the process to configure Tealeaf and the client frameworks:
- Install and implement the client framework, Android, iOS, or UI Capture.
- Configure session agents.
- Configure PCA.
Client framework tasks
Use the client framework documentation to configure Tealeaf for client frameworks:
- Deploy and configure the client framework.
- Set up data privacy in the client framework.
- Configure sessionization on the client framework.
- Configure sessionization on the server.
- Configure the target page.
Windows pipeline, Reference and session agent, and WURFL
When data is captured and passed through Tealeaf, session information is analyzed and sometimes transformed in the Windows pipeline. The pipeline is a series of configurable session agents. Each of the agents performs one or more operations on the hit data before the agent passes the hit to the next agent in the sequence.
Whether a mobile native application submits a user agent string is determined by the developer of the application. To facilitate user agent detection, the Tealeaf client frameworks for Mobile App automatically submit a user agent string and other device properties, which the Tealeaf Reference session agent uses to populate the same values in the request that are used by Mobile web.
The Tealeaf Reference session agent is deployed in the default pipeline to verify user agent information that is submitted by the client with each request. When a web browser or fixed browser submits a request to a server, it typically includes a string to identify itself. This string is used by the Tealeaf Reference session agent to perform lookups against the WURFL public standard, which identifies mobile user agents. When WURFL is downloaded from its source and deployed, more useful information about the browser, operating system, and platform is extracted based on the user agent and inserted into the request of the hit.
Session agent configuration
Windows pipeline session agent configuration varies based on how data is submitted and captured. Most of the frameworks do not require additional configuration. This table lists the frameworks and whether additional configuration is needed:
| Framework | Configuration |
|---|---|
| Mobile native applications |
For mobile native applications that use the step-based method of submitting and capturing data, no additional configuration is required in the Windows pipeline. For mobile native applications that use the legacy, hit-splitting method of processing data within of Tealeaf, some session agents must be deployed in your Windows pipeline. |
| UI Capture |
If you are using the JSON version of UI Capture, no additional configuration in the Windows pipeline is required. For mobile web applications captured by UI Capture, deploy the Tealeaf Reference session agent to capture user agent information for mobile web browsers. The Tealeaf Reference session agent is included by default in the Windows pipeline. |
PCA Configuration
By default, the CX Passive Capture Application is configured to enable the capture of the JSON mimetypes that is submitted by the Tealeaf client frameworks. Before you continue, verify that these types are enabled for capture.
Each Logging Framework might be using a different content type for submitting events for capture to Tealeaf. Be sure to review and verify the content type for each deployed client framework.
| Framework | Required Content Type to Capture |
|---|---|
| Tealeaf UI Capture | application/json |
| Android Logging Framework | text/json |
| iOS Logging Framework | text/json |
Next steps
After the PCA is configured to capture client framework data and the client framework is properly deployed, data is captured by Tealeaf.
After all configuration is complete, you can test for the presence of client framework data and define events and event-related objects to enable search and replay of sessions and to provide insightful analysis of your applications.
Default Tealeaf client framework event objects
Tealeaf provides default events and event-related objects for detecting, capturing, and storing data from the client framework that you deploy in your web environment. As you build your object library, you might want to print this page and complete the gaps with the names of the objects that you created. You can also gather this information at any time by reviewing the dependent objects for any selected object in the Event Manager.
Generated user agent attributes
This table describes the attributes that are generated by Tealeaf based on user agent information.
| Hit Attribute | Event | Dimension | Session Attribute | Description |
|---|---|---|---|---|
| Standard Event Object Reference | Standard Event Object Reference | Standard Event Object Reference | Detection of source of hit from mobile native application | |
Standard Event Object Reference (=MOBILE) |
Standard Event Object Reference | Detection of Mobile Web hit captured by UI Capture | ||
Standard Event Object Reference (=MOBILE_APP) |
Standard Event Object Reference | Detection of Mobile Web hit captured by a mobile client framework |