8.3 Report Renderer

QuickBuild 2.0 Documentation

After generating the build report, you may want to render the report for QuickBuild to display, so that it will be very easy to track the project's status. The report can  be rendered in two places, one is in the Build tab for build related reports, and the other is in the Statistics tab for the statistics report.

In Build tab, the reports can be rendered in two places, one in Build Dashboard, and the other is detailed report. Following is the screenshot for JUnit report:
Screenshot of JUnit Dashboard

Screenshot of JUnit Test Cases Report

Supported Renderers

QuickBuild currently supports following renderers which you can enable by defining XML in the plugin settings:

Renderer Type Name Description Used In
Table Renderer table Render the report using a table Build Tab, Statistics Tab, Build Dashboard
Velocity Renderer velocity Render the report using velocity template Build Tab, Statistics Tab, Build Dashboard
PieChart Renderer pieChart Render the report using a pie chart Build Dashboard
Statistics Data Table statsTable Render the statistics report using a statistics table in Dashboard Build Dashboard
Variation Renderer variation Compare to the same report in previous build and use other renderer to render the report Build Tab
Composite Renderer composite Composite other renderers into a group Build Tab, Statistics Tab
Statistics LineChart Renderer lineChart Render the statistics report in Statistics Tab Build Tab, Statistics Tab

The renderer contains following attributes/elements:

Attribute Name Description Required
type The renderer type. YES
source The report name defined in report meta data which the renderer will render to the web. YES
title When rendered to the web, the title of the report, it will also be used in the navigation menu of the tab YES
root The root xpath by which QuickBuild will load the report, if it is not set, then the whole report will be loaded. You can embed an expression to the definition of root xpath. NO
filter The filter is an expression which will be evaluted as a Boolean value, the context for the expression is a data row, the rows which return false value will be omitted. This option is an complementary option to the 'root' attribute. NO
orderBy The orderBy attribute means that we will sort the data rows by specified column, while loading the source report. NO
asc When orderBy is specified, the 'asc' attribute means we will sort the records in ascendant or descendant order. When 'asc = true', it means that we will sort the records ascendant order, otherwise it will be sorted in descendant order. NO
Expression In Renderer

In most cases, the expressions in renderers are embedded in a string, an interpolutable string, except the 'filter' attribute. The 'filter' attribute uses an expression directly to evaluate to a Boolean value that will be used to decide which rows are accepted and which rows are omitted.

Renderer Field

Renderer field is widely used in the definitions of renderer. The renderer fields are used to retrieve the data from report or to calculate a value from the [data row].

We will describe the usage of renderer field in each specific render later. Following is an overview for the renderer field.

Attributes for Renderer Field

Attribute Description Required
source This attribute defines from which report column the field will retrieve data. The value is the name of report column defined in report meta data. NO
expression An interpolutable string with which you can define a calculable column in the table, the context for the expression is [data row], that is, you can generate a string from the values of the row. NOTE: this attribute may NOT apply to some renderers. NO
color The color for this field. The color can also be an interpolutable string which should return a valid CSS type color value, for example, the color "#FF0000" is a valid color, "FF0000" is not. NO
pattern The [format pattern] for this field. If you don't want to use the default pattern to format your data, then a valid [format pattern] can be defined by this attribute to override the default format. NO
title The title name for this field. NO

Labels

 
(None)