If you use OverStat in an Activity or Fragment, you must implement logFormCompletion to generate reports based on user activity within a form.
Note: This step is completely manual and will not be automated because of the different architectures that an application can have, it is difficult to instrument. The form page can also have additional custom validation that would indicate if completion was correct or not.

Button addToCart = (Button) productView.findViewById(R.id.buttonAddCart);
addToCart.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        Tealeaf.logFormCompletion(true);

How to extract and capture application images for replay

Local images

Images that are bundled within an application can be extracted by using the IBM Tealeaf Android Image Extraction tool as an initial step for Tealeaf SDK integration and better replay experience. To get started, find the README.txt file under the Android Release folder: AndroidRelease/Tealeaf/AndroidImageCaptureTool/README.txt.

The tool extracts all the packaged image resources in the APK file and set an extra attribute called "tag" on the application's layout XML file for Views that contain images.

For example, android:tag="@drawable/home_background" tag is automatically added by the tool as shown. You can also manually update it to select a different image resource ID if needed:

<ImageView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:src="@drawable/home_background"
android:tag="@drawable/home_background" />

External images

These images are usually hosted on external servers, which are loaded dynamically during an application's runtime environment via network requests.

Due to Android framework limitations on capturing runtime images and performance considerations, you would need to pass external image URL paths to Tealeaf SDK by using one of the following mechanisms:

• Use the ImageView.setTag((String) url) method
  Note: This method assumes that you are not using the ImageView's tag object in your code.
• Use the ImageView.setTag(resourceId,(String) url) method
  Note: This method assumes that you are using the View's tag object in your code, then you can follow the following code snippet to redirect the Tealeaf tag to ImageView.setTag(ImageView.getId(), tag).
  • The following sample ImageView definition shows an "android:tag" attribute, which would be automatically generated by the image extraction tool, or you can manually update support image replay:
    

    <ImageView
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:src="@drawable/home_background"
    android:tag="@drawable/home_background" />
    

  • For image replay, use a View's tag object. The following example shows how to redirect the tag object to the View's setTag:
    

    ImageView myView = (ImageView) findViewById(R.i.d.image1);
    //Potential XML tag found
    Object tag = myView.getTag();
    
    //Assuming myTag is the object you want to set for the view
    if ((tag == null) || (tag != null && !(tag instance of myTag))) {
    
    //Redirect the tag to the other setTag(View.setTag(resourceId, object) method which operated on a HashMap data structure.
    if ( View.NO_ID !=view.getID() && view.getId() != 0 && tag != null) {
    myView.setTag(myView.getId(), tag);
    }
    

Android auto instrumentation capability configuration files

teacuts.jar is a module that provides Android auto instrumentation capabilities. The two configuration files are shown:

• TeaCutsAdvancedConfig.json – Advanced configuration file for enabling or disabling auto instrumentation features.

  {
  "TeaCutsLibraryVersion":"2.0.0.1",
  "DefaultAlertDialogLayoutDelay":500
  }
  

  DefaultAlertDialogLayoutDelay property is default at 500 milliseconds. You can change this value if the replay shows a timing issue when the AlertDialog is displayed.

• TeaCutsBasicConfig.properties – Basic configuration file for enabling or disabling auto instrumentation features.
  • Starting the 2.0.0.1 ability to auto instrument AlertDialogs
    • It defaults to true. If you used manual instrumentation for AlertDialog, then you can set it to false.
      

      AlertDialogEnabled=true
      

  • Starting 2.0.0.1 ability to auto instrument TextView/Button/EditText without explicit OnClick listener
    Note: This feature supports only API level 15 or above
    • It defaults to true. If you used manual instrumentation, then you can set it to false.
      

      TextViewEnabled=true