How can a custom modification be made to an existing report in IBM Rational Integration Tester?
IBM Rational Integration Tester's in-built reports are based on XML data published by the application and transformed into human readable data using XSLT. This XSLT is stored on the file system and a number of clients have taken advantage of this fact to modify the shipped XSLT in order to create customized reports.
The intention of this document is to share the information required to make such modifications.
This document is intended for use by those with proficient XSLT skills, who are prepared to determine the contents of the source XML by examination and who wish to modify XSLT which ships with IBM Rational Integration Tester in order to create customized reports.
With IBM Rational Integration Tester installed in the default location the report templates are found here:
The report templates have a ".xsl" extension. For example there is a "Detailed Report.xsl" file which contains the template for the Detailed Report. Modifying this file will modify the detailed report which appears within IBM Rational Integration Tester.
The ".xsl" files contain instructions in the XSLT language which is a standard XML application. Documentation for XSLT is available in books and on the Internet.
Modifying XSLT is a great deal easier if it is also possible to see the XML upon which the XSLT is acting. One way to see the XML is to temporarily replace the template to be modified with an identity template which simply returns the incoming XML, and then run the report.
Example Identity Template:
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="2.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="xml" indent="yes"/>
<xsl:apply-templates select="@*|node()" />
When this is executed the displayed report will appear as a blank page. This is correct.
The blank page may then opened in an external viewer (using the "Open Externally" toolbar button) causing it to appear in the computer's default web browser. The web browser's view source option can then be used to display the XML.
Multiple Source Documents
The XSLT reports commonly process more than one XML source document. In that case the primary XML document will itself refer to other XML documents.
For example this section of XML is a reference to another URL:
<task name="Folder/Test 1" logLocation="test-execution-data:27283"/>
The other URL which is later expanded into the XSLT processed output:
<xsl:variable ... select="document(TestSuite/task/@logLocation)/Test/summary"/>
The URL of the second XML document is relative to the location of the primary XML document.
It is possible to connect directly to the IBM Rational Integration Tester results database and to then use dedicated reporting tools to generate reports directly from the recorded data. This allows the user to create a completely new report containing data from the IBM Rational Integration Tester test results.
The format of the tables and views within the IBM Rational Integration Tester results database is not published, and therefore it is necessary to determine the structure of the data by examination of the values in the database.
In future there may be a set of dedicated reporting views are created for reporting directly from the database, or for populating a data warehouse for subsequent reporting. Such a set of views should remain backwardly compatible with new releases of IBM Rational Integration Tester.
Compatibility with future releases
The ability to create tailored reports by modifying XSLT files within IBM Rational Integration Tester is a consequence of the application design, but it is not a feature of the software. Both the XSLT which ships with IBM Rational Integration Tester and the XML from which it runs may change in future; or the reporting mechanism may be changed. Customers must therefore be aware that tailored reports created through modified XML may not be usable with future versions of IBM Rational Integration Tester.
The format of the tables and views in the IBM Rational Integration Tester results database is also subject to potential change with future release of IBM Rational Integration Tester. Customers must therefore be aware that tailored reports created by accessing the database directly or through third party reporting tools may not be usable with future versions of IBM Rational Integration Tester.