Caliber Visual Studio.NET Integration 11.5 Visual Studio Integration
Micro Focus The Lawn 22-30 Old Bath Road Newbury, Berkshire RG14 1QN UK http://www.microfocus.com Copyright Micro Focus 2016. All rights reserved. MICRO FOCUS, the Micro Focus logo and Caliber are trademarks or registered trademarks of Micro Focus IP Development Limited or its subsidiaries or affiliated companies in the United States, United Kingdom and other countries. All other marks are the property of their respective owners. 2016-09-01 ii
Contents Caliber for Visual Studio...4 About Caliber...5 Tour of Caliber for Visual Studio...6 Logging on...7 Projects... 8 Selecting Projects... 9 Removing Projects...10 Baselines...11 Selecting Project Baselines...11 Requirements... 12 Refreshing Requirements...13 Requirement References... 14 Requirement Attributes... 15 Viewing Requirement Attributes...15 Requirement Discussions... 16 Participating in Discussions... 16 Posting Messages... 16 Replying to Messages...16 Requirement Change Notifications... 17 Requirement History... 18 Viewing Requirement History...18 Requirement Traceability...19 Creating a Trace between Requirements...19 Requirement Grid... 20 Displaying Groups of Requirements Using the Requirement Grid...20 Printing the Requirement Grid... 20 Exporting Requirement Grid Contents to XML...20 Logging Off... 21 Contents 3
Caliber for Visual Studio Caliber for Visual Studio provides Visual Studio users visibility into the latest requirements stored in Caliber, view requirement history, establish traces with other requirements, and participate in discussions. 4 Caliber for Visual Studio
About Caliber Caliber is an enterprise requirements management system designed to facilitate collaboration, impact analysis, and communication in the definition and management of changing requirements. Caliber helps organizations large or small, in local or global offices effectively manage expectations across the lifecycle so that projects are delivered on time, within scope, and according to specification. Designed for ease of use, the intuitive interface of the client for Microsoft Visual Studio provides developers the real-time access they need to requirements right in their own IDE. Caliber also helps applications meet end-user needs by allowing all project stakeholders marketing teams, analysts, developers, and managers to collaborate and communicate the voice of the customer throughout the lifecycle. Caliber provides: Visibility: Dynamic business demands makes visibility a must. Customers are faced with constantly evolving software requirements and less time, money or resources to deliver software. Communication & Collaboration: Business demands drive requirements which drives application development. All members of a project team need to have a common understanding of the requirements. Requirements need to be simple, complete, concise, and accurate. Software development teams are able to respond rapidly to ever-changing requirements. Control: Traceability and metrics reporting are key to proactively controlling a software project. To ensure they are being fulfilled, requirements should be traced to other artifacts in the lifecycle such as design, change requests and source code files. Traceability allows enterprises to enable automated change notifications and impact analysis. Requirements also have many important metrics concerning scope creep and volatility which are key to understanding the status of projects. About Caliber 5
Tour of Caliber for Visual Studio After you have opened a Caliber for Visual Studio project, the Caliber explorer displays the Caliber for Visual Studio project requirements. Expanding the project displays requirement types, and expanding requirement types displays requirements. Projects Right-click on the project name to open the Requirement Grid. Requirements Click a requirement to view and edit requirement information on a series of tabs: Details: Displays the requirement name, version, owner, status, priority and description. Responsibilities: Displays a list of users and groups that you can select to receive e-mail notifications about requirement changes. References: Displays reference information for a requirement. Traceability: Allows you to view and modify the relationships between requirements and other related development information. Validation: View validation procedures for the selected requirement. Discussion: Displays all discussions for a requirement. Allows you to participate in existing discussions or start new discussions. History: Details all revisions made to a requirement, including changes to specific attributes, requirement descriptions, status, priority, etc. Displays the change history for a requirement. Change history includes who created the requirement, when the requirement was created and any revisions or changes to the requirement and the dates those changes occurred. Custom Attributes: Displays all user-defined attributes for the selected requirement. Each requirement type can have multiple, customizable tabs. These are created and administered in the standalone Caliber client. 6 Tour of Caliber for Visual Studio
Logging on You must logon a Caliber for Visual Studio project to view requirements. 1. Select View > Other Windows > Caliber Explorer. 2. In the Caliber Explorer window, click...<<click Here to Add a New Caliber Project>>. The Logon window appears. 3. Enter a server name (using <servername:portnumber> if your Caliber server uses a non-default port), a user name and password and click Logon. 4. Select a project and a baseline and click Add. Logging on 7
Projects A project contains a collection of requirements that you need to manage as a whole, such as an application or system under development. Caliber projects consist of several types of information, including users and groups, requirement types and requirements. Project Administration Caliber project administration is maintained in the Caliber Administrator component of the standalone Caliber. Caliber Projects in Visual Studio Before you can access Caliber for Visual Studio requirements in Visual Studio, you must logon the Caliber for Visual Studio server. 8 Projects
Selecting Projects 1. Choose View > Other Windows > Caliber Explorer. The Caliber Explorer appears. 2. Expand the Project node. 3. If the project is not already open, click <<Click Here to Add a New Caliber Project>>. 4. Type your Caliber server name, User ID, and Password and click Login. In case your Caliber server uses the port different from the default 20000 one, type the port number after the Server name as follows: servername:port number. For example, Caliber:5353. 5. After a successful login, select a project and baseline in the enabled Project and Baseline drop-down lists respectively. 6. Click Add to add the selected project to the Caliber Explorer window. Selecting Projects 9
Removing Projects 1. Choose View > Other Windows > Caliber Explorer. The Caliber Explorer appears. 2. Right-click the Project node. 3. Choose Remove Caliber Project. The project is removed. 10 Removing Projects
Baselines A Caliber project can contain multiple baselines that allow you to view sets of requirements at specific versions, using a single label to refer to the requirements. The currently selected baseline appears in line with the name of the Caliber project. The default baseline for a Caliber project is Current Baseline. You can only edit requirements in the current baseline. For other baselines all requirements are read only. Project Baseline Administration Creation of project baselines, and comparison of baseline content is performed in Caliber Author. Caliber Project Baselines in Visual Studio Before you can access Caliber for Visual Studio requirements in Visual Studio, you must logon the Caliber for Visual Studio server. Selecting Project Baselines 1. Choose View > Other Windows > Caliber Explorer. The Caliber Explorer appears. 2. If a Caliber project is already open, right-click on the project and select Remove Caliber Project. 3. In the Caliber Explorer, click <<Click Here to Add a New Caliber Project>>. 4. Type your Server name, User ID, and Password and click Login. 5. After a successful login, specify the project and baseline you want to view in the Project and Baseline dropdown lists respectively. The currently selected baseline appears in line with the name of the specified Caliber project. In case your Caliber server uses the port different from the default 20000 one, type the port number after the Server name as follows: servername:port number. For example, Caliber:5353. Note: For baselines other than Current Baseline, all requirements are read only. Note: If the selected baseline is not available (for example, the baseline has been deleted), then Caliber baseline is not available and may have been deleted dialog box opens in Visual Studio and the baseline displays the Current Baseline. Baselines 11
Requirements Requirements are specifications that the application or system you are building must meet. Requirements can originate from many sources such as business rules, business process models, product marketing, prototypes, development meetings, and more. Each requirement within a project has the unique ID (or serial) number that displays in the Requirement Tag/ID field on the Details tab in the document window. The serial number does not change, regardless of the requirement position, and it is not reused if the requirement is deleted. Each requirement is assigned to a Requirement Type. Requirement Types are high-level groups of requirements, typically classified by their function (i.e., Business, Marketing, GUI, Hardware, Software, etc.). 12 Requirements
Refreshing Requirements 1. Choose View > Other Windows > Caliber Explorer. 2. If you have not already opened requirements, click <<Click Here to Add a New Caliber Project>> and log into Caliber. 3. Click Refresh button in the toolbar. The latest changes made in Caliber are now reflected in the project. Note: To access a recently created Caliber project from Visual Studio, you must first open it in Caliber Author. This initializes the Caliber project and makes it available for selection in the Project drop-down list of the Logon to Caliber dialog box. Refreshing Requirements 13
Requirement References You can include additional information or resources for a requirement using requirement references. For example, you can reference a specification document, meeting notes, a link to a Web page, a screen shot or anything else that might be of use in defining or understanding a requirement. You can add or edit references in Caliber Author. You can have an unlimited number of references for each requirement. Requirement references are shown on the References tab of a requirement document window. There are two differences between references and requirement traceability. You use references to link requirements with external objects that help define a requirement. References are single-direction links, so you can traverse them only from a source requirement. There are three types of references: File reference Text reference Reference on the Web File References You use this type to reference an existing file on the network. Reference files are best placed on a shared drive for all users to access. You can reference file of any type, such as Microsoft Word, Excel, Power Point, images, or HTML files. The content of the file is not stored in the Caliber project. Caliber for Visual Studio keeps only the filename and path to a referenced file. If the referenced file is no longer available or renamed, the reference becomes invalid. Text References You use this type to add a piece of text to a requirement. This text is stored in the Caliber project. Web References You use this type to link an external Internet resource. You need to specify a URL of a resource to reference. This URL is stored in the Caliber project. If the referenced link is no longer available or renamed, the reference becomes invalid. 14 Requirement References
Requirement Attributes Attributes are characteristics that help define a requirement. Both system and user-defined attributes are supported in Caliber for Visual Studio. You can view all requirement attributes. Requirement attributes are shown on the Details and User Attributes tabs of a requirement document window. System Attributes (Details) System attributes are those that Caliber automatically maintains for each requirement. You cannot choose which attributes are system attributes, but you can change or edit their values in Caliber Author. The system attributes that are maintained for each requirement are: Name the name of the requirement Tag/ID the tag of the requirement comes from the requirement type name; the serial number of the requirement is static and automatically generated; each ID number is unique in the system; if a requirement is deleted, that ID number will not be reused Version (see also requirement history) the revision number of the requirement; when a change is made to the requirement, the version number is automatically updated; the change may cause a major or minor revision number change; a Caliber administrator determines this when attributes types are defined in Caliber Author Status the requirement status Priority the requirement priority Owner the default Owner is the user who created the requirement; requirement ownership varies through the project life-cycle; typically, the beginning Owner is an analyst, after implementation, the Owner is a developer, and later, the Owner is a QA engineer Description the requirement description User-Defined Attributes User-defined attributes help further define requirements and are optional. They can be one of several different types of data, including text, long integer, date, boolean and users. A system administrator can set up the list of user-defined attributes in Caliber Author. For more information, please consult the Caliber User Guide. Viewing Requirement Attributes You can manage user-defined attributes available in your project by using the Caliber Administrator or Caliber Author. For more information, refer to the Caliber help. 1. Choose View > Other Windows > Caliber Explorer. The Caliber Explorer window appears. 2. Expand the project node. 3. Select a requirement. 4. Click the User Attributes tab (this tab name will vary depending on your organization). This shows optional user-defined attributes of the requirement. A user-defined attribute appears as a check box, a text field, a list box, a calendar chooser, or another window control. Requirement Attributes 15
Requirement Discussions Project teams can provide feedback on requirements through discussions. This collaborative feature enables team members to enter and reply to comments to help define, refine, and prioritize requirements. Each discussion is dedicated to a particular requirement. Discussion messages and replies are shown on the Discussion tab of a requirement document window. You can receive email notification that a new message has been posted for a requirement. The Caliber administrator must first enable notifications in the Caliber Administrator, then you must be assigned as a responsible user to receive change notifications. Participating in Discussions 1. Select a Caliber project in Visual Studio. 2. Select a Requirement Type and click the plus sign (+) to expand the list of requirements. 3. Select the requirement that contains a discussion. 4. Select the Discussion tab. All messages posted for the selected requirement appear. 5. Read, post, or reply to a message. Posting Messages 1. Click Post New. The New Message dialog box opens. 2. Type a subject in a Subject field. 3. Type a message in a message box. 4. Choose File > Post Message from the New Message dialog box menu. To exit without posting a message, choose File > Close from the New Message dialog box menu. Replying to Messages 1. Select the message. 2. Click Reply. The New Reply Message dialog box opens with the subject field automatically filled. 3. Type message in your message box. 4. Choose File > Post Message from the New Message dialog box menu. To exit without posting a message, choose File > Close from the New Message dialog box menu. 5. Click Refresh on the Discussion tab to update the Discussion list. 16 Requirement Discussions
Requirement Change Notifications Caliber for Visual Studio can notify one or more users by email about requirement changes. Notified users are shown on the Responsibilities tab of a requirement document window. All team members have user accounts in the Caliber Server. Each user belongs to one or more groups. Usually the Owner of a requirement assigns responsibility to the user or users who could be affected by changes made to the requirement. The Caliber administrator manages user accounts and groups and enables notifications in the Caliber Administrator component of Caliber Author. For information on enabling notifications, please see the Caliber User Guide. Requirement Change Notifications 17
Requirement History Caliber for Visual Studio maintains a history record for each requirement. The history record assigns revision numbers and keeps a list of changes for each revision. All changes made to a requirement, including changes to specific attributes (the requirement description, status, priority, and so on) are recorded in the requirement history. The current requirement version is displayed on the requirement Details tab. Viewing Requirement History The History tab shows the list of revisions for the selected requirement in the upper part of the window. The initial revision is displayed at the top. The list of attributes changed at the selected revision is displayed at the lower part of the window. 1. Choose View > Other Windows > Caliber Explorer. The Caliber Explorer appears. 2. Expand the node. 3. Select a requirement. 4. Click the History tab. 5. Select a revision. 6. Select a change from the attribute changes list, 7. Click the Detail... button. A dialog box opens displaying old and new values of the attribute, date and time of the change, name of the user who made this change, and the user comments about the change. 18 Requirement History
Requirement Traceability Traceability allows you to create and track relationships between requirements and other related development information. Such relationships are called "traces" and shown on the Traceability tab of a requirement document window. Changing a requirement can potentially require changes in other software artifacts. Tracing related software artifacts helps to ensure that changes are implemented correctly at all levels. Traces between requirements are bidirectional, so you can traverse a trace from a source or destination requirement. A requirement can trace to : Another requirement in the same Caliber for Visual Studio project or across projects on the same Caliber for Visual Studio Server A file stored in a CM system Another software artifact supported by Caliber for Visual Studio traceability add-ins When you create a trace, Caliber for Visual Studio for Visual Studio automatically implies traces to other requirements that can be affected. For example, if there are direct traces between a software requirement and an interface requirement, and between the interface requirement and a coding requirement, there is also an implied trace between the software requirement and the coding requirement. When you change a requirement, traces to other software artifacts become suspect. Suspect traces are an indicator that other objects can be affected by the changed requirement and you should review them. You can establish traceability between requirements from the requirement Traceability tab. Provided that the Caliber project was enabled for external traceability (refer to Caliber User Guide), you can also create traces to Team Foundation System. Creating a Trace between Requirements 1. Open Caliber Explorer. 2. Click the Traceability tab. 3. Click Modify. The Traceability Modification dialog box appears. 4. Choose a project from the drop-down list. 5. Click the plus sign (+) to expand the requirement list and navigate to the requirement to trace to/from. 6. Optional: Right-click the requirement in the list and select Properties to view requirement properties. 7. Click Trace From or Trace To. 8. Click Save. Requirement Traceability 19
Requirement Grid You can view requirements in a spreadsheet format to sort requirements and export requirements to XML. The grid view displays the requirement type, tag, name, status, priority, responsible users, owner and user defined attributes. Selecting a requirement displays its description in the lower pane of the Requirement Grid. Displaying Groups of Requirements Using the Requirement Grid The Requirement Grid is used to display a set of requirements. The grid view includes the requirement type, tag, name, status, priority, users, owner and many other attributes. 1. Choose View > Other Windows > Caliber Explorer. The Caliber Explorer appears. 2. Expand the project node. 3. Right-click the Caliber project that contains the requirements to view. 4. Choose Requirement Grid. The Requirement Grid appears. To force the Requirement Grid to stay on top, choose View > Always on top. To sort requirements, click on the column header to sort by that column. To view requirement details, select the requirement in the Requirement Grid dialog box and choose View > Go to requirement. Printing the Requirement Grid 1. Choose File > Print from the Requirement Grid main menu. The Report Setup dialog box opens. 2. Click Print Preview. This displays the Requirement Grid in a browser, from which you can follow standard Windows printing procedures. Exporting Requirement Grid Contents to XML 1. Choose File > Print from the Requirement Grid main menu. The Report Setup dialog box appears 2. Click Export. The Save As dialog box appears 3. Type the file name and specify where to save the file. The default file name is RequirementGridReport.xml. 4. Click Save. The Requirement Grid content is exported. 20 Requirement Grid
Logging Off 1. Select View > Other Windows > Caliber Explorer. 2. Expand the project node. 3. Select Log off Caliber. The project closes and you are logged off. Logging Off 21
Index B baselines selecting 11 C change details 18 D discussions accessing 16 posting message 16 replying 16 replying to messages 16 starting 16 H history 18 I introduction 4 L log off 21 log on 7 O overview 5 P projects removing 10 selecting 9 R requirement grid exporting 20 printing 20 viewing 20 requirements about 12 attributes 15 change notifications 17 discussions 16 editing attributes 15 grid 20 history 18 references 14 refreshing 13 system 15 traceability 19 user-defined 15 viewing attributes 15 T tour 6 traceability between requirements 19 22 Index