Integrating CaliberRM with Software Configuration Management Tools

Transcription

1 Integrating CaliberRM with Software Configuration Management Tools A Borland White Paper By Jenny Rogers, CaliberRM Technical Writer January 2002

2 Contents Introduction... 3 Enabling SCM for a Project... 4 Traceability... 4 Creating Traceability Links... 4 SCM Menus and Toolbars... 6 Viewing SCM Traces... 7 Traceability Matrix... 7 Traceability Diagram... 8 SCM Traces in Document Factory

3 Introduction Software Configuration Management (SCM) systems are development tools that track changes and provide version control for source code or other file types. CaliberRM supports the Microsoft Common Source Code Control API (also called SCC API or SCCI). Most SCM systems have an SCC API that can be used to access the functionality if their product. The table below lists the SCM tools and versions that have been tested with CaliberRM. Vendor Tool Version Tested Borland StarTeam 4.2 and above Merant PVCS Version Manager 6.0 Microsoft SourceSafe 6.0 Rational ClearCase 3.2 Using CaliberRM s integrated SCM solution, you can create traceability links to and from requirements with objects in source control. Linking requirement objects with source objects provides immediate tracking from a requirement that has been changed to its associated source file in an SCM system. This also provides most SCM functionality from within CaliberRM. 3

4 Enabling SCM for a Project To enable SCM for a project: 1. In Framework Administrator, click the Projects button or select View > Projects from the menu. 2. Select the project for which you want to enable SCM. 3. Select the External Traceability tab. 4. Select SCM from the Disabled Integration(s) list, and click the Move Left button. 5. To save the information, select File > Save Changes from the menu, or click the Save button. To cancel the changes, select Edit > Cancel Changes from the menu, or click the Cancel Changes button. Traceability Creating Traceability Links You must have a supported SCM tool installed on your system to create SCM trace links in CaliberRM. In addition, SCM integration must be enabled for your project. SCM trace links are created in the Traceability Modification window on the SCM Files tab. If an SCM system is not installed, you get an error message when you click the tab. If SCM is installed, but not enabled for the current project, this tab reads No SCC provider found on this machine Otherwise, the information displayed is SCM system dependent. To link requirements to source control objects: 1. Open a project and select the requirement for which you want to create SCM link. 2. Click the Traceability tab. This window displays the current to and from traces, if any. 3. Click Modify. The Traceability Modification window opens with the Requirements tab displayed, along with the Open a Project dialog box. Since you are not opening another project here, click OK. 4. Select the SCM Files tab. The information displayed on this tab depends on the installed SCM system. 4

5 Note: The examples in this text use Microsoft Visual SourceSafe. Each supported SCM tool may present windows and dialogs that differ from the examples displayed in this documentation. 5. In CaliberRM, select the requirement you want to create a trace to or from. 6. Click the Traceability tab. 7. Click the Modify button. 8. Select the SCM Files tab. Microsoft SourceSafe prompts you to log on. Once logged on, you are prompted to create or open a local project in SourceSafe. The folder containing this project becomes your working folder and opens automatically when you access the Traceability tab. 9. Select an SCM project and open it. When you open or create an SCM project, the source control objects are listed in the Traceability Modification window. 10. Select the source control object to trace to or from. 11. Select Trace > Trace To or Trace From from the menu, or click the Trace From or Trace To button. The trace indicator appears next to the object showing the direction of the trace. 12. Repeat steps 6 through 8 until you have created all the SCM links needed. 13. Click the Save button to save the traces, or click the Cancel Changes button to cancel the traces. 14. Close the Traceability Modification window to return to the Traceability tab. The SCM traces are displayed on the Traceability tab. The following information about a linked source control object is listed on the Traceability tab. The Object s file type icon Trace To or From: SCM object name Tag/ID: SCM system name Status: Checked in or out status Project: SCM project name Existing SCM traces appear disabled when: SCM is not installed on your system. SCM is disabled for the project. You are not logged on to the SCM system. 5

6 You can double-click an SCM object on the Traceability tab or the Modify Trace dialog box. The latest version of that object opens in the SCM working directory using the application associated with the file type. SCM Menus and Toolbars When SCM is enabled, SCM-specific menus and toolbar items become available in CaliberRM. When you select an SCM entry on the Traceability tab or the Traceability Modification window, you can perform most SCM operations. When you select an SCM operation, the pop-up windows and dialog boxes displayed are dependent on the SCM system installed. Some source control systems may not provide all the functionality presented on the menus or toolbars. If you select an operation not supported by your SCM system, an error message is displayed. SCM operations are available from the CaliberRM menu and the Traceability Modification menu while viewing the SCM Files tab. To select SCM functions from CaliberRM or the Traceability modification window, select Tools > Source Control. The following table describes the menu items and corresponding toolbar buttons for SCM. Toolbar Button Menu Name Description Get Latest Version Check Out Check In Get the latest version of an object in source control and open it using the associated program. Check out a source control object. Check in a source control object. 6

7 Toolbar Button Menu Name Description Undo Check Out Show History Show Difference Properties Refresh Status Cancel the checkout of a source control object. Show the history of a source control object. Compares different versions of objects in source control. Show the properties of a source control object. Refresh the SCM Window. Launch Application New Start the application associated with the selected source control object. Open a new SCM Project or SCM Application. Viewing SCM Traces SCM traces can be viewed in the Traceability Matrix and on the Traceability Diagram. Traceability Matrix An SCM tab is available within the Filter dialog box that allows you to include SCM objects in the Traceability Matrix in rows or columns or both. Note: The default Traceability Matrix does not include SCM objects. To view SCM objects in the Traceability Matrix: 1. Select Tools > Traceability Matrix from the menu, or click the Traceability Matrix button on the toolbar. 2. Select View > Filter from the Traceability Matrix menu, or click the Filter button on the toolbar. 7

8 3. The Traceability Filter window is displayed. Select the appropriate boxes on the CaliberRM Projects tab to include the project and requirement types that you want to appear in the matrix. 4. Click the SCM tab in the Traceability Filter dialog box. 5. To show SCM objects in rows or columns or both, select the appropriate boxes. Note: The items to be displayed in the Traceability Matrix are listed in the Rows and Columns Filter lists at the bottom of the Traceability Filter dialog box. 6. Click OK. The SCM filtered Traceability Matrix is displayed. For more information on setting up filters for the Traceability Matrix, see Chapter 16: Traceability in the CaliberRM User s Guide. Traceability Diagram SCM trace links can also be viewed in the Traceability Diagram. To view a Traceability Diagram including SCM traces: 1. Select a requirement. 2. Select Tools > Trace Diagram from the menu, or click the Trace Diagram button. An example of a Traceability Diagram including SCM traces is shown below: For more information on the traceability diagram features, see Chapter 16: Traceability in the CaliberRM User s Guide. 8

9 SCM Traces in Document Factory You can also include SCM information in a document generated by Document Factory. For more information, see Chapter 22: Document Factory in the CaliberRM User s Guide. Made in Borland Copyright 2002 Borland Software Corporation. All rights reserved. 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. Corporate Headquarters: 100 Enterprise Way, Scotts Valley, CA Offices in: Australia, Brazil, Canada, China, Czech Republic, France, Germany, Hong Kong, Hungary, India, Ireland, Italy, Japan, Korea, the Netherlands, New Zealand, Russia, Singapore, Spain, Sweden, Taiwan, the United Kingdom, and the United States. 9