Description of BIRT sample reports and charts:

This file contains descriptions of the sample BIRT files included with the release. 

 

CQSamples.rptlibrary:

The samples library contains a collection of components that are used by multiple report samples.  BIRT rptlibrary files are a convenient way to share common components.

 

The sample reports are configured to use a sample BIRT data source that is saved in CQSamples.rptlibrary. The default data source specifies the SAMPL database in the 7.0.0 schema repository.  All samples are created using the “Defect” sample record type.  To change the settings for the sample data source:

1.    Go to the BIRT navigator

2.    Open report resource CQSamples.rptlibrary

3.    From Data Explorer, expand the “Data Sources” list

4.    Double-click on “CQSamples_Connection”

5.    Make desired settings changes, and click OK

 

 

AllDefectsSummary.rptdesign:

Shows report in table format.  Inner grid is used for demonstration of basic formatting.  Each outlined row represents details about a specific defect record.

Data Set Query:         <importfolder>/Defect Details for Report

BIRT computed columns: none

Query parameters:       none

Report parameters:      username, password

BIRT filters:           none

Required sub-reports:   none

 

AllDefectsSummaryWithChart.rptdesign:

Shows chart of all defects and summary report of all defects on the same report.  The 2D chart shows the count of all defects, with the X-axis grouped by state, and the Y-axis showing the distinct number of defects in that state.  The report in table format shows the summary information for each defect record.

Data Set Query:         Public Queries/All Defects

BIRT computed columns: none

Query parameters:       none

Report parameters:      username, password

BIRT filters:           none

Required sub-reports:   none*

*Note:  Although the table included in this report is the same as another table included in the sample reports, the samples included for this release do not currently make use of shared Report Items.  Defining a shared Data Set and a Report Item of type Table would allow the sample reports to make use of the same table, instead of maintaining a distinct implementation for each.

 

 

Chart_AllDefectsByState_Severity_Priority.rptdesign:

This report design shows 3 pie charts and 1 horizontal bar chart.  All three charts share the same Data Set Query and result set.  The ClearQuest Query being used uses the (Count) field exposed through the query builder.  Using the (Count) field allows the aggregation to occur within ClearQuest, as opposed to BIRT, which is more efficient than passing (potentially) thousands of rows to BIRT for summation.

Data Set Query:         <importfolder>/Count By State-Severity-Priority

BIRT computed columns: none

Query parameters:       none

Report parameters:      username, password

BIRT filters:           none

Required sub-reports:   none

 

 

Chart_DefectSeverityAndOwner.rptdesign:

This report design shows 2D distribution chart.  The X-axis is grouped by owner, with a custom expression that displays "<unassigned>" if there is no owner.  The Y-axis values are distinct counts of defects, grouped by defect severity.

Data Set Query:         <importfolder>/Defect Details for Report

BIRT computed columns: none

Query parameters:       none

Report parameters:      username, password

BIRT filters:           none

Required sub-reports:   none

 

 

Chart_StateTransitionsByDate.rptdesign:

This report design shows 3D line chart with drill down capability.  The X-axis is specified as the date (to the day) on which there was a state transition.  The Y-axis shows the number of distinct defect records that had a state transition on that specific day.  The Y-axis is further grouped by the state to which the defect record transitioned to.  Interactivity is defined for the Value (Y) Series.  In this case, enabling a Tooltip for the Mouse Over action showing the state and date for the specified point, and drill down to a sub-report for the Mouse Click action.  The sub-report is opened in another window when selected.

Data Set Query:         <importfolder>/State Transitions by Date

BIRT computed columns: CalculatedDateString

Query parameters:       none

Report parameters:      username, password

BIRT filters:           none

Required sub-reports:   StateTransitionsByDateDrilldown.rptdesign

 

 

Chart_UnresolvedDefectsByAgeInWeeks.rptdesign:

Shows a bar chart displaying the number of weeks since unresolved defects were submitted.  The X-axis shows the number of weeks since today, calculated at run-time*.  The Y-axis is the number of distinct records that were opened at that time frame.  The values are further grouped by State.  Interactivity is defined for the Value (Y) Series.  In this case enabling a Tooltip for the Mouse Over action showing the date time that the records were submitted.

Data Set Query:   <importfolder>/Unresolved Defects and Submit Date

BIRT computed columns: none

Query parameters:       none

Report parameters:      username, password

BIRT filters:           none

Required sub-reports:   none

*Note:  DateTimeSpan does not include a function to determine weeks, so the calculation is done based on the number of days, divided by 7, and rounded.

 

DefectDetailByID.rptdesign:

Shows report in grid format.  Report details are limited to a single defect record.  Report is intended to be used with the equals operator, although other operators are available for selection on the ListFieldOperator from the shared report library.  The header for the report makes use of Dynamic Text.

Data Set Query:         <importfolder>/Defect Details by ID

BIRT computed columns: none

Query parameters:       id_Operator, id_Parameter

Report parameters:      username, password, id_Operator, id_Parameter

BIRT filters:           none

Required sub-reports:   none

 

 

 

 

DefectSummaryByState.rptdesign:

Shows report in table format.  Drill down capability demonstrated on the ID column.  The hyperlinks provided in the ID column are tied to another report, and when selected, opens the sub-report in another window.

Data Set Query:         <importfolder>/Defect Summary by State

BIRT computed columns: none

Query parameters:       State_Operator, State_Parameter

Report parameters:      username, password, State_Operator,                               State_Parameter

BIRT filters:           none

Required sub-reports:   DefectDetailByID.rptdesign

 

 

 

 

StateTransitionsByDateDrilldown.rptdesign:

Shows report in table format, grouped by ID.  The grouping allows for all state transitions for a specific distinct defect record to be shown together.  This report is intended to be used as a sub-report, but can be used independently if desired.  This report uses the same query as the master report*, and filters the data based on the input parameters.  Drill down to a sub-report is enabled on the ID.

Data Set Query:         <importfolder>/State Transitions by Date

BIRT computed columns: CalculatedDateString

Query parameters:       none

Report parameters:      username, password, HistoryDateTime, State

BIRT filters:           CalculatedDateString, new_state

Required sub-reports:   DefectDetailByID.rptdesign

*Note:  The same ClearQuest query is used, however the query is being re-executed.