IBM DOORS Next Generation

Transcription

1 IBM DOORS Next Generation Hands-on lab workbook with Jazz/RM Last updated: 11 July 2015 (Version 1)

2 Copyright IBM Corporation, 2015 US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

3 IBM Software Contents LAB 1 RM FUNDAMENTALS WITH A WEB CLIENT EXPLORE THE DASHBOARD FOR THE METER READER REQUIREMENTS CHECKING OUT THE HOME MENU EXPLORING A MODULE UNDERSTANDING MODULES FINDING THINGS IN PROJECTS AND MODULES VIEWING TRACEABILITY IN THE LINKS EXPLORER ADDING COLUMNS TO A VIEW AN OVERVIEW OF REQUIREMENT RE-USE ARTIFACT TYPES AND ATTRIBUTES FILTER BY ATTRIBUTE SAVING A SHARED VIEW YOU VE CREATED PROJECT PROPERTIES EDITOR LAB SUMMARY LAB 2 DEALING WITH CHANGES TO REQUIREMENTS SEEING TRACEABILITY LINKS IN A VIEW FORMATTING VIEW TO SHOW ATTRIBUTES OF LINKED ELEMENTS UNDERSTANDING THE LOCKING GRANULARITY CREATING MODULE BASELINES EXPLORE THE VIEWS IN THE SYSTEM REQUIREMENTS MODULE ON-LINE COLLABORATION USING COMMENTS SUSPECT LINKS AND SUSPICION PROFILES VIEWING THE CHANGE HISTORY OF AN ARTIFACT ESTABLISHING TRACEABILITY USING DRAG AND DROP VIEWING LIVE INFORMATION ON DASHBOARDS OPTIONAL: MANAGE SUSPICION PROFILES EDITOR LAB SUMMARY LAB 3 IMPORTING AND REPORTING LAUNCH THE IMPORT ARTIFACT WIZARD INSPECT THE WORD DOCUMENT TO BE IMPORTED EXPLORE THE MODULE CREATE A PERSONAL VIEW SHOWING TRACEABILITY DOWNSTREAM PRINTING VIEWS IN PDF OR MICROSOFT WORD USING THE DOCUMENT-STYLE REPORTING MENU EXTENSION EXERCISES EXTENSION EXERCISE A: PRINT MODULE BOOK EXTENSION EXERCISE B: EXPLORE SOME OF THE OTHER VIEWS EXTENSION EXERCISE C: MORE DRAG AND DROP LINKING EXTENSION EXERCISE D: MORE CREATE AND PRINT EXTENSION EXERCISE E: TAKE A LOOK AT THE PAYMENT KIOSK PROJECT LAB SUMMARY APPENDIX A. NOTICES APPENDIX B. TRADEMARKS AND COPYRIGHTS Contents Page 3

4 IBM Analytics THIS PAGE INTENTIONALLY LEFT BLANK 4 Rational DOORS Next Generation Open Labs

5 IBM Software Overview This workshop demonstrates how the IBM Systems and Software Engineering solution can help companies reduce the time, cost, and risk of developing profitable products and systems. Participants of this Proof of Technology (PoT) will get hands on experience with the Requirements Management application of the IBM Jazz platform. With rising system & project complexity, organizations and engineering leaders face the difficulty of falling productivity, rising costs and delays when working across multiple functional units, sites, projects and companies. In many cases they also need to raise the overall quality of their delivered system product. Over the course of the Proof of Technology, users will explore how integrated IBM tools support the product development lifecycle, decreasing cost and time to market by: Managing Requirements across the entire lifecycle and disciplines, from stakeholder requirements to system, software and hardware requirements, through to test. Enabling distributed teams to collaborate and communicate throughout the development lifecycle. Enabling projects to be managed effectively, by providing accurate visibility into project health status and team workloads. Automating traceability and auditability by managing artifacts and their inter-relationships across the lifecycle, empowering teams to deliver more value by removing manual tasks. Overview Page 5

6 IBM Analytics Icons The following symbols appear in this document at places where additional guidance is available. Icon Purpose Explanation Important! This symbol calls attention to a particular step or command. For example, it might alert you to type a command carefully because it is case sensitive. Information This symbol indicates information that might not be necessary to complete a step, but is helpful or good to know. Troubleshooting This symbol indicates that you can fix a specific problem by completing the associated troubleshooting information. 6 Rational DOORS Next Generation Open Labs

7 IBM Software Lab 1 RM Fundamentals with a Web Client Requirements management is a proven process for help in ensuring objectives and constraints are translated into project work and project deliverables in an effective manner. Good requirements management can reduce development time, improve control over requirement changes, reduce total project cost, help teams to work more effectively across disciplines (and with higher accountability), reduce rework, and improve quality and time to market. In this section we will look at DOORS Next Generation. DOORS Next Generation is a Jazz-based version which is available at no extra cost to clients with active subscription and support for IBM DOORS. Its features are also available to users with Rational Requirements Composer (RRC) licensing entitlement (as of version 5.0, IBM Rational Requirements Composer was renamed to IBM DOORS Next Generation). IBM DOORS Next Generation incorporates many concepts of DOORS such as modules and views. Unlike DOORS, it shares common components, license management and server architecture with other Jazz products such as IBM Quality Manager and IBM Team Concert. For some organizations this can simplify the deployment of a tightly integrated lifecycle management solution; it installs with a single installation method and uses a commercial repository backend. The Jazz-based products make extensive use of web clients - removing the need for client installation and broadening the accessibility of requirements to a wider range of stakeholders. In this lab we will give participants a hands-on opportunity to use the web client. We learn about accessing a requirements project, finding requirement details, creating views and some basic editing of artifacts. Some of the biggest problems facing many development organizations are poor requirements that is having no requirements, the wrong requirements or gold plating the requirements. Collaboration between stakeholders is an important enabler to help reduce project risks by focusing on improving the transfer of knowledge and expertise in a team. As part of this, IBM s Jazz strategy makes strong use of web clients to reduce the deployment burdens of getting wider stakeholders involved in participating in a team. Web browsers facilitate multi-disciplinary collaboration, enabling stakeholders who don t normally have tools installed, domain specialists, and even customers to collaborate. Associated with this is capturing key design decisions as you go as well as an audit trail so that rationales and knowledge can be traced to decision points. Corresponding videos similar to subsequent labs are available on IBM s developerworks pages. The following video can be used as a rough reference although some changes have been made to the flow in this workbook to highlight enhancements since v4.0.: Lab 1 RM Fundamentals with a Web Client Page 7

8 IBM Analytics 1.1 Explore the dashboard for the Meter Reader Requirements In this first section we take a look at the Dashboards capability of Jazz-based products to display succinct real-time information about a project and to communicate status information across a team to enhance collaboration. Project and personal dashboards are a key component of all Jazz-based products. They provide realtime information on individual tasks as well as insight into overall project status, traceability coverage, risk and more. 1. Launch the Jazz/RM web client and login as Pete. a. Use the Clients > Requirements Management shortcut in the taskbar to open the Requirements Management application. b. Login as Pete, the project manager, with the username pete and password pete. 8 Rational DOORS Next Generation Open Labs

9 IBM Software c. This loads the All Projects page listing all the Requirements Management (/rm) projects that we have been granted access to. Because Pete has the necessary permissions, it provides links to navigate to manage project areas for each project to perform administration tasks (don t navigate yet). d. Each project has its own dashboard. Scroll down, and choose Explore Dashboard for the Meter Reader Requirements project. e. Dashboards provide information about the project status at a glance as well as options to drill down to get more complete information associated with individual queries. As well as assisting management and whole team collaboration with project transparency, they can also assist with on-boarding new team members, and as a single source where the team can find information about the project using only a web client. Lab 1 RM Fundamentals with a Web Client Page 9

10 IBM Analytics f. It s possible to have personal and project dashboards. This is a project dashboard. g. For your information Personal Dashboards are accessible via the Home menu in the top left (we ll stick with the Project Dashboard though). 10 Rational DOORS Next Generation Open Labs

11 IBM Software h. There is also a mini dashboard to the left of the page that can be popped out by clicking on it. This dashboard is handy because it s available instantly on any of the screens. 2. Review the reviews. a. Observe the Reviews widget. Pete is involved with one active review, the Recharging handheld review. b. Select the Show all active reviews icon. Lab 1 RM Fundamentals with a Web Client Page 11

12 IBM Analytics c. All reviews that have been started and not yet completed. d. Hover over the Leak detection review title. There are six requirements included in the review. Pete has completed this review, approving four requirements, and abstaining from two. 12 Rational DOORS Next Generation Open Labs

13 IBM Software 3. Action a review. a. Hover over the Recharging handheld review title. This review is for just one requirement and is pending review approval by Pete. b. Click the Recharging handheld link to open up the review. c. We can now review the requirement and see an option to Approve, Disapprove, or Abstain. Lab 1 RM Fundamentals with a Web Client Page 13

14 IBM Analytics One of the key ways that IBM DOORS Next Generation can assist with business challenges is through enhanced collaboration. Communication and collaboration is central to the objective to improving requirements definition and understanding. Use of reviews and comments are part of this. They provide an audit trail of why decisions are being made for both live progress tracking as well as downstream audits against process compliance. Of course, different projects will have different needs in terms of rigor. 4. Approve the review with comments. a. Check the box in front of the requirement. b. With requirements selected, the option to Approve, Disapprove, or Abstain approval of the requirements is no longer greyed out. c. Click Approve with Comments. 14 Rational DOORS Next Generation Open Labs

15 IBM Software d. Type the Comment: I ll approve, but can you make sure we set the Priority as High? e. Click Approve to close the Comment dialog. f. Verify that review is showing 100% complete and the status of all the requirements is approved. g. Click Done to commit the changes. Lab 1 RM Fundamentals with a Web Client Page 15

16 IBM Analytics h. Click Yes to confirm the review is done. 5. Navigate back to the project dashboard. a. Click the Project Dashboard link in the main menu to go back to the project dashboard. b. Click the Refresh icon to reload the Dashboard. c. Switch to Show all active reviews again. The Recharging handheld review status has changed to indicate it is complete. 16 Rational DOORS Next Generation Open Labs

17 IBM Software d. The Comments widget provides a feed of recent activity. Dashboards are customizable to meet both project and individual needs. Dashboards provide transparency of information and are customizable for different roles. You can have a personal dashboard as well as project dashboards. 6. A dashboard can optionally harvest information from any of the Jazz applications or projects on the server. Let s add a widget. a. Click Add Widget in the top-right of the dashboard. Lab 1 RM Fundamentals with a Web Client Page 17

18 IBM Analytics b. Pull-down the catalog selection list to view the Jazz applications installed. As well Jazz/rm, the following applications are also running on this Jazz Team Server. Jazz/ccm For managing change requests and tasks, as well as software configuration management (SCM) of source files and builds. Jazz/qm For managing test plans, test cases and results, and their associated development and review. Jazz/dm An optional component, for managing or publishing Rational Rhapsody and other models to a web server. jazz/relm The IBM Engineering Lifecycle Management (RELM) solution for reporting and presenting OSLC link information across multiple tools. Some aspects of Jazz products are common to multiple tools, such as user management and sign on, dashboards. For example, licensing for IBM Quality Manager Quality Professional licensing entitles the user to use the planning and work item features of the Jazz/ccm application and some aspects of Jazz/rm. Licensing for Collaboration Lifecycle Management Practitioner licensing allows users full capabilities of Jazz/ccm, Jazz/rm and Jazz/qm applications. c. Choose Change and Configuration Management (/jazz) from the pull-down list. 18 Rational DOORS Next Generation Open Labs

19 IBM Software d. Click on the Plans category. e. Click Add Widget to add the widget called Plans. Lab 1 RM Fundamentals with a Web Client Page 19

20 IBM Analytics f. Click the x in the top-right to close the Add Widget selector and return to the dashboard. g. Verify that the widget was added. It is not currently scoped to a project area. h. Click on the preferences link to scope the widget to a particular plan. i. Choose Select to pick a scope. 20 Rational DOORS Next Generation Open Labs

21 IBM Software j. Pick the Meter Reader Planning > Requirements Analysis Team. Select OK to close the preferences dialog. k. You can now see the plans scoped to this team. DOORS Next Generation licensing includes Read/Write access to all the work item, planning and dashboard features in the /ccm application. There is also Read access to the other applications, for example, to comment on reviews of test plans and test cases without requiring additional licenses. Lab 1 RM Fundamentals with a Web Client Page 21

22 IBM Analytics A plan is a set of work items with a schedule. If you click to enter the plan then you would see that you can view the work items in multiple ways. For example, the Work Breakdown view shows progress of Work Items against owners. The steps for exploring the plan are skipped for the purpose of brevity in this lab. If you have time later then you could perhaps return to the dashboard and click on the plan here to explore it in more detail. 22 Rational DOORS Next Generation Open Labs

23 IBM Software 7. It makes sense for the more useful widgets to be in the top left area. Optionally reorder the widgets and save the Project Dashboard. a. Check the dashboard looks similar to this: b. a. Pete has now made a change to the dashboard. It s important to save this before proceeding. Click the Save button in the top-right of the dashboard. Lab 1 RM Fundamentals with a Web Client Page 23

24 IBM Analytics 1.2 Checking out the Home menu DOORS Next Generation is built on the Jazz web server architecture. This means that it is designed to work over the internet, or secure private wide-area networks. The first thing to note, therefore, is that the client is entirely web browser based and requires no client installations. The same server architecture can be shared with other Jazz applications and is capable of supporting not just requirements but also managing tests and test plans, design artifacts, configuration management of files and change management and defect tracking. 1. View the Home menu. a. Jazz-based products provide a variety of mechanisms to access the same data. One useful way is via the Home pull-down menu. Here, for example, you can access personal dashboards or dashboards of other Jazz projects. b. Jazz offers common user management, licensing, installation and backups, helping to reduce IT costs and easing system administration. 24 Rational DOORS Next Generation Open Labs

25 IBM Software c. Return to the Project Dashboard before continuing. 1.3 Exploring a module In this section we will explore the IBM DOORS Next Generation requirements project in more detail. We re going to look further at the 7 Fundamentals of Requirements Management: Granularity, Attributes, Hierarchy, Traceability, Collaboration, Security and Audit Trails, and Reporting. 1. Browse the Artifacts. a. Choose Artifacts > Browse Artifacts from the main menu. Lab 1 RM Fundamentals with a Web Client Page 25

26 IBM Analytics a. So why do we care about Requirements Management? Well, many industry studies highlight the importance of good requirements management. Get requirements right and we can reduce risk to improve the predictability of our projects, satisfy our customers and ensure that our systems we re building are safe. 26 Rational DOORS Next Generation Open Labs

27 IBM Software b. Initially, we see the root folder with no artifacts displayed. Lab 1 RM Fundamentals with a Web Client Page 27

28 IBM Analytics 2. The folders here enable us to organize the structure of the project and are similar to folders on a file system. The usage here is one part of the hierarchy fundamental of Requirements Management; the organization of large volumes of data and separation of concerns between different stakeholder communities. a. Click on the folders. The artifacts shown are filtered to only show elements in the selected folder. For example, the 02 Reference folder contains an AMR Standards Documents specification. 28 Rational DOORS Next Generation Open Labs

29 IBM Software b. Folders have options on their pencil menu including, for example, Assigning Team Ownership and creating and deleting them. 3. If we click on the 01 Requirements folder, we can see that it contains four requirement modules. a. Click on the 01 Requirements folder. Lab 1 RM Fundamentals with a Web Client Page 29

30 IBM Analytics b. The workspace has collapsable panes to both the right and left. If needed, collapse the right pane in order to make more room. 30 Rational DOORS Next Generation Open Labs

31 IBM Software 4. Modules are another way of managing data, this time in a hierarchical document-like structure. If we hover over the module name then a rich hover appears showing us more information, including a preview of its heading hierarchy. a. Hover the mouse over the AMR Stakeholder Requirements Specification to view the rich hover. The format is a Module. A module is type of collection that has a documentlike structure. Lab 1 RM Fundamentals with a Web Client Page 31

32 IBM Analytics b. The Type for this module is Stakeholder Specification. This is a project-specific artifact type. Types allow us to customize attributes, icons and preferred contents and link types. 5. Some of the modules here have been imported from existing Word documents using the import wizard here. A range of import options are possible. a. The Import Artifact wizard is accessed in the Artifacts menu 32 Rational DOORS Next Generation Open Labs

33 IBM Software b. c. You could launch the Wizard and look at the options. However, this step is skipped for the purposes of brevity for the initial walkthrough. In Lab 3, we ll revisit Importing. Return to the module browser view. 1.4 Understanding modules One of the key fundamentals of Requirements Managements is granularity; the ability to manage requirements at the atomic level. As experts in Requirements Management, we know it s not sufficient to trace between documents. We need to be able to break things down to a finer level of granularity and assign unique identifiers; both for process compliance but also to enable basic project control. 1. If we click on the module then we can start to appreciate more how DOORS Next Gen supports this. a. Click on the AMR Stakeholder Requirements Specification to open it up. Lab 1 RM Fundamentals with a Web Client Page 33

34 IBM Analytics b. The module should open. In this instance we are looking at a document that captures the needs of the stakeholders of the system. Stakeholders may be users of the system. Other examples of stakeholder requirements are industry standards or constraints. Usually a well written user requirement does not state what the system is, rather what the user wants from the system. Of course, writing good requirements is something that requires experience. If you do not see the requirements as shown below, load the default view by selecting the eraser icon. We ll cover views later. 34 Rational DOORS Next Generation Open Labs

35 IBM Software c. The first thing to emphasize is that in Jazz, the ID numbers are unique to the database, opening up some interesting new capabilities we ll touch on later. 2. The module format consists of a structure with a heading hierarchy that we can collapse and expand by clicking on the arrows, or clicking on the icons to the top left. a. Click on the arrows to collapse and expand the Intended Use and other sections. Lab 1 RM Fundamentals with a Web Client Page 35

36 IBM Analytics b. Click on the Show 1 Level of Hierarchy icon above the module to collapse the tree to 1 Level only. 36 Rational DOORS Next Generation Open Labs

37 IBM Software c. Click on Show Full Hierarchy so that all the elements are shown before proceeding to the next section. Modules allow us to see the requirements and their attributes together and inline, facilitating easy editing of text and customizable views looking at the same data in different ways. 3. A handy feature we can use with modules is called Create and Print. a. Locate the Create and Print icon above the module. Lab 1 RM Fundamentals with a Web Client Page 37

38 IBM Analytics b. This has three options available. This will print the view of the module currently active as a book or table in PDF or Microsoft Word format. c. Click on Create and Print Microsoft Word Document Various options are provided, for example, choosing whether to include comments and/or attribute information. d. Printing is covered in Lab3. For now, we ll skip the steps to actually generate the document. If you have time later, you might want to return the module and try it out. Click Cancel. 38 Rational DOORS Next Generation Open Labs

39 IBM Software 4. As we scroll down you may notice that the information is loaded when needed. DOORS Next Generation is natively built as a web 2.0 application. It is dynamically paging information in the background, and is designed to cope with large volumes of data and wide area distribution. 5. We can see that this module contains a rich array of artifact types, including a use case diagram, a table, and some images. a. Inspect the contents of the module by scrolling. Lab 1 RM Fundamentals with a Web Client Page 39

40 IBM Analytics 6. If we look at the use case diagram then we can see that it is more than just an image. It was created using one of the graphical editors and the graphical elements on it are linked to other artifacts in the project. a. Click on the ID number or the element name in the rich hover in order to open it up. b. Hover over the elements on the diagram. Note how they are linked to artifacts in the project. The use case diagram here is one of the diagram types supported by the graphical editors. Graphical editors enable you to visually elaborate requirements in business process diagrams, use case diagrams, user sketches, or storyboards. DOORS Next Generation v6 provides expanded Visio-like drawing capabilities, with configurable palettes of shapes. 40 Rational DOORS Next Generation Open Labs

41 IBM Software c. Return to the module by clicking the Go back one page arrow in the browser. d. Verify the module is shown. 1.5 Finding things in projects and modules There are a variety of ways to find things fast. We can search both across projects, within a project and within a module. 1. A quick look at the Quick Search. a. Locate the Search Projects control in the top right of the DOORS Next Generation window. Lab 1 RM Fundamentals with a Web Client Page 41

42 IBM Analytics b. Click in the text field and type: detect water leaks. This does a search of all the projects (However, it will navigate you to the folder rather than module). There are various options also available. For example, to confine search to a particular project and via the More Options menu. Or via the More Options menu. 42 Rational DOORS Next Generation Open Labs

43 IBM Software 2. We can limit the search to an individual module using the Find/Go To dialog on a module. Let s return to the module and find the requirement that contains the text detect water leaks using this. a. Load the default view again. b. Click on the Find/Go To magnify glass icon to the top right on the module. c. Type the text detect water leaks and click Find (or ENTER). Lab 1 RM Fundamentals with a Web Client Page 43

44 IBM Analytics d. Verify that the requirement was found. If not ensure that full hiearchy is shown and/or choose Wrap search. e. Close the Find dialog. 44 Rational DOORS Next Generation Open Labs

45 IBM Software 1.6 Viewing traceability in the Links Explorer 1. This Requirement is actually linked to other requirements. We can see traceability graphically using the Links Explorer launched from the Other Actions submenu. a. Click on the pencil icon menu for the detect water leaks requirement we changed earlier. Choose Other Actions > Open Links Explorer. b. A diagram view of related links dialog should be opened. Lab 1 RM Fundamentals with a Web Client Page 45

46 IBM Analytics 2. Here we can see how the stakeholder requirement traces to this system requirement and if we click on the plus sign to the right of the system requirement then we can see how the links to lower level requirements cascade down a hierarchy. a. Click on the + sign to the right of the System Requirement. Large systems are usually developed by multiple teams formed from different engineering disciplines. A hierarchy of requirement levels essentially enables us to manage complexity. The different requirement levels represent the work owned by different teams working on the same problem and provide a way of separating the concerns of each team. The traceability allows us to drill down from the abstract view to the detail; connecting data to ensure the integrity of the work as a whole. b. As well as traceability, what the Links Explorer is also highlighting is impact analysis; the ripple effect that is likely as upstream requirements change. For example, what may need to change if the customer changes their mind? It s important in any requirements management solution that you re able to cope with inevitable changes since this is invariably about connecting the parts of your organization so that they re able to work as an integrated whole. Understanding impact in advance is also useful in certain contractual situations, since you can begin to estimate the likely cost of change. 46 Rational DOORS Next Generation Open Labs

47 IBM Software 3. The satisfied by links shown here defined using an open standard called OSLC and represent requirement to requirement relationships. OSLC links to other types of artifacts are also possible, such as tests and work items. For example, the stakeholder requirement also traces to a work item of type task. a. Locate the Implemented By linked element. Lab 1 RM Fundamentals with a Web Client Page 47

48 IBM Analytics b. Use the rich hover for the task to view the information. c. We can see that this Task is In Progress and planned for the requirements phase. It is related to the implementation of 4 requirements. Work Items are part of the ccm and planning components that actually comes with DOORS Next Generation. Importantly, if you deploy DOORS Next Generation then you can also use the Jazz features associated with planning; creating tasks or raising defects, assigning work to team members, and viewing and reporting the progress of these on plans and dashboards. 48 Rational DOORS Next Generation Open Labs

49 IBM Software Note that the Links Explorer view is able to show any links that are stored in the Jazz Team Server. It really comes alive when you have traceability to other artifacts in the application lifecycle such as traceability to Work Items, Test Cases, and Design Artifacts. d. Close the Diagram view of related links dialog. Lab 1 RM Fundamentals with a Web Client Page 49

50 IBM Analytics 1.7 Adding columns to a view Modules are displayed with information presented in columns. We can easily add or remove the information shown. 1. Let s add a column to show the Artifact Type and where it is used; both very important aspects associated with how granularity works. a. Click the Configure Page Settings icon from the top left of the module.. b. In the drop down list, choose Artifact Type. c. Repeat the steps to add Used in Modules. 50 Rational DOORS Next Generation Open Labs

51 IBM Software 2. While we re here, we ll also add columns for priority and comments. a. This time choose Configure Columns to Display 3. By starting to type the name of the attribute that we want, we can filter the list to find it, and then click Add to move it to the Columns shown list. a. Type pri so that the Priority attribute is shown. b. Double click (or click Add) to add it to the columns to show list. Lab 1 RM Fundamentals with a Web Client Page 51

52 IBM Analytics c. Repeat the steps to add the Comments attribute also. d. Click OK to close the Change Column Display Settings dialog and update the table view. 1.8 An overview of requirement re-use In IBM DOORS, requirements are stored in modules and their IDs are unique to the module. In IBM DOORS Next Generation, requirements are referenced by modules, rather than stored in them, and their IDs are unique to the database. This means that it is possible for the same requirement to be re-used in multiple modules. This creates some interesting new opportunities. 52 Rational DOORS Next Generation Open Labs

53 IBM Software 1. When the view refreshes the Used in Modules column will display an icon if the artifact is used in more than one module. a. Hover over the column titles to locate the Used in Modules column. b. Scroll down to find the first requirement where an icon is present in this column. c. Hover over the icon to see where else the element is used. Lab 1 RM Fundamentals with a Web Client Page 53

54 IBM Analytics DOORS Next Generation has built-in support for re-using requirements, without the need for scripting or product extensions. Although it supports scripting and product extensions the need to write any is greatly reduced in DOORS Next Generation. The functionality here draws on over 20 years of experience as market leaders in complex systems requirements management. DOORS Next Generation 6 extends the reuse concept to full configuration management, using streams to manage product variants across the development lifecycle. d. Right click to Open Link in New Window for the 478 Requirements for Reuse link in the rich hover. 54 Rational DOORS Next Generation Open Labs

55 IBM Software e. The 478: Requirements for Reuse module should be shown. f. This is a separate module inside the 01 Requirements folder. We can tell its location from the breadcrumb control at the top. g. Explore the module. If you want, add a Used in Module column. When you re finished, you can close the Requirements for Reuse window (to return to the previous window). Lab 1 RM Fundamentals with a Web Client Page 55

56 IBM Analytics h. Verify that you re looking at the 479: AMR Stakeholder Requirements Specification. i. The columns you add earlier should still be shown. 56 Rational DOORS Next Generation Open Labs

57 IBM Software 1.9 Artifact types and attributes 1. Note in the Artifact Type column that the artifacts in this module are not all of the same type. Some of the artifacts here are for headings or information only, while others are formal stakeholder requirements. Lab 1 RM Fundamentals with a Web Client Page 57

58 IBM Analytics 2. If we hover over the IDs in the table, then a rich hover provides more detail about the related artifact, including its attributes. Stakeholder Requirements have a different set of attributes than Headings. This makes perfect sense, of course, because there is little point in tracking the priority of a heading artifact. a. Hover over an artifact of type Stakeholder Requirement. It has a large set of attributes including Priority, Schedule and Status (many of these haven t been set yet). b. Hover over an artifact of type Heading. It has virtually no attributes. 58 Rational DOORS Next Generation Open Labs

59 IBM Software 3. The use of attributes is another key requirement management fundamental; attributes are used to control your process. a. We can set attributes in the column. Click in the Priority cell for a Stakeholder Requirement and set the Priority as High. b. We can also multi-select to set attributes. Check the selection boxes to the left of two other Stakeholder Requirements and choose Edit the attributes for 2 Artifacts from the pencil icon menu. Lab 1 RM Fundamentals with a Web Client Page 59

60 IBM Analytics c. Set the Priority to Medium for these. d. Click Save to close the dialog. e. Your changes should be shown. 60 Rational DOORS Next Generation Open Labs

61 IBM Software 4. We can also click on the column title to apply ordering to the displayed artifacts. a. Click on the Priority column so that the aritifacts are listed in Priority Ordered descending (you need to click twice for this) Filter by attribute 1. The table is currently showing all the artifacts regardless of type. We can filter this list, for example, to only show Stakeholder Requirements. This is useful when trying to understand coverage completeness, since you re only really concerned with artifacts that are formal requirements rather than just for information or structure. Lab 1 RM Fundamentals with a Web Client Page 61

62 IBM Analytics a. Load the default view again. b. All artifact types should be shown, including headers and requirements. c. Click on the Filter by Attribute panel to the left. d. Click to filter on Artifact type. 62 Rational DOORS Next Generation Open Labs

63 IBM Software e. Check the boxes for Stakeholder Requirement and System Requirement. f. Click Apply to update the view. g. Artifacts of type Heading have been removed from the list. Lab 1 RM Fundamentals with a Web Client Page 63

64 IBM Analytics 1.11 Saving a shared view you ve created Views are something that users with the correct permissions can create to suit their particular needs or their job role. Views can contain attributes and/or relationships in the columns. For example, there may be views relating to aspects of the lifecycle such as traceability to test, traceability to design, or particular project management or review tasks. 1. We can save any of the layouts we construct and users can recall saved views for the different tasks they might perform. We ll save the current column layout as a new view called Priority Ordered. a. Click on the Views section to expand it (don t click on the eraser icon as this resets the displayed columns!). b. Click on the Save View icon. 64 Rational DOORS Next Generation Open Labs

65 IBM Software c. Enter the name Priority Ordered. We ll create this as a Personal rather than shared view (don t press OK yet). d. Check the box Use in all modules and then click OK. Because attributes are project wide we can also re-use views across different modules. This can be done simply by checking a box; helping to ease the administration of a project that contains many modules. Lab 1 RM Fundamentals with a Web Client Page 65

66 IBM Analytics e. The new view should now be in the list. The color and background indicate that it is a Personal, rather than Shared view. Views are especially important with large volumes of data as they allow us to understand the same dataset in different contexts. Test engineers, Project Managers, and Requirements Engineers will be interested in different attributes and relationships. Users can also create and delete their own private views to support particular tasks they are performing. Since the tool is role-based, it is possible to control which users can create and delete the shared views Project properties editor Different projects may have different attributes they want to record as well as different artifact types. As such, the views we want are also likely to be different. The underlying information model of the artifact types and their attributes is fully customizable. Those with the necessary permissions can do this through the Manage Project Properties editor, accessible from the Administration menu. 1. Access the Manage Project Properties editor. a. Choose Manage Project Properties from the Administration menu in the top right of the window. 66 Rational DOORS Next Generation Open Labs

67 IBM Software b. Verify the Artifact Types editor tab is opened. Lab 1 RM Fundamentals with a Web Client Page 67

68 IBM Analytics 2. Using the Project Properties editor you can customize existing project templates, or build new ones. Here are the Heading and Stakeholder Requirement artifact types that we saw earlier. We could go ahead and add or remove attributes. We can create new artifact types, as well as define the attributes that each type has. a. Click on the Heading type. No attributes are listed. b. Click on the Stakeholder Requirements type. It has a large number of attributes, including Priority (we d need to scroll down in the list to find this). c. 68 Rational DOORS Next Generation Open Labs

69 IBM Software Importantly, the data model used here is project wide, which means that it s not necessary to re-define attributes for each module; rather you can re-use them across the project. This enables views to also be shared across modules. 3. If we look at the Artifacts Attributes tab, we can see that the Priority attribute is typed by an enumeration called HighMediumLow. a. Click on the Artifact Attributes tab. Lab 1 RM Fundamentals with a Web Client Page 69

70 IBM Analytics b. Click on the Priority attribute. It is typed as HighMediumLow. 4. Once we re happy with our information model we can deploy it as project templates that can be used to seed the creation of new projects. A number of templates are defined out of the box that you can use, or you can upload templates that others have shared. a. Click on the Templates tab. 70 Rational DOORS Next Generation Open Labs

71 IBM Software b. One of the samples listed here is the Meter Reader Requirements Sample. The project we re using here was initially created from this template. c. To save/export a project template, there is an option to create a new template based on the project or to import a project template, select Upload Template to bring in what others have shared. You can also create Artifact templates, for example, to create boilerplate text and structure for particular types of module. Lab 1 RM Fundamentals with a Web Client Page 71

72 IBM Analytics 5. We ve finished this lab. a. Close the Firefox window (but be careful not to close any of the console windows for the servers). 72 Rational DOORS Next Generation Open Labs

73 IBM Software Lab Summary In this lab we explored some of the features of the web client for IBM IBM DOORS Next Generation, highlighting how the heritage of the IBM DOORS product has been incorporated into the Jazz-based product through features such as: The use of modules to group formal requirement artifacts into a document-like structure along with other contextual information such as headings, information and images, and tables. The use of views to visualize requirement information in a tabular format appropriate to different needs. We also explored a number of features that are different between IBM DOORS Next Generation and IBM DOORS, for example: The use of dashboards to display and access real-time project information, and common user management and licensing across multiple applications. Wide use of web clients to reduce deployment costs and widen the range of stakeholders who can contribute on a project. Requirement id s are database, rather than module, wide (allowing requirement re-use across multiple modules). Graphical editors for capturing requirement-related diagrammatic information such as use case diagrams, business process diagrams, and user interface sketches. The platform that DOORS Next Generation is built on is called Jazz and was designed as a collaboration platform. IBM DOORS Next Generation shares a similar look and feel as other established Jazz-based products such as IBM Team Concert and IBM Quality Manager. Features such as on-line comments, feeds and dashboards help support this role. For more information on Jazz and Jazz-based products, visit the Jazz Community Site. End of lab exercise Please wait for the instructor before moving onto the next lab Lab 1 RM Fundamentals with a Web Client Page 73

74 IBM Analytics THIS PAGE INTENTIONALLY LEFT BLANK 74 Rational DOORS Next Generation Open Labs

75 IBM Software Lab 2 Dealing with changes to requirements So far we ve looked at granularity and attributes in detail, and touched on hierarchy, audit trails and security. Let s delve a little deeper now to get to the core of requirements management and the requirement management fundamentals of hierarchy and traceability. Hierarchy can be thought of in two ways. We ve already seen structural hierarchy in action through the ability to organize artifacts in folders or using modules with a heading structure. Another form of hierarchy is abstraction and layering. Abstraction allows us to manage complexity and requirements should always be written with a perspective in mind. Stakeholder requirements are formal statements of user need and usually owned by the customer or a product manager, or represent standards the system must conform to. It s usually the purpose of a lower level requirement to say how these needs will be met. In this lab we continue our exploration of traceability and how we flow information between teams when requirements start to change in a dynamic team environment. We ll view traceability in a table, make use of drag and drop to establish traceability, as well as see how team members working at different levels are notified that changes have occurred. At the end we ll see how the dashboard has started to come alive with the changes made so far, and how the collaboration features such as dashboards and suspicion profiles help keep everybody notified without the need for onerous manual steps. 2.1 Seeing traceability links in a view In this section we will also look in more detail at some views that were already created for the project to show traceability relationships 1. Launch the Jazz/RM web client and login as Pete. a. Use the Clients > Requirements Management shortcut in the taskbar to open the Requirements Management application. Lab 2 Dealing with changes to requirements Page 75

76 IBM Analytics 2. Login as Pete, the project manager, with the username pete and password pete. a. This loads the All Projects page listing all of Pete s Requirements Management (/rm) projects. b. Scroll down, and choose to Show Modules for the Meter Reader Requirements project. 76 Rational DOORS Next Generation Open Labs

77 IBM Software c. Locate the 479: AMR Stakeholder Requirements Specification and click on the link to open it up. 3. We can view traceability to downstream artifacts in a view. a. Click on the Trace to System Requirements view. b. A column is now showing downstream requirement artifacts that satisfy the given Stakeholder Requirement. Lab 2 Dealing with changes to requirements Page 77

78 IBM Analytics c. We can hover over the link to see more information. For example, the Priority and Verification Method. 2.2 Formatting view to show attributes of linked elements 1. We can also show attributes of linked elements in the related cell. a. Click the Configure Page Settings icon to the top left of the module and click Configure Columns to Display. 78 Rational DOORS Next Generation Open Labs

79 IBM Software b. Highlight the Satisfied by relationship and click Format. c. Choose to show the Priority and Verification Method attributes of the linked element. d. Click OK to close the Format Link Display Column dialog. Lab 2 Dealing with changes to requirements Page 79

80 IBM Analytics e. Click OK to close the Change Column Display Settings dialog and update the displayed columns. f. The attribute values for the linked element are now shown under the associated linked element. In much of DOORS Next Generation a focus has been placed on providing simple user interface controls to add or remove data from the display. This means that the functionality is available for use straight out-of-the-box with less expert knowledge. 80 Rational DOORS Next Generation Open Labs

81 IBM Software 2.3 Understanding the locking granularity 1. We can edit elements or their attributes directly in the view by double clicking in the cell. As we make an edit, you ll notice that the locking is at individual artifact level rather than module level. A lock is taken implicitly when we begin editing and released when we re finished. a. Scroll to the bottom of the view. The last requirement listed in this view relates to detecting water leaks. It says The water interface shall detect water leaks and record leak status with the account data. b. Double-click in the cell for the detect water leaks requirement text. A rich edit control appears and a lock is taken implicity at this point. The granularity of locking is very different from IBM DOORS and very different from that possible with spreadsheets and text documents. When we edit a requirement, the lock is automatically taken on the artifact. We don t need to lock the module in order to make updates and the type of lock we re using here is transient; taken when we begin to edit and released when we re finished. This type of implicit locking is not persisted between sessions. The finer granularity/transient locking helps to reduce the conflicts between users as the module is evolved. Lab 2 Dealing with changes to requirements Page 81

82 IBM Analytics c. Highlight the text meter interface and choose Insert. d. Choose Lookup Term. e. Select the Meter Interface glossary term. 82 Rational DOORS Next Generation Open Labs

83 IBM Software f. Single click on another requirement. The save is completed and the lock released. This fine granularity of transient locking means that conflicts are very rare. The user doesn t need to make choices about whether to open a module with exclusive edit. Team members can work in parallel on the same module across a wide area network, something impossible with documents on a file system. 2. We ve made a simple change to this requirement using the rich edit control to change the meter interface text to use a glossary term. a. Hover over the Meter Interface glossary term. A rich hover provides a more detailed description of the glossary term. This helps to clarify, for example, that we are referring to a physical device here, rather than say an actor. Glossary terms can be used to enrich understanding and improve the consistency of information. Lab 2 Dealing with changes to requirements Page 83

84 IBM Analytics 2.4 Creating module baselines Of course, a full audit trail is also captured and can be viewed; both on the individual artifact level or for the artifact in a module. We can also choose to baseline the module, or look at previous versions. This touches on another fundamental of requirements management - the capture of audit trails and history to ensure the security of the changes. 1. Viewing baselines. a. Expand the right information sidebar. b. At the bottom of the sidebar, click on the Module Baselines section to expand it. 84 Rational DOORS Next Generation Open Labs

85 IBM Software c. A baseline of the module has already been created. A module baseline is a snapshot of a module at a moment in time. Hover over the baseline number to view the name in a hover. d. Pete can create a new baseline in the Module Baselines tab here by clicking on the icon called Create a new baseline for this module. Click on the icon to launch the create module baseline dialog. Lab 2 Dealing with changes to requirements Page 85

86 IBM Analytics e. Change the Version to 0.2 (next minor number) by picking it from the pull-down list. f. Click OK to create the baseline. 86 Rational DOORS Next Generation Open Labs

87 IBM Software g. Click Close to close the dialog (you don t have to wait since the baseline will be created in the background). In Jazz products, we can control who is able to perform tasks by assigning permissions to a role and then roles to a user. Since Pete has the project administrator role, then he is able to create module baselines. Role-based development is another concept intrinsic to Jazzbased applications. Roles enable us to define just the right amount of rigor needed based on a given development methodology. We can tailor these according to the project s needs and the project stage. We can also partition a project and give different permissions to different sub teams. Enabling the correct level of ceremony automatically on a project enables individuals to work collaboratively in teams. Having role based controls also helps when on-boarding new members by limiting the work to their role and automating aspects of process enforcement. Lab 2 Dealing with changes to requirements Page 87

88 IBM Analytics 2.5 Explore the views in the System Requirements module 1. Let s navigate to the downstream element by opening it in a new window. a. Right-click the downstream link for the detect water leaks requirement. Choose Open Link in New Window (we will keep the existing Window open). b. A new window for the downstream module should open. In this window you should be looking at the AMR System Requirement Specification. System requirements tell us what system we re going to build for the client in order to meet the user requirements. c. The downstream artifact you navigated to is highlighted. 88 Rational DOORS Next Generation Open Labs

89 IBM Software d. The Priority Ordered view that we created earlier is also available in this module. Click on it to update the module view. e. The priority ordered list is displayed. Most of the requirements don t have a priority set. This module contains mostly System Requirements. The ability to reuse views in DOORS Next Generation means that it is easier to maintain the project. The ability to reuse views is possible because attributes can be shared across modules. Lab 2 Dealing with changes to requirements Page 89

90 IBM Analytics 2.6 On-line collaboration using comments One of the key things about Jazz is that it s a collaboration platform designed for improving communication between people and teams. In this section we look at one of the collaboration features of IBM DOORS Next Generation, based on on-line commenting and discussion. 1. Of course, prioritization often means soliciting opinions for a wide range of stakeholders. Let s also add a comment to the requirement. a. When we created this view, we added a column for Comments. Click on the comment icon for the requirement currently marked as Low priority. b. The Create comment for dialog is launched. 90 Rational DOORS Next Generation Open Labs

91 IBM Software c. Add the comment: I think this should be High priority. d. Click OK to save the comment: e. The comment is shown in the Artifacts Comments panel. On-line discussions can record communication between people; whether that is direct with your customers or internally across different stakeholders and domain experts in your organization. The use of web server technology here means that users can collaborate, and that their comments and views are captured and visible to all rather than lost in s or chat windows. Lab 2 Dealing with changes to requirements Page 91

92 IBM Analytics 2. At this point, we re touching on the collaboration fundamental of requirements management; bringing people together. This increases your chance of getting the requirements right, a factor that can have a significant impact on your project timescales and customer satisfaction levels. a. Click to Collapse the properties pane. b. We can also read or reply to the comment in the column by hovering over the icon. 92 Rational DOORS Next Generation Open Labs

93 IBM Software 2.7 Suspect links and suspicion profiles A suspicion profile identifies a set of link types, artifact types, and attributes to watch for changes. When artifacts that match the profile criteria are changed, the linked artifacts are marked with a suspicion indicator to alert team members of possible impact of the change. Administrators can create multiple suspicion profiles that correspond to different roles or areas of interest in a project. 1. Locate the downstream requirements affected by the change we made earlier. a. Switch to the Trace to Stakeholder Requirements view. b. This shows the upstream traceability in a column, i.e. Satisfies links to Stakeholder Requirements. Lab 2 Dealing with changes to requirements Page 93

94 IBM Analytics c. Scroll down to find the artifact that traces to the detect water leaks requirement that we changed earlier. We can find this because it has a suspect link indicator next to it. What this is saying is that the linked-to requirement has changed since the link was established; hence, the system requirement may require changing as well. Paper and manual based methods often fail when requirements start to change. Many organizations waste significant amounts of time working in silos and with stale data. d. This suspicion is flagged because we created a suspicion profile to flag when the text or the priority of the stakeholder requirement changed. To assess the suspicion here we could navigate to the element and view its history (for brevity we will skip this step, though). At this point we re getting to the heart of the fundamental purpose of requirements management; the ability to manage teams. Changes to requirements can be healthy, of course, and having the ability to change requirements will increase our likelihood of building the right system. Having smooth ways to flow information between people and provide visibility of the changes that occur in healthy systems development is an important part of this. 94 Rational DOORS Next Generation Open Labs

95 IBM Software 2.8 Viewing the change history of an artifact In this section we navigate to the linked element by opening it in a new window so that we can view the changes that were made to it. 1. Navigate to the stakeholder requirement. a. Right-click on the upstream 171: The meter interface shall detect requirement and choose Open Link in New Window. b. The Stakeholder requirements module is opened and the requirement is highlighted and shown in context. c. Click the 740 ID number to open it up. Lab 2 Dealing with changes to requirements Page 95

96 IBM Analytics 2. View the history for the requirement. a. Click Open History icon in the top right. b. Click on the Audit History tab. c. Click Show changes to the primary text. d. This is the change that we made earlier. In this instance, the requirement s primary text changed to add a link; however, the underlying requirement remains the same. 96 Rational DOORS Next Generation Open Labs

97 IBM Software e. You can Close the Firefox window that you opened to view the changes in now. f. Return to the 480: AMR System Requirements Specification window you kept open. 3. In this instance we know that the change was harmless so we ll clear the flag by clicking on the icon. a. On System Requirement 750, click the icon and choose Clear next to the stakeholder requirement. Lab 2 Dealing with changes to requirements Page 97

98 IBM Analytics b. Refresh the window. The suspicion marks are no longer shown. The idea of suspect links is something that works across the Jazz platform, for example, flagging tests as suspect if the requirements they are linked to change. At this point we re really starting to look at features that are wider than just requirements and where the use of Jazz products together has broader reach (especially the relationship between requirements and tests). 2.9 Establishing traceability using drag and drop There are a number of ways we can establish traceability. For example, we can click in a link cell and an OSLC picker dialog will be launched to allow us to find elements to link to. Another way we can establish traceability is using drag and drop. In this instance we ll first filter the view to find requirements for which we want to establish traceabilty. 1. Find all requirements with the word leak in their text. a. Click the Eraser icon in the Views section to Load default view. 98 Rational DOORS Next Generation Open Labs

99 IBM Software b. Click to Filter by Attribute. c. Filter to only show requirements where the name contains the word leak and click Apply. d. Verify that 7 requirements are listed. Lab 2 Dealing with changes to requirements Page 99

100 IBM Analytics 2. We re now going to use drag and drop between windows. We can use this in combination with the Windows docking windows feature. a. Click to Collapse the left-hand pane. b. Grab the System Requirements specification window and drag it to the right of the screen. 100 Rational DOORS Next Generation Open Labs

101 IBM Software c. Drag the Stakeholder Requirements window to the left. d. Both modules should be shown side-by-side now. Lab 2 Dealing with changes to requirements Page 101

102 IBM Analytics e. Click to Collapse the left and right panes in the Stakeholder Requirements as well so that you can see the requirement text. f. Scroll down to the bottom of the view in the Stakeholder Requirements so that you can see the detect water leak stakeholder requirement we modified earlier. 102 Rational DOORS Next Generation Open Labs

103 IBM Software 3. We re now going to drag and drop the top three requirements in order to create links. a. In the Systems Requirements select artifacts 653, 804, and 488 in the filtered view (you can multi-select by holding down the Shift key down and selecting the first and last). b. Grab the handle bars to the left (with the dots). c. Drag the requirements to the 479: AMR Stakeholder Requirements window and drop them into the Satisfied by column for the detect water leaks requirement that we changed earlier. Lab 2 Dealing with changes to requirements Page 103

104 IBM Analytics d. The detect water leaks stakeholder requirement should now have links to four system requirements. e. Voilà. The links appear! The drag and drop feature between browser windows is a feature very familiar to engineers who use the IBM DOORS product and is a very quick way to establish traceability between documents at different layers of the traceability hierarchy. If your screen size is limited then you could have chosen Open Link in New Tab and performed similar steps to drag the requirements between browser tabs containing different modules. This would have removed the need to collapse the side panels in the views. f. Logout of the web client 104 Rational DOORS Next Generation Open Labs

105 IBM Software g. Close both browser windows (but be careful to leave the server console windows running). In the next section, we re going to finish off by logging in as a different user Viewing live information on dashboards 1. Login as Susan, a requirements engineer working on the Meter Reader Requirements system. a. Choose Clients > Requirements Management from the Windows taskbar to launch a Firefox window. Lab 2 Dealing with changes to requirements Page 105

106 IBM Analytics b. Login as susan/susan. c. Maximize the browser window. 106 Rational DOORS Next Generation Open Labs

107 IBM Software 2. You can see in the top right that we re currently logged in as a user called Susan. This means that any changes that we make will be logged against the user id. It will also give us declared roles and associated permissions for a project, determining the read and write access we have. Each project can have different sets of roles and different permissions, if desired. a. Expand the User Profile section. Here we can see we are logged in as Susan. b. Susan has slightly different permissions than Pete and hence doesn t have the option to Manage Project Area. Role-based permissions are an important aspect of the Jazz platform. Roles and permissions can be defined on a project-by-project basis. Lab 2 Dealing with changes to requirements Page 107

108 IBM Analytics c. Choose Explore Dashboard for the Meter Reader Requirements System. d. Verify that the Meter Reader Requirements Project Dashboard loads. 3. The data on a dashboard is real-time and can be customized to show the information we want. For example, a widget shows recent comments. If we have something to contribute then we can respond by clicking on the icon, enabling us to have discussions with colleagues, where we can debate the rationales and importance of requirements. a. Locate the Comments widget. 108 Rational DOORS Next Generation Open Labs

109 IBM Software b. Click on the first comment listed to expand it. A reply icon appears. c. Choose to Reply to Comment. d. Type the comment I m not so sure.. Lab 2 Dealing with changes to requirements Page 109

110 IBM Analytics e. Click OK to add the comment. f. We need to reload the page to update the data. This can be done by clicking the Refresh button at the top right of the page. g. You need to click on the window to read the Comment text. 110 Rational DOORS Next Generation Open Labs

111 IBM Software The work we perform is captured with the data and hence available for audit and understanding. Widgets like this really come alive in a team context, and hyperlinks help us navigate through the data or perform useful actions. For example, if we had configured we could send an by clicking on the name. 4. Looking on the changes widget, we can see that a full history of changes is being kept by the tool. This goes back to the history and security fundamental. If we click on the change icon in the recent changes list, we can flick through the changes to see what they were and who performed them. a. Locate the Recent Changes widget. Lab 2 Dealing with changes to requirements Page 111

112 IBM Analytics b. Click on the change icon (triangle) to the left of the last change to view information about the changes. We can flick through the changes to an element if there are more than one. Do you recognize any from the earlier lab? 112 Rational DOORS Next Generation Open Labs

113 IBM Software 5. The scope here is wider than just pure requirements management. If a requirement change was linked to a Work Item or a review then this information is also available. a. Locate the Requirements Tracing widget. It is currently showing Implemented By links, i.e. the traceability between requirements and Work Items. b. We ve reached the end of the standard Lab 2 material. If you re ahead of time then you could take a look at the Plans view by clicking on the link (Note that there is a known issue on this particular image with the Taskboard view but the other views have some interesting featues to show). Alternatively, if you re interested in Suspicion Profiles you could perform the steps in the next section. Dashboards enable management to get accurate reports without needing to send around spreadsheets and can be customized to render information from the applications stored on the Jazz Team Server. This means that project status data is transparent and risks can be mitigated early in the process. Lab 2 Dealing with changes to requirements Page 113

114 IBM Analytics 2.11 Optional: Manage Suspicion Profiles editor If you are ahead of schedule and have time, or remain particularly interested in Suspicion Profiles then you could navigate the Manage Suspicion Profiles section before quitting the web client. 1. Open the Manage Suspicion Profiles section. a. Choose Manage Suspicion Profiles from the tools menu. b. If you scroll down you can see that the Requirements Management (/rm) application is Tracking suspicions. 114 Rational DOORS Next Generation Open Labs

115 IBM Software c. If you click on the Meter Reader Requirements link in the EDIT PROFILES section then you can see the Suspicion Profiles that have been defined. Lab 2 Dealing with changes to requirements Page 115

116 IBM Analytics d. Click on the SP1 Watch upstream Stakeholder changes for Systems Engineers profile and inspect the links and changes that are being tracked. Susan may not have the necessary privileges to edit or modify the suspicion profile. To edit the suspicion profile, log out as Susan and log back in as Pete. e. Exit the Firefox client completely when you re finished (but ensure you don t close any server windows). 116 Rational DOORS Next Generation Open Labs

117 IBM Software Lab Summary This brings us to the end of the lab. Of the 7 fundamentals: Granularity allows us to split statements into individual requirements artifacts for the purposes of traceability and tracking. Attributes can then be set to enable planning and status reporting. Hierarchy works in two ways either through abstraction or structure enabling us to organize and understand large volumes of data. Traceability between layers ensures the integrity of the information as a whole and enables large teams to collaborate in parallel. Collaboration features ensure that requirement issues are picked up early and that teams can cope with changes. Access control ensures pertinent information is protected from undesirable change and the audit trails associated are captured automatically as part of everyday work. The final fundamental is reporting; the ability of users to generate business level intelligence reports or to print and save documents for off-line viewing. In summary, DOORS Next Generation is a fully functional web 2.0 requirements management solution. It uses the Jazz web server architecture with a commercial grade repository, and you can align the database used with your company s IT infrastructure for the purposes of resilience, backup, and scaling. It has a centrally defined type system that it user customizable. The type system enables attributes and views to be shared, a simplification over classic DOORS. While the spirit of DOORS is preserved with module support, many features are accessible with simple user interface controls and don t require expert knowledge of scripting. The overall result is a more complete out of the box experience, with reduced training needs, and a more enjoyable user interface. There are also new features such as requirements re-use, and the capabilities that come from Jazz such as dashboards and planning. Lab 2 Dealing with changes to requirements Page 117

118 IBM Analytics THIS PAGE INTENTIONALLY LEFT BLANK 118 Rational DOORS Next Generation Open Labs

119 IBM Software Lab 3 Importing and Reporting In this lab we will look at the ability to import requirements from a Word document, one of a number of import options available. There are a number of options for importing requirements: Import requirements from within a text document Identifies and extracts requirements within the document (Word, Open Office, rich text document). You can also convert the document into a module. There is a YouTube video called Importing Documents into IBM DOORS NG v4.0.1 (9 56 ) - Import requirements from a CSV file Extracts requirements from a CSV file. The import from CSV is quite powerful in that it s possible to create a document heading structure. There are a number of on-line resources on Jazz.net that can help you with this. For example, using the CSV approach is described in the Jazz wiki: Import requirements from a ReqIF file Import requirements defined in a Requirements Interchange Format file. An XML file format that can be used to exchange requirements, along with their associated metadata. We will take a deeper look at document-style reporting. For report-generation, two capabilities that are provided out of the box: Standard-Print for a module (also known as Quick Print) The ability to quickly generate a Word or PDF file. This is accessible via a simple icon menu when you have a module open. A number of properties can be set to include/exclude information. Document-style Reports menu Ability to generate documents using a number of pre-authored templates provided in the installation. The templates were authored using IBM Publishing Engine (RPE). Lab 3 Importing and Reporting Page 119

120 IBM Analytics RPE is a separately licensed template authoring environment that works across the IBM suite (including IBM DOORS, IBM Rhapsody, and Quality Manager etc.). Templates created with RPE can used to generate documents without needing an RPE license. The RPE templates are located in a folder on the server. If you have RPE then the templates listed here can also be used as a starting point for your own templates. It is recommended to leave the factory templates in situ, however, and create copies. More information is available in the Help pages. RPE enables companies to build document templates that can harvest information from more than one source. 3.1 Launch the Import Artifact wizard In this section we login to the web client and launch the import wizard. During the import, the elements of the document will be across different artifacts and different artifact types by detecting the presence keywords. In this instance, we re importing something nominally called a vision document ; an upfront outline of what the user wants to achieve. Vision-type documents tend to be less rigorously defined. A typical process might be to formalize these into better requirements by carrying out a requirements elicitation phase with the customer resulting in a formal stakeholder requirements specification. This could then be reviewed and agreed with the customer before the system starts to be designed, and may form a contractual basis for the project. 1. Login as Susan, the requirements engineer. a. Choose Clients > Requirements Management from the Windows taskbar to launch a Firefox window. 120 Rational DOORS Next Generation Open Labs

121 IBM Software b. Login as susan/susan. c. This time, choose to Show Artifacts for the Meter Reader Requirements. Lab 3 Importing and Reporting Page 121

122 IBM Analytics 1. Choose to import. a. Choose Artifacts > Import Artifact from the main menu to launch the import wizard. b. The Import wizard should launch. 122 Rational DOORS Next Generation Open Labs

123 IBM Software c. A wide range of options are provided, e.g., a text document, CSV file (from spreadsheet) or via the standardized XML-based Requirement Interchange Format (ReqIF). d. Choose to Import requirements from within a text document and click Next >. Lab 3 Importing and Reporting Page 123

124 IBM Analytics e. You should now be on the Select text document page. 3.2 Inspect the Word document to be imported In this section we observe the structure and content of the AMR Vision Document. 1. Locate and open the document to be imported. a. Launch Windows Explorer from the taskbar. b. Locate the AMR Vision Document.doc file in the C:\_DemoData\DOORS Next Generation\Automated Meter Reader folder. 124 Rational DOORS Next Generation Open Labs

125 IBM Software c. Double click to open the document in Microsoft Word. Lab 3 Importing and Reporting Page 125

126 IBM Analytics d. The document has structure in terms of nested headings and paragraphs. 126 Rational DOORS Next Generation Open Labs

127 IBM Software e. Some of the text has keywords, for example, shall, will be, and should. We can use these keywords during the import to treat differently these elements from statements which are just informational. f. Close the Word document. Lab 3 Importing and Reporting Page 127

128 IBM Analytics 2. Drag the file to the list to import. a. Drag the AMR Vision Requirements.doc into the Files(s) section in the import wizard. 128 Rational DOORS Next Generation Open Labs

129 IBM Software b. Ensure the Location for new requirements is the 01 Requirements folder. If not already selected then pick it. c. Select Yes, import the requirements and create a module. d. Check the boxes for Create a separate module for each source and Use source name. Lab 3 Importing and Reporting Page 129

130 IBM Analytics e. Select Requirements Specification as the artifact type for the new module.. f. Click Next > to move on to step 3 of the Wizard. 3. Specify how to identify requirements. a. Select the artifact type of Heading for headings and Information for images. b. Click + Add Keyword to add a keyword. 130 Rational DOORS Next Generation Open Labs

131 IBM Software c. Add the keyword should and make the artifact type to create Vision Statement. d. Do the same for keywords shall and will be (ensure that Vision Statement is selected as the artifact type to create for all of these). e. Scroll down. Lab 3 Importing and Reporting Page 131

132 IBM Analytics f. For all other text, select Information. 4. Extract the requirements. a. Click Next > proceed to analyze and extract the information from the document based on the rules you ve defined. b. When this completes, observe the summary information. It should look exactly like this, i.e. 9 Vision Statements, 6 Headings, 4 Information, and 1 Image. c. This is our opportunity to make any changes we need to the import settings before the artifacts are created. 132 Rational DOORS Next Generation Open Labs

133 IBM Software 5. Create the module. a. Click Finish to extract and import the requirements into the database and create the module. b. Once the extraction has finished click Close to exit the wizard. Lab 3 Importing and Reporting Page 133

134 IBM Analytics c. The view should update and we should now see that we have an AMR Vision Requirements.doc module in the 01 Requirements folder. 134 Rational DOORS Next Generation Open Labs

135 IBM Software 3.3 Explore the Module. 1. Explore the AMR Vision Requirements.doc module. a. Click on the AMR Vision Requirements.doc link to open the module. b. It contains a hierarchy of headings as well as the sequential elements representing the text and images in the document. Lab 3 Importing and Reporting Page 135

136 IBM Analytics 2. Add a glossary term. a. Locate the first text-based artifact, i.e. The company has decided b. Select the artifact s Edit button. c. Verify that a rich text control appears. A lock is taken at this point. d. Highlight the text Automated Meter Reader and click on Insert in the control panel. 136 Rational DOORS Next Generation Open Labs

137 IBM Software e. With the text highlighted choose Lookup Term. f. Click to find terms starting with: A. g. Select the existing Automatic Meter Reader term. Lab 3 Importing and Reporting Page 137

138 IBM Analytics h. Click away so that the change is saved. The Automatic Meter Reader is now shown as linked text. i. Hover over the term to see the meaning. Improving the clarity of requirements helps to reduce ambiguity of requirements and improve the understanding from stakeholders. Often two stakeholders may have different interpretations of the same term. The Glossary features can be used to ensure a common understanding of terms which is crucial for improving requirements definition. 3.4 Create a personal view showing traceability downstream 1. Add a column to view the artifact type for elements. a. Click the Configure Page Settings icon. Locate Configure Columns to Display from the pull-down menu. 138 Rational DOORS Next Generation Open Labs

139 IBM Software b. Add the Artifact Type attribute as well as the Satisfied By link type. c. Click OK to close the dialog. 2. View the Artifact Types. a. Scroll down to where the Vision Statements were imported. Some of the Artifact Types are Headings, some are Information, and others are Vision Statements depending on the choices we made in the module import. If any of the types are wrong then we can correct them after import. Lab 3 Importing and Reporting Page 139

140 IBM Analytics 3. Save the view. a. Expand the Views section and click Save View to persist the layout as a view. b. Save the view you created as a Personal view called Trace to Stakeholder Requirements. Personal views can be created by all users to suit their specific needs enabling them to leverage the configurability of the features available in IBM DOORS Next Generation to their full effect. 140 Rational DOORS Next Generation Open Labs

141 IBM Software c. The View has been saved. The ability to control permissions based on roles and to assign roles to different users means that you can apply a level of control to projects. This helps to prevent unwanted changes from being made by inexperienced or un-authorized users. We can, of course, choose the permissions given to roles to suit the project s needs. 4. Add a Link to the Stakeholder Requirements. a. Locate the Vision Statement The system will be targeted at residential, commercial and industrial customers. Lab 3 Importing and Reporting Page 141

142 IBM Analytics b. In the Satisfied By column, select Edit Links > Add Link. c. The Create Link dialog is prepopulated to create a Satisfied By Link type. d. Select This module and choose the AMR Stakeholder Requirements Specification. e. Search for the word commercial. One artifact is found. 142 Rational DOORS Next Generation Open Labs

143 IBM Software f. Select the artifact and choose OK. g. The link should now be shown in the column. You can use the rich hover to see more information about the linked item. 5. Navigate to the linked item. a. Right-click on the link and choose Open Link in New Tab. Lab 3 Importing and Reporting Page 143

144 IBM Analytics b. This will open up the AMR Stakeholder Requirements module in a new tab. c. Switch tabs so that you re looking at the AMR Stakeholder Requirements Specification. 144 Rational DOORS Next Generation Open Labs

145 IBM Software 3.5 Printing views in PDF or Microsoft Word IBM DOORS Next Generation comes with some standard document generation functionality. In this lab, we will create a PDF document using this capability, and highlight some of its additional functionality. 1. Invoke the standard print function. a. Standard print is sensitive to the view shown. Switch to the Upstream and Downstream Traceability view. b. Choose Create and Print PDF Document in the main toolbar for the AMR Stakeholder Requirements Specification. c. Check both of the boxes to include Comments and Attributes in a PDF document with the Book layout. Lab 3 Importing and Reporting Page 145

146 IBM Analytics d. If you ve not already done so click OK to generate. A progress window will be displayed during rendering. DOORS Next Generation provides this useful print and save capability out-of-the-box. IBM Publishing Engine, a separately licensed tool, would need to be used to author new document formats. e. Choose Open with > Adobe Reader. 146 Rational DOORS Next Generation Open Labs

147 IBM Software f. Once generated, the PDF document should open. g. Scroll down. Note that hyperlinks are added to open the artifacts in the web client if needed. Lab 3 Importing and Reporting Page 147

148 IBM Analytics h. Since we checked the Attributes option prior to generation, the document also contains hyperlinks to the requirements that are linked to an element. It s possible to click on these links to navigate to them in the web client. i. Close the PDF document when you ve finished looking at it. 148 Rational DOORS Next Generation Open Labs

149 IBM Software j. Close any open dialogs to return to the module. 3.6 Using the Document-style Reporting menu In this section we explore more document-style reporting. 1. There are also a number of out-of-the-box document style reports available from the main Reports menu. a. Click on Reports > Generate a Document-Style Report. Lab 3 Importing and Reporting Page 149

150 IBM Analytics b. A number of default templates that are provided out of the box. For example there are options to Print Module Book or Print Module Table in the list of Available reports. These templates are provided out of the box in a folder in the Server installation. It is possible to create your own templates with IBM Publishing Engine (RPE) and add them to the list shown without stopping and restarting the server (by running an admin command to refresh the list). c. d. This concludes the formal lab steps. If you have time then pick a topic of interest from the extension exercises listed in the next section. When you re finished, close the PDF or Words documents you created and any open DOORS Next Generation windows (be careful not to close the server windows). 150 Rational DOORS Next Generation Open Labs

151 IBM Software 3.7 Extension Exercises By now you should be much more familiar with the user interface and how to navigate around. If you have time, the following challenges are provided to provide insight and exercise your knowledge Extension exercise A: Print Module Book Try generating reports using the Print Module Book template in the Document-style Reports menu Extension exercise B: Explore some of the other views Have you looked at the other views in the Meter Reader Requirements project? For example, the Gold Plating view in the 13: AMR System Requirements Specification which shows requirements that exist but have not been traced to any system need. Analyzing this list may help us reduce unnecessary development cost and time, enabling us to focus on the things that are really important to the customer. If something really is important to the customer, then you could argue that it ought to be in the stakeholder requirements since it is the stakeholder requirements that would normally trace to acceptance testing. Increasing the level of rigor in how to manage requirements can therefore help to reduce project risk and the chance that you build the wrong system or spend effort on things that are not needed. The Verification view is also interesting. It shows that the requirements are Validated by tests. The Requirements Engineer is able to navigate to the test information by selecting the link. Lab 3 Importing and Reporting Page 151

152 IBM Analytics Try adding an Implemented by view to the AMR Stakeholder Requirements that shows the Work Items that are implementing the requirements Extension exercise C: More drag and drop linking Based on what you learnt in the previous labs can you use drag and drop to establish additional traceability between the artifacts in the Vision Document and the Stakeholder Requirements module? Did you realize that you can also drag and drop to move or copy elements between modules, hence if you drag to an element rather than a link cell then you ll be given a much wider choice. 152 Rational DOORS Next Generation Open Labs

153 IBM Software Extension exercise D: More Create and Print If you wish, try changing views in either the Stakeholder requirements or Vision document modules and repeating the Standard Print or Report Print steps. This standard print functionality is based on the active view, hence if you have a traceability column in the view, or a filtered list, then the results will be different. Try comparing the Book and Table formats Extension exercise E: Take a look at the Payment Kiosk project Have a look at the Jazz/rm project for the Payment Kiosk. Can you spot the differences in terms of Artifact Types and how it is structured? By managing project properties, you can build an artifact taxonomy related to specific project needs and domains. If you are interested in knowing more, then ask your instructor. Lab 3 Importing and Reporting Page 153

154 IBM Analytics Lab Summary This concludes the section on importing and printing documents. In this lab we explored some of the features of the web client for IBM IBM DOORS Next Generation, highlighting how it supports workflows associated with the use of modules, in particular: The ability to import external documents as modules while preserving the heading hierarchy and structure. Use of the Create Links dialog to establish traceability between modules. The use of built-in document generation to generate PDF or Word output. The use of Glossary terms to provide text hover information. If you want to see collaboration in action then there is no better place than Jazz.net where you can see the project dashboards for the team developing the Jazz Requirements Management application. On Jazz.net you can raise enhancement requests directly with the development team, search work items, or see what the team is working on. This open community approach helps IBM connect directly to the user community. Recognizing that ultimately it is good people that lie at the heart of good systems definition, Jazz makes data available for anyone with a web browser; it s not hidden on a local drive or being sent as a version that is already out-of-date in an . The requirements are visible to those who have the necessary permissions, improving your collaboration between customers and domain experts, and improving the predictability and quality of output of your engineering teams. End of lab exercise Please wait for the instructor before moving onto the next lab 154 Rational DOORS Next Generation Open Labs

155 IBM Software Appendix A. Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo , Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Notices Page 155

156 IBM Analytics Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction and intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. All references to fictitious companies or individuals are used for illustration purposes only. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. 156 Rational DOORS Next Generation Open Labs

157 IBM Software Appendix B. Trademarks and copyrights The following terms are trademarks of International Business Machines Corporation in the United States, other countries, or both: IBM AIX CICS ClearCase ClearQuest Cloudscape Cube Views DB2 developerworks DRDA IMS IMS/ESA Informix Lotus Lotus Workflow MQSeries OmniFind Rational Redbooks Red Brick RequisitePro System i System z Tivoli WebSphere Workplace System p Adobe, Acrobat, Portable Document Format (PDF), and PostScript are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, other countries, or both. Google and the Google Logo are registered trademarks of Google Inc. Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. See Java Guidelines Microsoft, Windows, Microsoft Word, Excel, and the Windows logo are registered trademarks of Microsoft Corporation in the United States, other countries, or both. Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. UNIX is a registered trademark of The Open Group in the United States and other countries. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. ITIL is a registered trademark and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office. IT Infrastructure Library is a registered trademark of the Central Computer and Telecommunications Agency which is now part of the Office of Government Commerce. Other company, product and service names may be trademarks or service marks of others. Notices Page 157

158 IBM Software Copyright IBM Corporation The information contained in these materials is provided for informational purposes only, and is provided AS IS without warranty of any kind, express or implied. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, these materials. Nothing contained in these materials is intended to, nor shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software. References in these materials to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. This information is based on current IBM product plans and strategy, which are subject to change by IBM without notice. Product release dates and/or capabilities referenced in these materials may change at any time at IBM s sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. IBM, the IBM logo and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. If these and other IBM trademarked terms are marked on their first occurrence in this information with a trademark symbol ( or ), these symbols indicate U.S. registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at Copyright and trademark information at ibm.com/legal/copytrade.shtml Other company, product and service names may be trademarks or service marks of others. 158 Rational Systems and Software Engineering Accelerator