Android: Server configuration

Quick start server configuration

Overview

Skill Level: Intermediate
Capture and process data that is submitted from the Android SDK (or Eclipse plug-in)
You can quickly set up the Tealeaf Experience Analytics for Mobile Basic Edition and Windows based servers to capture and process data that is submitted from Android.

Prerequisites

Before getting started, ensure that you install and implement SDK (or the Eclipse plug-in) by following these instructions:

Step-by-step

1. Add a target page to your web server environment to which the Android SDK can submit posts.

is designed to capture traffic between a client and a web server. To facilitate capture, you must add a target page to your web server environment to which the Android SDK can submit posts.

After you add the target page to your web environment and enable the appropriate access permissions, you must configure the URL for the target page in the TLFConfigurableItems.properties page.

Note:

If needed, you can configure the client framework to submit by HTTPS by adding the protocol identifier to the post URL. See Configuration file

2. Add a sampling function to work with the Android SDK KillSwitch.

You can add a sampling function to work with the Android SDK KillSwitch. You can use this sampling function to throttle the sampling rate and thus the volume of traffic that is forwarded for capture.

For more information about sampling functions for various server environments, see Sample code.

3. Verify traffic capture.

You verify that the in your environment is configured to capture and process the data that is submitted from the Logging Frameworks.

The data is submitted using specific content types, which the is typically configured to capture by default. You must verify that these content types were enabled for capture through the Web Console.

Verifying capture type configuration

You use this procedure to verify that the is configured to capture the content types submitted by the Android SDK.

Note:

Depending on the version of the you installed, the required content types may already be configured for capture.

The Android SDK submits messages using the text/json content type.

Note:

Each Logging Framework can use a different content type for submitting events for capture to . Be sure to review and verify the content type for each deployed client framework.

  1. Log in to the web console: <PCAServer>:8080
    where <PCAServer> is the host name of the server.

  2. Click the Pipeline tab.

  3. Click Edit Type Lists.

  4. In the Capture All POST Types box, verify that the following values are included:
    text/json
    text/x-json
    application/json
    application/x-json

  5. Click Add.

  6. The is now configured to capture the required content types. All subsequent hits of this type are captured.

  7. Save changes.

Configuring for Logging Framework screen captures

See UICActivity class.

Optionally, you can enable the Android SDK to capture screen captures during the initial load of each view or screen of your web application. These screen captures are forwarded to the Target Page in .PNG format for capture and use during session display.

When this option is enabled, you must configure the to capture these screen captures. By default, the drops capture of binary or static content, so you must configure it to capture these images that are submitted as binary POSTs to the target page.

  1. Log in to the web console:<PCAServer&gt;:8080 Where <PCAServer> is the host name of the server.

  2. Click the Pipeline tab.

  3. Click Edit Type Lists.

  4. In the Excluded File Extensions list, verify that png is listed.

  5. In the Included File Extensions list, verify that png is not listed.

Note:

If a file extension is included in this list, then all instances that are sent as responses are captured, which greatly expands the volume of data that is captured by the . Capture in this manner is not required.

  1. In the Binary POST Types box, enter the following value:image/png

  2. Click Add.

  3. The image/png POST type is added and enabled for capture. This setting allows the PNG posts to be captured by the Save changes.

Enabling automated extraction of compressed POSTs

The Android SDK automatically compresses POST data. You must configure the to extract them.

Note:

For Build 3502 or later, this decompression is done automatically. If you are using one of these builds, this configuration step is not necessary.

  1. In the Web Console, click the Pipeline tab.

  2. Select Inflate compressed requests and responses.

  3. Save changes.

Results

The compress POSTs are now automatically extracted by the and processed normally.

4. Monitor captures and processing

You use different tools for testing your configuration and monitoring captures on an ongoing basis.

At target page
You can test the basic functionality of the target page by triggering GET and POST actions on the URL where the target page was installed.

In Windows pipeline
You can monitor the capture and processing of hits in the Windows pipeline in real-time through the Management System.

5. Configure sessionization for Android applications in Tealeaf and Acoustic Analytics

provides multiple mechanisms for identifying and tracking individual visitor sessions. For the Android SDK, more configuration can be required.

Review the following steps and complete any necessary ones to sessionize your mobile application.
To enable sessionization of hits that are captured through the Android SDK, you must deploy the Sessioning session agent.

  1. Log in to the Portal as an administrator.

  2. From the Portal menu, select Tealeaf > TMS. The Management System opens.

  3. Click the WorldView tab.

  4. For the View, select Servers.

  5. Click the Transport Service node.

  6. Select Transport Service configuration. Then, click View/Edit.

  7. The Pipeline Editor opens.Note: Verify that the Sessioning session agent was installed. If it was not installed, drag it from the Available SessionAgents window to the pipeline.

  8. Select the Sessioning session agent. Click Edit.

  9. In the Sessioning session agent configuration, modify the PrimarySessField value as follows:PrimarySessField=AppEnv:SessionID,env:HTTP_X_TEALEAF

  10. Save the configuration file.

  11. Push the change to all servers. A restart is needed for the new sessionization keys to take effect.

Android view name as URL during replay

Errors that can occur during session replay can be resolved by using the Android view name as the URL during replay.

When you attempt to replay a session captured by the Android SDK, an error message can indicate that there are no viewable pages in the session. This error is related to the manner in which pages on Android devices are mapped.

Instead of displaying the URL during replay, you can configure replay clients to show the Android view name instead, which eliminates this cosmetic error message.

To use the Android view name as the URL when you replay the session, complete the following steps to configure the appropriate replay profile rule.

Note:

Currently, configuration of this rule must be applied through the replay profile that is stored on the Replay Server. Instructions follow.

When this change is applied, the Navigable Pages list in Replay view in Browser-Based Replay and RealiTea Viewer is populated with the Android view name as the URL, instead of the generic Target page URL.

  • Browser-Based Replay or BBRThis web-based replay client is accessible through the Portal and retrieves its sessions through the Replay Server in your environment.

  • RealiTea Viewer or RTVThis replay client is a stand-alone Windows application that must be installed separately on your desktop. Through RealiTea Viewer, you can search for and replay sessions that are stored in your environment.

To change the replay profile, you can use these options:

  • Applying the view name change locally
  • Applying the view name change to the Replay Server

Applying the view name change locally

Complete the following steps in RealiTea Viewer to make changes locally and test use of the Android view name during replay.

  1. Start the RealiTea Viewer application on your local desktop.

Note:

RealiTea Viewer must be installed locally on your Windows desktop.

  1. Load a session that is captured from the Android SDK.

  2. From the RealiTea Viewer menu, select Tools > Options....

  3. Click the Profiles tab.

  4. If you did not do so already, enter the name of the Replay Server that controls the replay profile in the Server check box. Click Check for Updates Now. If a server version of the profile is available, your local version is synchronized to it.

  5. Click Edit Raw Profile.

  6. Complete the editing steps that are listed in the section that follows. You are editing the raw XML file that is stored on your local desktop. See Applying the view name change to the Replay Server.

  7. After editing the profile as required, click Save Changes > Exit.

  8. Click OK.

  9. Replay the session. Click Replay in the toolbar.

  10. In the Navigable Pages list, the listed URLs reflect the Android view name for the screen.

  11. If the Navigable Pages list is being populated accurately, you can send your changes back to the Replay Server for deployment to other replay users.

    a. From the RTV menu, select Tools > Options.

    b. Click the Profiles tab.

    c. Click Upload Settings to Server.

Applying the view name change to the Replay Server

Complete the following steps on the Replay Server so that all Browser Based Replay users see the Android view name during replay.

In the following steps, you apply the change to the Replay Server by accessing the server and editing the appropriate file. This change is then available to all users of the Replay Server's profile, which includes all Browser Based Replay users.

  1. Log in to the server hosting the Replay Server as an administrator.
    Edit the following file:
    <Tealeaf_install_directory>\system\ReplayServerProfile.xml

  2. Locate the RequestMapping section, which should be near the top of the file.

  3. Add a Request Mapping, URL element entry. Locate the following header:
    <RequestEntry name="URL">

  4. Add the following key name as a new entry to the list of entries:
    `<Key name="HTTP_X_TEALEAF_VIEW_CLASS" enabled="1"/>

  5. Save the file.

6. Dynamically configure server-side settings from the client application.

As needed, you can change server-side settings from the client application. All configuration items can be configured dynamically from the client.

You can plan to manage server configuration during initialization of the application, then update it selectively and as needed during run time.

See Android SDK Library Tealeaf Class References for more information.

Expected outcome

After you complete this tutorial, you can capture and process data that is submitted from the Android SDK (or Eclipse plug-in).

Updated 4 months ago


Android: Server configuration


Quick start server configuration

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.