Jazz

download Jazz

of 99

  • date post

    02-Dec-2014
  • Category

    Business

  • view

    1.771
  • download

    2

Embed Size (px)

description

 

Transcript of Jazz

  • 1. CLM 3.0 - Traceability reports for a lifecycle project with RPE Oana HateganReporting Arena Team Member www.reportingarena.com

2. About the author

  • Reporting Arena part of E Global Business Solutions Group helps clients effectively implement and leverage the suite of IBM Rational Software. As a group of consultants who are focused on Rational Publishing Engine, our team has a big advantage beside our competitors, being the teamwho actually developed this tool.
  • With years of experience honed in software development, our staff brings skills and experience you can draw on to help you improve your team's software development capability and maximize the return on your investment in IBM Rational Software tool

3. Reporting Arena Services

  • Implementation of Rational Publishing Engine
  • RPE Template Design and Optimization
  • Custom Solutions for IBM Rational Publishing Engine
  • Migrating Legacy Solutions to Rational Publishing Engine
  • Rational Publishing Engine Training
  • Integrate RPE in Rational Tools
  • Packaged Services

4. Introduction

  • The goal of this tutorial is to present the basic steps that a user has to perform in order to extract data from a specific CLM Module, and to follow links to get information from all linked modules.
  • Also in this tutorial the user can find information about CLM Schema Discovery process, advance filtering using JavaScript expressions, fancy table formatting and some valuable information about defining and using variables in master pages.

5. Prerequisites

  • Microsoft WindowsXP/Vista/7
  • Rational Publishing Engine 1.1.2
  • Rational Team Concert 3.0
  • Rational Requirements Composer 3.0.1
  • Rational Quality Manager 3.0.1
  • Microsoft Word 2003/2007 (to visualize the output document)
  • Basic knowledge of using Rational Publishing Engine
  • Basic knowledge of using Rational DOORS
  • Basic knowledge of XML language, XML schema definitions and JavaScript language
  • CLM username and password

6. Output Document Description

  • I am looking to create a traceability document containing RRC Requirements, RQM Test Plans and related Test Cases and RTC Work Items.Each of the above modules will be represented by a table with entries for each module element and links to elements description. The document will offer the option of tracing a requirement or a test case from a specific work item.
  • Also, a master page will be created, having a title page section and a header displaying the document generation time. The templates footer will contain the current page number.

7. Use Case 1/2

  • Steps to obtain the desired Output Document:
  • 1. Create a template for a report containing RRC requirements
  • Iterate through all the requirements and display the ID, Title, Type and Modified attributes, if they are not empty. For a Collection of Requirementwe will display the nested requirements. Each table entry will be linked to a more detailed description of the requirement.
    • [add XML schema, create paragraphs, tables, containers, drag queries, use conditions]
  • 2 .Create a template for a report containing RTC work items
  • Iterate through all the work items and display the ID, Summary, Target, Owner, Project Areaand Priority attributes, if they are not empty. Each work item will have a link to the implemented requirement and corresponding test case, as well as a task description.
    • [add XML schema, create paragraphs, tables, containers, drag queries, use conditions]

8. Use Case 2/2

  • 3.Create a template for a report containing RQM test plans and test cases
  • Iterate through all the test plans and display the ID, Name, State, Owner, Release and Modified attributes, if they are not empty. Each test plan will have a link to the related test cases and each test case and test plan will be linked to a detailed description, requirement and corresponding test case, as well as a task description.
    • [dynamic data source configuration, create paragraphs, tables, containers, drag queries, use conditions]
  • 4.Add additional template structures like: Table of Contents , Table of Tables and Master Page

9. Tutorial Outline

  • 1.Requirements section
  • 2.Work items section
  • 3.Test plans and test cases section

10. Requirements - Checkpoint 1. Iterate through all therequirements and display some attributes 2. For each Collection display the related requirements 3. Create a detailed description for each requirement 4. Link the table entry to the requirement description 5. Create a master page with header and footer 6. Configure Document Specification 11. Desired Output Document Header section:on left side: generation time Table Header Collectionand related requirements Footer section page number / total pages number Requirement description 12. Add an XML data source 1/2

  • The first step is to open theRational Publishing EngineinStudioperspective.
  • Go toFilemenu, and selectNew->Document Template
  • To extract information from CLM we need to have in our template the correspondingXMLdata source schema .
  • Add an XMLdata source schemausing theData Source Schemasentry from theOutlineview.
  • Right click, and selectInsert->Data Source Schema

13. Add an XML data source 2/2

  • In theAdd Data Source Schemawizard, on the second page, select the default REST schema, using schema typeREST , and, asData Source ID,type : REST_rm
  • ClickFinishto insert the schema into the template.
  • In theSchema filefield, insert the data schema URL:
  • https://server_name:port/rm/publish/resources?metadata=schema
  • Introduce CLM username and password in the User Authentication Box

NOTE: The XML file containing all current resources: https://server_name:port/rm/publish/resources/* 14. Set dataSource/Artifact Query Create a Table:Select the Table element in thePaletteview and click in the desired location in the Template Content Editor. The first row will be the tables header. Set thedataSource/artifact query [$1] to the Container: Drag the desired query from theData Source Schemasview and drop it on the Container. NOTE:Its recommended to use the Container element when you want to iterate a collection of elements. The container element will not add extra empty paragraphs. Iterate elements:Select a Container and drop it inside the created table. Use drag and drop to add the second row inside the Container. This row will be iterated for eachdataSource/artifactelement. 15. Display Requirement attributes

  • Add a Text element in each first row cell. Double-click on each Text element to modify the Text content. Add the attributes names in each cell. Right-click on each cell and select theHeader Style.
  • Expand the Artifact element from theData Sourceschema, and drag theIdentifierattribute into the first cells text box. SelectUse as valuecontext.
  • Do the same for the rest of the cells.

In this moment in our template we iterate through all artifacts, and display for each of them five attributes, each one in a separate table cell. NOTE: The attributes from the data schema can be better understood by looking at the XML file https://giediprime:9445/rm/publish/resources/* 16. Change Date Format 1/2

  • I used a JavaScript expressionto change the date format.Double-click on the Text element and selectScript expression .

Initial format Modified format The initial format is the format in which the date is stored in thedataSource/artifact/collaboration/modifiedelement.The modified format is the date format after applying the JavaScript expression. 17. Change Date Format 2/2 p1 stores the date (yyyy-mm-dd) i stores the number of the month The JavaScript expression splits the date string into year, month, day and time. To convert the month format( ex 06 -> Jun) we use the month number as an index for themonthsarray.Next, we compose the output by concatenating the month number with the day, year and time. NOTE: You need to check the used attributes in the left side of the Script Expression container.Convert the date value to string p3 stores the time (hour:min:sec) str[0] -> year str[1] -> month str[2] -> day str[3] -> hour:min:sec 18. Requirements - Checkpoint 1. Iterate through all therequirements and display some attributes 2. For each Collection display the related requirements 3. Create a detailed description for each requirement 4. Link the table entry to the requirement description 5. Create a master page with header and footer 6. Configure Document Specification 19. Iterate the Collection elements 1/4

  • In order to display the requirements contained by a Collection , we need to modify the previous table. We want the related Requirements names to appear bellow the Collection name.
  • In the XML file you can see that the object type (requirement or collection) is the value of thedataSource/artifact/collaboration/ attributes/ObjectTypeelement.
  • If theObjectType/nameis Collection, it means we have to