Integrate the reporting module to your app https://github.com/OpenSRP/opensrp-client-reporting
Add it to your dependencies in the projects'
build.gradlefileAdd the following lines to your Application Class
// Init Reporting library ReportingLibrary.init(context, getRepository(), null, BuildConfig.VERSION_CODE, BuildConfig.DATABASE_VERSION);
Add the required repositories from the reporting lib to your Apps Repository file
IndicatorRepository.createTable(database); IndicatorQueryRepository.createTable(database); DailyIndicatorCountRepository.createTable(database); //create the hia2Report table that stores the report before sync and updated the sync status after sync EventClientRepository.createTable(database, Hia2ReportRepository.Table.hia2_report, Hia2ReportRepository.report_column.values());
Depending on your implementation you may need to add code for the following screens,
Dally Tallies, Draft Monthly and Sent Monthly fragments
To get examples of the code you can view the code for the following project
To add queries for your indicators, you will need to add a file called
indicator-definitions.ymlThe
.ymlfile has the following structureindicators: - key: "ME_MAT_Child_HIV_Status_Unknown" description: "Maternity Child HIV Status Unknown" indicatorQuery: "SELECT count(*) from maternity_child WHERE child_hiv_status = 'Unknown' and '%s' = strftime('%Y-%m-%d', event_date)" grouping: "maternity" - key: "ME_MAT_Child_HIV_Status_Exposed" description: "Maternity Child HIV Status Exposed" indicatorQuery: "SELECT case when nvp_administration = 'No' THEN 'No_NVP' when nvp_administration = 'Yes' THEN 'NVP_Started' else 'Null' END NVP, count(1) from maternity_child WHERE child_hiv_status = 'Exposed' and '%s' = strftime('%Y-%m-%d', event_date)" isMultiResult: true expectedIndicators: - "ME_MAT_Child_HIV_Status_Exposed_No_NVP" - "ME_MAT_Child_HIV_Status_Exposed_NVP_Started" grouping: "maternity"groupingis optional if your app has only one module integratedkeyis used to identify the indicators (they have no spaces and special characters conventionally) , with some mapping from the strings file during render you can show a more readable key/text.descriptionis additional information of the indicatorindicatorQueryis the object that hold the query, in this field the following placeholder%s, is preserved for today's date inY-m-dsqlite date format. The query has to have a daily filter since the queries are aggregated upto monthly level.In this file you can have
simplequeries which return one result ormulti-resultquery that does the vice versa.
To start building daily tallies for queries in the
indicator-definitions.ymlfile add the following code in yourAppRepository.javafile.// initialize from yml file ReportingLibrary reportingLibraryInstance = ReportingLibrary.getInstance(); // Check if indicator data initialised boolean indicatorDataInitialised = Boolean.parseBoolean(reportingLibraryInstance.getContext() .allSharedPreferences().getPreference(indicatorDataInitialisedPref)); boolean isUpdated = checkIfAppUpdated(); if (!indicatorDataInitialised || isUpdated) { Timber.d("Initialising indicator repositories!!"); reportingLibraryInstance.initIndicatorData(indicatorsConfigFile, database); // This will persist the data in the DB reportingLibraryInstance.getContext().allSharedPreferences().savePreference(indicatorDataInitialisedPref, "true"); reportingLibraryInstance.getContext().allSharedPreferences().savePreference(appVersionCodePref, String.valueOf(BuildConfig.VERSION_CODE)); }This will add the indicators to the
hia2_indicatorstable. Checkout an example of aHIA2IndicatorsRepositoryin the following repositories https://github.com/OpenSRP/opensrp-client-giz-malawi or https://github.com/OpenSRP/opensrp-client-chw-coreThen add a call to a job as such below to begin the task of creating reports from the last time the job run.
RecurringIndicatorGeneratingJob.scheduleJob(RecurringIndicatorGeneratingJob.TAG, TimeUnit.HOURS.toMinutes(6), getFlexValue(BuildConfig.DATA_SYNC_DURATION_MINUTES));