Spira Custom Reports

Articles
Graphing the Lead Time and Cycle Time - Part 3

When the data for creation date, start date, and end date are good, we can aggregate the data in a graphical format. This article will demonstrate how to write a simple query to show the trends of these lagging metrics.  

Addressing incorrect data before graphing Lead Time and Cycle Time - Part 2

When aggregating lead time and cycle time graphically, it is important to ensure correct data is present in the required date fields that mark the appropriate workflow status required for computing the lead time and cycle time metrics. This article explains how to perform some diagnostics before aggregating data in the graphs using the task module.

Creating the Report for computing the Lead Time and Cycle Time - Part 1

One of the frequent questions that the Agile Project teams face is computing the cycle and Lead time.  Depending upon the team's practices, this computation may be applied for Requirements, Tasks, or Defects. This article addresses how to create a report for lead time and cycle time based on tasks.

Retrieving requirement associations

This article describes how to retrieve artifact's associations due to the dependency type that become challenging.

Defining the Custom Graphs for Program Capabilities and Milestones

This article provides instructions on creating Custom Graphs for Program Capabilities and Milestones.

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.

Custom Report of Test Sets, Test Cases, and Test Steps

One of our customers recently asked about creating a report that brought the test set, test  case, and test step in a specific format to help them with their test planning.  This KB article explains how this can be done.

 

Requirements Covered in Tests Report, Where the Tests are Filtered

The build in requirements test coverage metrics include all test cases in a project, not just those in specific statuses. This custom report lets you get the count of requirements and the percentage coverage by test cases in a specific status.

Formatting Actual Duration in a Custom Report

By default Spira displays duration values in hours formatted as 0.00 number. If you wish to format these values as hhh:mm:ss then you need to change the XSLT in a custom report.

Create a custom report of all users with their role in each product

If you want to get a report of all the users in the system split by their role per product then this article helps you to achieve that. The custom reporting module in Spira allows you to create a custom report to extract that information.

Creating a Link to the Spira Artifact Item in ESQL

One of the customers recently asked about including a link as an additional column in the tabular report so that it is easy for the receiver to directly access the link instead of navigating through the system. This article provides the query to accomplish this request as part of their query.

EVM - Leading Indicators for Forecasting

In a series of EVM articles, part 1, part 2, and part 3, we discussed about implementing the earned value management (EVM) lagging indicators. In this article, we will discuss the forecasting metrics.

Implementing EVM - Schedule and Summary of Task Based Cost Metrics in Spira - Part 3

This is the final extension to the Earned Value Management. The main difference here is that the the task module contains the details of the costs that needs to be aggregated and added to the cost of time at the blended rate. 

Implementing EVM - Schedule and Cost Metrics in Spira - Part 2

This is an extension of the earlier EVM article on implementing schedule metrics alone. In this article, let us explore adding cost metrics, such as the cost variance and the cost performance index, with summarized costs tracked at the release level.

Implementing EVM - Schedule Metrics in Spira

Recently, an attendee in a conference asked me how Spira can support the earned value management (EVM) for project tracking. The question came up as cost is not part of the standard Spira setup. This article addresses this need. 

Creating a custom report to display all artifacts owned by users

If you need to report against the artifacts owned by one user, but across multiple products - this article helps you to achieve that. The report example focuses specifically on incident and tasks, but can be changed to include more or different artifacts.

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.

Accommodating New Requirement Statuses

Spira currently limits the statuses available for the requirement artifact due to the support the requirement status level automation. One request, despite infrequent, is to address how to accommodate excluding requirements at a release level or reporting on requirements in this 'required but currently unavailable' requirement status. This article addresses this requirement.   

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.

Creating a Risk Register at Portfolio Level

A customer recently asked how to get a list of all risks across all projects within a portfolio. This article explains how to create such 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.

Using a Custom Report to Find Test Cases Not in a Test Set

We had a customer ask us how they could find all the test cases that are NOT part of a specific test set. Now there is unfortunately not a way to do it directly in the Spira UI. However that is where the handy custom reporting functionality comes in!

Using ODATA to Create SpiraPlan Reports using Tableau and/or PowerBI

When using the SpiraPlan ODATA API to create custom reports in popular reporting platforms such as PowerBI and/or Tableau, customers have had some common questions. In this article we answer some of the most frequent ones.

Creating a list of comments for any users in the system

If you need to extract comments for artifact, for a period of time or filtered by comment creator - you can easily do that using Custom Report tool or - if you're using SpiraPlan you can use OData or (PowerBI Desktop) to visually create reports and analysis.

Creating a Custom Requirement Summary Graph using ESQL

A customer recently posted on the forums that they wanted to create a similar graph to the built-in Requirements Summary one using Spira custom graphs and ESQL. In this article we include an example.

Graph of requirements by status in open releases

This article explains how to create a graph of the number of requirements by status, assigned to any open release in a product, using the custom graphing engine.

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.

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.

Modifying the Test Set Summary Report to Exclude Folders

When you run the Test Set Summary Report and filter by a specific test set or a very narrow filter, you will often see the matching test sets and all of the folders in the product. This article explains how you can modify the report to exclude the folders from the output.

Formatting Dates in Custom Report in ESQL

A customer recently asked how to format the date format removing the time component in the custom report. This article address how it can be done.

Adding Document Version to Test Case Attachment Grid

We had a customer that was looking to add the current document version to the grid of attachments shown in the standard Test Case Detailed report. This article explains how you can easily add this field.

Report of Incidents Associated with Blocked Test Cases

One of our customers asked us how to extract the defects/incidents linked to the blocked test cases in a report. This article shows you how to do this using a simple custom report.

Displaying a Test Case - Risk Exposure Report

With SpiraPlan, you have the ability to create and manage risks, requirements and test cases in the same system. You can use the Associations feature to link the requirements to risks, and the test coverage feature to link requirements to test cases. However, as part of a risk based testing methodology, you will often want to see which of your test cases have the greatest overall, aggregate associated risk; if you are limited in time, these are the most critical tests to execute. This custom report generates such a view for you quickly and easily.

Displaying a Requirements - Risk Exposure Report

With SpiraPlan, you have the ability to create and manage both risks and requirements in the same system. You can use the Associations feature to link the requirements to risks. However, as part of a risk based testing methodology, you will often want to see which of your requirements have the greatest overall, aggregate associated risk. This custom report generates such a view for you quickly and easily.

Displaying a Test Case - Risk Traceability Matrix Report

With SpiraPlan, you have the ability to create and manage risks, requirements and test cases in the same system. You can use the Associations feature to link the requirements to risks, and the test coverage feature to link requirements to test cases. However, it is often useful to be able to generate a traceability matrix between test cases and their associated risks. This custom report generates such a table for you quickly and easily.

Displaying a Requirements - Risk Traceability Matrix Report

With SpiraPlan, you have the ability to create and manage both risks and requirements in the same system. You can use the Associations feature to link the requirements to risks. However, it is often useful to be able to generate a traceability matrix between requirements and risks. This custom report generates such a table for you quickly and easily.

Creating a Velocity Comparison Chart for Agile or Scrum Product Delivery

A customer once asked how to create a velocity comparison chart for their Scrum Team to measure planned versus actual velocity across the releases. This article addresses how this chart can be created.

Creating a Custom Graph based on a set of values in a Custom List

A customer recently asked about creating a custom graph based on a set of values in a custom list on an artifact. This article explains how this can be done. 

Implementing Sorting and Filtering on Tasks using XSLT

In one of the training sessions on reporting, a request came up on how data in the XSLT can be sorted similar to ordering results using the ORDER BY clause in ESQL. Both ESQL and XSLT offer its own power which is beyond the scope of this article. But, this article explains a simple way to sort the folders and the tasks in these folders by filtering out the tasks in the root folder and filtering tasks that do not have a name filled in.

Custom Report to pull Custom Properties with Data

A customer had a list of custom properties on the requirement artifact. Some of these custom properties on some requirement had data filled in. When they pulled a report of these requirements, some of these empty custom properties took up much of the report space. So, the customer wondered about reporting only those non-empty custom properties on the artifact. This article explains how this can be achieved.

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? 

Custom Use Case Requirements Report using Custom Reports

We had a customer that was looking to use the Custom Reporting feature in Spira to generate a simple use case report that matched their existing template and format. This article shows how you can do this yourself.

Report of Incidents by Program

A customer asked us if we could provide a report of all the incidents across all projects and programs. In SpiraPlan you already have a Program Incidents list page that shows this information.  However sometimes you want the information in a report format.

Displaying a Graph of Requirements Test Coverage by Custom Property

Imagine you have a situation where you want to display a requirements test coverage graph for requirements organized by a multi-select custom property. In this article we show how you can use that property to display a custom graph in the Spira reporting dashboard.

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.

Custom Report of Test Sets, Test Cases, Test Runs by Folder and Release

We had a customer looking for a consolidated report of the test sets and their test cases, grouped by release and test set folder. The report needed to have the individual test case instances in the test set along with the associated test runs.

Generating a Report of Artifacts that have Invalid Dates

Sometimes you will load in data into SpiraTeam using Excel, Google Sheets or other methods where you end up with dates that are invalid, for example tasks that have an end date before their start date! This article explains how you can use a custom report to quickly find them.

Creating a Graph of Automated vs. Manual Test Execution Durations

Sometimes you will want to get an idea how fast your manual and automated tests are taking. You can use the custom graphing feature to create a custom graph for this.

Creating a Report of Requirements Test Coverage Percentages

SpiraTest comes with a built in graph for displaying the requirements' test coverage information. However sometimes you want the raw data and percentages rather than just the graphical form. This KB article shows how you can use the custom reporting functionality to do this.

Creating Requirements Traceability Matrices with Custom Fields

Sometimes you want to be able to create a Requirements Traceability Matrix (RTM) and include custom properties in the different traced/linked items. You can do some of  this using the standard report and customizing the XSLT template, but for more complex changes, it may be better to use a custom ESQL 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.

Displaying Custom Properties at the Test Step Level

Spira allows custom property at the test step level. This functionality allows testers additional flexibility. When custom reports are designed, some customers prefer to show the custom property at the test step level. This article discusses how to structure the ESQL query to accommodate this need. 

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.

Sample Custom Report - Release Notes

A customer posted a question about a sample custom report generated from Spira. In this example we show how we use the custom reporting tools in Spira to generate the release notes of another one of our products Rapise.

Report to identify number of days a defect is assigned to a person

A customer asked is how they could run a report on a daily basis to see for how long a defect has been assigned to someone and the audit log of the assignment changes. That is best done by using the History table and the main Incident table together in a custom report

Sample Project Baseline Custom Reports

The latest version of SpiraTeam and SpiraPlan (v6.5.2) has support for creating and managing project baselines. In this initial release there are no standard reports built into the system for viewing baselines and the changes that have occurred. This article we provide some custom reports you can use until the next version is released.

Creating a Simplifed Custom Requirements Report

We recently needed to get a report of a set of requirements and include the associated tasks and enhancements/bugs related to the new requirements so that we could have a virtual design session. We took the standard Requirements Detailed Report and make some changes. This article provides that report in case you ever need something similar

Creating a Custom Report with Grouped Headings

A customer asked us how we could group the data in a report by a sub-heading. For example, suppose you want to display a list of all the Components, and under each component, show a table of associated requirements. Well your trusty friend XSLT 1.0 comes to the rescue.

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.

Display Report of Task, Incident, Test Case Effort by Person

In this article, we will create a custom report that displays a list of users in the system and the associated effort for tasks, incidents and test cases.

Report of Test Cases and Test Results by Program

A customer asked us if we could provide a report of all the test cases and test results across all projects and programs. In the future we plan on having built in screens for quality managers to be able to see the test results and test metrics across all projects without needing to run a report. However this report will give you the information in the meantime.

Creating a Report of User Activity and Effort

A customer asked us if we could provide a report of all the activity by users across all projects and programs. In the future we plan on having built in screens for resource managers to be able to see user activity across all projects without needing to run a report. However this report will give you the information in the meantime.

Pie Chart of Test Run by Status for Release

Sometimes customers need to show a Graph with all the Test Runs by status for a specific Release in Spira. This article explains how to use the custom graphing engine to achieve this.

Pie Chart of Incident Status for a Specific Component

Sometimes customers need to show a Graph with all the Incidents by status for a specific Component in Spira. This article explains how to use the custom graphing engine to achieve this.

Custom Report that Displays Test Sets, Test Cases, Test Steps and Linked Incidents/Attachments

A customer asked us how you could create a custom report that shows the following information in a single table:

  • A list of test sets containing:
    • test cases
      • test steps
  • For each test step, the linked:
    • attachments
    • incidents
Creating a Requirements Traceability Report of Requirements Tests and Defects

A customer asked us if it was possible to create a version of the requirements traceability report that would display the following:

  • Requirement (name and ID)
  • Test Case (name and ID)
  • Test Run (ID and execution status)
  • Incident (ID)
Create Test Case Folder Report

If you want to generate a list of all the test case folders in a product, here is an example template to get you started

 

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 Incidents' Reopen Count

One of the metrics that customers often find useful is the number of times that a specific incident has been reopened. We plan on adding some built-in dashboard widgets for this metric, but in the meantime, we have a custom report that you can use to report on this metric from Spira.

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.

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.

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.

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.

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.