The content on this page is deprecated. Please see the separate documentation space for developer reference material about FishEye and Crucible. |
Name |
Crucible Reporting plugin |
|---|---|
Version |
2.0.0 |
Product Versions |
1.5.x, 1.6.x |
Author(s) |
|
Homepage |
http://confluence.atlassian.com/display/CODEGEIST/Crucible+Reporting+plugin |
Price |
Free |
License |
|
JavaDocs |
|
IssueTracking |
N/A |
Subversion URL |
https://svn.atlassian.com/svn/public/contrib/crucible/crucible-export-plugin
or browse via fisheye |
Download JAR |
crucible-export-1.0.0.jar (for Crucible 1.5.x) /crucible-export-1.6.2.jar (for Crucible 1.6.x) /crucible-export-2.0.0.jar (for Crucible 2.x) |
Download Source |
Description/Features
A plugin for Crucible that facilitates the generation of a consolidated report for a specific review. This is especially useful if you are required to keep hard copies of your code review (like in the case of an audit
)
Usage
|
This plugin requires Crucible 1.5 or higher |
Crucible 1.5 installation
The plugin can be installed by copying the crucible-export-1.0.0.jar file into the CRUCIBLE_HOME/var/plugins directory. You will also need to copy the iText jar file (available from http://www.lowagie.com/iText/download.html) into the CRUCIBLE_HOME/lib directory.
Crucible 1.6 and higher installation
The plugin can be installed by copying the crucible-export-1.6.2.jar file into the CRUCIBLE_HOME/var/plugins/user directory.
Running the plugin
As Crucible does not currently have a mechanism to include user interface components via it's plugin api, the export mechanism can be opened by visiting http://YourCrucibleHost/plugins/servlet/export. From this page, the user must enter their username, password and the review id they wish to export.

Once the details are entered and the 'Run' button is clicked, a PDF including the Crucible Review details is generated. This report includes the summary information of the review, as well as any general and specific file comments.
Version History
Crucible 1.6 and higher support
Version |
Date |
Description |
|---|---|---|
2.0.0 |
5 Aug 2009 |
Updated plugin to support Crucible 2.0 |
1.6.2 |
22 Mar 2009 |
CRPT-2 Sort versioned comments for a specific file (thanks Soren!) |
1.6.1 |
10 Dec 2008 |
Added ability to include defect and revision information in report (thanks Soren!) |
1.6.0 |
22 Sep 2008 |
Updated plugin to support Crucible 1.6.0 beta |
Crucible 1.5 support
Version |
Date |
Description |
|---|---|---|
1.0.0 |
9 May 2008 |
Updated plugin to support Crucible 1.5.1 |
0.0.4 |
4 May 2008 |
Added i18n support |
0.0.3 |
29 April 2008 |
Updated unit tests |
0.0.2 |
21 April 2008 |
Updated plugin to support Crucible 1.5 |
0.0.1 |
23 Mar 2008 |
Initial plugin version |

13 Comments
Hide/Show CommentsNov 17, 2008
Dale Miller
I updated crucible+fisheye from version 1.5.4 to 1.6.3 today. I had been using this plug-in in 1.5.4. I downloaded and installed the crucible-export-1.6.0.jar file and copied it to the var/plugins/user directory. Using the Administration menu under plugins I clicked on the "Check for new plugins in /opt/crucible-1.6.2/var/plugins/user" and "Crucible Export" version "1.6.0" state "Enabled" "All modules enabled" was displayed. When I expand the "Name" it also shows "Export Servlet" and "export-resource" enabled.
When I run the program using the URL, I enter the Review ID, my username, and password, I get the following.
500 Server Error
FishEye was unable to process your request.
com.atlassian.crucible.spi.services.NotFoundException
CFR-1009 not found under MISTIC-100
You are running release CR1.6.3 FE1.6.3 (build-337 2008-11-04), please report your release number when reporting bugs.
This is on a Linux processor. Crucible+Fisheye 1.6.3 are working for us. What do I need to get the export plugin to work?
Thank you.
------------------------------------------
I tried the plugin using a review that had no comments entered and it worked. So it must be connected to the "NotFoundException"
I can view MISTIC-100 in crucible. It appears to have the exception for all reviews that have 1 or more comments.
Dec 03, 2008
Dale Miller
With more testing, I have determined that it fails for peer reviews that have an "Added" file in the list, as is the case in MISTIC-100 for id CFR-1009.
reviewItem:
permId:
id . . . . . . . . . . . . . : CFR-1009
authorName . . . . . . . . . : koobeu
commitDate . . . . . . . . . : 2008-09-06T15:58:08.903-0500
commitType . . . . . . . . . : Added
fileType . . . . . . . . . . : File
fromPath . . . . . . . . . . :
fromRevision . . . . . . . . :
repositoryName . . . . . . . : MISTIC_SVN
toPath . . . . . . . . . . . : branches/sprint8/mistic/web/src/view/shared/javascript/classes/NodeCount.js
toRevision . . . . . . . . . : 3661
Dec 09, 2008
Søren Vejrup Carlsen
I filed a report for this issue, yesterday:
http://jira.atlassian.com/browse/CRUC-926?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpane
And it turns out, that this problem is solved in Crucible-1.6.4
The exporter works now, but needs further development.
Dec 09, 2008
Dale Miller
I upgraded to Crucible-1.6.4 yesterday and the problem I reported has been corrected.
Feb 19, 2009
Anonymous
Hello,
Congratulations, great plugin
But it would be great if I could export the report to a Word file instead of PDF. I miss the ability to change the logo to my company's one on top of the report.
Feb 19, 2009
Ross Rowe
Hi, great idea, I've just requested that a Jira project get created to manage the Reporting plugin issues, I'll make sure this feature request gets recorded.
Cheers,
Ross
Mar 02, 2009
Ross Rowe
Hi again, I've just raised CRPT-1 to reference the Microsoft Word format improvement.
Thanks,
Ross
Jul 23, 2009
Anonymous
Are there plans to upgrade this plug-in to v2.0.0 of Crucible?
Jul 24, 2009
Ross Rowe
Hi, sorry about that, I'm looking at updating the plugin to support Crucible v2 now.
Cheers,
Ross
Aug 21, 2009
Wim Deblauwe
Any updates on this? I am currently evaluation Crucible 2, and i would like to try this plugin.
regards,
Wim
Aug 21, 2009
Ross Rowe
Yep, version 2.0.0 of the plugin should support Crucible v2.
Cheers,
Ross
Jan 25, 2010
Ed Beaty
Hi! I'm not sure this is a bug, but when I try using the plugin library to generate a report using the CrucibleRestClient with Crucible 1.6.4, no "file comments" show up. It looks like the CrucibleRestClient.getAllRevisionComments method is looking for a "versionedComment" tag, but the XML returned by the REST request is a series of "versionedLineCommentData" tags.
Here's what I was doing when I saw the issue:
CrucibleRestClient client = new CrucibleRestClient();
client.setBaseUrl("http://server");
client.login("user", "password");
ReviewExporter exporter = new ReviewExporter(client, new Locale("us_en"));
ByteArrayOutputStream out = exporter.createPdfExport("user", "password", "ticketname");
out.flush();
FileOutputStream file = new FileOutputStream("path_to_report.pdf");
out.writeTo(file);
file.close();
out.close();
I'm doing this to generate reports for a large number of code reviews at once. We're probably upgrading to Crucible v2 soon, and am curious if this issue occurs with the new Crucible, or if v2 has batch reporting functionality, or if I'm just doing something dumb.
Thanks for a great plugin!
-Ed
Jan 26, 2010
Dale Miller
I currently have Crucible+Fisheye 2.1.3 installed for our project. I do not use this plugin now. Instead I use the "Download Review as Text" on the "Tools" pull-down. The information in the review is presented in text form in your browser window. You can cut from the page, print the page, or use the link. The link has "/comments.txt" appended to the review URL. You can easily edit the review number in the URL and quickly see the content of another review.
It appears to be an undocumented feature that many people have not noticed.
Add Comment