Rational Publishing Engine and Rational ClearQuest

4,276 views

Published on

This tutorial presents extended information about using Rational Publishing Engine to extract data from Rational ClearQuest and create output documents to present in a friendly way the extracted data. Using Rational Publishing Engine, a Template used to extract all the Defects of a ClearQuest project and related information will be created. The Defects will be displayed in a Table in the Microsoft Word output document.

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
4,276
On SlideShare
0
From Embeds
0
Number of Embeds
52
Actions
Shares
0
Downloads
0
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Rational Publishing Engine and Rational ClearQuest

  1. 1. Using Rational Publishing Engine to extract data from Rational ClearQuest Calin Rusu Reporting Arena Team Member www.reportingarena.com
  2. 2. About the author <ul><li>Reporting Arena is part of Global E-Business Solution Group, an IBM Business Partner that became IBM Software Services Business Partner for Rational Tools in 2010. </li></ul><ul><li>Reporting Arena is formed by a large part of the team that developed IBM Rational Publishing Engine, team that also developed and maintained Telelogic DocExpress. </li></ul><ul><li>The team has been active in the document generation world for the past 8 years gathering invaluable expertise in the real-world document generation needs. </li></ul>
  3. 3. Services <ul><li>At Reporting Arena, we specialize in providing enterprise-grade services for publishing needs, by setting up a correct documentation process and adopt it to your organization specific needs. </li></ul><ul><li>Template Design and Optimization </li></ul><ul><ul><li>With many years of first-hand experience in the document generation world, including the development of Rational Publishing Engine, and long exposure to many data source repositories and real-world documentation needs we are in a good position to handle complex scenarios including the creation of cross-products documents. </li></ul></ul><ul><li>Custom Solutions </li></ul><ul><ul><li>Rational Publishing Engine is a great solution for document generation needs but there are tasks that require additional capabilities that might not be immediately available in RPE. We provide custom solutions that enable Rational Publishing Engine to fully meet your requirements. </li></ul></ul><ul><li>Migration from other document generation technologies </li></ul><ul><ul><li>Rational Publishing Engine supersedes IBM Rational SoDA and IBM Telelogic DocExpress. Reusing the SoDA and DocExpress templates will not only prevent from wasting the resources spend to create these assets but will also reduce the time needed to create and validate matching RPE assets. </li></ul></ul>
  4. 4. Goal <ul><li>This tutorial will present the basics of using Rational Publishing Engine to extract data from Rational ClearQuest . </li></ul><ul><li>Also it will be presented information on how to create output documents to present in a friendly way the extracted data. </li></ul><ul><li>The Template created using Rational Publishing Engine will be used for extracting the Defects information Rational ClearQuest . </li></ul>
  5. 5. Prerequisites <ul><li>Microsoft Windows XP/Vista/7 </li></ul><ul><li>Rational Publishing Engine 1.1.1.2 or later </li></ul><ul><li>Rational ClearQuest 7.1.0 </li></ul><ul><ul><li>SAMPL data base using DefectTracking Schema </li></ul></ul><ul><li>RPE DataServices for Rational ClearQuest </li></ul><ul><li>Microsoft Word 2003/2007 (to visualize the output document) </li></ul><ul><li>Basic knowledge of using RPE </li></ul><ul><li>Basic knowledge of using Rational ClearQuest </li></ul>
  6. 6. Use Case <ul><li>The output document will contain a Table displaying the list of all Defects . The following attributes will be displayed for each Defect element: id , State , Priority , Severity , Headline , Owner’s full name , Submitter’s full name , Submit Date and Description . </li></ul><ul><li>Output document additional information </li></ul><ul><ul><li>The title page will present the name of the ClearQuest project. </li></ul></ul><ul><ul><li>The name of the ClearQuest project will be presented in the header section of the output document. </li></ul></ul>
  7. 7. Steps to obtain the output document 1/2 <ul><li>1. Data Source Schemas </li></ul><ul><li>Two Data Source Schemas will be retrieved from ClearQuest using REST Schema Discovery : </li></ul><ul><ul><li>Data Source Schema for Defects </li></ul></ul><ul><ul><ul><li>Used to extract the Defects </li></ul></ul></ul><ul><ul><li>Data Source Schema for Project </li></ul></ul><ul><ul><ul><li>Used to extract information about the Project </li></ul></ul></ul><ul><li>2. Defects query and attributes </li></ul><ul><li>All Defects will be extracted. </li></ul><ul><li>A set of attributes ( id , State , Priority , Severity , Headline , Owner’s full name , Submitter’s full name , Submit Date and Description ) will be displayed for each Defect . </li></ul>
  8. 8. Steps to obtain the output document 2/2 3. Formatting the Table Formatting properties will be used to provide a nice look of the Table in the output document. 4. Master Page A Master Page will be created and used. 5. Title page A title page will be created to present the Project name. 6. Configure Document Specification Document Specification will be configured to extract the desired data and to generate the output document for Microsoft Word.
  9. 9. Checkpoint <ul><li>1. Data Source Schemas </li></ul><ul><li>2. Defects query and attributes </li></ul><ul><li>3. Formatting the Table </li></ul><ul><li>4. Master Page </li></ul><ul><li>5. Title page </li></ul><ul><li>6. Configure Document Specification </li></ul>
  10. 10. Defects Schema Discovery 1/10 <ul><ul><ul><li>The REST Resource Discovery wizard will start. This wizard will provide guidance for choosing the correct schema. </li></ul></ul></ul><ul><li>Getting the Data Source Schema using the REST Schema Discovery wizard </li></ul><ul><ul><li>Select from Menu </li></ul></ul><ul><ul><ul><li>Data -> Schema Discovery -> REST Schema Discovery … </li></ul></ul></ul>
  11. 11. Defects Schema Discovery 2/10 Specify Credentials The Name (name of the schema) and the Base URL are mandatory information. In this tutorial, “quad” is the name of the machine providing data services on the 8080 port. Specify Data Source Schema name Specify Data Source Schema description Insert Base URL of resource
  12. 12. Defects Schema Discovery 3/10 Check the href in the Adaptor folder and click Next . The href represents the URL of the Resource to be discovered.
  13. 13. Defects Schema Discovery 4/10 Each wizard page will ask to choose an href value.
  14. 14. Defects Schema Discovery 5/10 Check the href in the DBSet folder and click Next .
  15. 15. Defects Schema Discovery 6/10 Each wizard page will ask to choose an href value.
  16. 16. Defects Schema Discovery 7/10 Check the href in the Database folder and click Next .
  17. 17. Defects Schema Discovery 8/10 Select the SAMPL data base. Click Next .
  18. 18. Defects Schema Discovery 9/10 Check the href in the Query folder of the PublicQueries folder and click Next .
  19. 19. Defects Schema Discovery 10/10 Select the All Defects?Type=Query and press Finish to get the schema. Schema will be downloaded and added to Template .
  20. 20. Project Schema Discovery 1/3 The process is similar like getting the schema for Defects . Difference: insert the Project in the Name field.
  21. 21. Project Schema Discovery 2/3 Select href of the Query subfolder of the RecordQueries folder.
  22. 22. Project Schema Discovery 3/3 Select the Project and press Finish to get the schema. Schema will be downloaded and added to Template .
  23. 23. Data Source Schemas The two Data Source Schemas are added to the Data Source Schema view and in Outline view.
  24. 24. Checkpoint <ul><li>1. Data Source Schemas </li></ul><ul><li>2. Defects query and attributes </li></ul><ul><li>3. Formatting the Table </li></ul><ul><li>4. Master Page </li></ul><ul><li>5. Title page </li></ul><ul><li>6. Configure Document Specification </li></ul>
  25. 25. Table design 1/4 Create a Table having 7 Rows, each Row having 6 Cells: Select the Table in the Palette . Click in the desired location in the Template Content . The New Table dialog will open. Select 7 Rows and 6 Cells. Click Ok.
  26. 26. Table design 2/4 The Table is created in the Template Content having the selected number of Rows and Cells.
  27. 27. Table design 3/4 Create a Container in the Table below the last Row.
  28. 28. Table design 4/4 Select all the Rows and move them in the Container. For each Defect it will correspond the Container having a set of 7 Rows in output document.
  29. 29. Set Defects query Set the Query/results/Defect query to the Container: Drag the query from the Data Source Schemas view and drop it into the Container. Note: Query/results/Defect query is referred by $1 notation – referred as $1 query context.
  30. 30. Defects query attributes 1/2 The attributes marked in red will be used in template. To be able to use the fullname attribute of the Query/results/Defect/Owner query, it will be necessary to set a new query.
  31. 31. Defects query attributes 1/2 The attributes marked in red will be used in template. To be able to use the fullname attribute of the Query/results/Defect/Submitter query, it will be necessary to set a new query.
  32. 32. Defects query attributes 1/2 Use the id attribute of the Query/results/Defect query: Drag the id attribute from the Data Source Schemas view and drop it in the first Cell of the first Row. The Select Context dialog will open. Select Use as value and the default $1 context. Click OK. The attribute will be inserted in the Cell. Set the name of the Row to id info : select the Row, in the Properties view, expand Metadata item, and set the value of the name property. Best Practice: Set suggestive names to Template elements to provide information about the content of them.
  33. 33. Defects query attributes 2/2 Set the name of the Rows: Defect info for the second Row and Headline info for the 3 rd Row. 1.Use the State attribute of the $1 query in the second Cell of the second Row. Select Use as value . 2.Use the Priority attribute of the $1 query in the 4th Cell of the second Row. Select Use as value . 3.Use the Severity attribute of the $1 query in the last Cell of the second Row. Select Use as value . 4.Use the Headline attribute of the $1 query in the second Cell of the third Row. Select Use as value . 2 1 3 4
  34. 34. Attribute fullname of Owner query 1. Set the Query/results/Defect/Owner query to the Owner info Row. Use existing $1 query context. 2. Use the fullname attribute of the Query/results/Defect/Owner query in the second Cell of the Headline info Row. Select Use as value . Set Owner info the name of the Row below the Headline info Row. 1 2
  35. 35. Attribute fullname of Submitter query 1. Set the Query/results/Defect/Submitter query on the Row. Use existing $1 query context. 2. Use the fullname attribute of the Query/results/Defect/Submitter query on the second Cell. Select Use as Value . Set Submit info the name of the Row below the Owner info Row. 1 2
  36. 36. Submit_Date attribute Use Submit_Date attribute of the Query/results/Defect query in the 5 th Cell of the Submit info Row. Select Use as value .
  37. 37. Description attribute Use Description attribute of the Query/results/Defect query on the Row below Submit info Row by dropping it in the second Cell. Select Use as Value .
  38. 38. Text as a label Create a Text in the first Cell of the Defect info Row. This Text will be used as a label for the State attribute of the Query/results/Defect query.
  39. 39. Set Text Content Set the content of the Text: Double click on the Text. The Set Content for Current Element dialog opens: Select Simple Value tab and write “State”. Click Ok.
  40. 40. Label for each attribute Create Text elements in the proper Cells. Set the proper content for each Text.
  41. 41. Last Row in Table The Cells of the last Row are empty. The last Row is used as a separator between two Defect elements in the output document.
  42. 42. Preview Output Document There are empty cells that need to be removed. The merge cells operation will be used. Configure the Data Sources. run the report to preview the output document. Please see Step 6. Configure Document Specification
  43. 43. Checkpoint <ul><li>1. Data Source Schemas </li></ul><ul><li>2. Defects query and attributes </li></ul><ul><li>3. Formatting the Table </li></ul><ul><li>4. Master Page </li></ul><ul><li>5. Title page </li></ul><ul><li>6. Configure Document Specification </li></ul>
  44. 44. Set Bold for Text elements Select the Text elements, open contextual menu, open Formatting submenu and select Bold .
  45. 45. Formatting The Defect Id Select the Text element presenting the id attribute of the Defect query. Set font size property value to 14 . Set bold property value to true .
  46. 46. Merging Cells 1/2 To merge the 6 Cells into one single Cell, the col span property is used. Set col span property value of the first Cell from the Row to 6 to merge all the Cells into one Cell.
  47. 47. Merging Cells 2/2 <ul><li>Set the col span property value for the following Cells: </li></ul><ul><li>In Headline Info Row , set for the second Cell the value 5 </li></ul><ul><li>In Owner Info Row, set for the second Cell the value 5 </li></ul><ul><li>In Submit Info Row, set for the second Cell the value 2 </li></ul><ul><li>In Submit Info Row, set for the 5th Cell the value 2 </li></ul><ul><li>In Description Info Row, set for the second Cell the value 5 </li></ul><ul><li>In last Row, set for the first Cell the value 6 </li></ul><ul><li>Fewer cells will appear in output document in all rows excepting the second row. </li></ul>
  48. 48. Preview Output Document The labels are displayed using bold formatting. The id of the Defect font is bold and is displayed using a larger font size. The desired cells are merged.
  49. 49. Checkpoint <ul><li>1. Data Source Schemas </li></ul><ul><li>2. Defects query and attributes </li></ul><ul><li>3. Formatting the Table </li></ul><ul><li>4. Master Page </li></ul><ul><li>5. Title page </li></ul><ul><li>6. Configure Document Specification </li></ul>
  50. 50. Create Master Page 1/10 To create a Master Page, select the Master Pages item in the Outline , right click to open the contextual menu. Select Insert -> New Master Page … The New Master Page dialog opens. Insert the name of the Master Page. Click Ok. The “MPDefects” Master Page is created. The Header and Footer are automatically created for the Master Page.
  51. 51. Create Master Page 2/10 A new tab Master Page: MPDefects is created in the editor. A new child node Master Page : MPDefects is created in Outline.
  52. 52. Create Master Page 3/10 Header 1. Create a Table having one Row with two Cells 2. Create two Paragraphs in the first Cell. 3. Create a Text in each Paragraph and set the Text content. 4. In the second Cell create a Text (no value) Footer 1. Create a Paragraph 2. In Paragraph create a Text , a Page Number, another Text and a Total Pages Number. 3. Set the content of the two newly inserted Text elements
  53. 53. Create Master Page 4/10 Select the Table from the Header. In the Properties view: Set autofit to window value for the table auto fit property. Set resize to fit contents to false . Select the first Cell of the Table. In the Properties view: Set top left value for the cell alignment property. Set 325 value for the cell width property. Formatting the Header
  54. 54. Create Master Page 5/10 Formatting the Footer Select the Paragraph from the Footer. In the Properties view: Set value center for the paragraph alignment property.
  55. 55. Create Master Page 6/10 Data Source query cannot be used in the Master Pages. It is possible to use an internal Variable of which value can be assigned to a specific attribute of a query. The assignment must take place before the Variable will be used in Master Page. Create an internal Variable named projectName_ : In the Data menu , select New Variable , the New Variable dialog will open. Set the name of the Variable. Let the default value internal for Access, because the Variable will be used only for calculation in the Template.
  56. 56. Create Master Page 7/10 Switch to Master Page editor tab. Drag the projectName_ Variable from Outline and drop it in the Text from the second Cell of the Table from Header.
  57. 57. Create Master Page 8/10 Switch back to the Template Content editor tab. Drag the Master Page from Outline and drop it in the area of the Table. Note: the Master Page icon in the Table. Another way of using the Master Page: Select the Table. Using contextual menu, from the Master Page submenu select the suitable Master Page.
  58. 58. Create Master Page 9/10 Select the Template Content tab. Create a Container above the Table in the Template Content. Set its Name to Project Info . Select the Project Data Source Schema. Set the query Query/results/Project to the Project Info Container. This query will be the first to be executed. We need to use the Assignment feature to assign the value of the Name attribute of the Query/results/Project to the projectName_ Variable in the context of the Project Info Container.
  59. 59. Create Master Page 10/10 Variable Assignment: Select the Project Info Container, and select Edit Assignments… from the contextual menu. Click Add in the Assignments Editor dialog. Select the projectInfo_ Variable and click Ok. The Set Assignments for Current Element dialog will open. In the Data Expression tab select the Name data attribute of the Query/results/Project query.
  60. 60. Intermediary Output Document The Footer The Header
  61. 61. Checkpoint <ul><li>1. Data Source Schemas </li></ul><ul><li>2. Defects query and attributes </li></ul><ul><li>3. Formatting the Table </li></ul><ul><li>4. Master Page </li></ul><ul><li>5. Title page </li></ul><ul><li>6. Configure Document Specification </li></ul>
  62. 62. Create a Title Page 1. Create a Paragraph below the Project Info Container. 2. Set the “Title” Style for the Paragraph: Drag from the Outline the “Title” Style and drop it in the Paragraph area. The Style icon will appear in the Paragraph. 3. Create a Paragraph inside it. Set the value 300 for the before spacing property. Create inside a Text element with a suitable content. 4. Create another Paragraph. Create a Text element having the projectName_ Variable as content inside the Paragraph. 1 3 2 4
  63. 63. Checkpoint <ul><li>1. Data Source Schemas </li></ul><ul><li>2. Defects query and attributes </li></ul><ul><li>3. Formatting the Table </li></ul><ul><li>4. Master Page </li></ul><ul><li>5. Title page </li></ul><ul><li>6. Configure Document Specification </li></ul>
  64. 64. Running the report <ul><li>Select the Launcher Perspective to be able to: </li></ul><ul><ul><li>Configure the Data Sources </li></ul></ul><ul><ul><li>Configure the Microsoft Word Output </li></ul></ul>The Microsoft Word Output Defects Data Source Project Data Source
  65. 65. Configure Data Source Select the Project Data Source , open contextual menu and Configure Data Source… Select Discover and the REST Resource Discovery wizard will start. The same steps must be performed as for the getting the Data Source Schemas to obtain the proper URL for all two Data Sources. The Configure REST Data Source dialog will open.
  66. 66. Configure Output Select the Output -> Target: Word . Open contextual menu and select Configure Output… The Configure Word Output dialog will open. Select the location where of the Word output document will be created.
  67. 67. Results Title Page Sample Page
  68. 68. More Information <ul><li>RPE Online Help </li></ul><ul><li>http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp?topic=/com.ibm.help.download.tpe.doc/topics/publishingengine_version1_1.html </li></ul><ul><li>RPE Developer Works Forum </li></ul><ul><li>http:// www.ibm.com/developerworks/forums/forum.jspa?forumID =1512 </li></ul><ul><li>RPE Community Wiki </li></ul><ul><li>http:// www.ibm.com/developerworks/wikis/display/rpe/Home </li></ul><ul><li>Rational ClearQuest </li></ul><ul><li>http://www-01.ibm.com/software/awdtools/clearquest/ </li></ul><ul><li>RPE Data Services </li></ul><ul><li>http://publib.builder.ibm.com/infocenter/rpehelp/v1r1m1/topic/com.ibm.rational.pe.install.doc/topics/c_dataservices_deployment.html </li></ul>
  69. 69. Media Channels <ul><li>Reporting Arena on YouTube </li></ul><ul><li>http://www.youtube.com/ReportingArena </li></ul><ul><li>Reporting Arena on Twitter </li></ul><ul><li>http://www.twitter.com/ReportingArena </li></ul><ul><li>Reporting Arena on Facebook </li></ul><ul><li>http://www.facebook.com/Reporting-Arena </li></ul><ul><li>Reporting Arena on LinkedIn </li></ul><ul><li>http:// www.ibm.com/developerworks/wikis/display/rpe/Home </li></ul>

×