SpiraPlan

Articles
What's the Best Way to Test Out the Source Code Features During a Trial?

When you sign up for a trial of either SpiraTeam or SpiraPlan you can add our TaraVault source code management system as a free add-on.  This lets you initialize a new Git (or Subversion) repository, commit files, make changes and also view the branches and changes. In addition, trials of SpiraTeam/SpiraPlan also come with a built-in dummy test provider that simulates a source code repository. This is useful to see how the features work without needing to actually commit any code yourself.

This article explains the two different options you have for trying out Spira's code management features and provide guidance on which is best for you.

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.

Migrating users in Spira from LDAP/ActiveDirectory to ADFS or AzureAD

Many of our on-premise customers have integrated Spira with their Microsoft Active Directory (AD) infrastructure using our LDAP integration option. When they want to move to the cloud, they need to switch their users from LDAP to Single Sign On (SSO) using an Oauth based option such as ActiveDirectory Federated Services (ADFS) or AzureAD. This article describes the process.

Retrieving requirement associations

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

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.

Migration to New Atlassian Centralized Administration - Impact to Integrations

Beginning on February 15, 2024 and continuing into March, Atlassian will be migrating its customers to a new, centralized user management experience called Atlassian Administration. These changes will change the default permissions and roles in Atlassian's products. These changes may require you to update your permissions to ensure the integration between Jira and SpiraTest works uninterrupted.

How to extract large amounts from Spira using Excel or OData

Import/export tools (including Custom reports ) are limited on row handling, due to performance issues it may cause. To get more than 10000 rows at the time, you will need to do it in batches or filter the report in some logical way.
This article explains how to override that limitation with minimum manual efforts.

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.

 

Troubleshooting Eclipse IDE Plugin Installation on Eclipse 2022-12

When you are installing the Spira plugin for Eclipse on workstations running Eclipse 2022-12, sometimes it won't install because of missing/invalid dependencies. This article provides information on fixing this issue and also how to deploy the fixes for customers where their Eclipse instance is not able to download packages from the Internet.

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.

С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.

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.

What is Copied when an Artifact is Cloned

Several customers had questions about the "copying of  artifacts", specifically looking for information about which linked data and dependent data elements are copied. In this article we clarify this information.

Purpose behind a Release Clone Option

We had a customer ask recently why this clone option at the release level in Spira did not make a copy of all the artifacts associated in the previous release. This article addresses this question.

Impact of Bulk Edit Privilege in Spira

A customer recently asked about the impact of turning off the Bulk Edit privilege in Spira. This blog addresses the specific areas this Bulk Edit privilege influences.

What's Migrated from Jira into Spira?

We have a migration tool that makes it easy to move from Jira (cloud, server and data-center editions) to Spira (SpiraTest, SpiraTeam and SpiraPlan editions). This article provides some more information on exactly what is migrated in each module.

Best Practices for using Test Sets in Spira

Customers often have questions about the best way to use test sets in SpiraTest, SpiraTeam and/or SpiraPlan. In this article we cover some of the most common ways that test sets are used in projects.

Agile FAQs when Using SpiraTeam and SpiraPlan

When our implementation partners work with different customers to implement Spira in their organizations, often times they have questions about the tool, that are in reality more process/methodology questions. We discuss some of the most common ones in this article.

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.

Agile Best Practices when Using SpiraTeam and SpiraPlan

When our implementation partners work with different customers to implement Spira in their organizations, often times they have questions about the tool, that are in reality more process/methodology questions. We discuss some of the most common ones in this article.

Create a Summary Report of Test Cases and Defects using Power BI

This article explains how to generate a simple test execution report that includes the list of test cases, execution dates and raised defects using PowerBI.

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.

How to Fix Embedded Spira Image URLs When You Change Server URLs

You may come across a situation where the base URL of your Spira instance has changed and the embedded image URLs no longer match. This will cause a broken image to display inside the various rich text editors in Spira. This article explains how you can use SQL to do a bulk update of the offending URLs.

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.

How to share a query from PowerQuery (Microsoft Excel or PowerBI)

If you're using SpiraPlan's OData to extract data, Power Query helps with extraction and transformations steps that are represented as queries with share options to be used by other users.
This article covers the general mechanisms to share a query in Power Query.

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.

Extracting Custom List value names using OData

If you're using SpiraPlan you can use OData to visually create reports and analsyis. In this example, we are getting an artifact's and product's multi-select custom property value names using Excel Power Query. The build in custom repoort views for artifacts and products show all custom fields, but only their raw values. That means that for custom lists only the ID of the custom list value(s) are shown and not the actual names. Here is what to do to find  and display the names.

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.

How to format .md documents - MarkDown language basic syntax

If you have created a Spira document with  .md extension, you can add formatting elements (headings, bulleted lists, URLs) to plain text without the use of a formal text editor or the use of HTML tags. Please note that Spira supports all original markdown syntax and does not support any extended syntax (like tables, footnotes, checklists)

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 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.

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.
 

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.

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.

Connecting the ALM 11.5 Migration Tool to HP ALM Without Using IE

When you want to migrate your requirements, test cases, defects and other data from HP/Micro Focus ALM to SpiraTeam, you will need to make sure you have all of the ALM client components installed. However the ALM Components are normally loaded using the insecure Internet Explorer 11 (IE11) web browser. To avoid needing to use this browser, you can use the Micro Focus ALM Client Launcher instead. This article explains how.

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.

Information on Requirement Types and Statuses

A customer recently asked for assistance requirement  documentation on the Inflectra website about help on the various fields available when creating requirements in Spira. 

Specifically, the columns such as Type (List of values = Design element, Epic, Feature, Need, Quality, Use Case, User Story). They needed to understand what was the intended use of each of these fields.  and also the meaning of list of values under the status fields (Planned, Requested, developed etc). They wanted to see if we could provide a more detailed explanation or guide what each list of values means? They did not want to make any incorrect assumptions.

Jira Server 9.0 and Later Breaking API Changes

For performance reasons, Atlassian has made breaking changes to the Jira Server API in version 9.0 (and later). This means that is you are using the Spira data synchronization plugin for Jira Server, you need to download the most recent version from our website. This also affects Jira Data Center.

Note: this does not affect Jira Cloud.

How to create a manual test run using the Spira API

To create new manual test runs in SpiraPlan, SpiraTeam, or SpiraTest through the API, you need to make two connected API calls. The first creates the Pending Test Run, and the second finalizes and logs the test run. The Pending Test Run call allows for the manual API test run process to support key features users experience in the UI of the app itself. These include multiple test cases in one test run pending, linked test steps, and test parameters.

How to use these two API calls is explained below, using the v6 REST API as an example. 

Synchronizing On-Premise Spira Sync with Microsoft Azure DevOps (TF400324)

Recently (starting in March 22nd, 2022, but later for some customers) Microsoft removed support for TLS 1.0 and 1.1 endpoints. If you are using an on-premise version of Spira, or a cloud version that uses an on-premise data-synchronization utility, you may get the TFS error: TF400324

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? 

How to fix Jira synchronization issues - mapping errors

Sometimes when integrating Jira with Spira, you might receive errors that refer to artifact mappings, statuses, or even users. This can happen  even if the synchronization status is marked as ‘Success’ and highlighted in green. In this article we have combined certain synchronization errors that might appear while configuring integration with Atlassian Jira.

How to fix Jira DataSync error codes – 400, 401, 404 and 500

Sometimes during the Jira plugin configuration to sync with Spira, you might get an error that is not self-describing and the errors do not point to an obvious solution. In this article we provide guidance on how to resolve some common synchronization errors with specific error codes (400, 401, 404 and 500)

Moving Rapise Tests Between Spira Products

Sometimes you want to move or clone tests. If tests have linked Rapise test cases, then you need to properly handle the move as described here.

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.

How to use the Excel365 addin if you are not able to use the official Microsoft Office Marketplace

Our Office365 addin let's users easily and quickly send data to Spira, or get data out of Spira, across different products and artifacts. We distribute this addin from within Microsoft's Office marketplace. This gives users convenience and confidence: the addin is easy to install, and has been vetted by Microsoft's marketplace team. Some organizations do not allow users to use this marketplace. How do you use this addin in such cases? 

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.

Accessing the Spira 6.0 REST API using C# .NET

We have had several requests for sample code illustrating how to access the Spira 6.0 REST API in C# code. You can of course use the SOAP API instead where Visual Studio auto-generates the C# code for you, but since we have a complete REST Unit Test framework in C#, we are sharing the sample code

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.

Upgrading Spira Editions - What is The Process?

Customers often ask us about the process for upgrading from SpiraTest to SpiraTeam / SpiraPlan or from SpiraTeam to SpiraPlan. In this article we address some of the common questions for both cloud and on-premise customers.https://spiradoc.inflectra.com/Spira-Administration-Guide/System/#license-details

Uploading Screenshots to Spira using the v6.0 REST API

We have had some customers looking to upload files to Spira using our REST API. This article provides some sample code.

We Can't Load This Add-In Because We Couldn't Connect to the Catalog

If you are using our Excel 365 addin you may see the error message:

ADD_IN ERROR

We Can't Load This Add-In Because We Couldn't Connect to the Catalog

The steps to take to resolve this are below

Using the Spira REST API to Remove Test Cases from a Test Set

We had a customer that was looking for a more automated way to remove test cases from a test set. The good news is that our REST API makes this easy.

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. 

Git TaraVault Repository Doesn't Initialize After Upgrade to v6.7

If you are a cloud SpiraTeam or SpiraPlan user and have been using TaraVault Git repositories, you may find that your existing repositories don't appear in Spira after the update to v6.7. This may be caused by an authentication issue that is easy to fix

Purging out Large Batches of Old Automated Test Runs in SpiraTest

We had a customer that was looking for a way to easily purge out a large set of older automated test runs that were no longer needed in their project to free up space.

There is not currently a built-in tool to do this, but we thought it might be useful to provide a way to do it using a SQL Server Agent Job.

Entering Mathematical Equations into Requirements

We had a customer ask us what was the recommended way to enter mathematical equations into a requirement in Spira. There are a couple of options depending on several factors:

  • You want to do it 100% natively in Spira, vs. using an external tool with Spira
  • How complex the equation is
  • Does the equation need to be editable after the fact
Importing from DOORS, Should I use importer or ReqIF File?

A prospective customer asked us to elaborate on the pros and cons of importing into SpiraTeam using either ReqIF or the DOORS importer plug-in?

Fixing 'Access is denied' and 'Invalid Login' error messages with Perforce Integration

When you use the Perforce Provider for Spira you may sometimes run into a Windows folder permission error. This is due to the Perforce API running as a specific user that does not have access to the Windows temporary profile storage area.

Building a Spira Web Farm with IIS Servers

This document contains an overview of how to setup and configure SpiraTest, SpiraTeam or SpiraPlan in a load balanced web farm scenario. It contains links to additional information from Microsoft, and community resources related to the scenario.

Cannot insert the value NULL into column 'TASK_WORKFLOW_ID', table

During the upgrade of an older version of Spira v6.x to the latest version of Spira v6.x the installer logs the following:

Cannot insert the value NULL into column 'TASK_WORKFLOW_ID', table 'SpiraTest.dbo.TST_TASK_TYPE'; column does not allow nulls. UPDATE fails.  The statement has been terminated. [System.Data.SqlClient.SqlException]

HP ALM Migration Custom Field Import Errors

When you are running the import from HP / MicroFocus ALM into Spira, you sometimes come across error messages that look like the following:

Error "The field <RQ_USER_17> cannot be used with requirement type <Non Functional>"

Connecting the HP ALM 11.5 Migration Tool to HP ALM

When you want to migrate your requirements, test cases, defects and other data from HP ALM to SpiraTeam, you will need to make sure you have all of the HP ALM client components installed.

Creating a new Test Run in Spira using the v6.0 REST API

Although we have comprehensive documentation published on our website regarding the Spira REST API, sometimes users need some additional examples. In this article we publish an example of how to record a new test run using our REST API.

Using the Spira REST API to Update Artifacts

One of the most common needs when using the Spira REST API is the ability to update an item in the system (e.g. test case, requirement, task, defect, etc.). This article explains how you can use the REST API 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.

Integration with Jira - Basic auth with password is not allowed on this instance

If you are integrating Spira (SpiraTest, SpiraTeam, or SpiraPlan) with Atlassian Jira, you may get this error message if you have not updated the integration for a while:

Basic auth with password is not allowed on this instance

Fixing Embedded Spira Image URLs When You Change Server URLs

You may come across a situation where the base URL of your Spira instance has changed and the embedded image URLs no longer match. This will cause a broken image to display inside the various rich text editors in Spira. This article explains how you can use SQL to do a bulk update of the offending URLs.

Data Synchronization with JIRA - What Synchronizes

A customer recently had some questions about what synchronizes between Spira and Jira, so we thought that this article would help clarify things.

Links in Jira to Spira no longer visible in new Jira UI

One of the features of the Spira synchronization service for Atlassian Jira is that it automatically adds relevant links to the user story and issue pages in Jira to make it easier to navigate from Jira back to SpiraTest, SpiraTeam, or SpiraPlan. Some users have reported these links are no longer visible.

Can we limit access to our Spira or KronoDesk Instance to Specific IP Addresses?

For additional security, customers may want to limit who can access their cloud instances of SpiraTest, SpiraTeam, SpiraPlan, or KronoDesk to specific networks and IP addresses. This article describes why you would want to do this and how we support this.

Using SpiraTest on BDD Projects

Behavior-Driven Development (BDD) is an Agile software development process that encourages collaboration among developers, QA and non-technical or business participants in a software project. It encourages teams to use conversation and concrete examples to formalize a shared understanding of how the application should behave. This article outlines how you can use SpiraTest to manage BDD style requirements and test cases.

Using the new Spira Reports API

In version 6.2.1 of SpiraPlan, SpiraTeam and SpiraTest we have added a new reporting API that lets you access the reporting capabilities of Spira programatically.

Troubleshooting Emails Not Being Received from Spira or KronoDesk

Sometimes when you use Spira or KronoDesk and perform actions (e.g. assigning bugs, test cases, etc.) email notifications are not received correctly. This article provides some common reasons and solutions

Tuning SQL Server Databases using SQL Engine Tuning Advisor

The SQL Server Database Engine Tuning Advisor examines how queries are processed in the databases you specify, and then recommends how you can improve query processing performance by modifying database structures such as indexes, indexed views, and partitioning. This can be used by on-premise customers to improve the performance of their Spira and KronoDesk instances.

Folder List in Chrome 76 corrupted, unclickable - FIXED IN CHROME 77

With a recent update to Google Chrome (v76), Chrome had the CSS engine was modified which would make the sidebar navigation folder tree to become unusable. This issue was resolved by Google with the release of Chrome 77

This article is now obsolete.

How to move a Spira or KronoDesk installation to another Server

Sometimes it is necessary to move a SpiraTeam, SpiraTest, SpiraPlan, or KronoDesk installation to another server, without wanting to lose all of your data. This KB will guide you through the steps of transferring the install over, and optionally upgrading the application. This guide will walk you through the recommended steps when needing to move both the application and database to new servers.

Upgrade from v5.4 to v6.0 blocked by missing FullText Index Error

Sometimes when running the Spira v6.0 installer to upgrade from v5.4.0.4 to v6.0 you get the following error:

Table or indexed view 'TST_ATTACHMENT' does not have a full-text index or user does not have permission to perform this action.

This article describes the cause and provides the solution

Definitions of Spira Artifacts

SpiraPlan has a range of artifacts. These  are the building blocks of a product or program and contain all of their data. Each artifact holds different data and is used in different ways. For instance, requirements are one artifact, and releases are another. They work differently, and are not interchangable. There are artifacts to help you test, plan, track bugs and tasks, and more.

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.

Installing Spira or KronoDesk with a large SQL Server model database size

When you are installing SpiraTest, SpiraTeam, SpiraPlan or KronoDesk on a database server with a large 'model' database sometimes the install will fail because the initial Spira/KronoDesk database is not large enough to contain your model database. This article provides the solution

Upgrade from v5.4 to v6.0 Blocked by Foreign Key Constraints

When you upgrade from v5.4 to v6.0, unlike previous versions of the upgrader, we don't delete the entire database and recreate it. The upgrader makes the changes to live database in-situ. However if you have missing foreign key constraints in the v5.4 database it can lead to bad data that breaks the installer.

The 'TestCaseWorkflowId' property on 'TestCaseType' could not be set to a 'null' value

When you upgrade from v5.4 to v6.0 upon opening a test case detail page you receive the error: "The 'TestCaseWorkflowId' property on 'TestCaseType' could not be set to a 'null' value". This article explains the cause and provides the solution

Sometimes You See "Multiple controls with the same ID" Error after Migrating Projects

You can use the Spira Project Backup & Migration Tool to move projects between one instance of SpiraTest and another pretty easily. However there is a known issue that can sometimes occur if you have deleted custom properties.

Integration Spira with Active Directory and Multiple Base DNs

Sometimes users have more complex LDAP configurations. For example, users may have two different "Base DN"s where the users are located. They want to know - if there a way somehow to define two different "Base DN"s ?

Integrating Spira with a Cucumber-Based Java Automation Framework

Many of our customers are using SpiraTest / SpiraTeam with their own in-house test automation framework. In this article we explain how you can use our REST API and/or our sample jUnit code to integrate your own framework easily with Spira.

Enable TLS 1.2 in Internet Explorer 8, 9 or 10

If you have disabled TLS 1.0 and 1.1 encryption protocols on your IIS web server, you may run into issues accessing the web interface of Spira or KronoDesk from older versions of Windows and/or IE.

Deleting the Sample Users in Spira (for versions 6.4 and earlier)

Sometimes you want to delete the sample users in SpiraTest, SpiraTeam or SpiraPlan. This article explains the steps for doing this.

You can manage and delete all sample data from the "Manage Sample Data" system admin page. 

If this page is not available (for instance you are on a version older than 6.5) you can delete the sample data manually. 

SVN Repository Stops Indexing With Error "Only one usage of each socket address"

When SpiraTeam or SpiraPlan is connecting to a Subversion (SVN) repository running on Windows Server, sometimes the Windows server will not close connections fast enough, causing the cache build to fail.

Using SpiraTeam with Microsoft Azure DevOps

When using SpiraPlan, SpiraTest or SpiraTeam with Microsoft Azure DevOps instead of a local installation of Microsoft Team Foundation Server there are a couple of differences in the integration configuration that you will want to be aware of. This article describes those differences.

How to migrate or downgrade a SQL Server database to a lower version

This post shows you how you can migrate or downgrade a SQL Server database from one version to a lower or earlier one. E.g. 2016 to 2014, 2014 to 2012, 2012 to 2008 etc. This can be useful if you maintain a heterogeneous environment of SQL Server instances and you have a backup from a newer version that needs to be hosted onto an older version. This happens to us quite a bit when customers installed a trial on SQL Server Express (latest version) and we need to host it on one our cloud servers.

Example of using Spira v5.0 SOAP API to Filter Test Sets

A customer asked us for some sample code that illustrated how you can retrieve a filtered list of test sets using the Spira API. This example includes sample code using the Spira v5.0 API.

Forcing the SpiraTeam On-Premise Git Provider to Update

When you integrate SpiraTeam or SpiraPlan installed on-premise with an external Git source code repository, Spira has to maintain a copy of the Git repository locally. Sometimes you need to refresh this Git repo manually if an update did not complete. This article explains the process

How to Migrate a SpiraTeam Database from On-Premise to Cloud

This article explains the process for making a backup image of your "on-premise" SpiraTeam (or SpiraTest, SpiraPlan) instance and preparing it so that it can be sent to Inflectra to host on our cloud environment. This can happen when you have been using SpiraTeam on-premise, but now want to migrate to the cloud.

When executing a test set with a configuration, an error occurs.

This article explains what to do if you are attempting to execute a test set and get this error message: "There are no test runs in this pending set to be resumed." 

Fixing "The maximum recursion 100 has been exhausted" error in Spira 5.0 and 5.1

Customers running Spira v5.0 or v5.1 may experience an issue where the system will let you create test case folders that point to one of their children as parent. This causes an infinite loop which will break the system. This article provides a solution to fix the issue (though we recommend upgrading to v5.4 to prevent it happening in the future).

This article is obsolete.
The infinite loop issue was fixed in later versions of 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.

jUnit or TestNG Plugins Receive a 502 Connection reset by Peer error

One of our customers was reporting that their instance of our TestNG plugin was reporting a 502 Connection Reset by Peer error. We did some debugging with them, and the issue appears to be a bug inside some versions of the Java Virtual Machine (VM) itself.

Test Set Execution Status Not Updating When I Run Test Cases

Sometimes customers will contact us regarding questions as to why the execution status indicator of their test sets is not being updated (i.e. everything still looks as not run) even after running some of the test cases. This article explains why this might be the case and provides solutions.

TeamCity Spira Plugin Does Not Save Global Settings

When you are first using the SpiraTeam plugin for JetBrains TeamCity, you may run into the issue where the settings for TeamCity are not being saved correctly.

Troubleshooting the "Report ID" Does Not Exist Error in Spira

Sometimes when you try and run certain reports you may get an strange error message "The passed in report ID or report format ID does not exist". This message is unfortunately a red herring, and there is a different reason for this error.

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.

Error Saving Item Due to Old Custom Property Records in Spira 5.x

If you have recently upgraded to Spira v5.x from an earlier version and get an error message saving artifacts that mentions 'XPKTST_ARTIFACT_CUSTOM_PROPERTY' then you may have some old artifact custom property records that are blocking the new item saving

How do I Recover a Deleted Project in Spira?

Most of the artifacts in Spira are "soft deleted", i.e. they are simply marked with a deleted flag, and can be recovered easily by a project administrator using the Project History Changes option to review the changes, filter by deletes and revert the change. However when a system administrator deletes a whole project, it physically deletes the project and cannot be undone.

What's Migrated from HP ALM into SpiraTeam

We have a migration tool that makes it easy to move from HP ALM (aka Quality Center) to SpiraTeam. This article provides some more information on exactly what is migrated in each module.

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.

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.

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.

Uploading Screenshots to Spira using the v5.0 REST API

We have had some customers looking to upload files to Spira using our REST API. This article provides some sample code.

How to Control Upgrades of Cloud Spira in Life Sciences

Many of our customers work in the life sciences and healthcare industries. They want to use cloud hosted versions of SpiraTest, SpiraTeam, or SpiraPlan, but they need to be able to control the updates and also be able to have a staging and production environment. This article explains the options we provide

Long Running Import Tasks into Spira Failing

Many of our customers are importing from other tools, such as HP QC, HP ALM, Microsoft Test Manager, TestRail, etc. We have convenient import tools for these products. However sometimes these import tasks can fail due to interruptions. This article provides some solutions

Releases and Iterations - What Rolls Up?

Customers sometimes contact us with questions about how the Releases and Iterations in Spira work, specifically what kinds of data (test status, task progress, etc.) roll up from an iteration to a minor release, and from a minor release to a  major release. Also they want to know whether iterations are included when you filter by release. This article provides some clarifications.

GET an automated test script using Spira's REST API

An automated test case stores its test script as a standard document inside of the SpiraTest/Team/Plan application. To GET the current script using our REST API you need to make 2 calls: 1 to get the document ID and the other to retrieve the script itself.

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.

How do I use TaraVault On-Premise?

If you are using SpiraTeam and SpiraPlan on-premise, and are looking at our TaraVault cloud-hosted code management service, this article explains what TaraVault is, and how you can have the same functionality on Premise.

Which artifacts can be shared across projects?

By default, all projects are completely self-contained; artifacts in one project can only be linked or associated with artifacts in the same project.  However, there is a way for the project admin to selectively allow other projects to access artifacts in the current project.  (Administration -> Project Associations)

The cross-project functionality is being introduced gradually.  As of Spira version 6.0, it applies only to requirements, test cases, tasks (SpiraPlan and SpiraTeam), and incidents.

This article explains how and where the artifacts from another project can be used.

Fixing the database when you have incidents linked to values from other projects

The incidents in Spira are able to have customizable incident types, statuses, priorities and severities. This means that each project has unique IDs for the various attributes. Sometimes when you incorrectly load in data using our Excel Add-In, you can link incidents to attributes from other projects. This article describes the problem and the solution.

Removing News Feed Widget from On-Premise Spira Installations

Some of our customers who have SpiraTest, SpiraPlan, and SpiraTeam installations wanted to know how you can remove the "News Feed" RSS widget from all users' dashboards since it was causing Spira to access the www.inflectra.com domain.

Order of Database Table Deletes when Projects Deleted in Spira

Some of our customers wanted to know that we delete the data in the SpiraTest, SpiraPlan, and SpiraTeam tables when we delete a project.
This article outlines that approximate order of the data being deleted

Best Practices for Configuring Microsoft SQL Server for use with SpiraTest, SpiraTeam, and KronoDesk

When you install SpiraTest, SpiraTeam, SpiraPlan, or KronoDesk on premise, you have a choice in different ways to configure SQL Server. Every situation is different, but this article presents some recommendations.

Increasing the Maximum Upload File Size in IIS

By default, IIS web server allows for limited file size to be uploaded to the web server. For IIS 6 and IIS 7, the default maximum file upload size is 4 MB and 28.6 MB respectively. IIS 7 returns a 404 error (HTTP Error 404.13 - CONTENT_LENGTH_TOO_LARGE) if someone uploads something larger than 30MB. In order to allow for larger file size uploads, a few server changes are required.

Troubleshooting LDAP & ActiveDirectory Integration

Integrating SpiraTest, SpiraPlan or SpiraTeam with your LDAP or ActiveDirectory direcory server makes a lot of sense. It allows you to have a single user authentication system, with all logins and passwords centrally managed. Spira includes integration out of the box with LDAP and this article provides help for some common issues that we have come across.

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

Best Practices When Using SpiraTeam for V-Model Projects

SpiraTeam has been designed to work with a variety of different software development methodologies, including several different flavors of agile, waterfall and hybrid. This articles describes one of the more popular waterfall methods called the V-Model and gives best practices for how to use SpiraTeam on such projects.

Rebuilding the Database Indexes - Advanced Version

With the latest version of SpiraTest, SpiraPlan and SpiraTeam, we have provided a simple button in the Data Tools section that lets you rebuild the database indexes using the same script that we published in KB10. However sometimes the database is so large that the execution takes longer than the 30 minutes allowed by the application, or you want more control over the fragmentation levels that trigger a rebuild. This article provides guidance and a more advanced script for power users.

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.

How to Install a SpiraTeam Database from our Cloud Servers Locally

This article explains the process for taking a SpiraTeam (or SpiraTest, SpiraPlan) backup image from Inflectra's cloud servers and installing it on a local "on-premise" instance of SpiraTeam. This can happen when you have been using SpiraTeam in the cloud, but now want to host it locally.

How to generate a HAR file in Chrome or Firefox

Sometimes, when troubleshooting complex issues with SpiraTest, SpiraPlan, SpiraTeam or KronoDesk, it's necessary for us to get some additional information to troubleshoot the issue further. For example, when we receive a report of performance trouble when using our cloud services, there are a lot of different factors that may contribute to the problem. To narrow down the cause of the performance problem, we need more data.

Setting up Incident Workflow Transitions and Notifications

A workflow is a predefined sequence of incident statuses linked together by “workflow transitions”.  Incident statuses and workflow transitions are highly configurable. This article gives an overview of workflow transitions.

Accessing the SpiraTeam Graph Data Grid as CSV

When you display a graph in the SpiraTeam reporting page, you can download a graph as a CSV file. Some customers have asked about ways to get the data making a REST call. This article explains the components of the API.

How Are the Attachments in SpiraTeam Stored?

We often get questions about how the attachments in SpiraTeam are stored, and what the relationship is between the X.dat files on the file system and the original filenames. This articles provides information on this.

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.

Synchronizing JIRA 5.0+ with Spira version 4.x

The plugins listed on our website for integrating with JIRA are compatible with the latest major version (5.0 at time of writing) of SpiraTest, SpiraPlan or SpiraTeam. This article provides older versions of the JIRA data-synchronization plugin for customers that are using older versions of Spira.

Installing the Excel Add-Ins on a machine that has a newer version of Microsoft VSTO

When you install the Spira MS-Office Add-Ins to help import data into SpiraTest, SpiraPlan or SpiraTeam from Excel, Word or MS-Project the installer will check that you have the Microsoft Visual Studio Tools for Office (VSTO) pre-requisite installed. Sometimes if you have this already installed with a newer version it will prevent the install from completing.

This article is obsolete, since there is a new version of the import/export tools available. To import data using SpiraPlan Excel Import/Export Too l/ SpiraPlan MS-Word Requirements & Test Case Import Tool it is not required any more to have Microsoft Visual Studio Tools for Office (VSTO) installed as a prerequisite.

Spaces are being removed from Rich Text Editors in Chrome 54

When using rich text editors in SpiraTest, SpiraPlan, SpiraTeam or KronoDesk with Google Chrome 54, users are seeing spaces not being accepted.

This article is now obsolete.
All issues with rich text editors have been resolved.

How Do I Import From Excel 2010+ into SpiraTeam v4.x

We recently announced the release of an updated MS-Office plugin for Spira v5.0 that makes use of the new API in Spira 5.0. However some customers still need the older MS-Office 2010+ plugin for older versions of Spira (v4.x).

This article is obsolete.
Our Excel365 plugin can be downloaded from the Microsoft Store from the add-ins menu. More details about the Excel365 addin can be found here.

Why are Months in Czech & Slovak Cultures Sometimes Shown in Roman Numerals

When running Spira or KronoDesk on certain versions of Windows, when using the Czech or Slovak culture settings (or using Server default when Windows is installed in those languages) you may get unusual formatted dates.

This article is obsolete.
There is a new Style Guide for Czech and Slovak - can be found here: https://download.microsoft.com/download/7/b/5/7b57e4a1-d299-4238-9997-f3ac51d6f763/ces-cze-StyleGuide.pdf

Using SpiraTeam with Visual Studio Online

When using SpiraPlan, SpiraTest or SpiraTeam with Microsoft Visual Studio Online instead of a local installation of Microsoft Team Foundation Server there are a couple of differences in the integration configuration that you will want to be aware of. This article describes those differences.

Database Changes Between Spira v4.2 and v5.0

As part of the v5.0 update to SpiraTest, SpiraPlan and SpiraTeam, we made major changes to the database structure to improve performance and usability as well as lay the foundation for v5.1, v5.2 and v5.3 due out later this year. Customers using custom reports that relied on the old v4.2 database structure will need to modify their custom reports.

This article is obsolete.
This only applies to upgrading to v5.0 which was released in 2016.

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.
Make sure you can use all verbs in our API for self-hosted customers - fixing a 403 error
On-premise / self-hosted customers who have Spira installed on older versions of Windows (eg Windows Server 2003) may be using an old version of Internet Information Services 6 (IIS 6). IIS 6 can restrict by default which API verbs it allows throwing a 403.1 error.
Spira Icons Don't Appear When Running on Internet Explorer 11.0 in v5.x

A couple of our customers have run into a situation where the new font-based glyph icons that we're using in Spira 5.0 don't display. This is usually due to a configuration issue within IE itself, this article provides the recommended solution.

What to do When Upgrading to Spira 5.4 (or below) Fails?

When you upgrade an older version of SpiraTest, SpiraPlan or SpiraTeam (hereafter referred to as Spira) from an older version to the latest version, the installer has to upgrade the application and database at the same time. This article provides some solutions to cases where the installer throws an error or fails to upgrade the database for some reason.

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.

DOORS Import DXL Runtime Error
Sometimes when you are using the SpiraTeam Importer for IBM Rational DOORS, you will get a DXL Runtime Error. This article explains the cause and provides the appropriate solution.
SpiraTeam and KronoDesk have IDs that occasionally jump by 1,000

When using SpiraTest, SpiraPlan, SpiraTeam or KronoDesk with SQL Server 2012 or later, you may occasionally have a situation where the ID for an artifact (test cases, incident, ticket) suddenly jumps by exactly 1,000 values (e.g. from 214 to 1214 instead of just incrementing to 215).

Resolving 'Unable to cast COM object' errors when using MS-Office Add-Ins

Sometimes when using our MS-Office Add-Ins (for Excel, Word and Project) on a new computer you will see an error message of the type:

Unable to cast COM object of type 'System.__ComObject' to interface type 'Microsoft.Office.Tools.Excel.Worksheet'. This operation failed because the QueryInterface call on the COM component for the interface with IID ...

This article explains the cause of these types of error and provides some common solutions
 

Migrating from Cloud/Hosted Trial to On-Premise
We sometimes get customers that have signed up for a hosted/cloud trial of our products but want to migrate their trial data to an on-premise installation for production use (instead of just having us move it to our production cloud servers). This article outlines the process for such a migration.
Running Queries Using SQL Server Management Studio

During the course of investigating a technical support issue for SpiraTest, SpiraPlan, SpiraTeam or KronoDesk , the need may arise to run a query against your Microsoft SQL database. To do so, you will use Microsoft SQL Server Management Studio. If you did not install this when you installed SQL, you can install it from the original source.

Configuring MS SQL Server for Remote Access

When connecting from Spira or Krono installed on a separate application server to a remote SQL server, you may have difficulties connecting. This article describes the steps for making sure that your SQL Server can be accessed remotely.

Useful constants when calling the Spira API
Sometimes when using our SOAP or REST APIs there are constants that are useful for some of the filters. In many cases they are included in the build-in API documentation, but sometimes they are not listed. This article details some of the release/requirement ones that may be useful:
Some of my users are receiving 'Invalid Viewstate' errors. How do I resolve this?
Ask the user to clear out their browser's cache of cookies and stored internet pages/content. After they do this and then close and reopen their browser, the issue should be resolved.
After restoring a backup of my database, I keep getting unable to login to database errors?

This usually just means that the restored database just needs to be linked to the existing database server login. This can be done by executing the appropriate SQL command listed below:

How do I migrate data from a trial installation of Spira or KronoDesk to the production one?

This is a common need, since you may have installed SpiraTest, SpiraPlan,  SpiraTeam, or KronoDesk  on a workstation to evaluate its capabilities and now need to install it on a production server for real use, but you don't want to lose all your existing data.

Choosing a Database to Run SpiraTeam or KronoDesk On

This article answers some common questions about which databases you can run SpiraTest, SpiraPlan, SpiraTeam and KronoDesk on, and where you can get them from.

Hosting Questions - SpiraTest, SpiraPlan, SpiraTeam & KronoDesk

You already know the advantages of us hosting your application in our cloud:

  • Focus on managing your projects not hardware
  • Flexible pricing and contracts by # users
  • Backups and all maintenance handled by our staff
  • Globally accessible using just a web browser
  • Get up and running in minutes with no installations
  • Choice of hosting locations (USA, EU, Canada, India, Singapore, Australia)               

However you may have questions about our hosting service. This article provides important information about our cloud hosting services, including security, privacy and reliability information.

SpiraTeam & KronoDesk - Common Installation Questions

Our web-based products: SpiraTest, SpiraPlan, SpiraTeam and KronoDesk make use of the Microsoft IIS web-server and Microsoft SQL Server database platforms.
This KB article explains some of the more common error messages that can occur after installing one of our products and the steps to remedy them.
Article was initially written specifically for versions v3.0 - v4.2 of Spira and versions v1.x of KronoDesk, but some of the issues applicable to the recent versions as well.

SpiraTeam and KronoDesk - Upgrade Questions

One of the benefits of using Inflectra software is that you get unlimited upgrades for the first year and as long as you maintain an active service plan. This articles describes the process for upgrading your installation of SpiraTest, SpiraPlan, SpiraTeam or KronoDesk to the latest version. It also answers many common questions about the process.

How should I backup my installation of Spira or KronoDesk?

This article describes the process for backing up instances of SpiraTest, SpiraPlan, SpiraTeam or KronoDesk (hosted on-premise). The example is written using SpiraTeam, but applies equally well to SpiraTest, SpiraPlan or KronoDesk, you just need to change the database name in the SQL files.

Common Email Sending Issues when using SpiraTeam or KronoDesk
It is a common need to be able to connect our products (SpiraTest, SpiraPlan, SpiraTeam and KronoDesk) to a mail server. If we are hosting it in our cloud, then we take care of this for you, however if you are hosting it yourselves, you need to connect Spira or KronoDesk to an SMTP mailserver. This article provides answers to some common mail questions.
Finding deleted requirements when you only know a child item's ID

Sometimes you have a situation where a user deletes an entire tree of requirements and you only know the ID of one of the child items and not the parent ID that was actually deleted. This KB article provides a query that lets you find all the deleted parents of a specific requirement.

SpiraTeam and KronoDesk Javascript Not Loading Fully on Windows 8+

If you install SpiraTeam or KronoDesk on Windows 8 or later, you need to make sure that the various IIS Roles and Features are installed. If not, you may find that various Menus don't display correctly or that the pages do not display any data.
This article describes the features and roles that need to be included.

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.

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.

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.

Performance issues with IE9 running apps under ASP.NET 4.5

If you face performance issues with Spira or KronoDesk when the users use Internet Explorer 9.0, there is a known issue in ASP.NET 4.5 that can cause the client to disconnect and all subsequent AJAX calls do not get processed. This article describes the symptoms and the solution.

This article is now obsolete.
Internet Explorer 9 is no longer supported by Spira or KronoDesk.

How to adjust the logging levels in Spira and KronoDesk

Sometimes to diagnose issues with SpiraTest, SpiraPlan, SpiraTeam or KronoDesk it is helpful to increase the logging level to log all trace activity in the system. This KB article describes how to enable this feature.

Getting 'X' is not a member of type 'Inflectra.SpiraTest.DataModel.IncidentView' after 4.2 upgrade

After upgrading to Spira v4.2, if you get either of the following error messages:

  • 'Width' is not a member of type 'Inflectra.SpiraTest.DataModel.IncidentView'
  • 'DisplayMode' is not a member of type 'Inflectra.SpiraTest.DataModel.IncidentView'

Please follow the instructions in the article to solve the issue that happens when you try and use a saved filter that gives this issue.

This article is obsolete.
It is referring to the old bug fixed in later versions and applies only to that particular case when upgrading to Spira v4.2.

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:

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.

List of Possible Filterable Field Names in Spira when Using API

When you use our SOAP or REST web service APIs you will often times want to retrieve a filtered list of data. This is done by using the RemoteFilter that lets you query the list of requirements, test cases, tasks, incidents, etc. and pass in the field to be filtered. This article includes the list of standard fields that you can use in the RemoteFilter.

Modifying the underlying MS-Word Templates in Spira 4.1+
The web-based custom reporting system in Spira v4.1 (or later) is designed to let you easily change the layout and contents of the various reports (and to create your own reports). It works in a format-agnostic manner, so that the same templates and layouts can be used regardless of whether the final report will be in PDF, HTML, Excel or MS-Word format. However sometimes there is a need to modify the specific template used to generate a specific format (e.g. MS-Word). This article describes the process.
Spira or KronoDesk displays 404 page not found error on certain pages

If you have an installation of SpiraTest, SpiraPlan, SpiraTeam or KronoDesk that displays a 404 page not found message on certain pages, it may be due to a configuration issue on the server preventing the URL rewriter from functioning correctly.

Upgrading SpiraTeam v4.1 from older version fails due to .NET 4.0 check failing

Sometimes when running the SpiraTeam v4.1 installer to upgrade from an older version of SpiraTeam (same also applies to SpiraTest and SpiraPlan) you will get the error message:
You must install the Microsoft .NET Framework 4.0.30319 even though .NET 4.0, 4.5 or 4.5.1 is installed.

This article is now obsolete.
Current framework requirements listed here.

A DLL required for this install to complete could not be run

If you run one of our installation packages (.msi) and receive the following message:

A DLL required for this install to complete could not be run

Enabling Windows Installer (.msi) Trace Logging
Sometimes when installing our products you get error messages during the installation and it's necessary to provide Inflectra support personnel with detailed trace/logging information so that they can better support you. This article describes the steps necessary to enable Windows Installer (.msi) trace logging.
Ways to Optimize Spira and KronoDesk Performance

Sometimes we get help desk tickets from on-premise customers regarding the performance of our web-based applications (SpiraTest, SpiraPlan, SpiraTeam and KronoDesk). Whilst every situation is different, this article provides some common best practices that should help having a high-performing system.

Changing Requirement Status in Spira v4.1 to match v4.0
In v4.1 the status of requirements was changed so that requirements set to 'Completed' in v4.0 will now be shown as 'Developed' with two new statuses Tested and Completed available.
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.

List of reportable entities in Spira 4.1-5.4

Spira 4.1 onwards includes the ability to write custom reports against various reportable entities.
This article provides a list of reportable entities that were available in Spira version 4.1 through to 5.4

MSDTC Causing Issues Creating Requirements & Use Cases on Spira 4.1
If you are running Spira v4.1 and you have the situation where you cannot create requirements or use case steps, please read this article for instructions on how to fix the issue.
Issues using the KronoDesk and Spira Screenshot Java Applet

SpiraTest, SpiraPlan and SpiraTeam versions older than v4.1 and KronoDesk versions lower than v1.1.0.7 use a screenshot capture utility written using the Java development platform. This lets the web browser capture a screenshot and attach it to items in the system without having to first save the item. This article describes some issues using this applet and outlines the replacement plan we have implemented to use HTML5 instead of Java going forward.

Exporting all incidents out of the system into Excel

Several users have asked - if it is possible to extract all incidents logged in a SpiraTest server no matter what the project is.
Using the built-in Incident reports or Excel Add-In, you have to extract incidents for each project and then move into one spreadsheet however they wanted to know if it was possible to do this as one extract from within the tool.

Troubleshooting the MS-Office 2003 Add-Ins

If you have installed the MS-Office Add-In for SpiraTest, SpiraPlan or SpiraTeam and the necessary prerequisites (VSTO and the Primary Interop Assemblies if using the MS-Office 2003 Add-In) but it won't display the Add-In in your instance of MS-Excel, MS-Word or MS-Project, follow these instructions to help us troubleshoot.

Integrating SpiraTest, SpiraPlan or SpiraTeam Hosted with JIRA On-Demand

This article describes the steps in integrating a hosted instance of SpiraTest, SpiraPlan or SpiraTeam with Atlassian's JIRA On-Demand (hosted). We recommend using our cloud hosted data synchronization service that means you don't need any special tools or downloads to use both products together. Let us do the work for you!

Java Security Warning on appSupa when pasting screenshot attachment

When using some versions of Java with SpiraTest, SpiraPlan, SpiraTeam or KronoDesk you may get the following warning message when pasting in screenshots or images:

When I click to paste a screenshot attachment, get Java security warning (see screenshot) which says " Block potentially unsafe components from being run?  Application: appSupa  Java has discovered application components that could indicate a security concern. Contact the application vendor to ensure that it has not been tampered with" with options to Block and Unblock.   "The application contains both signed and unsigned code".

This article is obsolete, due to the fact Java has been disabled for most of the browsers.

Trouble with drag and drop when using Google Chrome browser

When attempting to drag and drop items to rearrange list pages, it does not work.

This article is obsolete.
Google Chrome and other browsers are fully compatible with Spira functionality.
How to access Spira v4.x SOAP web services using Java

This knowledge base article describes how to connect to the SpiraTest, SpiraPlan & SpiraTeam 4.x SOAP web services using Java code. It assumes that you've generated the SOAP proxy classes using JAX-WS. If you need to download pre-compiled versions of the classes, they can be downloaded from this knowledge base article.

Note: We now recommend customers use our REST web service instead as Java has removed a lot of the JAX-WS classes from the newest versions of the JRE: https://api.inflectra.com/Spira/Services/v7_0/RestService.aspx

Sample code is here: GitHub JUnit Sample.

This article can be considered as obsolete, we now recommend customers use our REST web service instead as Java has removed a lot of the JAX-WS classes from the newest versions of the JRE: https://api.inflectra.com/Spira/Services/v7_0/RestService.aspx

How to access Spira v4.0 SOAP web services using Java

This knowledge base article describes how to connect to the SpiraTest, SpiraPlan & SpiraTeam SOAP web services using Java code. It assumes that you've either generated the SOAP proxy classes using JAX-WS or are using the pre-compiled ones attached to this KB article.

This article is obsolete, we now recommend customers use our REST web service instead as Java has removed a lot of the JAX-WS classes from the newest versions of the JRE: https://api.inflectra.com/Spira/Services/v7_0/RestService.aspx

Fixing error where uploading attachments gives missing folder or types message

This articles provides the solution to the following error messages that you may receive in Spira if you have missing default project attachment types/folders for a project:

APPLICATION.Business.Attachment::Insert: Inflectra.SpiraTest.Business.ProjectDefaultAttachmentTypeException, Can't locate the default project attachment type for project X
or

APPLICATION.Business.Attachment::Insert: Inflectra.SpiraTest.Business.ProjectDefaultAttachmentFolderException, Can't locate the default project folder for project X

This article is obsolete, since new versions of Spira have this issue already resolved and do not require any manual intervention to correct the possible error message.

Installing MS-Office Add-Ins for multiple users

Since our MS-Office 2007 Add-In for SpiraTeam uses the Microsoft VSTO technology, it's limited to being installed for a single user on a given PC.
However if you need to be able to have multiple users access it, there are some registry keys that you can manually add.

Setting the Proxy Server for Spira to Connect to External Resources

In situations where your SpiraTest, SpiraPlan or SpiraTeam server is located on a company network that does not have direct Internet access (and connects through a proxy server), some of the integration features of Spira may not work correctly:

  • The weather widget on the My Page
  • The list of recent builds if your Jenkins server is hosted outside your network
  • The RSS feed widgets on the My Page
  • Data synchronization with bug-trackers that are externally hosted

This article outlines the step necessary to tell the Spira server to use the proxy server for its Internet connections.

Article can be considered as obsolete.
Described fix applies to outdated versions of the application only.

Errors occur when trying to attach a screenshot or display "My Profile" page

SpiraTeam uses Java (tm) for attaching screenshots to artifacts and for adding a user logo or avatar on My Profile page.

If a current version of the Java Plug-In is not installed in your browser, problems can occur. 
Depending  on your browser, the source of the problem may not be clear.  For example, sometimes IE will report that  there is a problem with the page. This article explains how to update your browser's Java Plug-In.
 
This article can now be considered as obsolete.
The most of the browsers have removed Java applets from the standard functionality due to vulnerabilities, performance degradation, and other complexities.
 
How to embed images into SpiraTeam artifact descriptions

When you need to embed an image inside the description of a requirement, test case, task, etc. you need to follow the process outlined in this article. With the release of SpiraTeam 4.0 you can then have these images appear in the PDF, HTML and MS-Word 2003 format reports.

This article is now obsolete.
It is not required anymore to first upload the images and then specify the URL to display it in the description of the artifact (and then report) - all description fields are now rich text and screenshot images can be copied directly from the clipboard - the file will be automatically added to the description of any artifact.

List of reportable entities in SpiraTeam 4.0

The new release of SpiraTest, SpiraPlan and SpiraTeam 4.0 includes the ability to write custom reports against various reportable entities. This articles provides a list of the available entities.

This article is now obsolete.
Currently Spira has a number of views available that helps to create powerful custom reports using ESQL queries. Each available table is listed with all of their exact field names. In our documentation you can find a full list of available custom report tables.

The application doesn't display correctly after upgrading versions

Sometimes after your instance of SpiraTest, SpiraPlan, SpiraTeam or KronoDesk is upgraded (or you upgrade an on-premise edition), the screen doesn't display correctly.

Unable to create a new project after upgrading to v4.0
If you have upgraded from Spira v3.2 to v4.0 you may receive a Foreign Key violation error message when you try and create a new project. We have identified the cause and will be adding a fix to patch 003. This article describes an immediate workaround.
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.

Changing SQL Servers or Updating Server Names

The steps to perform when needing to move the database to another SQl Server, or when changing the DNS name of your SQL Server.

Installing SpiraTest, SpiraPlan and SpiraTeam v3.x on SQL Server 2012
When installing Spira on SQL Server 2012 (any edition) using Windows Authentication, you may receive an error message "Cannot Create User" (or similar) during the installation. This is because of a configuration change in SQL Server 2012 (as opposed to earlier versions). This article explains the step needed to prepare SQL Server 2012 for installing Spira v3.x. Newer versions of Spira will not need this step as the installer has been updated.
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.
How do I move my SpiraTest/Plan/Team database to another server

This article describes the process and steps for moving your SpiraTest, SpiraPlan or SpiraTeam database from one computer to another.
The article will refer to SpiraTeam, but it applies equally to the other products.

Incident Custom Properties are Disabled

In SpiraTest, when you create a new custom property in the incidents section, they are disabled by default. Unlike other parts of the system, the incident tracker has a customizable workflow. This article describes the steps necessary to enable the new custom properties in the workflow (which will make the custom property enabled).

This article is now obsolete.
Custom Properties are now always active and do not require separate activation.

Using SpiraTeam Data Synchronization with TFS on a 64-bit system

SpiraTeam is designed to work on both 32-bit and 64-bit systems, taking advantage of the extra memory and power available if you have a 64-bit operating system. However Microsoft's Team Foundation Server (TFS) - part of Visual Studio Team System (VSTS) - only runs in 32-bit mode. Therefore when using our integration there are a couple of steps you need to perform.

How do I create a new Spira plugin for a bug-tracker
We have many different plugins available for different bug-tracking tools (see https://www.inflectra.com/SpiraTeam/Downloads.aspx) however there may be cases where you need to integrate SpiraTest, SpiraPlan or SpiraTeam with a bug-tracker we do not currently support. This article explains the process for writing such a plugin.
Rebuilding Database Indexes

This article has a couple SQL commands that can be run to optimize database speed and performance.  This article applies to on-premise instances only.  If your instance is cloud-hosted, please create a Help Desk ticket.

How to Import Data into SpiraTest/Team from MS-Excel

This article describes the steps for importing data from an Excel spreadsheet into SpiraTeam. You can use this to import requirements, test cases, tasks, incidents and releases.

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.

Application Dropdowns and Other Controls Not Displaying Correctly
When installing SpiraTest/Plan/Team or KronoDesk on a Windows 2008+ server, some of the controls or content in the application does not display correctly.
How to resolve PageHandlerFactory-Integrated Bad Module errors

This article describes how to resolve the following error message that can occur on new installations of SpiraTest, SpiraPlan, SpiraTeam or KronoDesk when ASP.NET is not correctly configured. This message typically only occurs on Windows Vista, Windows7 or Windows 2008 Server.

HTTP Error 500.21 - Internal Server Error
Handler "PageHandlerFactory-Integrated" has a bad module "ManagedPipelineHandler" in its module list.

How to access Spira v3.x SOAP web services using Java

This knowledge base article describes how to connect to the SpiraTest, SpiraPlan & SpiraTeam SOAP web services using Java code. It assumes that you've generated the SOAP proxy classes using JAX-WS. If you need to download pre-compiled versions of the classes, they can be downloaded from our website at: JavaSoap30Classes.zip

Note: We now recommend customers use our REST web service instead as Java has removed a lot of the JAX-WS classes from the newest versions of the JRE: https://api.inflectra.com/Spira/Services/v7_0/RestService.aspx

Sample code is here: GitHub JUnit Sample.

How to access SOAP web services using C# with WCF

This knowledge base article describes how to connect to the SpiraTest, SpiraPlan & SpiraTeam SOAP web services using .NET code written in C#. The code assumes that you're using Visual Studio 2008 or later and are using the newer .NET 3.0+ Windows Communication Foundation (WCF) "Add Service Reference" rather than the older .NET 2.0 ASMX web service client.