SlideShare a Scribd company logo

Rational Publishing Engine and Rational ClearQuest

GEBS Reporting, profile picture
GEBS Reporting

This document details how to use the Rational Publishing Engine to extract data from Rational ClearQuest for generating defect reports. It covers prerequisites, configuration steps, and the process for creating output documents that include defect information such as ID, state, priority, and more. The guide also addresses template design, custom solutions, and migration from other technologies, highlighting the capabilities of Reporting Arena as a provider of publishing solutions.

Technology
1 of 69
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
Using Rational Publishing Engine to extract data from Rational ClearQuest Calin Rusu Reporting Arena Team Member www.reportingarena.com
About the author 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. 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. 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.
Services 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. Template Design and Optimization 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. Custom Solutions 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. Migration from other document generation technologies 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.
Goal This tutorial will present the basics of using Rational Publishing Engine to extract data from Rational ClearQuest . Also it will be presented information on how to create output documents to present in a friendly way the extracted data. The Template created using Rational Publishing Engine will be used for extracting the Defects information Rational ClearQuest .
Prerequisites Microsoft Windows XP/Vista/7 Rational Publishing Engine 1.1.1.2 or later Rational ClearQuest 7.1.0 SAMPL data base using DefectTracking Schema RPE DataServices for Rational ClearQuest Microsoft Word 2003/2007 (to visualize the output document) Basic knowledge of using RPE Basic knowledge of using Rational ClearQuest
Use Case 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 . Output document additional information The title page will present the name of the ClearQuest project. The name of the ClearQuest project will be presented in the header section of the output document.
Steps to obtain the output document 1/2 1. Data Source Schemas Two Data Source Schemas will be retrieved from ClearQuest using REST Schema Discovery : Data Source Schema for Defects Used to extract the Defects Data Source Schema for Project Used to extract information about the Project 2. Defects query and attributes All Defects will be extracted. 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 .
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.
Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
Defects Schema Discovery 1/10 The REST Resource Discovery wizard will start. This wizard will provide guidance for choosing the correct schema. Getting the Data Source Schema using the REST Schema Discovery wizard Select from Menu Data -> Schema Discovery -> REST Schema Discovery …
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
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.
Defects Schema Discovery 4/10 Each wizard page will ask to choose an href value.
Defects Schema Discovery 5/10 Check the href in the DBSet folder and click Next .
Defects Schema Discovery 6/10 Each wizard page will ask to choose an href value.
Defects Schema Discovery 7/10 Check the href in the Database folder and click Next .
Defects Schema Discovery 8/10 Select the SAMPL data base. Click Next .
Defects Schema Discovery 9/10 Check the href in the Query folder of the PublicQueries folder and click Next .
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 .
Project Schema Discovery 1/3 The process is similar like getting the schema for Defects . Difference: insert the Project in the Name field.
Project Schema Discovery 2/3 Select href of the Query subfolder of the RecordQueries folder.
Project Schema Discovery 3/3 Select the Project and press Finish to get the schema. Schema will be downloaded and added to Template .
Data Source Schemas The two Data Source Schemas are added to the Data Source Schema view and in Outline view.
Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
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.
Table design 2/4 The Table is created in the Template Content having the selected number of Rows and Cells.
Table design 3/4 Create a Container in the Table below the last Row.
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.
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.
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.
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.
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.
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
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
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
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 .
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 .
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.
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.
Label for each attribute Create Text elements in the proper Cells. Set the proper content for each Text.
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.
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
Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
Set Bold for Text elements Select the Text elements, open contextual menu, open Formatting submenu and select Bold .
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 .
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.
Merging Cells 2/2 Set the col span property value for the following Cells: In Headline Info Row , set for the second Cell the value 5 In Owner Info Row, set for the second Cell the value 5 In Submit Info Row, set for the second Cell the value 2 In Submit Info Row, set for the 5th Cell the value 2 In Description Info Row, set for the second Cell the value 5 In last Row, set for the first Cell the value 6 Fewer cells will appear in output document in all rows excepting the second row.
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.
Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
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.
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.
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
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
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.
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.
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.
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.
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.
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.
Intermediary Output Document The Footer The Header
Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
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
Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
Running the report Select the Launcher Perspective to be able to: Configure the Data Sources Configure the Microsoft Word Output The Microsoft Word Output Defects Data Source Project Data Source
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.
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.
Results Title Page Sample Page
More Information RPE Online Help http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp?topic=/com.ibm.help.download.tpe.doc/topics/publishingengine_version1_1.html RPE Developer Works Forum http:// www.ibm.com/developerworks/forums/forum.jspa?forumID =1512 RPE Community Wiki http:// www.ibm.com/developerworks/wikis/display/rpe/Home Rational ClearQuest http://www-01.ibm.com/software/awdtools/clearquest/ RPE Data Services http://publib.builder.ibm.com/infocenter/rpehelp/v1r1m1/topic/com.ibm.rational.pe.install.doc/topics/c_dataservices_deployment.html
Media Channels Reporting Arena on YouTube http://www.youtube.com/ReportingArena Reporting Arena on Twitter http://www.twitter.com/ReportingArena Reporting Arena on Facebook http://www.facebook.com/Reporting-Arena Reporting Arena on LinkedIn http:// www.ibm.com/developerworks/wikis/display/rpe/Home

More Related Content

PPS
Using Rational Publishing Engine to generate documents from Rational Rhapsody
GEBS Reporting
 
PPT
Generate Excel documents with Rational Publishing Engine 1.1.2 and Reporting ...
GEBS Reporting
 
PPT
RPE - Template formating, style and stylesheet usage
GEBS Reporting
 
PPT
Jazz
GEBS Reporting
 
PPTX
Reconciliation Tool
Achal Kagwad
 
PPT
SQL
Harshad Umredkar
 
DOC
Itech 1006 assignment 2 sem1 2017
Sandeep Ratnam
 
PDF
Plsql 9i vol2
Chithra Balakrishnan
 
Using Rational Publishing Engine to generate documents from Rational Rhapsody
GEBS Reporting
 
Generate Excel documents with Rational Publishing Engine 1.1.2 and Reporting ...
GEBS Reporting
 
RPE - Template formating, style and stylesheet usage
GEBS Reporting
 
Jazz
GEBS Reporting
 
Reconciliation Tool
Achal Kagwad
 
SQL
Harshad Umredkar
 
Itech 1006 assignment 2 sem1 2017
Sandeep Ratnam
 
Plsql 9i vol2
Chithra Balakrishnan
 

What's hot (12)

PPT
Chapter09
Rajesh Mandava
 
PDF
Oracle Concurrent Program Setup document
venkatesh gurusamy
 
PDF
Testing File
malikredpot
 
DOC
Apps1
Sultan Sharif
 
DOCX
Universe
Pavan Kumar
 
PDF
EBS R12 Concurrent program tracing
Sachin Srivastava
 
PDF
Waiting too long for Excel's VLOOKUP? Use SQLite for simple data analysis!
Amanda Lam
 
PDF
Handouts how to use microsoft access to conduct an overlap analysis
Charleston Conference
 
PDF
Sap abap material
Kranthi Kumar
 
PDF
Events Registration System Part 1
Adolfo Nasol
 
PDF
Event Registration System Part 2
Adolfo Nasol
 
PDF
semantics_documentationsbn
Aiswarya Vinayachandran
 
Chapter09
Rajesh Mandava
 
Oracle Concurrent Program Setup document
venkatesh gurusamy
 
Testing File
malikredpot
 
Apps1
Sultan Sharif
 
Universe
Pavan Kumar
 
EBS R12 Concurrent program tracing
Sachin Srivastava
 
Waiting too long for Excel's VLOOKUP? Use SQLite for simple data analysis!
Amanda Lam
 
Handouts how to use microsoft access to conduct an overlap analysis
Charleston Conference
 
Sap abap material
Kranthi Kumar
 
Events Registration System Part 1
Adolfo Nasol
 
Event Registration System Part 2
Adolfo Nasol
 
semantics_documentationsbn
Aiswarya Vinayachandran
 
Ad

Viewers also liked (12)

PPT
GanttChart for IBM Rational ClearQuest ver 1.3.1
CM-Consult
 
PDF
Veekay industries
Veekay Industries
 
PPTX
Growth Hacking czyli o zarządzaniu wzrostem
Adam Wesolowski
 
PPTX
6 клас. Іграшки теорія
Andy Levkovich
 
PPTX
Workshop 4 Making Grammar Instruction Meaningful and Enjoyable
Maryna Tsehelska
 
PDF
Sticker termo sensible
MARIO CISNEROS LOPEZ
 
PDF
ASSESEMENT ON FACTORS DECLINING LABOUR PRODUCTIVTY IN CONSTRUCTION PROJECTS
IAEME Publication
 
PPT
Grammaring
CHOI MIN JUNG
 
PPTX
Financial System in India
reshmajini
 
PPTX
інтернет круїз європа на твоїй долоні
Tatyana Novomlinets
 
PDF
Dentons wealth clarity newsletter spring 2017
Jonathan Gall
 
PPTX
Workshop 6 Teaching Environmental Protection
Maryna Tsehelska
 
GanttChart for IBM Rational ClearQuest ver 1.3.1
CM-Consult
 
Veekay industries
Veekay Industries
 
Growth Hacking czyli o zarządzaniu wzrostem
Adam Wesolowski
 
6 клас. Іграшки теорія
Andy Levkovich
 
Workshop 4 Making Grammar Instruction Meaningful and Enjoyable
Maryna Tsehelska
 
Sticker termo sensible
MARIO CISNEROS LOPEZ
 
ASSESEMENT ON FACTORS DECLINING LABOUR PRODUCTIVTY IN CONSTRUCTION PROJECTS
IAEME Publication
 
Grammaring
CHOI MIN JUNG
 
Financial System in India
reshmajini
 
інтернет круїз європа на твоїй долоні
Tatyana Novomlinets
 
Dentons wealth clarity newsletter spring 2017
Jonathan Gall
 
Workshop 6 Teaching Environmental Protection
Maryna Tsehelska
 
Ad

Similar to Rational Publishing Engine and Rational ClearQuest (20)

PPT
Rational Publishing Engine and Rational RequisitePro
GEBS Reporting
 
PPT
Rational Publishing Engine with Rational DOORS
GEBS Reporting
 
PPTX
QTP Automation Testing Tutorial 7
Akash Tyagi
 
PPT
Rational Publishing Engine and Rational System Architect
GEBS Reporting
 
DOCX
OBIEE 11g : Repository Creation Steps
Dharmaraj Borse
 
PPT
Test automation process _ QTP
Bharathi Krishnamurthi
 
PPT
Test automation process
Bharathi Krishnamurthi
 
DOCX
BUS 145 – Database Project – Part 2 Build and Test The.docx
RAHUL126667
 
PPT
Less06 2 e_testermodule_5
Suresh Mishra
 
PPTX
ETL Validator Usecase - Data Profiling and Comparison
Datagaps Inc
 
PPT
Managing Oracle Streams Using Enterprise Manager Grid Control
scottb411
 
PDF
Creating a repository using the oracle business intelligence administration tool
Ravi Kumar Lanke
 
DOC
Itech 1006 assignment 2 sem1 2017 (2)
Sandeep Ratnam
 
PDF
Programming Without Coding Technology (PWCT) Environment
Mahmoud Samir Fayed
 
PDF
Data_Processing_Program
Neil Dahlqvist
 
PPTX
Test automation of ap is using postman
BugRaptors
 
PDF
CaseStudy-MohammedImranAlam-Xcelsius
Mohammed Imran Alam
 
PDF
For this project your task is to update the RSS Reader program you w.pdf
fathimahardwareelect
 
DOCX
synopsis
jayant parmar
 
PDF
websphere cast iron labs
AMIT KUMAR
 
Rational Publishing Engine and Rational RequisitePro
GEBS Reporting
 
Rational Publishing Engine with Rational DOORS
GEBS Reporting
 
QTP Automation Testing Tutorial 7
Akash Tyagi
 
Rational Publishing Engine and Rational System Architect
GEBS Reporting
 
OBIEE 11g : Repository Creation Steps
Dharmaraj Borse
 
Test automation process _ QTP
Bharathi Krishnamurthi
 
Test automation process
Bharathi Krishnamurthi
 
BUS 145 – Database Project – Part 2 Build and Test The.docx
RAHUL126667
 
Less06 2 e_testermodule_5
Suresh Mishra
 
ETL Validator Usecase - Data Profiling and Comparison
Datagaps Inc
 
Managing Oracle Streams Using Enterprise Manager Grid Control
scottb411
 
Creating a repository using the oracle business intelligence administration tool
Ravi Kumar Lanke
 
Itech 1006 assignment 2 sem1 2017 (2)
Sandeep Ratnam
 
Programming Without Coding Technology (PWCT) Environment
Mahmoud Samir Fayed
 
Data_Processing_Program
Neil Dahlqvist
 
Test automation of ap is using postman
BugRaptors
 
CaseStudy-MohammedImranAlam-Xcelsius
Mohammed Imran Alam
 
For this project your task is to update the RSS Reader program you w.pdf
fathimahardwareelect
 
synopsis
jayant parmar
 
websphere cast iron labs
AMIT KUMAR
 

Recently uploaded (20)

PPTX
Programs and apps: productivity, graphics, security and other tools
4mqw9zch22
 
PDF
August Patch Tuesday
Ivanti
 
PDF
Enhancing emotion recognition model for a student engagement use case through...
IAESIJAI
 
PPTX
Chapter 5: Probability Theory and Statistics
RandyFin
 
PPTX
A Presentation on Touch Screen Technology
memembruh336
 
PDF
MIND Revenue Release Quarter 2 2025 Press Release
MIND CTI
 
PDF
Transform Your ITIL® 4 & ITSM Strategy with AI in 2025.pdf
PDCA Consulting
 
PDF
Univ-Connecticut-ChatGPT-Presentaion.pdf
ry7r52mzb4
 
PDF
Accuracy of neural networks in brain wave diagnosis of schizophrenia
IAESIJAI
 
PPTX
Tartificialntelligence_presentation.pptx
ry7r52mzb4
 
PDF
Unlocking AI with Model Context Protocol (MCP)
Brian McKeiver
 
PDF
Getting Started with Data Integration: FME Form 101
Safe Software
 
PDF
Microsoft Solutions Partner Drive Digital Transformation with D365.pdf
Microsoft Dynamics
 
PPTX
TechTalks-8-2019-Service-Management-ITIL-Refresh-ITIL-4-Framework-Supports-Ou...
bonakiduza1024
 
PDF
From MVP to Full-Scale Product A Startup’s Software Journey.pdf
KodekX
 
PDF
Zenith AI: Advanced Artificial Intelligence
Biz Preneurs
 
PDF
project resource management chapter-09.pdf
ssuser00e6e21
 
PPTX
OMC Textile Division Presentation 2021.pptx
JahangirAlam816069
 
PPTX
A Presentation on Artificial Intelligence
memembruh336
 
PDF
Approach and Philosophy of On baking technology
30anthuong17
 
Programs and apps: productivity, graphics, security and other tools
4mqw9zch22
 
August Patch Tuesday
Ivanti
 
Enhancing emotion recognition model for a student engagement use case through...
IAESIJAI
 
Chapter 5: Probability Theory and Statistics
RandyFin
 
A Presentation on Touch Screen Technology
memembruh336
 
MIND Revenue Release Quarter 2 2025 Press Release
MIND CTI
 
Transform Your ITIL® 4 & ITSM Strategy with AI in 2025.pdf
PDCA Consulting
 
Univ-Connecticut-ChatGPT-Presentaion.pdf
ry7r52mzb4
 
Accuracy of neural networks in brain wave diagnosis of schizophrenia
IAESIJAI
 
Tartificialntelligence_presentation.pptx
ry7r52mzb4
 
Unlocking AI with Model Context Protocol (MCP)
Brian McKeiver
 
Getting Started with Data Integration: FME Form 101
Safe Software
 
Microsoft Solutions Partner Drive Digital Transformation with D365.pdf
Microsoft Dynamics
 
TechTalks-8-2019-Service-Management-ITIL-Refresh-ITIL-4-Framework-Supports-Ou...
bonakiduza1024
 
From MVP to Full-Scale Product A Startup’s Software Journey.pdf
KodekX
 
Zenith AI: Advanced Artificial Intelligence
Biz Preneurs
 
project resource management chapter-09.pdf
ssuser00e6e21
 
OMC Textile Division Presentation 2021.pptx
JahangirAlam816069
 
A Presentation on Artificial Intelligence
memembruh336
 
Approach and Philosophy of On baking technology
30anthuong17
 

Rational Publishing Engine and Rational ClearQuest

  • 1. Using Rational Publishing Engine to extract data from Rational ClearQuest Calin Rusu Reporting Arena Team Member www.reportingarena.com
  • 2. About the author 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. 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. 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.
  • 3. Services 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. Template Design and Optimization 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. Custom Solutions 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. Migration from other document generation technologies 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.
  • 4. Goal This tutorial will present the basics of using Rational Publishing Engine to extract data from Rational ClearQuest . Also it will be presented information on how to create output documents to present in a friendly way the extracted data. The Template created using Rational Publishing Engine will be used for extracting the Defects information Rational ClearQuest .
  • 5. Prerequisites Microsoft Windows XP/Vista/7 Rational Publishing Engine 1.1.1.2 or later Rational ClearQuest 7.1.0 SAMPL data base using DefectTracking Schema RPE DataServices for Rational ClearQuest Microsoft Word 2003/2007 (to visualize the output document) Basic knowledge of using RPE Basic knowledge of using Rational ClearQuest
  • 6. Use Case 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 . Output document additional information The title page will present the name of the ClearQuest project. The name of the ClearQuest project will be presented in the header section of the output document.
  • 7. Steps to obtain the output document 1/2 1. Data Source Schemas Two Data Source Schemas will be retrieved from ClearQuest using REST Schema Discovery : Data Source Schema for Defects Used to extract the Defects Data Source Schema for Project Used to extract information about the Project 2. Defects query and attributes All Defects will be extracted. 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 .
  • 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. Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
  • 10. Defects Schema Discovery 1/10 The REST Resource Discovery wizard will start. This wizard will provide guidance for choosing the correct schema. Getting the Data Source Schema using the REST Schema Discovery wizard Select from Menu Data -> Schema Discovery -> REST Schema Discovery …
  • 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. 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. Defects Schema Discovery 4/10 Each wizard page will ask to choose an href value.
  • 14. Defects Schema Discovery 5/10 Check the href in the DBSet folder and click Next .
  • 15. Defects Schema Discovery 6/10 Each wizard page will ask to choose an href value.
  • 16. Defects Schema Discovery 7/10 Check the href in the Database folder and click Next .
  • 17. Defects Schema Discovery 8/10 Select the SAMPL data base. Click Next .
  • 18. Defects Schema Discovery 9/10 Check the href in the Query folder of the PublicQueries folder and click Next .
  • 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. Project Schema Discovery 1/3 The process is similar like getting the schema for Defects . Difference: insert the Project in the Name field.
  • 21. Project Schema Discovery 2/3 Select href of the Query subfolder of the RecordQueries folder.
  • 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. Data Source Schemas The two Data Source Schemas are added to the Data Source Schema view and in Outline view.
  • 24. Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
  • 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. Table design 2/4 The Table is created in the Template Content having the selected number of Rows and Cells.
  • 27. Table design 3/4 Create a Container in the Table below the last Row.
  • 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. Label for each attribute Create Text elements in the proper Cells. Set the proper content for each Text.
  • 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. 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. Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
  • 44. Set Bold for Text elements Select the Text elements, open contextual menu, open Formatting submenu and select Bold .
  • 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. 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. Merging Cells 2/2 Set the col span property value for the following Cells: In Headline Info Row , set for the second Cell the value 5 In Owner Info Row, set for the second Cell the value 5 In Submit Info Row, set for the second Cell the value 2 In Submit Info Row, set for the 5th Cell the value 2 In Description Info Row, set for the second Cell the value 5 In last Row, set for the first Cell the value 6 Fewer cells will appear in output document in all rows excepting the second row.
  • 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. Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
  • 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. Intermediary Output Document The Footer The Header
  • 61. Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
  • 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. Checkpoint 1. Data Source Schemas 2. Defects query and attributes 3. Formatting the Table 4. Master Page 5. Title page 6. Configure Document Specification
  • 64. Running the report Select the Launcher Perspective to be able to: Configure the Data Sources Configure the Microsoft Word Output The Microsoft Word Output Defects Data Source Project Data Source
  • 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. 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. Results Title Page Sample Page
  • 68. More Information RPE Online Help http://publib.boulder.ibm.com/infocenter/rsdp/v1r0m0/index.jsp?topic=/com.ibm.help.download.tpe.doc/topics/publishingengine_version1_1.html RPE Developer Works Forum http:// www.ibm.com/developerworks/forums/forum.jspa?forumID =1512 RPE Community Wiki http:// www.ibm.com/developerworks/wikis/display/rpe/Home Rational ClearQuest http://www-01.ibm.com/software/awdtools/clearquest/ RPE Data Services http://publib.builder.ibm.com/infocenter/rpehelp/v1r1m1/topic/com.ibm.rational.pe.install.doc/topics/c_dataservices_deployment.html
  • 69. Media Channels Reporting Arena on YouTube http://www.youtube.com/ReportingArena Reporting Arena on Twitter http://www.twitter.com/ReportingArena Reporting Arena on Facebook http://www.facebook.com/Reporting-Arena Reporting Arena on LinkedIn http:// www.ibm.com/developerworks/wikis/display/rpe/Home