Question & Answer
Question
How can you build the Tealeaf UI Capture SDK from scratch?
Answer
IMPORTANT: The Tealeaf UI Capture SDK should be configured, tested, and validated by IBM Professional Services or by an approved IBM Business Partner before use in a production environment. The documentation on this page is provided as is by the IBM Tealeaf support team as a resource for training and enablement. It is not a substitute for engaging a professional.
Step 1: Downloading the Tealeaf UI Capture SDK from Fix Central
- The new builds and releases of the UI Capture SDK are distributed via IBM Fix Central .
- Version 5.5.0 of the UI Capture SDK (the latest at the time of writing) can be downloaded from here .
Step 2: Downloading the third party pako library
- The pako library is used by the UI Capture SDK to compress payloads and improve performance. Although not required, it is highly recommended, especially when using DOM capture. Not using compression can significantly impact the performance of the web site on which the UI Capture SDK is deployed.
- We recommend using the minified version, pako.min.js, which you can download from here
Step 3: Assembling the UI Capture SDK from the scripts in the Fix Central package
- A Tealeaf UI Capture SDK package downloaded from IBM Fix Central contains two "flavors" of the UI Capture SDK, W3C and jQuery. The package also contains a default configuration file, and sample target pages. Refer to the README file for more details on each file.
- The W3C version is the most commonly used version of Tealeaf UI Capture SDK. Unless Professional Services or your IBM Business Partner has specifically recommended you use the jQuery version, you should use the W3C version.
- In the next step we will build a W3C version of the UI Capture SDK using the following files from the Fix Central package:
/cxUICapture_5.5.0/defaultconfiguration.js /cxUICapture_5.5.0/W3C/tealeaf.min.js Step 4: Building the Tealeaf UI Capture SDK
- Open a text editor and create a new file
- Paste the content of the following scripts discussed in step 2 and step 3 above into the new file, in order
pako.min.js tealeaf.min.js defaultconfiguration.js 
- Save the file as tealeaf.js
The video below provides a hands on overview of these steps.
Video - downloading and building the Tealeaf UI Capture SDK (5 mins, mp4, 14 MB)
NOTE: in earlier versions of the UI Capture SDK package a configuration wizard was provided, which allowed for some of the configuration options described here to be done automatically. The Tealeaf Customer Experience on-Cloud (Tealeaf SaaS) product also includes a configuration wizard. These are potentially useful alternatives to configuring the UI Capture SDK by hand, as described in this article. However, neither configuration wizard will automatically include the pako library, and not all configuration options are exposed in the wizard interface.
Related Information
[{"Business Unit":{"code":"BU055","label":"Cognitive Applications"},"Product":{"code":"SSERNK","label":"Tealeaf Customer Experience"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"","label":""}}]
Was this topic helpful?
Document Information
Modified date:
09 January 2019
UID
ibm10747271