Child pages
  • Summary Display Plugin
Skip to end of metadata
Go to start of metadata


This plugin allows an easy and fully customized build report display.

Table of Content

Plugin Information

View Summary Display Plugin on the plugin site for more information.

Display an extended summary report in project and build pages.

Features

  • Allow a rich summary report visible from both project and build page
  • Reports must be written in an XML format according to the syntax described in section Syntax Description
  • This plugin allow the parsing of several XML files
  • Reports displayed are ordered according to the XML file names
  • Element displayed are based on 

Usage

  • In order to activate the plugin you must:
    • Activate result archiving of xml reports
    • Activate ACI report publication of the xml summary reports

Examples

  • Result at project level:

  • Same result at build page


  

Syntax Description

The Summary_report Hudson plugin can parse XML report with this structure: 
Only one section can be use in each XML file.

Section

Sections are created using <section> ... </section> tags.
Section attributes are:

  • name: section name
  • fontcolor: section font color

Example:

<section name="Performance Summary" fontcolor="#ffffff">
</section>

Field

Fields are created using <field> ... </field> tags.
Fields attributes are:

  • name: field name
  • value: field value
  • href: HTTP link, relative to the project build. For instance, to access artifact dir, you can specify href="artifact/artifacts"
  • titlecolor: font color for the field title
  • detailcolor: font color for the field details
  • <![CDATA[ ]]>: the CDATA term is used about text data that should not be parsed by the XML parser.
    Everything inside a CDATA section is ignored by the parser. It can be used to insert HTTP link given an absolute reference, as specified in the example below. 

    Only one CDATA is parsed between start and end field tag

Example:

<field name="Field Name To Display" titlecolor="black" value="My Field Value" detailcolor="#000000" href="artifacts/field.txt">
	<![CDATA[
		....TEXT....
		<a href="http://....">Link to something</a>
		...Some more text...
	 ]]>
</field>

Table

Tables are created using <table> ... </table> tags.
Fields attributes are:

  • sorttable="yes": Each column become sortableTable structure:
  • Lines are created using <tr>...</tr> tags.
  • Column are created using <td>...</td> tags.

The number of column must be identical  in each line.

Attributes of a cell are:

  • title:* *The text to show when the cursor is over the table cell.
  • bgcolor: Cell background color.
    Authorized values are: 
    • red, 
    • green, 
    • black, 
    • #fffff....
  • fontcolor: Cell font color.
    Authorized values are: 
    • red,
    • green, 
    • black, 
    • #fffff....
  • fontattribute: Cell font attribute
    Authorized values are:
    • normal, 
    • bold, 
    • number between 100 and 900
  • href: Link, this link is relative from the artifact storage location.
  • align: The text alinment
    Authorized values are:
    • center, 
    • left, 
    • right, 
    • justify
  • width: The width of the cell

Example:

<table sorttable="yes">
        <tr>
                <td value="Table title" bgcolor="red" fontcolor="black" fontattribute="bold" href="report.xls" align="center" width="200"/>
                <td value="Column 1" bgcolor="white" fontcolor="black" fontattribute="normal" href="" align="center" width="200"/>
        </tr>
        <tr>
                <td value="Line 1" bgcolor="white" fontcolor="black" fontattribute="normal" href="" align="left" width="200"/>
                <td value="Value 1" bgcolor="white" fontcolor="black" fontattribute="normal" href="" align="none" width="200"/>
        </tr>
</table>

Tabs

A tab set can contain a lot of tab. Tab sets are created using <tabs> ... </tabs> tags.

In a tab set, a tab is created using <tab> ... </tab> tags.

Tab attributes are:

  • name: Tab name

Content allowed for a tab:

  • field
  • table

It's not possible to insert tabs or accordion.

Example:

<tabs>
	<tab name="First tab">
		<field name="Build status" value="All target succeeded" />
		<field name="Functionnal status" value="Validation is Ok" />
	</tab>
	<tab name="Second tab">
		<table>
			<tr>
				<td value="Table title" bgcolor="red" fontcolor="black" fontattribute="bold" href="report.xls" align="center" width="200"/>
				<td value="Column 1" bgcolor="white" fontcolor="black" fontattribute="normal" href="" align="center" width="200"/>
			</tr>
			<tr>
				<td value="Line 1" bgcolor="white" fontcolor="black" fontattribute="normal" href="" align="left" width="200"/>
				<td value="Value 1" bgcolor="white" fontcolor="black" fontattribute="normal" href="" align="none" width="200"/>
			</tr>
		</table>
	</tab>
</tabs>

Accordion.

Accordions are created using <accordion> ... </accordion> tags.
Accordion attributes are:

  • name: Accordion name

Content allowed for nn accordion:

  • fields 
  • table.

It's not possible to insert tabs or accordion.

A Full Section Example

<section name="" fontcolor="">
	// To display a field
	<field name="" titlecolor="" value="" detailcolor="" href=""> <![CDATA[  ]]> </field>

	// To display a table
	<table>
		<tr>
			<td value="" bgcolor="" fontcolor="" title="" fontattribute="" href="" align="" width=""/>
			<td value="" bgcolor="" fontcolor="" title="" fontattribute="" href="" align="" width=""/>
		</tr>
		<tr>
			<td value="" bgcolor="" fontcolor="" title="" fontattribute="" href="" align="" width=""/>
			<td value="" bgcolor="" fontcolor="" title="" fontattribute="" href="" align="" width=""/>
		</tr>
	</table>

	// To display tabs
	<tabs>
		<tab name="">
		// Only insert table or field in tab
		</tab>
		<tab name="">
		// Only insert table or field in tab
		</tab>
	</tabs>

	// To display an accordion
	<accordion name="">
	// Only insert table or field in tab
	</accordion>
</section>

Changelog

Version 1.15 (Jan 29, 2016)

  • Fix issue JENKINS-33044: implement SimpleBuildStep thanks to Egor Shchegolkov
  • Made project testable on windows thanks to Egor Shchegolkov

Version 1.14 (Jan 29, 2016)

Version 1.13 (Apr 21, 2015)

  • Display on project page is now optional thanks to martinda
  • Project without builds no longer create errors thanks to martinda

Version 1.12 (Nov 7, 2014)

Version 1.10 (Sep 26, 2013)

  • Fixes for compatibility with jenkins version 1.532

Version 1.9 (Feb 6, 2013)

Version 1.8 (Jan 8, 2013)

  • Avoid javascript conflicts and allow absolute links (Contribution from Mattias Holmund)
    • Absolute links did not work, they were prefixed with a buildnumber
    • There were javascript conflicts between the jquery included in summary_report and the prototype.js used by jenkins
    • There were javascript conflicts between sorttable and javascript code included in jenkins. It manifested itself for me with the claim-plugin, but I believe it can cause all sorts of mysterious problems.
  • Table output slightly restyled and can now be restyles more with css.

Version 1.7 (Dec 10, 2012)

  • Use CSS classes for styling (Contribution from Mattias Holmund)

Version 1.5 (Sept 12, 2012)

  • Align panel on right without any size limit
  • Add support for attribute title in cells (<td title="my title">)

Version 1.4 (Jul 5, 2012)

  • Fix for URL loading issue when using plugin from windows
  • Improve error reporting

Version 1.3 (Jun 22, 2012)

  • Rename Git repository in summary_report-plugin to follow rules.
  • Corrections in the documentation.

Version 1.2 (Jun 22, 2012)

  • Rename plugin from Hudson Summary Display to Summary Display
  • Change keyword in the Jenkins prject configuration panel

Version 1.1 (Jun 20, 2012)

  • Cleanup in the descriptors.

Version 1.0 (Jun 13, 2012)

  • Initial Release.

15 Comments

  1. Hi, it is extremely useful plugin. We make wide use of it.

    Still there is a feature I am looking for: make tables editable, or even better some  columns editable.

    Did you think about something like this?

    If I am willing to do some work on this plugin to implement it, how difficult will it be?

  2. I find this plugin quite useful. We mainly use Jenkins as a bioinformatics workflow tool and many of our 'builds' benefit from a generic report generation tool such as this.

    Are you planning on adding any other types of HTML elements to these reports? I'm much interested in the ability to add images generated from such tools as R or other imaging tools.

    There is already a plugin that can aggregate images but it would be nice if it can be combined with the flexibility of your summary reporting plugin. Thank You!

    1. Hello

      i've been able to add image to a tab using this syntax:

      <tab name="Quality mark">
      <table><tr><td>
          <![CDATA[
              <img src="http://jenkins_ip:jenkins_port/userContent/myimage.png"/>
          ]]>
      </td></tr></table>
      </tab>
      

      Not sure if it could help.

      Image must be available as an url. In my case, it is uploaded to the userContent folder of my Jenkins instance.

      My 2 cents

      1. Thank you Geoffroy.

        Using your CDATA suggestion I'm now able to dynamically add graphs that are generated from the build. Very useful tip!

        I have gotten even more mileage out of this plugin by generating the required XML file directly from a configuration file.

        This eliminates coding the XML generation as part of your build and it transfers the responsibility to a single Scriptler script (writeXMLProperties_scriptlet.groovy) that can take a simple configuration file and generate the required XML

  3. Is there an option to include the table (or tabs or accordion) in the email notification that is sent post-build?

  4. What would be really nice/helpful is if the tab could take an element instead of name.

    Right now it takes the name and places it within an anchor tab.  If it would be allowed to take html snippet then would could set images for on the tabs instead of just a label.

  5. Looks like the info under "Usage" is out dated, doesn't seem there is a need to

    • Activate result archiving of xml reports
    • Activate ACI report publication of the xml summary reports

    I just see this now in latest version (1.10)

  6. I'm having an issue where Jenkin Projects that have a space in their name causes Tabs and Accordions to be broken.

    This is because the project name is used in constructing the id's for the tabs and accordions but ids can not have spaces.

    Please fix!

  7. This plugin allows arbitrary reports to be placed on Jenkins' project pages, made from the output of custom build steps, which was perfect for me.

    But I have a couple of queries about the documentation.

    • It looks like the body of a field element is supposed to be displayed as pure text. What about other html elements: bullet points, paragraph breaks and so on? I see that ![CDATA[ ]] can be used to embed a URL, but I didn't get other tags to work.What about other html tags? Also the field body seemed always to be in Courier, which looks a bit meh.
    • According to your docs, the only colours allowed in a table cell are "red", "green", "black" and colours specified by hex. So why is "white" used in the example? Is there a full list?
    • The attributes of a table cell are title, bgcolor, fontcolor, fontattribute, href, align and width. But the example also has value. Are there other attributes?
    • The "full section" example has // comments in it. Is this valid in the file that is read by the plugin? I would have thought it was <!-  ->
    • Documentation says the fontattribute for a table cell can be a number between 100 and 900. What does a numeric fontattribute mean? What is it supposed to be used for?

    Thanks

  8. The 1.2 introduce disrupted flow on plugin update therefore we face the jenkins 19475 issue: impossible to update plugin:

    https://issues.jenkins-ci.org/browse/JENKINS-19475https://issues.jenkins-ci.org/browse/JENKINS-19475

  9. Damn, I cant figure out how to use this plugin....Does anyone have a detailed tutorial they can post online?

    Any help would be awesome.

  10. Damn, I having a hard time figuring out how to pull the xml data into the html....Is there a step by step tutorial on how to use this somewhere online?

    Any help would be really appreciated.

  11. Hi,

    Thanks for this very useful plugin. One short question about it: when used in matrix projects, we have the reports published on each axis build page (which is nice), but couldn't find a way to aggregate them also on the parent matrix build page itself. 

    Did we miss something, or is this feature planned for a future release of the plugin ? (we tried also to achieve this  through the Flexible publish plugin without more luck).

    Thanks for the good work anyway.

    Phil.

  12. The snapshot shows multiple sections (1 through 4) but the documentation states that "Only one section can be use in each XML file.". This is confusing. Can you please clarify?

Write a comment…