Articles Tagged 'reports'

Articles
Reporting on Timesheets and Timesheet Entries

We have just released the new timesheet functionality in SpiraTeam and SpiraPlan v8.5. With this new release, timesheets and time entries are stored in dedicated database tables and then used to update the corresponding artifact totals. This means that you can now report on the time entered per-person, per-day as well as per-artifact. This custom report shows you how to access this new data.

How to group data in a custom report using XSLT

You may need to get the report that groups and aggregates the output results. This article explains how to achieve this using XSLT.

Pulling tags using custom reports

Built-in reports in Spira may not have included Tags column in the grid by default.
This can be easily fixed by cloning standard report and slightly editing it.

Create a Program user membership custom report

For audit or any other purposes, you may need to extract a list of program and project membership report.
This is possible with a custom report (must be using Spira 8.3+).

Please note that this report is to be used in addition to reviewing the list of users who currently are system admins.
Also consider that if there is no active project under the program user is member of - it will not be listed in this report

Creating a custom report of all pending test runs in a product

If you would like to create a custom report that shows list of Pending Test Runs and step counts, follow the steps below (note that you must be on at least Spira v8.3). 

This report will provide very similar information to the Pending Test Run widget on the Product Home Page.

Create a custom report for Tasks with their folders

You may need to create a report of Tasks with their folders. From Spira v8.3 it is now possible to display the name of the folder, just like it can be done for Test Cases and Test Sets 

Modifying standard Test Run Detailed report to display each step's start and end datetime

In case you need to get an execution date and time of the test step but keep the standard Test Run detailed report format, the fastest way is to modify the existing one. This article explains how to achieve that.

How to create a historical report of users getting or losing system admin permissions

For audit or any other purposes, you may need to extract a list of changes to system admin permissions for users. This is possible with a custom report (must be using Spira 8.2+).

Please note that this report is to be used in addition to reviewing the list of users who currently are system admins.

Displaying a Requirements Test Coverage Report by Release

Several customers have asked for a way to display a grid of all the requirements in a product, showing the test coverage for just a specific release or sprint vs. the whole product. We already have a Requirements Regression Coverage graph that shows this information at summary level, but what if we want to see the individual requirements' names. Luckily, Spira custom reports comes to the rescue!

Extracting the list of all Products using custom reports

In case you need to create a report that displays the list of projects in the system in Excel, HTML format this article explains how to achieve that.

How to get the list of users that have a specific permission in a product

You may need answer questions like: who today is able to see the source code in product X, or who can bulk edit requirements. You can do so using custom reports. The example below answers the first of the above questions.

How to Change the Date Format in the Spira Reports

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.

How to generate test set report with builds and execution statuses

If you need show the list of test sets with their test cases, execution statuses and related builds, follow this article to produce a custom report to do so.

Creating a custom report to display test step execution counts

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.

Creating a Custom Report to display a list of Incidents with their linked Test Cases

Some customers have asked how to create a custom report that lets them trace back from Incidents to Test cases (information about each incident with all the IDs of the test cases associated to that Incident). This is the opposite to Test Case Traceability report.

This article explains the process.

Creating a Custom Report of Electronic Signature Approval on Test Cases

A customer once asked how to create a list of all test cases that have electronic signature approval recorded.  For example, let us say that you have electronic signature turned on for a specific transition operation in the Test Case. Then, how do we create a list of all the test cases that have electronic signature recorded? 

How to find product membership for a product but in the past

You may want to see what product membership for a product was like historically - what users in what role were able to access the product at a specific point in time.

Starting from Spira 7.13 it is possible to track product membership changes and use custom reporting to review this historical data.

How to get the list of test cases that need to be re-run

You may need to create a list of test cases associated with a particular incident status to know that those incidents have been fixed and can now be verified by rerunning the tests.


This article explains how to generate a list of the test cases associated with incidents containing this status.

Report of Requirements that Contain Suspect Test Cases

A customer wanted to get a report of the number of requirements that have changed with mapped test cases that are yet to be updated (with capability to view specific requirements). When a requirement is changed and a test case is not yet changed, the test case has a suspect flag set automatically to True. So, the best way to get this data is to get a report of the number of requirements that are linked to at least one suspect test case.

How to add most recent comment to the Task summary report

This article explains how to get the most recent comment and add it as a column for an artifact summary report (if it is not already displayed).

Writing Custom Reports for SpiraTeam v2.3 - v3.2

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:

  • v2.3
  • v2.3.1
  • v3.0
  • v3.1
  • v3.2

This article is obsolete. To create a new report it is not currently necessary to populate the tables, all applicable tables are already populated and available as ‘views’. To find more about available custom report tables, getting started tutorial, information about using dynamic tokens in reports, custom reports, custom graphs, OData (SpiraPlan only), please refer to our documentation here.

How to retrieve incidents associated with a requirement using Custom Reports

Sometimes you may need to get the list of incidents associated with a requirement but that can be challenging in case an implicit association exist.
This article can help you to get these associations.

Requirement - Test Step Traceability Report

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.

Editing the language in report templates

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.

Finding Old Projects to Purge for GDPR Compliance

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.

Using the Spira v5.x Custom Reporting with Custom Properties

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.

Sample Release Notes Custom Report

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

Creating a SpiraTest custom report with date values (no time component)

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.

Creating a Report of Test Sets, Test Cases and Test Steps in Hierarchical Order

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)

Creating a report to display test cases with execution counts in Spira v4.2

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
How to email everyone in the system

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:

Writing Custom Entity SQL Reports in Spira

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.

Using the Spira v4.x Custom Reporting with Custom Properties

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.

How to show the Jira ID on the artifact list pages and in reports

This article describes the steps to do so you can display the Jira ID field in certain reports and on list pages.

Сreate a report to filter Parent Requirements only based on a Custom Field

From the UI the Parent requirement won't be retrieved if none of its children match the filter criteria.
This article shows you how to create a custom report that retrieves parent requirements that meet the filter criteria, even if none of their children meet it.
For example, if you need to create a custom report for requirements filtered by a custom property - here are the detailed instructions how to achieve that.

How to get a list of all Requirements associated to a Release or all Risks associated to Requirement

This article shows examples of how to find all artifacts of one type associated to another artifact. For example, getting the list of Requirements associated to a Release, or showing all Risks associated to a Requirement. This mimics what a user may see in the corresponding Associations tab but in a report.

How to make custom reports for program level artifact associations

This article explains how to create several different example custom reports for program level artifacts and their associations.

How to add and an image (logo) to the header or footer of a custom report

While custom images in custom report headers and footers are not directly supported this article explains a workaround so that you can embed an image or a  logo inside the custom report.

Summary report of all products with information about their programs

Sometimes you need to get a report of all the Programs and Products available in your Spira instance.
This article explains how to do that.

How to get the names of Custom List values instead of their IDs

In this article we will show how to get an artifact's and product's multi-select custom property values. Report views for artifacts and products contain all custom fields, but for those custom fields that use custom lists, only the ID of the custom list value(s) are shown. Here is what to do if you want to find the text that matches those IDs.

SpiraTeam MS-Excel Reports Give Message when Opening

When opening the SpiraTeam MS-Excel (printable) reports in MS Excel 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.

Using SubQuery (nested SELECT) in ESQL

You’ve probably encountered cases where it looks like you need another SELECT statement inside your main statement.
Is it possible to use nested SELECTs in ESQL? 
Yes, it’s possible!
In this article, we’ll explain the nested query (SELECT) and how to use it efficiently.

Writing a Custom Report to Display the Count of Incidents By Project and Priority

A customer of ours asked for a custom report / graph for displaying the count of incidents by project and by priority.

Creating a Risk Exposure History Report

 In this article we will show you how to create a risk exposure report to help product managers evaluate changes to risk exposures over time.

Creating a Bar Chart to visualize historical delivery of requirements and incidents

Custom graphs let you see powerful and meaningful summaries of your data. One example of this is seeing how many requirements or incidents were delivered historically, broken down by the year of their release. In this article we will show you how to create such a graph to help Product Managers see delivery over time, to help them assess and manage their current and future work program.
 

Creating a report for failed Test Cases with no linked Incidents

A customer of ours asked for a custom report for displaying the list of  failed Test Cases that do not have any incidents attached or created during testing.

Create a report of the number of Incidents and Requirements in past releases

Some customers may want to see the summary delivered outputs of their past releases. To do so, in this example, we create a custom report that shows a table of the total number of Incidents and requirements assigned to each past releases (releases with an end date in the past).

Create a report to display all artifacts across the system owned by a specific person

You may want to extract all the artifacts that have a specific person is assigned across all products, to see their current work. 
This article provides an example of such a report.

Specifying Heading Styles in Spira Custom Reports

A customer wanted to know the way to correctly format their reports so that they would look correctly in HTML and MS-Word in terms of the headings.

Creating a Report of All Users in the System

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.

Creating a Program Requirements Traceability Report in Spira

Some customers have asked us how they can create a program-level requirements traceability report (RTM) in Spira using the custom reporting functionality. This article explains the process.

Querying Child Requirements in a Custom Report

In our standard requirements traceability report, we display a list of test cases associated with the current requirement. However for parent requirements (Epics) that have child requirements that map to test cases, they are don't display the child requirements' test cases. This article explains how you can modify the report to include them.

Increasing the Size of Rapise Images in Spira Reports

When you run Rapise automated tests using RapiseLauncher the system will automatically embed the images from Rapise into the various test cases and test run reports. By default the report format has relatively small images so that they can fit easily into the tables of expected result and actual results. However some users have asked for ways to make the images bigger.

How to Specify the Width of Columns in Acrobat PDF Format Reports

The standard PDF reports in Spira and KronoDesk uses a dynamic table layout, so all of the cells take a general width that is based on the number of columns and the width of the page. A customer wanted to be able to modify the widths to make certain columns larger or smaller (e.g. make the ID field smaller than the name). This article explains the process to do this.

Spira PDF Reports Downloading Not Opening on Chrome

You may find that SpiraTest, SpiraTeam, SpiraPlan reports sometimes don't open on Google Chrome, but instead try and download instead, which can be annoying. This article explains the setting you need to change in Chrome to fix it.

Creating a Report of Test Cases and Test Runs in Hierarhical Order

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.

Creating a Summary Report of Test Cases and Defects

Sometimes you want a simple test execution report that includes the list of test cases, execution dates and raised defects, without all the ancillary information in the standard Spira reports. This article provides an example of such a report.

Simple Requirements Document Report

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.

Creating a Report of Documents in SpiraTeam

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.

Creating a Requirements Traceability Support Report

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.

Customizing the Requirements Traceability Report in Spira

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.

SpiraTeam Simplified Test Execution Report

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.

Embedding Image Attachments in a Report

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.

Displaying the Value of a List Custom Property in Spira Custom 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.

Fixing Security Issue that Prevents Excel Reports from Opening in Spira
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.
WebPart Error on Reports Page After Upgrading from v3.2 -> v4.0

After upgrading from v3.2 to v4.0 you may receive this error message when you access the Reports home page on certain projects:

PageLayout:: OnError:
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.

Writing Custom Reports in SpiraTeam v2.3 - v3.2
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.