Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Projects

Page tree
Skip to end of metadata
Go to start of metadata

Background

The BIRT module is used to create, execute and display BIRT content using the reporting engine and OpenMRS data. So, we're looking for a design with the following requirements. 

Timeline

Module design 

This is the current phase of the design to be enhanced over time.

List Reports

Please configure the Balsamiq Wireframes macro and select the wireframe to show. Learn more

Report (Report design(s) or dataset(s) generation)

Please configure the Balsamiq Wireframes macro and select the wireframe to show. Learn more
Please configure the Balsamiq Wireframes macro and select the wireframe to show. Learn more

Download Report Design and DataSets

Please configure the Balsamiq Wireframes macro and select the wireframe to show. Learn more

Create a New Report 

Please configure the Balsamiq Wireframes macro and select the wireframe to show. Learn more

Edit Report

View All Reports

Please configure the Balsamiq Wireframes macro and select the wireframe to show. Learn more

Convert and Download Report 

*

Please configure the Balsamiq Wireframes macro and select the wireframe to show. Learn more
*

  • No labels

1 Comment

  1. I'm a little confused by the requirements above. The reporting module already provides user interfaces for creating a new report definition, adding one or more datasets into the report definition, specifying one or more renderers that can produce a report from this report definition, and uploading design files for renderers as appropriate. It also provides a UI for viewing all existing report definitions, including filtering and pagination, editing and deleting. None of this is really required for this project, particularly in the first pass, so I do not think implementing any of the above mockups is desirable.

    Regarding the list of requirements:

    • Any "publishing" of report definitions should happen as a general reporting module enhancement and there is already a ticket for this work. It is outside the scope of the BIRT module integration project.
    • I see the actual BIRT report design process as happening outside of OpenMRS in an external BIRT Report Design tool. So I do not see how "previewing report before saving to OpenMRS" fits in.

    In general I think the requirements of the module can be summed up as:

    • Implement a ReportRenderer that can take a ReportDefinition and a BIRT Report Design file and produce appropriate, accurate rendered outputs
    • Provide tools (either via an ODA driver, web services, etc) in OpenMRS to facilitate authoring and previewing a report within an external BIRT report designer.
    • Implement everything (including any BIRT library dependencies) in a module so that someone who wishes to use the BIRT module does not need to install any additional dependencies on their server in order to do so.