API Guide. SilkCentral Test Manager

Transcription

1 API Guide SilkCentral Test Manager 2008

2 Borland Software Corporation 8303 N. Mopac Expressway, Suite A-300 Austin, TX Borland Software Corporation may have patents and/or pending patent applications covering subject matter in this document. Please refer to the product CD or the About dialog box for the list of applicable patents. The furnishing of this document does not give you any license to these patents. Copyright Borland Software Corporation and/or its subsidiaries. All Borland brand and product names are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries. All other marks are the property of their respective owners. March 2008 PDF

3 Contents Introduction 1 Overview Chapter 1 Creating Plug-Ins 3 Overview Plug-In Species Compilation Deployment Distribution Chapter 2 Source Control Integration 5 Overview Interfaces & Classes Conventions Configuring Source Control Plug-ins Chapter 3 Issue Tracking Integration 15 Overview Web Service Interface Java API Interface Integrating Third-Party Issue Tracking Chapter 4 Requirements Management Integration 33 Overview Deploying the API Requirements Plug-In API Interfaces for External RMS Chapter 5 Third-Party Test Type Integration 41 Overview Plug-In Implementation Structure of the API Sample Code Configuration XML File Deployment Chapter 6 SilkCentral Web Service Interface 51 SilkCentral Web Services Web Services Quick Start Administration Web Services Test Manager Web Services Issue Manager Web Services Index 91 SilkCentral Test Manager API Guide iii

4 iv SilkCentral Test Manager API Guide

5 Introduction About this manual This manual provides the information you need to create and deploy plug-ins to integrate third-party tools into Borland SilkCentral Test Manager (Test Manager). It contains Web service specifications, API descriptions, and explains how to integrate plug-ins within Test Manager. This chapter contains the following sections: Section Overview 1 Page Overview An API concept has been implemented for SilkCentral Test Manager for the integration of third-party applications. With SilkCentral s API s, you can now integrate your existing source-control, issue-tracking, and requirementsmanagement tools by configuring Test Manager plug-ins. A number of sample plug-ins ship with Test Manager For a complete description of the SilkCentral Test Manager Java API, please refer to the Test Manager API Specification, available in Test Manager s GUI on Help/Documentation/Test Manager API Specification. SilkCentral Test Manager API Guide 1

6 INTRODUCTION Overview 2 SilkCentral Test Manager API Guide

7 1 Creating 1Chapter Plug-Ins Introduction What you will learn This chapter explains how to create plug-ins for SilkCentral Test Manager. This chapter contains the following sections: Section Page Overview 3 Plug-In Species 3 Compilation 4 Deployment 4 Distribution 4 Overview This chapter describes how to create plug-ins for SilkCentral Test Manager. Only the tasks common for all plug-in types (aka species) are discussed. For information about a specific plug-in, see the specific documentation: Source Control Integration Issue Tracking Integration Requirements Management Integration Third-Party Test Type Integration Plug-In Species SilkCentral (which includes Test Manager) provides several plug-in API s (e.g., for source control Integration). Such a specific API is called a species. SilkCentral Test Manager API Guide 3

8 1 CREATING PLUG-INS Compilation Compilation For developing and compiling plug-ins, use Java version 1.5.0_07. This is important for compatibility reasons with SilkCentral Test Manager s Java runtime environment. Deployment When you create your plug-in classes (and implement a species API) you need to create a plug-in package (a jar or zip). If your plug-in has no further dependencies (or depends on libraries, that are already part of SilkCentral), just create a jar file that contains your classes. If your plug-in depends on additional libraries, put them and your self-created jar file into a zip archive. Place the created file into the plug-ins directory located at <application server installation directory>\plugins\. Note You need to restart the application server and the front-end server for the newly deployed plug-in to become available in Test Manager (see the SilkCentral Administration Module Online Help for information about restarting servers). Distribution As the plug-in species are known by SilkCentral, it s also known which servers (execution, application, front-end) require which species. Each plug-in can be installed on the application server SilkCentral automatically distributes the correct plug-ins to each server. 4 SilkCentral Test Manager API Guide

9 2 Source 2Chapter Control Integration Introduction What you will learn This chapter explains how to configure custom source control plug-ins for Test Manager. This chapter contains the following sections: Section Page Overview 5 Interfaces & Classes 6 Conventions 7 Configuring Source Control Plug-ins 8 Overview Source Control profiles enable Test Manager to integrate with external source control systems. The source control systems for which default plug-ins ship with Test Manager are: Borland StarTeam (StarTeam) - see the SilkCentral Administration Module Online Help Serena Version Manager (PVCS ) - see the SilkCentral Administration Module Online Help Concurrent Version System (CVS) - see CVS Plug-In Microsoft Visual SourceSafe (MSVSS) - see the SilkCentral Administration Module Online Help Universal Naming Convention (UNC) (file-system access) - see the SilkCentral Administration Module Online Help Subversion - see Subversion Plug-In SilkCentral Test Manager API Guide 5

10 2 SOURCE CONTROL INTEGRATION Interfaces & Classes Plug-ins for other source control systems are available from Borland s download area, in the SilkCentral Test Manager menu ( downloads/download_silk.html): With Test Manager s API, custom source control plug-ins can be configured, allowing you to define where Test Manager s execution servers should retrieve program sources for test execution. Please refer to the SilkCentral Test Manager Online Help for information about defining source control information for test containers/test definitions. Note See the SilkCentral Administration Module Online Help for details on configuring the default plug-ins that ship with Test Manager. Interfaces & Classes SourceControlProfile AbstractSourceContro lprofile VersionControlProfile AbstractVersionContr olprofile SourceControlProfileD ata SourceControlExcepti on SourceControlProfileF actory Note Refer to the JavaDoc (Help/Documentation/Test Manager API Specification) for full details regarding available Java classes and methods. SilkCentral distinguishes between two types of source control systems: SourceControlProfile and VersionControlProfile. The difference is that SourceControlProfiles are non-versioned, VersionControlProfiles are versioned. This specifies most methods, such as listing the source control system s content or getting the files from the source control system to a local directory. This implements convenient methods by using other methods, the SourceControlProfile specifies. Overriding methods here is mostly because of performance reasons. This adds features like check-in/check-out and label support to the SourceControlProfile. Implements methods that only use other VersionControlProfile methods and that are common for most implementations. This provides data that the user enters, which are needed to access the source control system. The most common data are hostname, port, username, and password. As there can always be a problem, each method that is intended to access the source control system may throw a SourceControlException (checked). This exception contains error code, so the caller receives an indication as to what caused the problem. Provides a static method to get an instance of a SourceControlProfile. 6 SilkCentral Test Manager API Guide

11 2 SOURCE CONTROL INTEGRATION Conventions SourceCodeControlInf o Contains data that is required for accessing the Source control system. This is used for other applications that integrate with SilkCentral and require access to the source control system. This class was designed to contain the information required for connecting via the Microsoft SCC API. Conventions Each Implementation must provide a default constructor and, optionally, a constructor with a SourceControlProfileData as a parameter. If this constructor is not provided, a bean setter for sourcecontrolprofiledata must be provided. As each interface method specifies the SourceControlException that is to be thrown, it s not allowed to throw a RuntimeException in any method used by the interface. SilkCentral Test Manager API Guide 7

12 2 SOURCE CONTROL INTEGRATION Configuring Source Control Plug-ins Configuring Source Control Plug-ins Before you can configure a source control plug-in within Test Manager, you need to deploy the plug-in. See Creating Plug-Ins for detailed information. Subversion Plug-In Adding Subversion profiles Subversion manages versions by using transaction numbers. With each commit, the transaction number is incremented. What other source control systems call labels are called tags in Subversion. These tags are encoded in the Subversion URL. Example: Additionally to the Subversion URL you may have a tag MyHost/svn/MyApp/tags/build1012. Test Manager supports Subversion tags as follows: If a Subversion URL contains the trunk directory, you can define e.g. a label tags/build1012. This label will then replace trunk in the Subversion URL. Note If the Subversion URL doesn t contain trunk and you define a label, Test Manager throws an error. Procedure To create a Subversion source control profile: 1 Select the Source Control tab from Administration/Configuration in the menu tree. The Source Control page appears, listing all of the source control profiles that have been created for the system. 2 Click the New Profile button to open the New Source Control Profile dialog. 3 Enter a name (e.g., Subversion) for the name for the new profile. This is the name that is displayed in the Test Manager GUI. 4 Select Subversion from the Source control system drop-down list. 5 Enter the URL of the Subversion repository you wish to access. If you do not know the URL of the repository, please consult your Subversion administrator. 6 Enter a valid Subversion user name and password. These credentials will be used to access your Subversion repository. 7 Enter the working folder to which Test Manager s execution server should copy the source files. The working folder must be a local path (e.g., C:\TempSources\). 8 SilkCentral Test Manager API Guide

13 2 SOURCE CONTROL INTEGRATION Configuring Source Control Plug-ins 8 Enter the project path you want this profile to use (optional). This is the path inside the repository that should be used as the root path. Alternately, you can click the Browse button next to the Project path field to connect to the Subversion system with the credentials you ve entered. If the connection is successful, the Select Project Path dialog will appear. Select the desired project path in the tree view and click OK. Leaving this field empty sets the project path to the root directory. 9 Click OK once you have finished entering the source control profile information; or click Cancel to abort the operation. If you click OK, Test Manager will attempt a trial connection to Subversion using the information you have provided. Note If an error occurs, please review the repository path and the Subversion login credentials you ve provided. Or consult your Subversion administrator. 10 If the trial connection to Subversion is successful, you will be returned to the Source Control page, where the new profile will be listed. Editing Subversion profiles Procedure To modify a Subversion source control profile: 1 Select the Source Control tab from Administration/Configuration in the menu tree. The Source Control page appears, listing all of the source control profiles that have been created for the system. 2 Select the name of the Subversion source control profile. 3 The Edit Source Control Profile dialog appears. From here you can: - Edit the name of the profile. This is the name that is displayed in the Test Manager GUI. - Edit the URL of the Subversion repository you wish to access. If you do not know the URL of the repository, please consult your Subversion administrator. SilkCentral Test Manager API Guide 9

14 2 SOURCE CONTROL INTEGRATION Configuring Source Control Plug-ins Deleting Subversion profiles - Edit the Subversion user name and password. These credentials are used to access your Subversion repository. - Edit the working folder to which Test Manager s execution server should copy the source files. The working folder must be a local path (e.g., C:\TempSources\.) - Edit the project path you want this profile to use. This is the path inside the repository that should be used as the root path. Alternately, you can click the Browse button next to the Project path field to connect to the Subversion system with the credentials you ve entered. If the connection is successful, the Select Project Path dialog will appear. Select the desired project path in the tree view and click OK. 4 Click OK once you have finished editing source control profile information; or click Cancel to abort the operation. If you click OK, Test Manager will attempt a trial connection to Subversion using the information you have provided. Note If an error occurs, please review the credentials and the repository path you have supplied. Or consult your Subversion administrator. 5 If the trial connection to Subversion is successful, you will be returned to the Source Control page. Procedure To remove a Subversion source control profile: 1 Select the Source Control tab from Administration/Configuration in the menu tree. The Source Control page appears, listing all of the source control profiles that have been created for the system. 2 Select the Delete icon of the Subversion source control profile. 3 A confirmation dialog appears, asking you to confirm the deletion. Click Yes to remove the selected profile; or click No to abort the deletion. 4 If you click Yes, you will be returned to the Source Control page, where the deleted profile will no longer be listed. CVS Plug-In Adding CVS profiles Procedure To create a CVS source control profile: 1 Select the Source Control tab from Administration/Configuration in the menu tree. The Source Control page appears, listing all of the source control profiles that have been created for the system. 10 SilkCentral Test Manager API Guide

15 2 SOURCE CONTROL INTEGRATION Configuring Source Control Plug-ins 2 Click the New Profile button to open the New Source Control Profile dialog. 3 Enter a name (e.g., CVS) for the new profile. This is the name that will be displayed in the Test Manager GUI. 4 Select CVS from the Source control system drop-down list. 5 In the Host field, specify the CVS server (name or IP address). 6 In the Port field, specify the port that is to be connected to. 7 In the Method field, specify the connection method. Currently, only the ext connection method has been tested. This makes the Port setting optional. 8 Enter the URL of the CVS Repository you wish to access (e.g., /var/lib/ cvs). If you do not know the URL of the repository, please consult your CVS administrator. 9 Enter a valid CVS User name and Password. These credentials will be used to access your CVS repository. Note that these settings are optional when using the ext connection method. 10 Specify the CVS Module that is to be used. 11 Enter the working folder to which Test Manager s execution server should copy the source files. The working folder must be a local path (e.g., C:\TempSources\). 12 Enter the project path you want this profile to use (optional). Alternately, you can click the Browse button next to the Project path field to connect to the CVS system with the credentials you ve entered. If the connection is successful, the Select Project Path dialog will appear. Select the desired project path in the tree view and click OK. Leaving this field empty sets the project path to the root directory. 13 Click OK once you have finished entering the source control profile information; or click Cancel to abort the operation. If you click OK, Test Manager will attempt a trial connection to CVS using the information you have provided. Note If an error occurs, please review the repository path and the CVS login credentials you have supplied. Or consult your CVS administrator. SilkCentral Test Manager API Guide 11

16 2 SOURCE CONTROL INTEGRATION Configuring Source Control Plug-ins 14 If the trial connection to CVS is successful, you will be returned to the Source Control page, where the new profile will be listed. Editing CVS profiles Procedure To modify a CVS source control profile: 1 Select the Source Control tab from Administration/Configuration in the menu tree. The Source Control page appears, listing all of the source control profiles that have been created for the system. 2 Select the name of the CVS source control profile. 3 The Edit Source Control Profile dialog appears. From here you can: - Edit the name of the profile. This is the name that is displayed in the Test Manager GUI. - Edit the CVS server (name or IP address) in the Host field. - Edit the port that is to be connected to in the Port field. - Edit the connection method in the Method field. Currently, only the ext connection method has been tested. This makes the Port setting optional. - Edit the URL of the CVS Repository you wish to access. - Edit your CVS User name and Password. Note that these settings are optional when using the ext connection method. - Edit the CVS Module that is to be used. - Edit the working folder to which Test Manager s execution server should copy the source files. The working folder must be a local path (e.g., C:\TempSources\.) 12 SilkCentral Test Manager API Guide

17 2 SOURCE CONTROL INTEGRATION Configuring Source Control Plug-ins Deleting CVS profiles - Edit the project path that you want this profile to use. Alternately, you can click the Browse button next to the Project path field to connect to the CVS system with the credentials you ve entered. If the connection is successful, the Select Project Path dialog will appear. Select the desired project path in the tree view and click OK. 4 Click OK once you have finished editing source control profile information; or click Cancel to abort the operation. If you click OK, Test Manager will attempt a trial connection to CVS using the information you have provided. Note If an error occurs, please review the credentials and repository path you have supplied. Or consult your CVS administrator. 5 If the trial connection to CVS is successful, you will be returned to the Source Control page. Procedure To remove a CVS source control profile: 1 Select the Source Control tab from Administration/Configuration in the menu tree. The Source Control page appears, listing all of the source control profiles that have been created for the system. 2 Select the Delete icon of the CVS source control profile. 3 A confirmation dialog appears, asking you to confirm the deletion. Click Yes to remove the selected profile; or click No to abort the deletion. If you click Yes, you will be returned to the Source Control page, where the deleted profile will no longer be listed. SilkCentral Test Manager API Guide 13

18 2 SOURCE CONTROL INTEGRATION Configuring Source Control Plug-ins 14 SilkCentral Test Manager API Guide

19 3 Issue 3Chapter Tracking Integration Introduction What you will learn This chapter explains how to integrate third-party issue-tracking systems into SilkCentral Test Manager. This chapter contains the following sections: Section Page Overview 15 Web Service Interface 16 Java API Interface 29 Integrating Third-Party Issue Tracking 30 Overview The interfaces discussed in this chapter are required for creating plug-ins for SilkCentral Test Manager that enable the integration of a third-party (external) Issue Tracking System (ITS) into SilkCentral Test Manager. Two types of integration are offered: Web Service Interface Java API Interface The issue tracking software packages that are currently supported by Test Manager out of the box are: Borland SilkCentral Issue Manager (Issue Manager) - see the SilkCentral Administration Module Online Help Borland StarTeam (StarTeam) - see the SilkCentral Administration Module Online Help SilkCentral Test Manager API Guide 15

20 3 ISSUE TRACKING INTEGRATION Web Service Interface Rational ClearQuest - see the SilkCentral Administration Module Online Help Issue Tracking Web Service - see Web Service Interface Bugzilla - see Bugzilla Web Service Interface Interface description The interface the WSDL is based on is pasted below. This interface also contains the documentation for the methods and types. The following Java code explains the interface, but does not imply that the web service has to be written in Java. Important: The web service needs to provide the same SOAP API as described in the WSDL specification, regardless of the programming language it is written in. Note The Web service interface currently only allows the creation of new issues. If you want to assign existing issues to test definitions, you should use the Java API (see Java API Interface ). /** * This interface is used to generate the WSDL of the Web Service a customer can implement * to integrate any, in the first place not supported, Issue Tracking System. * * The WSDL document will be generated out of this interface using Apache Axis Java2WSDL tool * */ public interface IssueTrackingSOAPInterface { /** * This method returns an ID that is used for all actions during a session to identify the user. The returned value will be passed to the other methods as parameter. user password a sessionid which is used for all other actions to determine the user */ public long logonuser(string user, String password) throws IssueTrackingServiceException; /** * Will be called when starting to enter a new issue 16 SilkCentral Test Manager API Guide

21 3 ISSUE TRACKING INTEGRATION Web Service Interface sessionid a (temporary) id for the new issue */ public String newissue(long sessionid) throws IssueTrackingServiceException; /** * Returns all IssueField objects of the (temporary) issue with the provided issueid. * The IssueField objects contain the current values of the fields. sessionid issueid */ public IssueField[] getfields(long sessionid, String issueid) throws IssueTrackingServiceException; /** * This method is used to synchronize with the current states of the external tracking tool. sessionid issueids array containing the ids of the requested issues state info of requested issues [0] id, [1] state, [2] longvalue (changedat) */ public String[][] getstates(long sessionid, String[] issueids) throws IssueTrackingServiceException; /** *This method is used to get all possible states an issue may have to do a mapping between internal and external states. sessionid all states an issue may have in this profile */ public String[] getpossiblestates(long sessionid) throws IssueTrackingServiceException; /** * This method is called if a field with type SELECT_ FIELD has dependent fields and was changed. * e.g.: The field "Product" has a depending field "Release". If "Product" changes, the IssueField * for "Release" has to be returned containing the proper options for the selected product. SilkCentral Test Manager API Guide 17

22 3 ISSUE TRACKING INTEGRATION Web Service Interface sessionid issueid (temporary) id of the issue field that has changed all fields of the issue that have changed (eg. other options) due to the change of the submitted field */ public IssueField[] fieldchanged(long sessionid, String issueid, IssueField field) throws IssueTrackingServiceException; /** * this method stores the issue with the values which are submitted in the fields array. * sessionid id the (temporary) id of the issue fields array of fields containing the values to store new id of the issue after storing into the tracking system */ public String store(long sessionid, String id, IssueField[] fields) throws IssueTrackingServiceException; /** * This method returns the Http link to the issue with the submitted id if available. sessionid id http link to the issue, null if either no link is available or the id is invalid */ public String getlink(long sessionid, String id) throws IssueTrackingServiceException; /** * Not used in this version. May be used in a future version to speed up the update process. product only infos of issues linked to this product will be returned changedsince timemillis, only infos of issues changed after will be returned. * Can be ignored by implementing services if not supported, * but then all issues of this product will be returned (may slow down updates). 18 SilkCentral Test Manager API Guide

23 3 ISSUE TRACKING INTEGRATION Web Service Interface array with actual infos about the changed issues */ public IssueInfo[] getchanges(string product, long changedsince) throws IssueTrackingServiceException; } The ComplexType IssueField corresponds to the following definition. /** * An IssueField represents one input field in the issue tracking dialog. name A unique name for the field (ID) type The GUI type of the field. SelectBox = 1, Checkbox = 2, TextField = 3, TextArea = 4 (handled as TextField in this version) value The current value of the field. options The options for a field of type SelectBox (type = 1) label The label for the field shown in the dialog required Defines whether the user has to enter a value for this field or if it can be left blank length The maximum number of characters that can be entered in a TextField or TextArea dependent Array of names of other fields whose content depend on the selection of this field. Used for SelectBoxes (type = 1) */ The ComplexType IssueInfo is not used in this version as the method getchanges is not yet called. WSDL specification A WSDL file (contents pasted below) describes the SOAP-API that must be implemented to enable integration. You need to host a Web Service implementing this WSDL. Here is the specification of the web service interface. This file was generated using the Apache tool Java2WSDL. <?xml version="1.0" encoding="utf-8"?> <wsdl:definitions targetnamespace=" issuetracking" xmlns=" xmlns:apachesoap=" xmlns:impl=" xmlns:intf=" xmlns:soapenc=" xmlns:wsdl=" xmlns:wsdlsoap=" xmlns:xsd=" SilkCentral Test Manager API Guide 19

24 3 ISSUE TRACKING INTEGRATION Web Service Interface <wsdl:types> <schema targetnamespace=" issuetracking" xmlns=" <import namespace=" encoding/"/> <complextype name="issuefield"> <sequence> <element name="name" nillable="true" type="xsd:string"/ > <element name="type" type="xsd:int"/> <element name="value" nillable="true" type="xsd:string"/> <element maxoccurs="unbounded" name="options" nillable="true" type="xsd:string"/> <element name="label" nillable="true" type="xsd:string"/> <element name="isrequired" type="xsd:boolean"/> <element name="maxlength" type="xsd:int"/> <element maxoccurs="unbounded" name="dependent" nillable="true" type="xsd:string"/> </sequence> </complextype> <complextype name="arrayofissuefield"> <complexcontent> <restriction base="soapenc:array"> <attribute ref="soapenc:arraytype" wsdl:arraytype="impl:issuefield[]"/> </restriction> </complexcontent> </complextype> <complextype name="issuetrackingserviceexception"> <sequence/> </complextype> <complextype name="arrayof_xsd_string"> <complexcontent> <restriction base="soapenc:array"> <attribute ref="soapenc:arraytype" wsdl:arraytype="xsd:string[]"/> </restriction> </complexcontent> </complextype> <complextype name="arrayofarrayof_xsd_string"> <complexcontent> <restriction base="soapenc:array"> <attribute ref="soapenc:arraytype" wsdl:arraytype="xsd:string[][]"/> </restriction> </complexcontent> </complextype> 20 SilkCentral Test Manager API Guide

25 3 ISSUE TRACKING INTEGRATION Web Service Interface <complextype name="issueinfo"> <sequence> <element name="id" nillable="true" type="xsd:string"/> <element name="status" nillable="true" type="xsd:string"/> <element name="synopsis" nillable="true" type="xsd:string"/> <element name="product" nillable="true" type="xsd:string"/> <element name="component" nillable="true" type="xsd:string"/> <element name="platform" nillable="true" type="xsd:string"/> <element name="url" nillable="true" type="xsd:string"/> <element name="changedon" type="xsd:long"/> <element name="changedby" nillable="true" type="xsd:string"/> </sequence> </complextype> <complextype name="arrayofissueinfo"> <complexcontent> <restriction base="soapenc:array"> <attribute ref="soapenc:arraytype" wsdl:arraytype="impl:issueinfo[]"/> </restriction> </complexcontent> </complextype> </schema> </wsdl:types> <wsdl:message name="getchangesrequest"> <wsdl:part name="product" type="xsd:string"/> <wsdl:part name="changedsince" type="xsd:long"/> </wsdl:message> <wsdl:message name="fieldchangedresponse"> <wsdl:part name="fieldchangedreturn" type="impl:arrayofissuefield"/> </wsdl:message> <wsdl:message name="getfieldsresponse"> <wsdl:part name="getfieldsreturn" type="impl:arrayofissuefield"/> </wsdl:message> <wsdl:message name="getpossiblestatesresponse"> <wsdl:part name="getpossiblestatesreturn" type="impl:arrayof_xsd_string"/> </wsdl:message> <wsdl:message name="logonuserresponse"> <wsdl:part name="logonuserreturn" type="xsd:long"/> </wsdl:message> <wsdl:message name="getstatesresponse"> SilkCentral Test Manager API Guide 21

26 3 ISSUE TRACKING INTEGRATION Web Service Interface <wsdl:part name="getstatesreturn" type="impl:arrayofarrayof_xsd_string"/> </wsdl:message> <wsdl:message name="getpossiblestatesrequest"> <wsdl:part name="sessionid" type="xsd:long"/> </wsdl:message> <wsdl:message name="newissueresponse"> <wsdl:part name="newissuereturn" type="xsd:string"/> </wsdl:message> <wsdl:message name="getchangesresponse"> <wsdl:part name="getchangesreturn" type="impl:arrayofissueinfo"/> </wsdl:message> <wsdl:message name="logonuserrequest"> <wsdl:part name="user" type="xsd:string"/> <wsdl:part name="password" type="xsd:string"/> </wsdl:message> <wsdl:message name="getfieldsrequest"> <wsdl:part name="sessionid" type="xsd:long"/> <wsdl:part name="issueid" type="xsd:string"/> </wsdl:message> <wsdl:message name="storeresponse"> <wsdl:part name="storereturn" type="xsd:string"/> </wsdl:message> <wsdl:message name="getstatesrequest"> <wsdl:part name="sessionid" type="xsd:long"/> <wsdl:part name="issueids" type="impl:arrayof_xsd_ string"/> </wsdl:message> <wsdl:message name="getlinkrequest"> <wsdl:part name="sessionid" type="xsd:long"/> <wsdl:part name="id" type="xsd:string"/> </wsdl:message> <wsdl:message name="newissuerequest"> <wsdl:part name="sessionid" type="xsd:long"/> </wsdl:message> <wsdl:message name="issuetrackingserviceexception"> <wsdl:part name="fault" type="impl:issuetrackingserviceexception"/> </wsdl:message> <wsdl:message name="fieldchangedrequest"> <wsdl:part name="sessionid" type="xsd:long"/> <wsdl:part name="issueid" type="xsd:string"/> <wsdl:part name="field" type="impl:issuefield"/> </wsdl:message> <wsdl:message name="getlinkresponse"> <wsdl:part name="getlinkreturn" type="xsd:string"/> </wsdl:message> <wsdl:message name="storerequest"> 22 SilkCentral Test Manager API Guide

27 3 ISSUE TRACKING INTEGRATION Web Service Interface <wsdl:part name="sessionid" type="xsd:long"/> <wsdl:part name="id" type="xsd:string"/> <wsdl:part name="fields" type="impl:arrayofissuefield"/> </wsdl:message> <wsdl:porttype name="issuetrackingporttype"> <wsdl:operation name="getfields" parameterorder="sessionid issueid"> <wsdl:input message="impl:getfieldsrequest" name="getfieldsrequest"/> <wsdl:output message="impl:getfieldsresponse" name="getfieldsresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="store" parameterorder="sessionid id fields"> <wsdl:input message="impl:storerequest" name="storerequest"/> <wsdl:output message="impl:storeresponse" name="storeresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="logonuser" parameterorder="user password"> <wsdl:input message="impl:logonuserrequest" name="logonuserrequest"/> <wsdl:output message="impl:logonuserresponse" name="logonuserresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="newissue" parameterorder="sessionid"> <wsdl:input message="impl:newissuerequest" name="newissuerequest"/> <wsdl:output message="impl:newissueresponse" name="newissueresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="getstates" parameterorder="sessionid issueids"> SilkCentral Test Manager API Guide 23

28 3 ISSUE TRACKING INTEGRATION Web Service Interface <wsdl:input message="impl:getstatesrequest" name="getstatesrequest"/> <wsdl:output message="impl:getstatesresponse" name="getstatesresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="getpossiblestates" parameterorder="sessionid"> <wsdl:input message="impl:getpossiblestatesrequest" name="getpossiblestatesrequest"/> <wsdl:output message="impl:getpossiblestatesresponse" name="getpossiblestatesresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="fieldchanged" parameterorder="sessionid issueid field"> <wsdl:input message="impl:fieldchangedrequest" name="fieldchangedrequest"/> <wsdl:output message="impl:fieldchangedresponse" name="fieldchangedresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="getlink" parameterorder="sessionid id"> <wsdl:input message="impl:getlinkrequest" name="getlinkrequest"/> <wsdl:output message="impl:getlinkresponse" name="getlinkresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> <wsdl:operation name="getchanges" parameterorder="product changedsince"> <wsdl:input message="impl:getchangesrequest" name="getchangesrequest"/> <wsdl:output message="impl:getchangesresponse" name="getchangesresponse"/> <wsdl:fault message="impl:issuetrackingserviceexception" name="issuetrackingserviceexception"/> </wsdl:operation> 24 SilkCentral Test Manager API Guide

29 3 ISSUE TRACKING INTEGRATION Web Service Interface </wsdl:porttype> <wsdl:binding name="issuetrackingsoapbinding" type="impl:issuetrackingporttype"> <wsdlsoap:binding style="rpc" transport=" schemas.xmlsoap.org/soap/http"/> <wsdl:operation name="getfields"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="getfieldsrequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="getfieldsresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="store"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="storerequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="storeresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="logonuser"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="logonuserrequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="logonuserresponse"> SilkCentral Test Manager API Guide 25

30 3 ISSUE TRACKING INTEGRATION Web Service Interface <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="newissue"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="newissuerequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="newissueresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="getstates"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="getstatesrequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="getstatesresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="getpossiblestates"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="getpossiblestatesrequest"> 26 SilkCentral Test Manager API Guide

31 3 ISSUE TRACKING INTEGRATION Web Service Interface <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="getpossiblestatesresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="fieldchanged"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="fieldchangedrequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="fieldchangedresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> <wsdl:operation name="getlink"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="getlinkrequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="getlinkresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> SilkCentral Test Manager API Guide 27

32 3 ISSUE TRACKING INTEGRATION Web Service Interface </wsdl:fault> </wsdl:operation> <wsdl:operation name="getchanges"> <wsdlsoap:operation soapaction=""/> <wsdl:input name="getchangesrequest"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:input> <wsdl:output name="getchangesresponse"> <wsdlsoap:body encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:output> <wsdl:fault name="issuetrackingserviceexception"> <wsdlsoap:fault encodingstyle=" schemas.xmlsoap.org/soap/encoding/" namespace=" scc.segue.com/issuetracking" use="encoded"/> </wsdl:fault> </wsdl:operation> </wsdl:binding> <wsdl:service name="issuetrackingservice"> <wsdl:port binding="impl:issuetrackingsoapbinding" name="issuetrackingport"> <wsdlsoap:address location=" issuetracking.endpoint"/> </wsdl:port> </wsdl:service> </wsdl:definitions> Configuring a Web Service profile Once your custom issue tracking Web service is hosted, you can configure an issue tracking profile in Test Manager. Procedure To configure a Web service issue tracking profile in Test Manager: 1 Select Administration/Configuration from the menu tree. 2 Select the Issue Tracking tab. 3 Click the New Profile button. The New Issue Tracking Profile dialog appears. 4 On the New Issue Tracking Profile dialog, select Issue Tracking Web Service from the Type drop-down list box. 5 In the Endpoint edit field, enter the URL of your hosted Web service. 6 Enter a valid Login name and Password into the respective fields, according to the values that have been implemented in the Web service. 28 SilkCentral Test Manager API Guide

33 3 ISSUE TRACKING INTEGRATION Java API Interface 7 Enter a meaningful Name and Description for the new issue tracking profile and click OK to confirm your settings. The new issue tracking profile is now available when entering issues in Test Manager. Java API Interface Note Refer to the JavaDoc (Help/Documentation/Test Manager API Specification) for full details regarding available Java classes and methods. Build environment Add the library scc.jar to your classpath, as it contains the interfaces you have to extend from. The jar file can be found in the lib directory of the Test Manager installation directory. You must extend two interfaces/classes: com.segue.scc.published.api.issuetracking.issuetrackingprofile com.segue.scc.published.api.issuetracking.issue Classes/Interfaces IssueTrackingProfile IssueTrackingData Issue IssueTrackingProfile (ITP) contains the methods that are required to access the ITS. The ITP accesses the ITS and interacts closely with the Issue. This gives information regarding the configured ITP. The ITP uses the data gathered here to access the ITS (e.g., user/password or the hostname/port of the ITS). Represents the issue itself (contains the data describing the issue). The issue is created when the user creates a new issue that is to be stored in the external ITS. Most of the data is contained in the ITF s. SilkCentral Test Manager API Guide 29

34 3 ISSUE TRACKING INTEGRATION Integrating Third-Party Issue Tracking IssueTrackingField IssueTrackingProfileE xception ITF s are provided by the issue. As they can be dependent upon each other, some notifications for changing the context are available. Only the field values that the user enters when creating a new issue in the external ITS should be returned. Any method can throw this exception with a message that helps the user identify their mistake. Integrating Third-Party Issue Tracking Issue tracking profiles enable Test Manager to integrate with external issue tracking systems. The issue tracking software packages that are currently supported by Test Manager out of the box are: SilkCentral Issue Manager (version 4.0 and higher) - see the SilkCentral Administration Module Online Help Rational ClearQuest - see the SilkCentral Administration Module Online Help SilkCentral Issue Manager see the SilkCentral Administration Module Online Help Issue Tracking Web Service - see Web Service Interface Bugzilla - see Bugzilla Plug-ins for other issue tracking systems may be available from Borland s download area, in the SilkCentral Test Manager menu ( Defining issue tracking profiles allows you to link test definitions within the Test Plan unit to issues in third-party issue-tracking systems. Linked issue states are updated periodically from the third-party issue tracking system. Refer to Creating Plug-Ins for detailed information regarding the deployment of your custom issue tracking profiles. Bugzilla The BugZilla plug-in relies on SilkCentral s Java API for integration. The Bugzilla integration has been tested with Bugzilla Modifications to your Bugzilla installation are not required to enable integration. SilkCentral Test 30 SilkCentral Test Manager API Guide

35 3 ISSUE TRACKING INTEGRATION Integrating Third-Party Issue Tracking Manager communicates with Bugzilla via Bugzilla s Web GUI (using Jakarta Common s HttpClient library). Note See the sources of com.segue.scc.issuetracking.bugzilla.bugzillaprofile and com.segue.scc.issuetracking.bugzilla.bugzillaissue to see how these elements fit together. Adding a Bugzilla profile Procedure To add a Bugzilla profile: 1 Select the Issue Tracking tab from Administration/Configuration in the menu tree. The Issue Tracking page appears, listing all the issue tracking profiles that have been created for the system. 2 Click the New Profile button to open the New Issue Tracking Profile page. 3 On the New Issue Tracking Profile dialog, enter a name for the new profile. This is the name that will be displayed in lists where issue tracking profiles are available for selection. 4 Enter a description for the new profile (this is only used for GUI display purposes). 5 Select Bugzilla from the Type drop list. 6 Enter the valid login and password that will be used to access Bugzilla. 7 Enter the URL of your Bugzilla installation (e.g., cgi-bin/bugzilla/). Note The URL must end with a slash ( / ) to establish a connection to Bugzilla. 8 Click OK when you have finished entering the profile information; or click Cancel to abort the operation. If you have clicked OK, Test Manager will attempt a trial connection to the Bugzilla installation using SilkCentral Test Manager API Guide 31

36 3 ISSUE TRACKING INTEGRATION Integrating Third-Party Issue Tracking the information you have provided. If an error occurs, please review the login credentials and the URL that you have supplied, or consult your Bugzilla administrator. 9 If the trial connection to Bugzilla is successful, a confirmation dialog appears, asking you if you want to map internal issue states to the states of the newly defined profile. If you select Yes, please proceed with step 3 of the following procedure. Click No if you want to map issue states later. Mapping issue states After defining a Bugzilla profile, you should map the existing issue states of Bugzilla to the states of Test Manager. Doing this enables Test Manager to list issues correctly when querying internal and external issues. Procedure To map issue states: 1 Select the Issue Tracking tab from Administration/Configuration in the menu tree. The Issue Tracking page appears, listing all of the issue tracking profiles that have been created for the system. 2 Click the Edit state mapping icon of the Bugzilla profile. 3 The Status Mapping dialog appears, listing all of bugzilla s existing issue states. These states are listed in the External column. Test Manager s internal issue states are available in the drop lists in the Internal column. Map internal issue states to corresponding external issue states by selecting the respective entries from the drop list. 4 Once you have mapped each external issue state to an internal state, click OK to save your settings; or click Cancel to abort the operation. 32 SilkCentral Test Manager API Guide