Customers sometimes ask us for a way to generate a report that would be a human readable requirements document. The built-in requirements detailed report often has more information that is needed in such a report. This article describes how to create such a report.
A customer asked us this question:
My team is using SpiraTeam 5.4 as a storage vault for all software documents. The documents are placed in a specific project "System" that has been created for this specific purpose.
The documents are placed into several subdirectories: Requirements, Risks, Design., General, etc
Can we generate a report that lists the name of the document, folder, author, and current version.
A customer of ours asked for a custom report / graph for displaying the count of incidents by project and by priority.
Of the unique needs of a requirements and test management system when working in the Defense industry, specifically when designing, building, and testing mission systems, is the ability to link individual test steps to the requirements. This article provides you with a custom report to use to display such a traceability matrix.
A customer asked us if it was possible to create a version of the requirements traceability report that would not display each of the individual mapped test cases, but instead would give summary counts by priority.
We often get enquiries from customers looking to customize some of the reports in Spira. Although our support does not generally extend to writing such reports for customers (we have consultants and partners who would be happy to do it as a service), in this article we explain a common situation that we get asked about.
The custom reporting functionality in SpiraTest, SpiraPlan and SpiraTeam v5.4 (or later) includes the ability to write complex reports, joining various tables, using SQL aggregation (COUNT, SUM, etc.) functions and other advanced reporting features. A common needs is to display a list of artifacts (requirements, test cases, etc.) and join against the custom property definitions so that you get the custom fields displayed with the names of the value not just the IDs. This articles explains how to do this.
The custom reporting functionality in SpiraTest, SpiraPlan and SpiraTeam v4.1 (or later) includes the ability to write complex reports, joining various tables, using SQL aggregation (COUNT, SUM, etc.) functions and other advanced reporting features. A common needs is to display a list of artifacts (requirements, test cases, etc.) and join against the custom property definitions so that you get the custom fields displayed with the names of the value not just the IDs. This articles explains how to do this.
Within the standard reports included with SpiraTeam (Test/Plan), some words exist, such as the 3-letter month abbreviations. These items are in English, even if you have chosen a different language for your Spira user interface. The report templates can be edited to change these words to a different language. This article explains how to do that.
We had a potential customer that was looking to generate simplified test result reports from SpiraTeam that had more details for each of the executed test steps, with full size screenshots displayed, rather than the small table cells that are in the small reports. This article contains an example of such a report.
With the establishment of the EU General Data Protection Regulation (GDPR), you now may need to find old SpiraTeam projects that are not active any more so that you can delete them and reduce unnecessary storage of personal data.
Customers sometimes ask us for a simple Release Notes report that can be used to display the list of new features and enhancements / fixed bugs in a specific release. We use a report like that ourselves to generate the Release Notes for our products (Rapise, SpiraTest, SpiraTeam, etc.). This article describes how you can create a similar report yourself
This article describes how you create / modify the XSLT report templates in Spira to include embedded images without having to manually embed them in the artifacts. It uses the ability of the XSLT reports to have an <IMG> tag in the report template that references the attachment URL.
Our Spira platform (SpiraPlan, SpiraTest, SpiraTeam) has powerful custom reporting capabilities that let you build custom reports using the Microsoft Entity SQL language. This article provides some pointers on writing such reports.
In the standard reports that come with SpiraTeam, we have the 'Detailed' reports that are designed to include a primary artifact (e.g. requirements) and then include tables that display lists of related items (e.g. Tasks, Incidents, etc.). By default, we only show some of the fields in these tables. This article explains how to display the value of specific custom fields in the tables when you customize the standard reports.
Sometimes you want to create a new custom report with a list of fields from SpiraTest that includes the date that a test cases was executed or the date that a defect was logged, but you don't want to clutter the report with the time part. Alternatively you want to join two tables on a date-time field where only a date comparison is needed.
The symptom is that whenever a user tries to open an Excel format report in SpiraTest, SpiraPlan or SpiraTeam, the report will download. When the user clicks on it to open,
Excel opens but the area where the report should be is blank and gray. It affects all reports types in Excel format. Other formats (HTML, XML, etc.) work fine.
Sometimes you want to get a report of all the test sets with their included test cases along with
their test steps with the tests organized by the order in which they are
displayed in SpiraTest. The custom reporting system in Spira allows you
to create a custom report of all the test cases (by test set) and test steps
sorted by test case order. This articles describes the process for
creating such a report.
(There are different versions of the ESQL query to use based on the version of Spira that you are using)
When opening the SpiraTeam MS-Excel 2007+ reports in MS Office 2010 or later you may get a message displayed - "The file you are trying to open 'xxx.xls' is in a different format than specified by the file extenstion". This article explains why this message appears and how to deal with it.
The build in reports in SpiraTest / SpiraTeam are primarily geared to display the # passes, # fails, etc. from the perspective of test cases. It assumes that even a single fail / block / caution of any of the steps constitutes a failure of the entire test case. However some of our customers were looking for ways to display the execution information at the test step level. This articles describes how to create a simple custom report to display this.
This articles describes the steps to create a custom report that displays a table of test cases with the following fields:
- Test Case ID
- Test Case Name
- Last Execution Date
- Last Execution Status
- Number of Test Runs
Sometimes you want to get a report of all the tests executed along with their test cases with the tests organized by the order in which they are displayed in SpiraTest. The custom reporting system in Spira allows you to create a custom report of all the test runs and test run steps sorted by test case order. This articles describes the process for creating such a report.
To save space in the various SpiraTest, SpiraPlan and SpiraTeam reports, the default report templates use the format xxxxx. Often times it will be required to display a different date format either across the entire report or in part of the report. This article describes how to change the date format in one of the standard reports by changing the XSLT template used to generate the report.
Sometimes you want to get a report of all the users in the system. The custom reporting system in Spira allows you to create a custom report of all the users. This articles describes the process for creating such a report.
We are planning on adding the ability to email the entire user list of the system and/or the membership of a specific project through the Spira UI, but for now this article explains how you can use a custom report to get a list of all the email addresses of the users of a Spira installation:
After upgrading from v3.2 to v4.0 you may receive this error message when you access the Reports home page on certain projects:
Cannot deserialize the blob of personalization data associated with the current page.
Parameter name: data [System.ArgumentException]
The serialized data is invalid. [System.ArgumentException]
Value cannot be null.
Parameter name: enumType [System.ArgumentNullException]
This article describes the solution to fix this issue.
Using SpiraTest, SpiraPlan or SpiraTeam versions v2.3 - v3.2 you can create custom reports that can be displayed in the Reports tab of the system. This article explains the process for creating such reports. Note that the reporting system is being updated in Spira v4.0 and these instructions will not apply to v4.0 or later versions of the system.
This articles describes how to write custom reports in SpiraTest, SpiraPlan and SpiraTeam. It also can be used to modify the layout and styling of the various built-in reports.
This information applies to the following versions of Spira: