Question & Answer
Question
How to upgrade your UI Capture SDK to the latest version
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 newer version of the Tealeaf UI Capture SDK from Fix Central
Step 2: Getting the necessary scripts from the UI Capture SDK package
Step 3: Upgrading the UI Capture
Step 4: Testing and Validation
The video below provides a hands on introduction to upgrading the UI Capture SDK.
Video - upgrading the UI Capture SDK (3 mins, mp4, 7.5 MB)
Step 1: Downloading the newer version of 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: Getting the necessary scripts from the UI Capture SDK 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.
- The following file is needed to upgrade to the latest version of the W3C flavor of the Tealeaf UI Capture SDK:
/cxUICapture_5.5.0/W3C/tealeaf.min.js Step 3: Upgrading the UI Capture
- Open your existing UI Capture SDK in a text editor
- Identify the core UI Capture SDK library, which is usually a one very long line just above the default configuration section.
- Replace the core script identified above along with comments (Licensing info, version details, etc) with the content of tealeaf.min.js obtained in Step 2.
- Save the file.
Step 4: Testing and Validation
- It is very important to test the new UI Capture SDK in your test or QA environment before rolling out to production on the live website.
- Review the release notes for your specific UI Capture SDK version to check whether there are new or deprecated features which make require changes your existing default configuration section.
- If you are using custom modules or custom code in your UI Capture SDK, we recommend working with IBM Professional Services to help you upgrade.
The video below provides a hands on introduction to upgrading the UI Capture SDK.
Video - upgrading the UI Capture SDK (3 mins, mp4, 7.5 MB)
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
ibm10747275