SpiraTeam Migration and Integration Guide Inflectra Corporation

Transcription

1 / SpiraTeam Migratin and Integratin Guide Inflectra Crpratin Date: December 11th, 2015

2 Cntents 0BIntrductin B1. Imprting frm Micrsft Excel B2. Imprting frm Micrsft Wrd B3. Imprting frm Micrsft Prject B4. Migrating frm HP QualityCenter Prject Backup and Migratin Migrating frm MS Test Manager Migrating frm HP ALM BIntrductin SpiraTeam is an integrated Applicatin Lifecycle Management (ALM) system that manages yur prject's requirements, releases, test cases, issues and tasks in ne unified envirnment: SpiraTeam cntains all f the features prvided by SpiraTest - ur highly acclaimed test management system and SpiraPlan - ur agile prject management slutin. With integrated custmizable dashbards f key prject infrmatin, SpiraTeam allws yu t take cntrl f yur entire prject lifecycle and synchrnize the hithert separate wrlds f develpment and testing. This guide utlines hw t migrate data t/frm ther tls int SpiraTeam. Fr infrmatin n integrating with ther bug/issue tracking systems, please refer t the separate SpiraTeam External Bug-Tracking Integratin Guide. Fr infrmatin n integrating SpiraTeam with third-party requirements management tls, please refer t the separate SpiraTeam Requirements Management Integratin Guide. This guide assumes that the reader is familiar with bth SpiraTeam and the apprpriate tl being discussed. Fr infrmatin regarding hw t use SpiraTeam, please refer t the SpiraTeam User Manual. Each f the sectins cvers a different tl s we recmmend using the table f cntents n the left t lcate the tl yu re lking t either integrate r migrate frm, then read the installatin and usage instructins. Page 1 f 46 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

3 1B1. Imprting frm Micrsft Excel The web-based interface f SpiraTeam is ideal fr creating and managing requirements, test cases and incidents fr a new prject. Hwever when migrating requirements, test cases, test steps and incidents fr an existing prject frm anther system r Micrsft Office dcument (e.g. Excel), it is useful t be able t lad in a batch f artifacts, rather than having t manually enter them ne at a time. T simplify this task, SpiraTeam cmes with a Micrsft Excel Add-In that can exprt requirements, test cases, test steps and incidents frm a ppulated Excel sheet int SpiraTeam. In additin, the Add-In allws yu t imprt thse same artifacts back int the Excel sheet t make batch updates which can then be used t update the master cpies n the server. Nte that this guide refers t SpiraTeam, but the Excel Add-In can be used with SpiraTest and SpiraPlan as well. The nly difference is that sme f the artifact types may nt be available in SpiraPlan/Test. 6B1.1. Installing the Micrsft Excel Add-In The first thing yu need t d is t g t the Add-Ons and Dwnlads page f the Inflectra Website (it can be fund in the SpiraTest, SpiraPlan r SpiraTeam sectins), and dwnlad the MS-Office Add-Ins installatin package. There are separate packages fr the fllwing versins f MS Office: MS-Office 2003 Add-Ins these are cmpatible with Micrsft Office 2003 and They can cnnect t SpiraTeam v2.3 r later. They als require Micrsft.NET 3.5. MS-Office 2007 Add-Ins these are cmpatible with Micrsft Office 2007 and They can cnnect t SpiraTeam v3.0 r later. They als require Micrsft.NET 4.0. MS-Office 2010 Add-Ins these are cmpatible with Micrsft Office 2010 and They can cnnect t SpiraTeam v4.0 r later. They als require Micrsft.NET 4.0. This installatin package will install the add-ins fr Micrsft Excel, Wrd and Prject at the same time. If yu dn t have the crrect versin f Micrsft.NET installed r sme f the necessary prerequisites, yu will be given the pprtunity t install them when yu first run the installatin package. Once yu have the Excel Add-In installed, the secnd thing yu ll need t dwnlad is the SpiraImprtTemplate Excel Sheet. This spreadsheet cntains the necessary pre-frmatted clumns that are needed fr the Add-In t easily recgnize the data and knw hw t handle it. There are three versins f the template available - SpiraImprtTemplate.xls fr the Excel 2003 Add-In, SpiraImprtTemplate.xlsx fr the Excel 2007 Add-In and SpiraImprtTemplate2010.xslx fr the Excel 2010 Add-In. Once yu have dwnladed the template, please duble-click n it t pen it up in MS-Excel. Yu will ntice that there is an additinal tlbar displayed in Excel which is used fr imprting/exprting data t/frm SpiraTeam: If yu are using the MS-Excel 2007 r 2010 Add-In, yu will see a mdified versin f the tlbar that makes use f the MS-Office Ribbn: Page 2 f 46

4 This tlbar allw yu t cnnect t SpiraTeam, and perfrm the imprt/exprt. The prcess fr using this tlbar is described belw: 7B1.1. Cnnecting t SpiraTeam The first thing yu need t d is t click n the [Cnnect] buttn t specify the infrmatin used t cnnect t yur instance f SpiraTeam: Please enter the fllwing infrmatin int the dialg bx: Spira URL: Please enter the web address that yu use t access SpiraTeam in yur brwser. This is usually f the frm Make sure that yu remve any suffixes frm the address (e.g. Default.aspx). User Name: Please enter the username that yu use fr lgging in t SpiraTeam Passwrd: Please enter the passwrd that yu use fr lgging in t SpiraTeam Remember Passwrd: If yu are using this Add-In n a private cmputer, yu can check this ptin t have the system remember yur credentials lcally. Please d nt use this ptin n a public cmputer and it will cmprmise the security f yur SpiraTeam installatin. Once yu have entered the necessary infrmatin, please click [Cnnect] t authenticate with the server. If the lgin infrmatin is invalid, yu will see an errr message appear, therwise yu will be cnnected and the list f prjects and artifacts will be ppulated. If yu want t end yur sessin, yu shuld just click the [Discnnect] buttn and the Add-In will clse yur cnnectin. 8B1.2. Chsing the Prject and Artifact Once yu have successfully cnnected t SpiraTeam, yu shuld nw chse the apprpriate Prject and Artifact in the system that yu will be imprting / exprting: Or Page 3 f 46

5 The artifact chice will match the name f the Excel sheet in the template, s if yu are ging t be imprting/exprting Requirements, yu shuld chse Requirements frm the drpdwn list and then click n the Requirements tab inside the Excel imprt template. Once yu have selected the prject and artifact, there are three buttns that yu can nw use: Imprt: Clicking this buttn will retrieve the data frm the SpiraTeam server and use that t ppulate the spreadsheet. Exprt: Clicking this buttn will take the data in the spreadsheet and use it t add/update items in SpiraTeam. Clear: This buttn allws yu t quickly clear the data in the imprt template while leaving all the necessary headings and ther infrmatin that the Add-In needs t be able t imprt/exprt data. Optins: (Only in MS-Excel 2007/2010 Add-Inx). This buttn allws yu t change sme f the imprt/exprt ptins. 9B1.3. Imprting / Exprting Data The Excel Add-In is capable f either imprting data frm SpiraTeam int the Excel template r exprting data frm the Excel template t SpiraTeam. Hwever it is imprtant t understand hw the system knws whether t add new items t SpiraTeam r whether t update existing items: If yu start with a blank imprt spreadsheet and enter items int it, they will nt have a value set n their ID clumn in the spreadsheet (this is always the first clumn in each sheet). When yu perfrm an Exprt, it will add these as new items in SpiraTeam If yu start with a blank imprt spreadsheet and chse t Imprt data frm SpiraTeam, thse rws will include the ID f the item in the first clumn f the spreadsheet. Yu can either update thse rws r add new rws in between. Any rws that have the ID clumn ppulated will be updated in SpiraTeam when yu chse Exprt, whereas any newly added rws will be inserted in SpiraTeam. 24B Imprting/Exprting Releases T imprt/exprt releases, first yu need t click n the Releases tab in the Excel sheet: Next if yu want t imprt the list f existing Releases frm SpiraTeam, yu shuld click n the [Clear] icn t first remve the sample infrmatin frm the spreadsheet, then click [Imprt] t lad the list f existing releases int the sheet. These items will all have the Rel # clumn ppulated s that the system knws t update them rather than insert them when yu subsequently click [Exprt]. If yu want t simply exprt a list f releases frm a spreadsheet, then yu need t either enter the releases int this specially frmatted spreadsheet r cut and paste them in frm anther existing Excel sheet that yu ve been using t manage releases previusly. Then click [Exprt] and the new items will be added t yur instance f SpiraTeam. The varius clumns that can be imprted, and the rules fr entering data are listed belw: Page 4 f 46

6 Field name Descriptin Rel # Release Name Release Descriptin Versin Number Active Iteratin Creatr Start Date End Date Stres the ID f the release. Shuld be left blank fr new items being added t SpiraTeam The name f the release. This field supprts indentatin, s yu need t use Excel s ability t Indent text fields t indicate hw the items in the release hierarchy are rganized The lng descriptin f the release. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld The versin number fr the release; acts as the shrt name Whether this release is active r nt. Shuld be set t either Y/N Whether this release is an Iteratin r nt. Shuld be set t either Y/N The user that shuld listed as the release s creatr. Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) The date that wrk n the release is scheduled t start The date that wrk n the release is scheduled t end # Resurces The number f peple / resurces that are scheduled t wrk n the release. Nn-Wk Days The number f nn-wrking days that shuld be subtracted frm the # available hurs fr wrk perfrmed n the release. MS-Excel 2003/2007 Add-In Specific Fields TEXT-01 TEXT-10 The ten (10) custm text prperties available in the prject LIST-01 LIST-10 The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. MS-Excel 2010 Add-In Specific Fields CUS-01 CUS-30 The thirty (30) custm fields defined in the prject. The value entered depends n the type f custm prperty: List prvide the numeric ID f the custm list value (e.g. PV00005 wuld be entered as just 5 ) MultiList prvide a cmma-separated list f the numeric IDs f the custm list values (e.g. PV00005 and PV00003 wuld be entered as just 5,3 ) Text enter the text, include HTML tags if rich-text Decimal enter the number (e.g. 1.0) Integer enter the number (e.g. 2) Date enter the number in the current lcal time frmat (e.g. m/d/yyyy fr the US, d/m/yyyy fr Eurpe) User enter the ID f the user Blean Enter either True r False Cmment The descriptin f a cmment that shuld be appended t the item. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld. Nte that this field always appends, s if yu want t add tw cmments, just enter the first value and click [Exprt], then replace it with the secnd value and click [Exprt] Page 5 f 46

7 Nte: the clumns that are required are listed in bld type. 25B Imprting/Exprting Requirements T imprt/exprt requirements, first yu need t click n the Requirements tab in the Excel sheet: Next if yu want t imprt the list f existing Requirements frm SpiraTeam, yu shuld click n the [Clear] icn t first remve the sample infrmatin frm the spreadsheet, then click [Imprt] t lad the list f existing requirements int the sheet. These items will all have the Req # clumn ppulated s that the system knws t update them rather than insert them when yu subsequently click [Exprt]. If yu want t simply exprt a list f requirements frm a spreadsheet, then yu need t either enter the requirements int this specially frmatted spreadsheet r cut and paste them in frm anther existing Excel sheet that yu ve been using t manage requirements previusly. Then click [Exprt] and the new items will be added t yur instance f SpiraTeam. The varius clumns that can be imprted, and the rules fr entering data are listed belw: Req # Stres the ID f the requirement. Shuld be left blank fr new items being added t SpiraTeam Requirement Name The name f the requirement. This field supprts indentatin, s yu need t use Excel s ability t Indent text fields t indicate hw the items in the requirement hierarchy are rganized Requirement Descriptin The lng descriptin f the requirement. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld Imprtance The imprtance / pririty f the requirement. It needs t be ne f the values frm the drpdwn list. Status The imprtance / pririty f the requirement. It needs t be ne f the values frm the drpdwn list. If this is nt specified, the requirement will default t the Requested status. Authr The user that shuld listed as the requirement s authr. Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) Owner The user that shuld listed as the requirement s wner. Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) MS-Excel 2003/2007 Add-In Specific Fields Release # The release that this requirement is scheduled fr. Needs t be the ID f the release (e.g. release RL00005 wuld be entered as just 5) TEXT-01 TEXT-10 The ten (10) custm text prperties available in the prject LIST-01 LIST-10 The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. MS-Excel 2010 Add-In Specific Fields Release Versin The release/iteratin that this requirement is scheduled fr. Needs t be the versin number f the release (e.g ) Page 6 f 46

8 CUS-01 CUS-30 Cmment The thirty (30) custm fields defined in the prject. The value entered depends n the type f custm prperty: List prvide the numeric ID f the custm list value (e.g. PV00005 wuld be entered as just 5 ) MultiList prvide a cmma-separated list f the numeric IDs f the custm list values (e.g. PV00005 and PV00003 wuld be entered as just 5,3 ) Text enter the text, include HTML tags if rich-text Decimal enter the number (e.g. 1.0) Integer enter the number (e.g. 2) Date enter the number in the current lcal time frmat (e.g. m/d/yyyy fr the US, d/m/yyyy fr Eurpe) User enter the ID f the user Blean Enter either True r False The descriptin f a cmment that shuld be appended t the item. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld. Nte that this field always appends, s if yu want t add tw cmments, just enter the first value and click [Exprt], then replace it with the secnd value and click [Exprt] Nte: the clumns that are required are listed in bld type. 26B Imprting/Exprting Test Sets T imprt/exprt test sets, first yu need t click n the Test Sets tab in the Excel sheet: Next if yu want t imprt the list f existing Test Sets frm SpiraTeam, yu shuld click n the [Clear] icn t first remve the sample infrmatin frm the spreadsheet, then click [Imprt] t lad the list f existing test sets int the sheet. These items will all have the TX # clumn ppulated s that the system knws t update them rather than insert them when yu subsequently click [Exprt]. If yu want t simply exprt a list f test sets frm a spreadsheet, then yu need t either enter the test sets int this specially frmatted spreadsheet r cut and paste them in frm anther existing Excel sheet that yu ve been using t manage test sets previusly. Then click [Exprt] and the new items will be added t yur instance f SpiraTeam. The varius clumns that can be imprted, and the rules fr entering data are listed belw: TX # Test Set Name Test Set Descriptin Flder Stres the ID f the test set. Shuld be left blank fr new items being added t SpiraTeam The name f the test set. This field supprts indentatin, s yu need t use Excel s ability t Indent text fields t indicate hw the items in the test set hierarchy are rganized The lng descriptin f the test set. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld Whether this item is a flder r nt. Shuld be set t either Y/N Page 7 f 46

9 Status Creatr Owner Planned Date The status f the test set. It needs t be ne f the values frm the drpdwn list. The user that shuld listed as the test set s creatr. Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) The user that shuld listed as the test set s wner. Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) The date that the test set needs t be cmpleted by. MS-Excel 2003/2007 Add-In Specific Fields Release # The release that this test set is scheduled fr. Needs t be the ID f the release (e.g. release RL00005 wuld be entered as just 5) TEXT-01 TEXT-10 The ten (10) custm text prperties available in the prject LIST-01 LIST-10 The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. MS-Excel 2010 Add-In Specific Fields Release Versin The release/iteratin that this test set is scheduled fr. Needs t be the versin number f the release (e.g ) CUS-01 CUS-30 The thirty (30) custm fields defined in the prject. The value entered depends n the type f custm prperty: List prvide the numeric ID f the custm list value (e.g. PV00005 wuld be entered as just 5 ) MultiList prvide a cmma-separated list f the numeric IDs f the custm list values (e.g. PV00005 and PV00003 wuld be entered as just 5,3 ) Text enter the text, include HTML tags if rich-text Decimal enter the number (e.g. 1.0) Integer enter the number (e.g. 2) Date enter the number in the current lcal time frmat (e.g. m/d/yyyy fr the US, d/m/yyyy fr Eurpe) User enter the ID f the user Blean Enter either True r False Cmment The descriptin f a cmment that shuld be appended t the item. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld. Nte that this field always appends, s if yu want t add tw cmments, just enter the first value and click [Exprt], then replace it with the secnd value and click [Exprt] Nte: the clumns that are required are listed in bld type. 27B Imprting/Exprting Test Cases T imprt/exprt test cases, first yu need t click n the Test Cases tab in the Excel sheet: Page 8 f 46

10 Next if yu want t imprt the list f existing Test Cases frm SpiraTeam, yu shuld click n the [Clear] icn t first remve the sample infrmatin frm the spreadsheet, then click [Imprt] t lad the list f existing test cases int the sheet. These items will all have the Test # and Step # clumns ppulated s that the system knws t update them rather than insert them when yu subsequently click [Exprt]. If yu want t simply exprt a list f test cases frm a spreadsheet, then yu need t either enter the test cases (including any test steps) int this specially frmatted spreadsheet r cut and paste them in frm anther existing Excel sheet that yu ve been using t manage test cases previusly. Then click [Exprt] and the new items will be added t yur instance f SpiraTeam. The varius clumns that can be imprted, and the rules fr entering data are listed belw: Test # Stres the ID f the test case. Shuld be left blank fr new items being added t SpiraTeam Test Case Name The name f the test case. This field supprts indentatin, s yu need t use Excel s ability t Indent text fields t indicate hw the items in the test case hierarchy are rganized Test Case Descriptin The lng descriptin f the test case. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld Pririty The pririty f the test case. It needs t be ne f the values frm the drpdwn list. Owner The user that shuld listed as the test case s wner. Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) Type This is used t tell the Add-In what type f rw this is. Yu shuld enter FOLDER if this rw is a test flder, TestCase if it is a test case and >TestStep if it is a test step belnging t a test case. These values shuld be selected frm the drpdwn list. Nte: Yu shuld make sure that test step rws are lcated directly underneath the test case they are a part f. Step # Stres the ID f the test step. Shuld be left blank fr new test steps being added t a test case Test Step Descriptin The descriptin f the test step. This shuld cntain the descriptin f the actins that the tester needs t take. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld Expected Result The expected result f the test step. This shuld cntain the descriptin f what the tester shuld see if the step succeeds. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld Sample Data The sample date fr the test step. This shuld cntain any sample data that the tester can use when testing the step. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld MS-Excel 2003/2007 Add-In Specific Fields Requirement The requirement that this test case shuld be mapped t. Needs t be the ID f the requirement (e.g. requirement RQ00005 wuld be entered as just 5). Nte that this field always appends, s if yu want t add a test case t tw requirements, run the exprt twice, nce fr Page 9 f 46

11 Release Test Set TEXT-01 TEXT-10 each requirement. Nte: This field nly Exprts t Spira and nt the ther way arund The release that this test case shuld be mapped t. Needs t be the ID f the release (e.g. release RL00005 wuld be entered as just 5). Nte that this field always appends, s if yu want t add a test case t tw releases, run the exprt twice, nce fr each release. Nte: This field nly Exprts t Spira and nt the ther way arund The test set that this test case shuld be added t. Needs t be the ID f the test set (e.g. test set TX00005 wuld be entered as just 5). Nte that this field always appends, s if yu want t add a test case t tw test sets, run the exprt twice, nce fr each test set. Nte: This field nly Exprts t Spira and nt the ther way arund The ten (10) custm text prperties available in the prject LIST-01 LIST-10 The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. MS-Excel 2010 Add-In Specific Fields Requirement The requirement(s) that this test case shuld be mapped t. Needs t be a cmma-separated list f requirement IDs (e.g. requirements RQ00005 and RQ00008 wuld be entered as just 5,8 ). Nte: This field nly Exprts t Spira and nt the ther way arund Release The release(s) that this test case shuld be mapped t. Needs t be a cmma-separated list f release versin numbers (e.g. releases and wuld be entered as , ). Nte: This field nly Exprts t Spira and nt the ther way arund Test Set The test set(s) that this test case shuld be added t. Needs t be a cmma-separated list f test set IDs (e.g. test sets TX00005 and TX00008 wuld be entered as just 5,8 ). Nte: This field nly Exprts t Spira and nt the ther way arund CUS-01 CUS-30 The thirty (30) custm fields defined in the prject. The value entered depends n the type f custm prperty: List prvide the numeric ID f the custm list value (e.g. PV00005 wuld be entered as just 5 ) MultiList prvide a cmma-separated list f the numeric IDs f the custm list values (e.g. PV00005 and PV00003 wuld be entered as just 5,3 ) Text enter the text, include HTML tags if rich-text Decimal enter the number (e.g. 1.0) Integer enter the number (e.g. 2) Date enter the number in the current lcal time frmat (e.g. m/d/yyyy fr the US, d/m/yyyy fr Eurpe) User enter the ID f the user Blean Enter either True r False Nte: the clumns that are required are listed in bld type. 28B Imprting/Exprting Incidents T imprt/exprt incidents, first yu need t click n the Incidents tab in the Excel sheet: Page 10 f 46

12 Next if yu want t imprt the list f existing Incidents frm SpiraTeam, yu shuld click n the [Clear] icn t first remve the sample infrmatin frm the spreadsheet, then click [Imprt] t lad the list f existing incidents int the sheet. These items will all have the Inc # clumn ppulated s that the system knws t update them rather than insert them when yu subsequently click [Exprt]. If yu want t simply exprt a list f incidents frm a spreadsheet, then yu need t either enter the incidents int this specially frmatted spreadsheet r cut and paste them in frm anther existing Excel sheet that yu ve been using t manage incidents previusly. Then click [Exprt] and the new items will be added t yur instance f SpiraTeam. The varius clumns that can be imprted/exprted, and the rules fr entering data are listed belw: Inc # Incident Name Stres the ID f the incident. Shuld be left blank fr new items being added t SpiraTeam The name f the incident. Incident Descriptin The lng descriptin f the incident. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld Type The type f the incident. It needs t be ne f the values frm the drpdwn list. Status The status f the incident. It needs t be ne f the values frm the drpdwn list. Pririty The pririty f the incident. It needs t be ne f the values frm the drpdwn list. Severity The severity f the incident. It needs t be ne f the values frm the drpdwn list. Detectr The user that fund the incident. Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5). If left blank, it will default t the user lgged in thrugh the Add-In. Owner The user that the incident shuld be assigned t Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) Detected Date The date that the incident was fund. If this field is nt ppulated, the current date is used instead Clsed Date The date that the incident was clsed. D nt enter a value in this field if the incident is nt in a clsed status. MS-Excel 2003 Add-In Specific Fields % Cmplete The cmpletin percentage f the incident Detected Release Reslved Release TEXT-01 TEXT-10 LIST-01 LIST-10 The release that this incident was fund in. Needs t be the ID f the release (e.g. release RL00005 wuld be entered as just 5) The release that this incident is scheduled t be fixed in. Needs t be the ID f the release (e.g. release RL00005 wuld be entered as just 5) The ten (10) custm text prperties available in the prject The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display Page 11 f 46

13 name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. Reslutin The descriptin f a reslutin/cmment that shuld be appended t the incident. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld. Nte that this field always appends, s if yu want t add tw cmments, just enter the first value and click [Exprt], then replace it with the secnd value and click [Exprt] MS-Excel 2007 Add-In Specific Fields Detected Release The release that this incident was fund in. Needs t be the ID f the release (e.g. release RL00005 wuld be entered as just 5) Reslved Release The release that this incident is scheduled t be fixed in. Needs t be the ID f the release (e.g. release RL00005 wuld be entered as just 5) Est. Effrt The estimated effrt assciated with the task (entered as a whle number f minutes) Act. Effrt The actual effrt assciated with the task (entered as a whle number f minutes) Rem. Effrt The remaining effrt assciated with the task (entered as a whle number f minutes) TEXT-01 TEXT-10 The ten (10) custm text prperties available in the prject LIST-01 LIST-10 The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. Reslutin The descriptin f a reslutin/cmment that shuld be appended t the incident. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld. Nte that this field always appends, s if yu want t add tw cmments, just enter the first value and click [Exprt], then replace it with the secnd value and click [Exprt] MS-Excel 2010 Add-In Specific Fields Detected Release The release/iteratin that this incident was fund in. Needs t be the versin number f the release (e.g ) Reslved Release The release/iteratin that this is planned t be fixed in. Needs t be the versin number f the release (e.g ) Est. Effrt The estimated effrt assciated with the task (entered as a whle number f minutes) Act. Effrt The actual effrt assciated with the task (entered as a whle number f minutes) Rem. Effrt The remaining effrt assciated with the task (entered as a whle number f minutes) CUS-01 CUS-30 The thirty (30) custm fields defined in the prject. The value entered depends n the type f custm prperty: List prvide the numeric ID f the custm list value (e.g. PV00005 wuld be entered as just 5 ) MultiList prvide a cmma-separated list f the numeric IDs f the custm list values (e.g. PV00005 and PV00003 wuld be entered as just 5,3 ) Text enter the text, include HTML tags if rich-text Decimal enter the number (e.g. 1.0) Integer enter the number (e.g. 2) Page 12 f 46

14 Cmment Date enter the number in the current lcal time frmat (e.g. m/d/yyyy fr the US, d/m/yyyy fr Eurpe) User enter the ID f the user Blean Enter either True r False The descriptin f a cmment that shuld be appended t the incident. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld. Nte that this field always appends, s if yu want t add tw cmments, just enter the first value and click [Exprt], then replace it with the secnd value and click [Exprt] Nte: the clumns that are required are listed in bld type. 29B Imprting/Exprting Tasks T imprt/exprt tasks, first yu need t click n the Tasks tab in the Excel sheet: Next if yu want t imprt the list f existing Tasks frm SpiraTeam, yu shuld click n the [Clear] icn t first remve the sample infrmatin frm the spreadsheet, then click [Imprt] t lad the list f existing tasks int the sheet. These items will all have the Inc # clumn ppulated s that the system knws t update them rather than insert them when yu subsequently click [Exprt]. If yu want t simply exprt a list f tasks frm a spreadsheet, then yu need t either enter the tasks int this specially frmatted spreadsheet r cut and paste them in frm anther existing Excel sheet that yu ve been using t manage tasks previusly. Then click [Exprt] and the new items will be added t yur instance f SpiraTeam. The varius clumns that can be imprted, and the rules fr entering data are listed belw: Task # Task Name Task Descriptin Status Pririty Requirement Owner Start Date End Date Est. Effrt Act. Effrt Stres the ID f the task. Shuld be left blank fr new items being added t SpiraTeam The name f the task. The lng descriptin f the task. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld The status f the task. It needs t be ne f the values frm the drpdwn list. The pririty f the task. It needs t be ne f the values frm the drpdwn list. The requirement that this task shuld be assciated with. Needs t be the ID f the requirement (e.g. requirement RQ00005 wuld be entered as just 5). The user that the task shuld be assigned t Needs t be the ID f the user (e.g. user US00005 wuld be entered as just 5) The date that wrk n the task is scheduled t start The date that wrk n the task is scheduled t end The estimated effrt assciated with the task (entered as a whle number f minutes) The actual effrt assciated with the task (entered as a whle Page 13 f 46

15 number f minutes) MS-Excel 2003 Add-In Specific Fields % Cmplete The cmpletin percentage f the task Release # TEXT-01 TEXT-10 The release/iteratin that this task is scheduled fr. Needs t be the ID f the release/iteratin (e.g. release RL00005 wuld be entered as just 5). The ten (10) custm text prperties available in the prject LIST-01 LIST-10 The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. MS-Excel 2007 Add-In Specific Fields Rem. Effrt The remaining effrt assciated with the task (entered as a whle number f minutes) Release # The release/iteratin that this task is scheduled fr. Needs t be the ID f the release/iteratin (e.g. release RL00005 wuld be entered as just 5). TEXT-01 TEXT-10 The ten (10) custm text prperties available in the prject LIST-01 LIST-10 The ten (10) drp-dwn list prperties available in the prject. Yu need t enter the ID value f the custm prperty nt the display name. E.g. if yu have a custm prperty with ID = PV00005 yu wuld enter just 5 in these bxes. MS-Excel 2010 Add-In Specific Fields Rem. Effrt The remaining effrt assciated with the task (entered as a whle number f minutes) Release Versin The release/iteratin that this task is scheduled fr. Needs t be the versin number f the release (e.g ) CUS-01 CUS-30 The thirty (30) custm fields defined in the prject. The value entered depends n the type f custm prperty: List prvide the numeric ID f the custm list value (e.g. PV00005 wuld be entered as just 5 ) MultiList prvide a cmma-separated list f the numeric IDs f the custm list values (e.g. PV00005 and PV00003 wuld be entered as just 5,3 ) Text enter the text, include HTML tags if rich-text Decimal enter the number (e.g. 1.0) Integer enter the number (e.g. 2) Date enter the number in the current lcal time frmat (e.g. m/d/yyyy fr the US, d/m/yyyy fr Eurpe) User enter the ID f the user Blean Enter either True r False Cmment The descriptin f a cmment that shuld be appended t the task. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld. Nte that this field always appends, s if yu want t add tw cmments, just enter the first value and click [Exprt], then replace it with the secnd value and click [Exprt] Nte: the clumns that are required are listed in bld type. Page 14 f 46

16 30B Execute Test Cases Offline As well as being able t imprt/exprt data, yu can als use the imprt spreadsheet t execute test cases while discnnected frm yur netwrk and then uplad the results t SpiraTeam as a single batch. T d this, when cnnected t the netwrk, cnnect t the server using the Add-In [Cnnect] icn, select the prject and Test Runs, then click n the Test Runs in the spreadsheet: Nw yu shuld click n the [Imprt] buttn, and the Add-In will lad the list f Test Cases (and in the case f the MS-Office 2007/2010 Add-Ins, any Test Sets as well) that are currently assigned t yu tgether with pen cells (marked in green) that yu can use t recrd the actual results f testing: Yu can nw discnnect frm the netwrk and perfrm the testing activities ffline. Enter the fllwing entries int the spreadsheet: Status Actual Result Incident Name The executin status f that test step. It shuld be selected drp the drpdwn list. The allwed values are: Failed / Passed / Blcked / Cautin. The lng descriptin f the actual result experienced during testing. If yu want it frmatted, yu need t add HTML tags such as <b> fr bld If yu want t lg an incident assciated with the test failure, enter the name f the incident here. The descriptin f the incident will be pre-ppulated with the Test Step Descriptin, Expected Result, and Actual Result. Once yu have finished testing and are cnnected back n the netwrk, just click n the [Cnnect] icn t have the Add-In cnnect with the SpiraTeam server, chse the prject name and Test Runs and then click [Exprt]. The test results will nw be upladed t the server. Nte: If yu are using the MS-Excel 2007/2010 Add-Ins, yu will als see the Test Set ID, Release ID and TX TC ID (Test-Set, Test Case unique ID). Yu can manually set a Release ID n test cases that were nt part f a test set Imprting Custm Prperty List Values T imprt/exprt custm prperty values (fr list custm prperties), first yu need t click n the Custm Values tab in the Excel sheet: Page 15 f 46

17 Next if yu want t imprt the list f existing custm list values frm SpiraTeam, yu shuld click n the [Clear] icn t first remve the sample infrmatin frm the spreadsheet, then click [Imprt] t lad the list f existing custm list values int the sheet. These items will all have the Value # clumn ppulated s that the system knws t update them rather than insert them when yu subsequently click [Exprt]. If yu want t simply exprt a list f custm list values frm a spreadsheet, then yu need t either enter the custm list ID and value name int this specially frmatted spreadsheet r cut and paste them in frm anther existing Excel sheet that yu ve been using t manage the values previusly. Then click [Exprt] and the new items will be added t yur instance f SpiraTeam. The varius clumns that can be imprted, and the rules fr entering data are listed belw: Field name Descriptin Value # Custm List # Custm Value Name Stres the ID f the custm list value. Shuld be left blank fr new items being added t SpiraTeam The ID f the custm list that the value is being added t (with the CL prefix remved). Fr example custm list CL00005 wuld be entered as just 5 The name f the custm value that yu are inserting/updating in SpiraTeam Nte: the clumns that are required are listed in bld type Changing the Imprt/Exprt Optins In the MS-Excel 2007 and 2010 Add-Ins, yu can change hw the imprt/exprt wrks by clicking n the Optins icn. This brings up the Optins dialg bx: Page 16 f 46

18 When yu imprt artifacts frm SpiraTeam int MS-Excel, if they have a frmatted descriptin, by default all the HTML tags that are used t describe the frmatting will be laded int the Excel cell. This is useful if yu plan n making changes and then updating SpiraTeam (since it will preserve the frmatting). Hwever if yu want t be able t mre easily read the descriptins in Excel and d nt plan n updating SpiraTeam, yu can select the ptin t Remve the Frmatting, which will cnvert the descriptins t plain-text befre lading them int Excel. Page 17 f 46

19 2B2. Imprting frm Micrsft Wrd The web-based interface f SpiraTeam is ideal fr creating and managing requirements, test cases and incidents fr a new prject. Hwever ften an rganizatin will ften have existing requirements dcumentatin and test case templates in Micrsft Wrd frmat that need t get easily migrated int SpiraTeam. T simplify this task, SpiraTeam cmes with a Micrsft Wrd Add-In that can exprt requirements and test cases frm a ppulated Wrd dcument int SpiraTeam. Nte that this guide refers t SpiraTeam, but the Wrd Add-In can be used with SpiraTest and SpiraPlan as well. The nly difference is that the Test Case imprt functinality will nt be applicable fr SpiraPlan users. 10B2.1. Installing the Micrsft Wrd Add-In The first thing yu need t d is t g t the Add-Ons and Dwnlads page f the Inflectra Website (it can be fund in the SpiraTest, SpiraPlan r SpiraTeam sectins), and dwnlad the MS-Office Add-Ins installatin package. There are separate packages fr the fllwing versins f MS Office: MS-Office 2003 Add-Ins these are cmpatible with Micrsft Office 2003 and They can cnnect t SpiraTeam v2.3 r later. They als require Micrsft.NET 3.5. MS-Office 2007 Add-Ins these are cmpatible with Micrsft Office 2007 and They can cnnect t SpiraTeam v3.0 r later. They als require Micrsft.NET 4.0. MS-Office 2010 Add-Ins these are cmpatible with Micrsft Office 2010 and They can cnnect t SpiraTeam v4.0 r later. They als require Micrsft.NET 4.0. This installatin package will install the add-ins fr Micrsft Excel, Wrd and Prject at the same time. If yu dn t have the crrect versin f Micrsft.NET installed r sme f the necessary prerequisites, yu will be given the pprtunity t install them when yu first run the installatin package. Once yu have the Wrd Add-In installed, the secnd thing yu ll need t dwnlad is the SampleWrdDcument dcument. This sample dcument cntains sme example requirements and test cases that be exprted int SpiraTeam. Als the dcuments make gd templates if yu re lking fr a way t standardize the imprt f requirements and test cases. There are tw versins f the dcument available - SampleWrdDcument.dc fr Wrd 2003 and SampleWrdDcument.dcx fr Wrd 2007 and later. Once yu have dwnladed the template, please duble-click n it t pen it up in MS-Wrd. Yu will ntice that there is an additinal tlbar displayed in Wrd which is used fr exprting requirements and test cases t SpiraTeam: If yu are using the MS-Wrd 2007 r 2010 Add-In, yu will see a mdified versin f the tlbar that makes use f the MS-Office Ribbn: This tlbar allw yu t cnnect t SpiraTeam, and perfrm the exprt. The prcess fr using this tlbar is described belw: Page 18 f 46

20 11B2.1. Cnnecting t SpiraTeam The first thing yu need t d is t click n the [Cnnect] buttn t specify the infrmatin used t cnnect t yur instance f SpiraTeam: Please enter the fllwing infrmatin int the dialg bx: Spira URL: Please enter the web address that yu use t access SpiraTeam in yur brwser. This is usually f the frm Make sure that yu remve any suffixes frm the address (e.g. Default.aspx). User Name: Please enter the username that yu use fr lgging in t SpiraTeam Passwrd: Please enter the passwrd that yu use fr lgging in t SpiraTeam Remember Passwrd: If yu are using this Add-In n a private cmputer, yu can check this ptin t have the system remember yur credentials lcally. Please d nt use this ptin n a public cmputer and it will cmprmise the security f yur SpiraTeam installatin. Once yu have entered the necessary infrmatin, please click [Cnnect] t authenticate with the server. If the lgin infrmatin is invalid, yu will see an errr message appear, therwise yu will be cnnected and the list f prjects and artifacts will be ppulated. If yu want t end yur sessin, yu shuld just click the [Discnnect] buttn and the Add-In will clse yur cnnectin. 12B2.2. Chsing the Prject and Artifact Once yu have successfully cnnected t SpiraTeam, yu shuld nw chse the apprpriate Prject and Artifact in the system that yu will be imprting / exprting: Or Once yu have selected the prject and artifact, there are tw buttns that yu can nw use: Exprt: Clicking this buttn will take the currently selected data in the dcument and use it t add new items in SpiraTeam. Page 19 f 46

21 Style Mappings: This buttn allws yu t change the parameters used by the Add-In when scanning the Wrd dcument t knw where each requirement, test case and test step beings and ends. The parameters selectin varies by the type f infrmatin being exprted, and will be discussed in the relevant artifact sectin belw: 13B2.3. Exprting Requirements int SpiraTeam T exprt requirements, first yu need t pen up the MS-Wrd dcument that cntains the requirements t be exprted. Then yu need t click n the Style Mappings icn t display the style mapping cnfiguratin dialg bx: This dialg bx allws yu t tell the Add-In which styles are being used in the dcument t describe each level f Requirements in the hierarchy. When yu run the Exprt, the Add-In will examine each paragraph in the dcument, and any item that matches ne f these styles will be cnsidered the start f a new requirement, and its indentatin level will be based n the apprpriate style. Once yu have verified that the styles match thse used in yur dcument, highlight the areas f the dcument that yu wish t imprt and click the [Imprt] buttn. Once yu have dne this, the Add-In will scan the selected prtins f the dcument and exprt the requirements int the system. During the exprt, the Add-In uses the fllwing rules fr dealing with the cntent: The text that matches the selected style will be laded as the Name field f the requirement Any text lcated between the selected styles will be laded int the Descriptin field f the requirement. The Add-In will attempt t match the frmatted used in the Wrd dcument. Hwever because f sme differences between MS-Wrd and HTML, it may nt be exact. Any embedded images will be added t the requirement as a file Attachment, with an embedded image tag added t Descriptin field Page 20 f 46

22 14B2.4. Exprting Test Cases int SpiraTeam T exprt test cases (and their test steps), first yu need t pen up the MS-Wrd dcument that cntains the test cases t be exprted. Then yu need t click n the Style Mappings icn t display the style mapping cnfiguratin dialg bx: This dialg bx allws yu t tell the Add-In which styles are being used in the dcument t dente the name f the Test Flder and the name f the Test Case. Fr the test steps, the Add-In currently requires that they be rganized in tables, with each clumn in the table being used cnsistently t describe ne f the three Test Step fields. Fr the imprt t wrk crrect, yur tables need t have at least three (3) clumns s that it can map them crrectly. Yu can use the same clumn multiple times (e.g. the cntents f clumn 2 wuld be imprted int bth the expected result and sample data). Once yu have verified that the styles and table clumns match thse used in yur dcument, highlight the areas f the dcument that yu wish t imprt and click the [Imprt] buttn. Once yu have dne this, the Add-In will scan the selected prtins f the dcument and exprt the test cases and test steps int the system. During the exprt, the Add-In uses the fllwing rules fr dealing with the cntent: The text that matches the selected style will be laded as the Name field f the Test Flder r Test Case Any text lcated between the selected styles will be laded int the Descriptin field f the Test Case. The Add-In will attempt t match the frmatted used in the Wrd dcument. Hwever because f sme differences between MS-Wrd and HTML, it may nt be exact. Any embedded images will be added t the Test Case as a file Attachment, with an embedded image tag added t Descriptin field Any tables lcated between the selected styles will be treated as the Test Steps belnging t the previus test case. The fields fr the Test Steps will be ppulated based n the index f the clumn. Any text lcated in the table cells int the apprpriate field f the Test Step. The Add-In will attempt t match the frmatted used in the Wrd dcument. Hwever because f sme differences between MS-Wrd and HTML, it may nt be exact. The first rw f the table is assumed t be a header rw, s if yu are seeing the first step f yur dcument being mitted, it means that yu need t add a header rws. Page 21 f 46

23 2.5 Errr Reprting If there is an errr during the imprt f either requirements r test cases, the errr message will be stred in a text file called Spira_WrdImprt.lg that can be fund n the desktp f the user running the imprt. Page 22 f 46

24 3B3. Imprting frm Micrsft Prject The web-based interface f SpiraTeam is ideal fr creating and managing requirements, releases/iteratins and tasks fr a new prject. Hwever when migrating requirements and tasks frm an existing prject, it is useful t be able t lad in an existing prject plan in batch and have SpiraTeam be able t interpret the data. T simplify this task, SpiraTeam cmes with a Micrsft Prject Add-In that can exprt requirements, releases and tasks frm a ppulated MS-Prject plan int SpiraTeam. In additin, the Add-In allws yu t imprt thse same artifacts back int the MS-Prject plan t make batch updates which can then be used t update the master cpies n the server. Nte that this guide refers t SpiraTeam, but the MS-Prject Add-In can be used with SpiraPlan as well. 15B3.1. Installing the Micrsft Prject Add-In The first thing yu need t d is t g t the Add-Ons and Dwnlads page f the Inflectra Website (it can be fund in the SpiraPlan r SpiraTeam sectins), and dwnlad the MS-Office Add-Ins installatin package. There are separate packages fr the fllwing versins f MS Office: MS-Office 2003 Add-Ins these are cmpatible with Micrsft Office 2003 and They can cnnect t SpiraTeam v2.3 r later. They als require Micrsft.NET 3.5. MS-Office 2007 Add-Ins these are cmpatible with Micrsft Office 2007 and They can cnnect t SpiraTeam v3.0 r later. They als require Micrsft.NET 4.0. MS-Office 2010 Add-Ins these are cmpatible with Micrsft Office 2010 and They can cnnect t SpiraTeam v4.0 r later. They als require Micrsft.NET 4.0. This installatin package will install the add-ins fr Micrsft Excel, Wrd and Prject at the same time. If yu dn t have the crrect versin f Micrsft.NET installed r sme f the necessary prerequisites, yu will be given the pprtunity t install them when yu first run the installatin package. Once yu have the MS-Prject Add-In installed, the secnd thing yu may want t dwnlad is the SamplePrjectFile.mpp MS-Prject plan. This prject file cntains a fully-ppulated prject plan and is a gd sample t test the imprt/exprt befre using a real prject plan. Once yu have dwnladed the prject file, please duble-click n it t pen it up in MS-Prject. Yu will ntice that there is an additinal tlbar displayed in MS-Prject which is used fr imprting/exprting data t/frm SpiraTeam: If yu are using the MS-Prject 2010 Add-In, yu will see a mdified versin f the tlbar that makes use f the MS-Office Ribbn: This tlbar allw yu t cnnect t SpiraTeam, and perfrm the imprt/exprt. The prcess fr using this tlbar is described belw: Page 23 f 46

25 16B3.1. Cnnecting t SpiraTeam The first thing yu need t d is t click n the [Cnnect] buttn t specify the infrmatin used t cnnect t yur instance f SpiraTeam: Please enter the fllwing infrmatin int the dialg bx: Spira URL: Please enter the web address that yu use t access SpiraTeam in yur brwser. This is usually f the frm Make sure that yu remve any suffixes frm the address (e.g. Default.aspx). User Name: Please enter the username that yu use fr lgging in t SpiraTeam Passwrd: Please enter the passwrd that yu use fr lgging in t SpiraTeam Remember Passwrd: If yu are using this Add-In n a private cmputer, yu can check this ptin t have the system remember yur credentials lcally. Please d nt use this ptin n a public cmputer and it will cmprmise the security f yur SpiraTeam installatin. Once yu have entered the necessary infrmatin, please click [Cnnect] t authenticate with the server. If the lgin infrmatin is invalid, yu will see an errr message appear, therwise yu will be cnnected and the list f prjects and artifacts will be ppulated. If yu want t end yur sessin, yu shuld just click the [Discnnect] buttn and the Add-In will clse yur cnnectin. 17B3.2. Chsing the Prject Once yu have successfully cnnected t SpiraTeam, yu shuld nw chse the apprpriate Prject in the system that yu will be imprting / exprting t / frm: Or Once yu have selected the prject, there are three buttns that yu can nw use: Page 24 f 46