Difference between revisions of "New Report Design - 2009"

From Catglobe Wiki
Jump to: navigation, search
(Finish 0.2)
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<accesscontrol>Main:MyGroup</accesscontrol>
 +
[[Category:Miscellaneous]]
 
== Introduction ==
 
== Introduction ==
 
[[Image:ReportEngine.jpg]]
 
[[Image:ReportEngine.jpg]]
Line 64: Line 66:
 
* [[Report unit testing system]]
 
* [[Report unit testing system]]
 
* [[Diagram generation process]]
 
* [[Diagram generation process]]
 +
* [[DiagramInfo]]
 
* [[Tabulation Script]]
 
* [[Tabulation Script]]
 
* [[Tabulation Script for setting inline style to Table Chart]]
 
* [[Tabulation Script for setting inline style to Table Chart]]
 
* [[Diagram viewer control]]
 
* [[Diagram viewer control]]
 +
* [[Cross diagram settings control]]
 
* [[Report viewer control]]
 
* [[Report viewer control]]
 
* [[Integrating with Dashboard]]
 
* [[Integrating with Dashboard]]
 
* [[Integrating with Monitor]]
 
* [[Integrating with Monitor]]
 +
* [[Generic object visitor pattern]]
 +
* [[Generic XML de-/serialization]]
 +
* [[DiagramInfo de-/serialization]]
 +
* [[Table chart builder]]
 +
* [[Integrating Ajax.Pro and MS AJAX.NET Json Serialization]]
 +
* [[Full CrossDigramImplementation]]
 +
* [[TrackingDiagram]]
 +
* [[Support for IFKA cross diagram layout]]
 +
* [[XmlVisitor]]
 +
* [[Pdf table layout]]
 +
* [[Make pdf generation process in parallel mode]]
 +
 +
== Presentations ==
 +
* [http://wiki.catglobe.com/images/5/51/NewReportSystem.ppt NewReportSystem.ppt]
 +
* [http://wiki.catglobe.com/images/8/87/NewReportSystem_-_Unit_Test.ppt NewReportSystem - Unit Test.ppt]
 +
* [http://wiki.catglobe.com/images/e/ef/NewReportSystem_-_Table_chart_builder.ppt NewReportSystem - Table chart builder.ppt]
 +
* [http://wiki.catglobe.com/images/5/5d/NewReportSystem_-_Diagram_generation.ppt NewReportSystem - Diagram generation.ppt]
 +
 +
== Test cases ==
 +
* [[Test case - Diagram viewer page]]
 +
 +
== Lesson learn ==
 +
This section lists all the:
 +
* ''Mistakes''
 +
* ''Useful knowledge''
 +
that we have encountered during implementation.
 +
 +
* [[Code that MUST be improved]]
 +
* [http://wiki.catglobe.com/images/9/90/Transferring_Array_object_among_different_javascript_context.ppt Transferring Array object among different javascript context]
 +
* [http://wiki.catglobe.com/images/b/bf/Associated_array_vs_MS.AJAX_NET_vs_for_each_loop.ppt Associated array vs MS.AJAX NET vs for each loop]
  
 
== Current implementation status ==
 
== Current implementation status ==
 
{| border="1"
 
{| border="1"
 
|-
 
|-
−
| '''Task'''  
+
| '''Modules'''  
−
| '''Current status'''  
+
| '''Done'''  
−
| '''Planned actions'''  
+
| '''To be done'''
 +
| '''Time estimation'''
 
|-
 
|-
−
| Implementation
+
| CrossDiagram
 
|  
 
|  
−
* Generation process
+
* Rather stable with lot of unit tests
−
** Data generation is well defined and tested
+
|
−
* Image charts
+
* Missing feature (VN2950REP - CrossDiagram - Support missing features in 5.8):
−
** Bar/Line/Pie/Radar charts have been implemented for single case of CrossDiagram
+
** Weight
−
** All stylesheet and dom operations are split into different files to ease the maintenance, however the files are still messy and need cleanup
+
** Left header
−
* Table charts
+
** Show error
−
** Table adaptors have been defined and tested
+
|
−
** Prototype for splitting huge table into sub-tables has been done
+
''TODO''
−
** Full support for HTML
+
|-
−
** Acceptable support for PDF
+
| Nevron (image) charts
−
* Stylesheet
+
|
−
** The stylesheet is kept as is intentionally to isolate to keep changing as the minimal level
+
* Bar/Line/Pie/Radar charts have been implemented for single case of CrossDiagram => However the design is not good enough !
−
* Tabulation Script
+
|
−
** The main script library has been moved to CatGlobe.Report assembly
+
* A new design and implement will be done (VN2894REP - Reimplement NevronBuilder)
−
** The code is hacked (with minimum impact) to allow plugging of new report's script library
+
|
−
** Diagram can be created using script
+
''TODO''
−
* Web controls
+
|-
−
** DiagramViewer control has been created
+
| Table charts
−
** DiagramSettings control has been created also, however this need more time to implement custom business and testing
+
|
 +
* Rather complete
 +
|
 +
* Support exporting to PDF with nice layout (VN2808REP - Make PDF output look nice without fiddling with stylesheet)
 +
* More request from the customer (VN2813REP - Conditional Formatting)
 +
|
 +
''TODO''
 +
|-
 
|  
 
|  
−
* Generation process
+
Stylesheet
−
** Apply data generation for the full CrossDiagram
+
|
−
** Apply data generation for other Diagrams
+
* The stylesheet is kept as is intentionally in order to keep changing at the minimal level
−
** Optimize values calculation
+
|
−
** Save calculation result to XML
+
* Redefine the hierarchy of stylesheet classes
−
* Image charts
+
|
−
** Full testing (manual) is required after DiagramViewer page have finished
+
''TODO''
−
* Table charts
 
−
** Apply external stylesheet
 
−
** Apply the table splitting code
 
−
** Support for PPT/Exel
 
−
* Stylesheet
 
−
** Redefine the hierarchy of stylesheet classes
 
−
* Tabulation Script
 
−
** Move all implementations to new assembly
 
−
* Web controls
 
−
** Implement ReportViewer control and page
 
−
** Apply DiagramViewer to Dashboard and Monitor
 
−
** Apply ReportViewer to TabulationScript result viewer page
 
 
|-
 
|-
−
| Intergration
+
| Tabulation Script
 +
|
 +
* Rather complete
 +
|
 +
* Add missing features (VN2951REP - TabulationScript - Support all PDF related scripts)
 +
|
 +
''TODO''
 +
|-
 +
| Web controls
 +
|
 +
* GUI for crossdiagram is nice enough
 
|  
 
|  
−
* Code has been committed
+
* More advance implementation with real Skin support (VN2895REP - Support skin for Setting control)
−
* Side-by-side Nevron's assemblies deployment is fine
+
* Increase the ratio of unit testing on GUI
−
* However, the project files (to actually build the new code into trunk) are not yet committed
+
|
−
* DiagramViewer page has been created
+
''TODO''
 +
|-
 +
| Unit tests
 
|  
 
|  
−
* Commit everything after version 5.8 has been released
+
* Rather complete for crossdiagram
−
* Finish DiagramViewer page => replace the current page
+
* 3D image assertion => ''at last resort compare byte to byte, another approach is comparing by calculating hash value''
−
* Start the ReportViewer page
+
|
−
* Start integrating to Monitor
+
* Integrate with CruiseControl for running everyday
−
* Start integrating to Dashboard
+
* Web-testing for testing controls
−
* Start integrating to Tabulation Script
+
* Ppt/Excel assertion => ''Use new XML format of Office'' (VN2779REP - Upgrade Slide component)
 +
* Configuration settings for hard-coded values
 +
|
 +
''TODO''
 
|-
 
|-
 
| Optimization
 
| Optimization
 
|
 
|
 +
* Stylesheet rendering is being optimized for using with AJAX
 
|
 
|
−
* Unit/Integration tests code coverage must be checked => acceptable ratio is 85%
 
 
* Code profiling must be done => minor change in design
 
* Code profiling must be done => minor change in design
 
* Performance counter must be implemented
 
* Performance counter must be implemented
 
* Generation time must less than current system
 
* Generation time must less than current system
−
|-
+
|
−
| Testing
+
''TODO''
−
|
 
−
* Test data generation API is completed
 
−
* Testers have created most of the current test cases
 
−
|
 
−
* Configuration settings for hard-coded values
 
−
* Check code coverage => define more test cases
 
−
* Ppt/Excel assertion
 
−
* Integrate CatGlobe.Report.Test project back to DomainTester project
 
−
* Testing of controls and javascript code
 
 
|}
 
|}
  
Line 180: Line 216:
 
| Finish version 0.2
 
| Finish version 0.2
 
| 54885
 
| 54885
 +
|-
 +
| 0.3
 +
| 27.10.2009
 +
| Nguyen Trung Chinh
 +
| Update implementation status
 +
| 57470
 +
|-
 +
| 0.4
 +
| 31.12.2009
 +
| Nguyen Trung Chinh
 +
| Update status and new projects
 +
| 59167
 
|}
 
|}

Latest revision as of 04:10, 18 October 2013

<accesscontrol>Main:MyGroup</accesscontrol>

Introduction

ReportEngine.jpg

The components/modules that are using Report engine are: Dashboard, Monitor, Tabulation Script, Report Viewer, Diagram Viewer. These modules send request of generation to report engine including:

  • A data cache which contains all source data
  • Stylesheets (including external and inline stylesheet) to apply
  • Kind of presentation that the report should be exported as (pdf, excel, ppt, word, html, image)
  • Other kinds of settings

The report engine takes the request, make calculation using the Interpreter, and then export the result into desired format.

A report consists of elements like: diagrams, images, text blocks, pages, paragraphs. The most important element is Diagram, which can be discriminated based on:

  • Data
    • Cross Diagram
    • Standard Diagram
    • Tracking Diagram
    • Campaign Diagram
  • Presentation type
    • Table chart
    • Image chart which include many kinds of chart like: pie, bar, line, funnel, area, radar etc.

Why a new system?

Current system drawbacks

  • Heavy XML processing
  • Heavy code duplication
  • Inconsistent generation process

Thus it makes the cost of fixing bugs and maintain the old system greater than the cost of making an new system.

New system goals

  • Remove the drawbacks of current system
  • Side by side working with the old system
  • Fully unit testing
  • Unit/Integration tests can be run automatically
  • Testing API must be simple enough for testers to join writing test cases
  • Report API must be keep as simplest as possible
  • Design documents must be officially registered on wiki page

Approach to new system

Steps are defined for approaching the new system, which are described below:

  • Take the smallest possible case for prototyping (CrossDiagram with one axis for both row and column)
  • Design the core functions to server the single case with full testing
  • Approach in depth to:
    • Tabulation Script
    • Diagram Viewer
    • StyleSheet
    • Different presentation types
  • Move on with Report and Report Viewer
  • Move on with Monitor
  • Move on with Dashboard
  • Move on with data calculation optimization
  • Performance refining => change design and test cases
  • Full implementation for:
    • Cross Diagram
    • Other diagrams
    • All presentation types
  • Replace the old system's gui components

Design details

Presentations

Test cases

Lesson learn

This section lists all the:

  • Mistakes
  • Useful knowledge

that we have encountered during implementation.

Current implementation status

Modules Done To be done Time estimation
CrossDiagram
  • Rather stable with lot of unit tests
  • Missing feature (VN2950REP - CrossDiagram - Support missing features in 5.8):
    • Weight
    • Left header
    • Show error

TODO

Nevron (image) charts
  • Bar/Line/Pie/Radar charts have been implemented for single case of CrossDiagram => However the design is not good enough !
  • A new design and implement will be done (VN2894REP - Reimplement NevronBuilder)

TODO

Table charts
  • Rather complete
  • Support exporting to PDF with nice layout (VN2808REP - Make PDF output look nice without fiddling with stylesheet)
  • More request from the customer (VN2813REP - Conditional Formatting)

TODO

Stylesheet

  • The stylesheet is kept as is intentionally in order to keep changing at the minimal level
  • Redefine the hierarchy of stylesheet classes

TODO

Tabulation Script
  • Rather complete
  • Add missing features (VN2951REP - TabulationScript - Support all PDF related scripts)

TODO

Web controls
  • GUI for crossdiagram is nice enough
  • More advance implementation with real Skin support (VN2895REP - Support skin for Setting control)
  • Increase the ratio of unit testing on GUI

TODO

Unit tests
  • Rather complete for crossdiagram
  • 3D image assertion => at last resort compare byte to byte, another approach is comparing by calculating hash value
  • Integrate with CruiseControl for running everyday
  • Web-testing for testing controls
  • Ppt/Excel assertion => Use new XML format of Office (VN2779REP - Upgrade Slide component)
  • Configuration settings for hard-coded values

TODO

Optimization
  • Stylesheet rendering is being optimized for using with AJAX
  • Code profiling must be done => minor change in design
  • Performance counter must be implemented
  • Generation time must less than current system

TODO

Document revisions

Version No. Date Changed By Description Svn revision
0.1 27.04.2009 Nguyen Trung Chinh Create the first version for working with a single case of CDG NA
0.1 20.07.2009 Nguyen Trung Chinh Refine the document NA
0.2 30.07.2009 Nguyen Trung Chinh Finish version 0.2 54885
0.3 27.10.2009 Nguyen Trung Chinh Update implementation status 57470
0.4 31.12.2009 Nguyen Trung Chinh Update status and new projects 59167
Retrieved from "http://wiki.catglobe.com/index.php?title=New_Report_Design_-_2009&oldid=24722"