You are here: NanoScope Software User Guide > Recipes > The Recipes Cookbook > XML Reports

XML Reports

Inserting a Report node into a recipe will generate an XML report detailing the recipe run results. A Report node will report on the actions of all of its parent nodes. Thus a Report node inserted as the last step of the Recipe will provide data on every step in the Recipe run, whereas a Report node inserted midway through the recipe will only report on a part of the recipe run.

The XML report will contain information about all of the input and output parameters, as well as the run status of each node. If a node has failed anywhere in the recipe run, recipe will terminate and the report will indicate which node has failed.

The XML report may be used as a data feed to generate a variety of report formats. XLS Transformations (XSLT) uses stylesheets to convert the XML file into a text, html, or another format.

Recipes provides three default XML conversion stylesheets, located at:

D:\Program Files\Nanoscope\8.15\plugins\recipes\stylesheets

The three default conversion files provided are:

defaultAnalysisEval.xsl – used to generate image analysis data reports. This stylesheet is employed automatically to create image analysis data reports within image analysis nodes simply by setting Create Data Report to Yes.
defaultHTML.xsl – used to generate HTML reports
defaultText.xsl – used to generate TXT reports

Ensure that the report file name has the appropriate file suffix. If the defaultHTML.xsl stylesheet is used, the generated report name should have a suffix of .html.

NOTE: Advanced users may wish to create their own .xsl stylesheets to customize the report format. It is also possible to use an XML report file (or a translated version of it) to integrate recipe output information with custom post processing software solutions.

XML to HTML Recipe Report Conversion

Right click on the root node and create a Report node as the last node in the recipe. A report as the last node in the recipe will report on the status of all of the nodes previous to it.
Select the XSL stylesheet file by clicking the "…" button next to the Stylesheet File field:

Select defaultHTML.xsl and click OK. The Stylesheet File field should now be populated with the directory path:

D:\Program Files\Nanoscope\8.15\PlugIns\Recipes\stylesheets\defaultHTML.xsl

NOTE: Ensure that you name the stylized report file with a .html suffix, such as Report1.html.

NOTE: Remember that the report files will be created in the directory specified in the My Recipe root node. The default directory is D:\Reports.

The Report node will generate both the original XML report as well as the formatted HTML report:

View the HTML report in a web browser. Each node should have the key parameters such as the run status and a start/finish time stamp. The exported images are shown in the report as well:

HINT: To view exported .tif files in a recipes report generated by the default HTML stylesheet, view the html file using Mozilla Firefox 2.0 or later with Apple Quicktime installed.

www.bruker.com	Bruker Corporation
www.brukerafmprobes.com	112 Robin Hill Rd.
nanoscaleworld.bruker-axs.com/nanoscaleworld/	Santa Barbara, CA 93117

	Customer Support: (800) 873-9750
	Copyright 2010, 2011. All Rights Reserved.