Knowledge Base Article

Home Page > Knowledge Base > Spira Platform

Home Page > Knowledge Base > Spira Platform > SpiraPlan

Home Page > Knowledge Base > Spira Platform > SpiraTeam

Home Page > Knowledge Base > Spira Platform > SpiraTest

Article How do I create a new Spira plugin for a bug-tracker

by Adam S on Friday, September 7, 2012

We have many different plugins available for different bug-tracking tools (see http://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.

The steps for writing a plugin for Spira are as follows:

  1. Download the SDK from our website: http://www.inflectra.com/Downloads/SpiraSDK.zip
  2. Download and install Microsoft Visual Studio 2010. This can then be used to open up the SDK Visual Studio Solution (.sln) file.
  3. The project you'll need to use to create a new bug-tracker is the SampleDataSync project. Expand this project inside Visual Studio.
  4. If you look through the main DataSync.cs file you will see that this file contains a template bug-tracking integration file. It includes all the code to connecting to SpiraTeam as well a commented sections where you would add the code to connect to the external bug-tracker.
  5. Once you've added the code to connect to your bug-tracker, you should rename the output file that it will generate to something like MyBugTracker.dll.
  6. Compile the plugin and add to the Bin folder of your SpiraTeam installation.
  7. Configure the connection information and any of the data-mapped fields or external keys needed by your plugin.
  8. Now start the DataSyncService and it will start your plugin.

If you need a reference to all the SpiraTeam functions available (in case you want to expland what the plugin can do) - please refer to the SpiraTeam API documentation - http://www.inflectra.com/SpiraDemo3/Services/v3_0

If you have any questions, please submit a help desk ticket.

 

Attachments
Article Info
Last Updated: 9/7/2012
Article ID: KB12
# Views: 1892
Powered by KronoDesk v1.1.0.15 | © Copyright Inflectra Corporation 2011-2016 | Licensed to Inflectra Corporation.