HowTo develop a new report

Example

This page uses the "Partner by City" as an example.

Report Definition

• this is for the sql queries and instructions how to calculate and render the report
• create new html report file in XmlReports/Partner/partnerbycity.html. See https://github.com/openpetra/openpetra/blob/master/XmlReports/Partner/partnerbycity.html

GUI Definition

• this is for defining how a screen should look like that presents all parameters of the report to the user
• see https://github.com/openpetra/openpetra/blob/master/js-client/src/forms/Partner/Reports/PartnerReports/PartnerByCity.html
• see https://github.com/openpetra/openpetra/blob/master/js-client/src/forms/Partner/Reports/PartnerReports/PartnerByCity.json

Data Calculation

For calculation of the data, see this class:

• https://github.com/openpetra/openpetra/blob/master/csharp/ICT/Petra/Server/lib/MReporting/MPartner/PartnerByCity.cs

Navigation

• see https://github.com/openpetra/openpetra/blob/master/js-client/etc/UINavigation.yml#L38

        Partner: {fa-icon=address-book, PermissionsRequired=PTNRUSER}
                Partners:
                    AddNewFamily: {Form=MaintainPartners, Action=NewFamily, fa-icon=user-plus}
                    AddNewOrganisation: {Form=MaintainPartners, Action=NewOrganisation, fa-icon=folder-plus}
                    MaintainPartners: {fa-icon=user}
                    ImportPartners: {fa-icon=file-import}
                    Reports: {Path=Partner/Reports/PartnerReports}
                        PartnerByCity:
                        PartnerBySpecialType:
                        PartnerBySubscription:
                        AnnualReportWithoutAnnualReceiptRecipients: