dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #16958
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 6601: Reports inline help
------------------------------------------------------------
revno: 6601
committer: Lars Helge Overland <larshelge@xxxxxxxxx>
branch nick: dhis2
timestamp: Mon 2012-04-16 16:54:22 +0200
message:
Reports inline help
modified:
dhis-2/dhis-services/dhis-service-core/src/main/resources/help_content.xml
dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/mainForm.vm
dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/message.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/resources/org/hisp/dhis/reporting/i18n_module.properties
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/dataSetReportForm.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataCompletenessForm.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataMartForm.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDocumentForm.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewOrgUnitDistribution.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewPivotTableForm.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewReportForm.vm
dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewTableForm.vm
--
lp:dhis2
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk
Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription
=== modified file 'dhis-2/dhis-services/dhis-service-core/src/main/resources/help_content.xml'
--- dhis-2/dhis-services/dhis-service-core/src/main/resources/help_content.xml 2012-04-16 13:41:33 +0000
+++ dhis-2/dhis-services/dhis-service-core/src/main/resources/help_content.xml 2012-04-16 14:54:22 +0000
@@ -2894,20 +2894,33 @@
<section id="reporting_intro">
<title>Reporting functionality in DHIS 2</title>
<para>The reporting module in DHIS 2 provides a range of reporting alternatives, and this section will explain how to use them to view and analyse data. Another section explains how to configure and set up the various reporting tools.</para>
+<para><emphasis role="bold">Standard reports:</emphasis> Standard reports are built on report tables, but are more advanced in its design allowing for more cosmetics and styles. These reports can also combine multiple tables and charts in the same report and be made available as one-click reports that are very easy to use. These reports can be downloaded as PDF files which makes them ideal for printing as well as sharing offline. </para>
+<para><emphasis role="bold">Dataset reports:</emphasis> Dataset reports are simply a printer friendly way to look at the data entry forms with either raw or aggregated data (over time or place). The design used in data entry will be used also in the data set reports. This will work only for data sets that has a custom data entry form set up.</para>
<para><emphasis role="bold">Dashboard:</emphasis> The fastest way to view your data. The dashboard can display up to four updated charts as well as shortcuts to your favourite reports, report tables, and map views. Each user can configure a personal dashboard.</para>
<para><emphasis role="bold">Data Visualizer:</emphasis> Do flexible visualizations of your data as charts and data tables. Any numbe of indicators and data elements can be included. Several chart types are available, such as column, stacked column, line, area and pie charts. The charts can be saved in order to be easily retrieved later and can also be put on your personal dashboard. Charts can be downloaded as image and PDF files to your local computer. </para>
<para><emphasis role="bold">Report tables:</emphasis> These are very configurable table outputs of your data, either showing raw or aggregated data, as well as indicator data. These tables are used as either a data source for more advanced reports, for export to external systems, or as a crude report itself, and are exportable to pdf, excel, csv and jasper design files. These tables represent a very dynamic, flexible and quick way to look at the data. Report tables can be set up with parameters to make them reusable over time and place.</para>
-<para><emphasis role="bold">Standard reports:</emphasis> Standard reports are built on report tables, but are more advanced in its design allowing for more cosmetics and styles. These reports can also combine multiple tables and charts in the same report and be made available as one-click reports that are very easy to use. These reports can be downloaded as PDF files which makes them ideal for printing as well as sharing offline. </para>
-<para><emphasis role="bold">Dataset reports:</emphasis> Dataset reports are simply a printer friendly way to look at the data entry forms with either raw or aggregated data (over time or place). The design used in data entry will be used also in the data set reports. This will work only for data sets that has a custom data entry form set up.</para>
<para><emphasis role="bold">Orgunit distribution reports:</emphasis> These reports are generated off the orgunit group set information and can show what types (and how many of each type) of health facilities that are located in a given area (any level in the hierarchy). These reports are automatically generated and display the information in both tables and charts, and downloads in pdf, excel, and csv are available.</para>
<para><emphasis role="bold">Reporting rate summary:</emphasis> These reports provide a nice overview of how many facilities that have submitted their data for a given dataset and period. Here you can get both the counts and the percentages showing the reporting rate for all or single data sets.</para>
<para><emphasis role="bold">Excel pivot tables:</emphasis> Excel pivot tables represents a very powerful way to analyse your data and DHIS 2 links directly to the pivot tables so that all the data will be available and updated in your Excel file. This can be a very useful tool for users that prefer working with the data offline. To update your local pivot tables you need the myDatamart tool which connects to the online server and downloads the latest data. This update will typically take place once a month when new data is available, but do not require a constant internet connection like the other reporting tools (if you are connecting to an online DHIS 2 server).</para>
<para><emphasis role="bold">Web-based pivot tables:</emphasis> The built in pivot table tool is a simple web-based tool to display indicator data by orgunit and period in a typical pivot table view and allows for some basic pivoting manipulations of the tables. It is a quick and easy way to look at many indicator values at the same time (by orgunit and/or period), but does not have the same functionality as the offline Excel pivot tables. </para>
<para><emphasis role="bold">GIS:</emphasis> Present and analyse your data using thematic maps. You can view both data elements and indicators and given that you have coordinates for all your orgunits you can drill down the hierarchy and view maps for all levels from country polygons to facility points. See the separate chapter on GIS for more details. All the map information is built into DHIS 2 and all you need to do is to register coordinates for your organisation units and the maps will be available.</para>
</section>
+<section id="standard_reports">
+<title>Using standard reports</title>
+<para>You access the available reports from the Services drop-down menu, by selecting Reports. In the report menu in the left bar, click Standard Report. A list of all pre-defined reports will appear in the main window. </para>
+<screenshot>
+<screeninfo>Standard reports</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata width="100%" fileref="resources/images/dhis2UserManual/standard_reports_ke.png" format="PNG"/>
+</imageobject>
+</mediaobject>
+</screenshot>
+<para>You run/view a report by clicking on the white and green arrow next to the report you want. You will then see a report parameter window where you must fill in the values needed for orgunit and/or reporting month, depending on what has been defined in the underlying report table(s). Click on "Get Report" when you are ready. The report will wither apper directly in your browser or be available as a .pdf file for download, depending on your browser settings for handling pdf files. You can save the file and keep it locally on your computer for later use. </para>
+</section>
<section id="report_tables">
<title>Using report tables</title>
-<para>Report tables are one of the more basic report options, but are fast and simple to use. To run a report table first navigate to the list of available report tables in Services->Reports->Report Tables and the click on the Green and white arrow (the first symbol in the operations list) next to the report table you want to view. </para>
+<para>Report tables is a simple-to-use tool for creating tabular analysis. To run a report table first navigate to the list of available report tables in Services->Reports->Report Tables and the click on the Green and white arrow (the first symbol in the operations list) next to the report table you want to view. </para>
<para><emphasis role="bold">Report parameters:</emphasis> Most report tables have parameters, which means that you can filter which orgunits and/or periods you want in the report. This makes the reports much more reusable. When you run the report table a Report parameter window will open and ask the user to input values for the selected parameters. The possible parameters are Reporting Month and Organisation Unit, and either one of these or both will show in the window. After selecting the values click on the Get Report button.</para>
<screenshot>
<screeninfo>Report table parameters</screeninfo>
@@ -2928,19 +2941,6 @@
</screenshot>
<para> </para>
</section>
-<section id="standard_reports">
-<title>Using standard reports</title>
-<para>You access the available reports from the Services drop-down menu, by selecting Reports. In the report menu in the left bar, click Standard Report. A list of all pre-defined reports will appear in the main window. </para>
-<screenshot>
-<screeninfo>Standard reports</screeninfo>
-<mediaobject>
-<imageobject>
-<imagedata width="100%" fileref="resources/images/dhis2UserManual/standard_reports_ke.png" format="PNG"/>
-</imageobject>
-</mediaobject>
-</screenshot>
-<para>You run/view a report by clicking on the white and green arrow next to the report you want. You will then see a report parameter window where you must fill in the values needed for orgunit and/or reporting month, depending on what has been defined in the underlying report table(s). Click on "Get Report" when you are ready. The report will wither apper directly in your browser or be available as a .pdf file for download, depending on your browser settings for handling pdf files. You can save the file and keep it locally on your computer for later use. </para>
-</section>
<section id="dataset_reports">
<title>Using dataset reports</title>
<para>Dataset reports are printer friendly views of the data entry screen filled with either raw or aggregated data. These are only available for data sets that have custom data entry forms and not for default or section forms.</para>
@@ -2952,6 +2952,11 @@
<para><emphasis role="bold">Reporting Organisation unit:</emphasis> Here you select the orgunit you want the report for. This can be at any level in the hierarchy as the data will be aggregated up to this level automatically (if you do not tick the option above).</para>
<para>When you are done filling in the report criteria you click on "Generate". The report will appear in html view in a printer-friendly format. Use print and save as functions in the browser to print or save (as html) the report.</para>
</section>
+<section id="resource">
+<title>Using resources</title>
+<para>The resource tool allows you to upload both files from your local computer to the DHIS server and to add links to other resources on the Internet through URLs. If you want to share the direct link to the DHIS resource you can right clik on the "view resource" button and copy the link address.</para>
+<para>The create a resource click on the "Add new" button. Enter a name for the resource, then choose between uploading a file or external URL. If you chose file upload click "Choose file" and select your file your local computer. If you chose URL enter the link to the resource on the Internet. Then click "Save".</para>
+</section>
<section id="data_visualizer">
<title>Using data visualizer</title>
<para>The data visualizer module can be accessed under "Services" in the top menu. See the chapter called "Using data visualizer" for a thorough explanation of this module.</para>
@@ -3015,6 +3020,19 @@
</mediaobject>
</screenshot>
</section>
+<section id="web_pivot_table">
+<title>Using web pivot table</title>
+<para>The web pivot table is a tool for displaying and pivoting indicator and data element data in an easy way. From the open data selection box start by selecting data type which can be data elements or indicators. Select the a group as a filter or leave it on "All". Select start date, end date and period type to indicate which periods you want to include in the pivot table. Continue by selecting an organisation unit from the selection tree. The childeren at the level below the selected organisationn unit will be included in the pivot table. Then click "Get data".</para>
+<para>After loading a pivot table you will see that indicators (or data elements) will appear on top as columns, while periods and organiation units are combined as rows. If you want to pivot the table click on the "Pivot" button and select new dimensions. These dimensions will be displayed as columns in the table when clicking "Pivot".</para>
+<para>In the pivot table you can click on any cell in order to show a menu. From this menu you can choose to visualize the relevant indicator, org unit and period as various chart variants.</para>
+<para>To save the pivot table data to your local computer click the "Download as excel" button. The Excel workbook will show each period as a sheet.</para>
+</section>
+<section id="data_mart">
+<title>Using data mart management</title>
+<para>The data mart is a set of tables in the DHIS database which is used by all reporting and analysis tools to retrieve data from. The data mart is populated based on the collected data. This management user interface allows you to controll that process of converting collected data into aggregated data and write to the data mart.</para>
+<para>The data mart management screen allows you to select period types, start date and end date which will control which periods are included in the data mart process. By default all data elements, indicators and organisation units will be included.</para>
+<para>The data mart process might take a long time and heavily utilize the resources of your server so make sure you start such processes at a feasible time in production environments. Data mart processes can be scheduled as regular tasks in the data administration module.</para>
+</section>
</chapter>
<chapter>
<title>Data entry</title>
=== modified file 'dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/mainForm.vm'
--- dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/mainForm.vm 2012-03-09 17:36:22 +0000
+++ dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/mainForm.vm 2012-04-16 14:54:22 +0000
@@ -52,7 +52,7 @@
</div>
#end
-<h3>$i18n.getString( "dashboard" )
+<h3>$i18n.getString( "dashboard" ) #openHelp( "dashboards_setup" )
• <a href="showSendFeedback.action">$i18n.getString( "write_feedback" )</a>
#if( $messageCount > 0 )• <a href="message.action">$messageCount #if( $messageCount > 1 )$i18n.getString( "unread_messages" )#else$i18n.getString( "unread_message" )#end</a> #end</h3>
=== modified file 'dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/message.vm'
--- dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/message.vm 2012-02-15 17:26:35 +0000
+++ dhis-2/dhis-web/dhis-web-dashboard-integration/src/main/webapp/dhis-web-dashboard-integration/message.vm 2012-04-16 14:54:22 +0000
@@ -2,7 +2,7 @@
var i18n_confirm_delete_message = '$encoder.jsEscape( $i18n.getString( "confirm_delete_message" ) , "'" )';
</script>
-<h3>$i18n.getString( "messages" )</h3>
+<h3>$i18n.getString( "messages" ) #openHelp( "dashboard_messages" )</h3>
<div style="margin-bottom:15px">
#if( $auth.hasAccess( "dhis-web-dashboard-integration", "sendMessage" ) )
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/resources/org/hisp/dhis/reporting/i18n_module.properties'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/resources/org/hisp/dhis/reporting/i18n_module.properties 2012-04-05 13:13:13 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/resources/org/hisp/dhis/reporting/i18n_module.properties 2012-04-16 14:54:22 +0000
@@ -207,4 +207,5 @@
include_regression=Include regression
print=Print
reporting_period=Reporting period
-completed_by=Completed by
\ No newline at end of file
+completed_by=Completed by
+view_resource=View resource
\ No newline at end of file
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/dataSetReportForm.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/dataSetReportForm.vm 2012-02-05 13:08:51 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/dataSetReportForm.vm 2012-04-16 14:54:22 +0000
@@ -23,7 +23,7 @@
padding-bottom: 5px;
}
</style>
-<h3>$i18n.getString( "dataset_report" )</h3>
+<h3>$i18n.getString( "dataset_report" ) #openHelp( "dataset_reports" )</h3>
<div id="control">
<input type="button" value='$i18n.getString( "data" )' style="width:120px" onclick="showCriteria()" />
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataCompletenessForm.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataCompletenessForm.vm 2012-03-18 22:44:02 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataCompletenessForm.vm 2012-04-16 14:54:22 +0000
@@ -9,7 +9,7 @@
var i18n_please_select_period = '$encoder.jsEscape( $i18n.getString( "please_select_period" ) , "'")';
</script>
-<h3>$i18n.getString( "reporting_rate_summary" )</h3>
+<h3>$i18n.getString( "reporting_rate_summary" ) #openHelp( "reporting_reporting_rate_summary" )</h3>
<div id="critiera" class="inputCriteria" style="width:660px;height:310px;">
<table>
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataMartForm.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataMartForm.vm 2012-04-11 09:02:06 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDataMartForm.vm 2012-04-16 14:54:22 +0000
@@ -1,4 +1,4 @@
-<h3>$i18n.getString( "data_mart_management" )</h3>
+<h3>$i18n.getString( "data_mart_management" ) #openHelp( "data_mart" )</h3>
<div id="critiera" class="inputCriteria" style="width:380px;height:170px;">
<table>
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDocumentForm.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDocumentForm.vm 2012-03-10 10:09:51 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewDocumentForm.vm 2012-04-16 14:54:22 +0000
@@ -7,7 +7,7 @@
var i18n_confirm_add_to_dashboard = '$encoder.jsEscape( $i18n.getString( "confirm_add_to_dashboard" ) , "'")';
</script>
-<h3>$i18n.getString( "resource" )</h3>
+<h3>$i18n.getString( "resource" ) #openHelp( "resource" )</h3>
<table class="mainPageTable">
<col>
@@ -37,9 +37,9 @@
<td>$encoder.htmlEncode( $document.name )</td>
<td>
#if ( $document.external )
- <a href="${document.url}" title="$i18n.getString( 'view_report' )">
+ <a href="${document.url}" title="$i18n.getString( 'view_resource' )">
#else
- <a href="../api/documents/${document.uid}/data" title="$i18n.getString( 'view_report' )">
+ <a href="../api/documents/${document.uid}/data" title="$i18n.getString( 'view_resource' )">
#end
<img src="../images/start_process.png" alt="$i18n.getString( 'view_report' )"></a>
<a href="displayAddDocumentForm.action?id=$!document.id" title="$i18n.getString( "edit" )"><img src="../images/edit.png" alt="$i18n.getString( "edit" )"></a>
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewOrgUnitDistribution.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewOrgUnitDistribution.vm 2012-03-18 22:44:02 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewOrgUnitDistribution.vm 2012-04-16 14:54:22 +0000
@@ -9,7 +9,7 @@
var i18n_select_org_unit = '$encoder.jsEscape( $i18n.getString( "please_select_org_unit" ) , "'")';
</script>
-<h3>$i18n.getString( "orgunit_distribution" )</h3>
+<h3>$i18n.getString( "orgunit_distribution" ) #openHelp( "orgunit_distribution_reports" )</h3>
<!-- Criteria -->
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewPivotTableForm.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewPivotTableForm.vm 2012-03-07 10:32:33 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewPivotTableForm.vm 2012-04-16 14:54:22 +0000
@@ -34,7 +34,7 @@
margin-bottom: 15px;
}
-div#pivot222
+div#pivot
{
position: relative;
left: 2px;
@@ -45,7 +45,6 @@
padding-left: 20px;
margin-bottom: 6px;
border-radius: 3px;
- -moz-border-radius: 3px; /* Firefox */
}
div.inputSection
@@ -81,13 +80,13 @@
</style>
-<h3>$i18n.getString( "pivot_table" )</h3>
+<h3>$i18n.getString( "pivot_table" ) #openHelp( "web_pivot_table" )</h3>
<!-- Control panel -->
<div id="control">
-<input type="button" value='$i18n.getString( "data" )' style="width:110px" onclick="showCriteria()" />
-<input type="button" value='$i18n.getString( "pivot" )' style="width:110px" onclick="showPivot()" />
+<input type="button" value="$i18n.getString( 'data' )" style="width:110px" onclick="showCriteria()" />
+<input type="button" value="$i18n.getString( 'pivot' )" style="width:110px" onclick="showPivot()" />
<input type="button" value="$i18n.getString( 'get_report_as_xls' )" onclick="exportXls()" style="width:130px">
<label id="dataLabel" style="color:#606060"></label>
</div>
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewReportForm.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewReportForm.vm 2011-03-28 20:09:32 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewReportForm.vm 2012-04-16 14:54:22 +0000
@@ -7,7 +7,7 @@
var i18n_confirm_add_to_dashboard = '$encoder.jsEscape( $i18n.getString( "confirm_add_to_dashboard" ) , "'")';
</script>
-<h3>$i18n.getString( "standard_report" )</h3>
+<h3>$i18n.getString( "standard_report" ) #openHelp( "standard_reports" )</h3>
<table class="mainPageTable">
<col>
=== modified file 'dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewTableForm.vm'
--- dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewTableForm.vm 2011-05-29 19:39:28 +0000
+++ dhis-2/dhis-web/dhis-web-reporting/src/main/webapp/dhis-web-reporting/viewTableForm.vm 2012-04-16 14:54:22 +0000
@@ -10,7 +10,7 @@
var i18n_no = '$encoder.jsEscape( $i18n.getString( "no" ) , "'")';
</script>
-<h3>$i18n.getString( "report_table" ) #openHelp( "reportTable" )</h3>
+<h3>$i18n.getString( "report_table" ) #openHelp( "report_tables" )</h3>
<table class="mainPageTable">
<tr>
