Skip to content

System: Integration

Data Synchronization

SpiraPlan® is capable of synchronizing its data with a variety of other systems, including but not limited to requirements management systems and standalone bug-tracking tools. The various integration plug-ins for SpiraPlan® and the steps for configuring the data-synchronization settings are described in the SpiraTest External Bug-Tracking Integration Guide. Each individual tool has its own separate guide that builds on this setup guide.

If you are synchronizing data between SpiraPlan® and one of these other systems, the 'Data Synchronization' administration page will show a list of active data-synchronizations services in user, together with the status and date/time of last synchronization:

In the example above, we have three plug-ins active, with incidents being exported into Github, JIRA, and Microsoft Team Foundation Server / Azure DevOps. The data of last sync and the status indicate if there are problems with the plug-in. In this example we can see that TFS is active, but none of the plugins have synced yet.

The 'Refresh' button allows you to refresh the status of the page to ensure that you are seeing the most up to date information. In certain circumstances you may want to reset the date of last sync and force a particular plug-in to examine all the records in the system to see if any were not synchronized - clicking on the 'Force Complete Re-Sync' button will achieve this. The recommended procedure for forcing a re-sync is to temporarily stop the SpiraPlan Data-Sync background Windows service, click the button to reset the last-sync date, and then start the service. This will ensure that the resetting doesn't happen mid-sync.

In the "Data Mapping" column each plugin has a dropdown that shows all the active products on the system, ordered alphabetically. The TFS plugin has this drodown open. You can see two different icons to the left of the product names: a full hexagon and an empty hexagon. A full hexagon means that the product is actively using this particular plugin. Selecting a product from the dropdown and then clicking the arrow to its right will take you to the detailed product data synchronization page for that plugin and product.

Source Code Integration (On-Premise Customers Only)

This section refers to the functionality available to on-premise customers of SpiraPlan. If you are using the cloud / hosted version of SpiraPlan, please refer to TaraVault Configuration instead.

SpiraPlan® is capable of integrating with a variety of source code / Software Configuration Management (SCM) tools such as Git, Subversion, CVS and TFS. This allows you to browse the source code repositories using the SpiraPlan web interface, and more importantly link commits in these tools to artifacts in SpiraPlan. This provides the end-to-end traceability from code commits/check-ins to the tasks, incidents and requirements that necessitated the code change.

The information on using the various source code providers for SpiraPlan® and the steps for configuring the provider-specific settings are described elsewhere - for example for Git.

To configure a source code provider, you need to click on the System Administration > Integration > Source Code link in the Administration navigation to bring up the list of configured source code providers:

By default the only provider listed will be the TestVersionControlProvider which is used for demonstration purposes only, and can be deleted from a production system by clicking on the "Delete" button to the right of it.

To add a new source code provider, click the "Add" button to enter the Plug-in details page. The fields required are as follows:

  • Name: The name of the source code provider that you're adding. This needs to match the name of the Plug-in DLL file that you're using (see the specific page for that provider in this documentation - eg Git).
  • Description: The description is for your use only, and does not affect operation of the plug-in.
  • Active: If checked, the plug-in is active and able to be used for any product.
  • Connection Info: This field holds the root of the repository for any product accessing the plug-in, unless overridden in the Product Settings. Use the syntax that is described for your tool on the relevant docs page for that provider.
  • Login / Password: The user id and the password of the user to use while accessing and retrieving information from the source code system.
  • Other Fields: The other fields (Domain, Custom1 -- Custom5) are provider-specific and will be described on the relevant docs page for that provider.

When finished, click the "Insert" button and you will be taken back to the Source Code integration list page, with new provider listed as an available plug-in:

To edit the settings for an existing source code provider, click on the "Edit" button on the far right of the row for that provider. You can edit the same settings that were shown above when you first created that provider.

If you want to change the settings for a particular product, make sure the product dropdown in that row has the correct product selected; and click the arrow to the right of the product name to manage that provider for that Product.

Test Automation

SpiraPlan® can be used to manage the development, scheduling and execution of automated unit, functional and load tests written using a variety of test automation engines (e.g. HP QuickTest Pro, SmarteScript, TestComplete, etc.). This section allows you to configure the different engines that are available in your environment so that the testers know which tools they can use to schedule tests with.

The information on using the various test automation engines for SpiraPlan® and the steps for configuring the engine-specific settings are described in the SpiraTest/Team RemoteLaunch Automated Testing Integration Guide.

To configure a test automation engine, you need to click on the Administration > Integration > Test Automation link in the Administration navigation to bring up the list of configured test automation engines:

To add a new test automation engine, click the "Add" button to enter the Automation Engine details page. The fields required are as follows:

  • Name: The name of the test automation engine that you're adding. This can be set to any name of your choice that would make sense to your users.

  • Description: The description is used for any comments or additional information that you need to use to describe the automation engine.

  • Active: If checked, the automation engine is active and able to be used in any product.

  • Token: This needs to match the name of the Automation Engine DLL file that you're using (see the SpiraTest/Team Automated Testing Integration Guide for more details on your specific tool) for the specific automation engine.

When finished, click the "Insert" button and you will be taken back to the test automation engine list page, with new automation engine listed.

To edit the settings for an existing test automation engine, just click on the "Edit" link next to the name of the engine and you will be able to edit the same settings that were shown above when you first created it.

Once you have made the appropriate changes, click the [Save] button to commit them.

You are now ready to use SpiraPlan® in conjunction with the test automation engine you added. For details on how to use the test automation features of SpiraPlan, please refer to the SpiraPlan® User Manual.