Mifos BI File Structure

Owned by Kay Chau
Last updated: Jan 04, 2011 by Jakub Sławiński (Unlicensed)Version comment

This page is to document our findings and decisions on setting up reports folder structure for Mifos BI Suite.

Goals

  • Easy to follow structure for reports and files and associated with them
  • Easy for community members to get the latest reports and deploy them
  • Easy for Mifos team to deploy reports releases to the cloud
  • Similar structure in git to what we will officially release and deploy
  • Able to release reports frequently

Non-Goals

  • Automatic installer for Mifos Reports

Other

  • Mifos ships with "Standard Reports" - these are reports we will provide as part of releases and continue to provide support for
  • Reports others in the community provide are separate
  • Mifos Standard Reports will all use CDF (for the near future) to display parameters

Structure of reports folder

Our standard reports should be structured in the following way:

1) in Git:

- reports/

    - standardReports/

        - report1.html

        - report1.xcdf

        - ...

        - reportN.html

        - reportN.xcdf

        - prpts/

            - report1.prpt

            - ...

            - reportN.prpt

index.xml from prpts directory has 'visible' property set to false, so the above structure can be directly deployed to pentaho-solutions server:

2) on bi server:

- pentaho-solutions/

    - standardReports/

        - report1.html

        - report1.xcdf

        - ...

        - reportN.html

        - reportN.xcdf

        - prpts/

            - report1.prpt

            - ...

            - reportN.prpt

By using the above structure we only show CDF filters to the end users. Moreover, we can still show reports without CDF by putting them directly under standardReports directory.