dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #29500
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1029: Update User manual Approval chapter
------------------------------------------------------------
revno: 1029
committer: Jim Grace <jimgrace@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Sun 2014-04-20 15:29:40 -0400
message:
Update User manual Approval chapter
added:
src/docbkx/en/resources/images/dhis2UserManual/approval_level_steps.png
src/docbkx/en/resources/images/dhis2UserManual/approval_partner_example.png
modified:
src/docbkx/en/dhis2_user_man_approving_data.xml
--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs
Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription
=== modified file 'src/docbkx/en/dhis2_user_man_approving_data.xml'
--- src/docbkx/en/dhis2_user_man_approving_data.xml 2014-01-03 14:22:28 +0000
+++ src/docbkx/en/dhis2_user_man_approving_data.xml 2014-04-20 19:29:40 +0000
@@ -1,11 +1,10 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. -->
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
<chapter>
<title>Data approval</title>
- <para>DHIS 2 has an optional feature that allows authorized users to approve data that has been entered. It allows data to be reviewed and approved at each level in the organisation unit hierarchy, so the approval follows the structure of the hierarchy from lower levels to higher levels.</para>
- <para>Data may be approved for each combination of (a) data set, (b) period and (c) organisation unit. Data may be approved for the organisation unit for which it is entered, as well as for higher-level organisation units to which the data is aggregated. It can be approved for a higher-level organisation unit only after it has been approved for all that organisation unit's children for the same data set and period.</para>
- <para>After a data set, period and organiasation unit combination has been approved, the form will
+ <para>DHIS 2 has an optional feature that allows authorized users to approve data that has been entered. It allows data to be reviewed and approved at selected levels in the organisation unit hierarchy, so the approval follows the structure of the hierarchy from lower levels to higher levels.</para>
+ <para>Data is approved for a combination of (a) data set, (b) period and (c) organisation unit. Data may be approved for the organisation unit for which it is entered, as well as for higher-level organisation units to which the data is aggregated. As part of system settings, you can choose the organisation unit level(s) at which data is approved. It can be approved at higher levels only after it has been approved for all that organisation unit's descendants at lower levels for the same data set and period.</para>
+ <para>After a data set, period and organisation unit combination has been approved, the form will
be locked and any further data entry or modification will be prohibited, unless it is later
un-approved.</para>
<para>For example, the following diagram illustrates that data has already been approved for organisation units C and D, for a given data set and period. It may now be approved for organisation unit B for the same data set and period. But it is not ready to be approved for organization unit A. Before it can be approved for organisation unit A, it must be approved for B, and for any other children of organisation unit A, for that data set and period.</para>
@@ -18,45 +17,220 @@
</mediaobject>
</figure>
<section>
+ <title>Approving and accepting</title>
+ <para>DHIS2 supports two different types of approval processes: either a one-step process where the data is approved at each level, or a two-step process where data is first approved and then accepted at each level. This is illustrated in the following diagram:</para>
+ <figure>
+ <title>Approving and accepting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="300px" align="center" fileref="resources/images/dhis2UserManual/approval_level_steps.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the one-step process, data is approved at one level, and then approved at the next higher level. Until it is approved at the next higher level, it may be unapproved at the first level. (For example, if the data was approved my mistake, this allows the approver to undo their mistake.) Once the data is approved at the next higher level, it may not be unapproved at the lower level unless it is first unapproved at the higher level. </para>
+ <para>In the two-step process, data is approved at one level, and then the approval is accepted at the same level. This acceptance is done by a user who is authorized to approve data at the next higher level. Once the data is accepted, it may not be changed or unapproved unless it is first <emphasis role="italic">unaccepted</emphasis>.</para>
+ <para>The two-step process is not required by DHIS2. It is an optional step for a user reviewing data at the next higher level. It has the benefit of locking the acceptance from the level below, so reviewer does not have to worry that the data could be changing from below while it is being reviewed. It can also be used by the higher-level user to keep track of which lower-level data has already been reviewed.</para>
+ </section>
+ <section>
<title>Configure approving data</title>
<para>When you add or edit a data set, you specify whether or not data entered for that data set
- will be available for approval. This is done with the <emphasis role="italic">Approve
- data</emphasis> option when adding or editing a data set.</para>
+ will be available for approval. This is done with the <emphasis role="italic">Approve data</emphasis> option when adding or editing a data set.</para>
+ <para>You can configure the organisation unit levels at which you want to approve data in these data sets. This is done in the <emphasis role="italic">Settings</emphasis> section, under <emphasis role="italic">System Approval Settings</emphasis>. Click the Add new button on this page and select the organisation unit level at which you want approvals. It will be added to the list of approval settings. You may configure the system for approving data at every organisation unit level, or only at selected organisation unit levels.</para>
+ <para>Note that when you add a new approval level, you may optionally choose a Category option group set. This feature is discussed later in this chapter.</para>
+ <para>On the <emphasis role="italic">System Approval Settings</emphasis> page, you may select the option <emphasis role="italic">Hide unapproved data in analytics</emphasis>. If this option is checked, unapproved data will not be shown in DHIS2 analytics such as reporting, pivot table, data visualizer and GIS (except in the data approval report for users who are authorized to approve the data.) If this option is not checked, then all data is shown whether approved or not.</para>
</section>
<section>
- <title>Authority for approving data</title>
- <para>To approve data, you must be assigned a role containing one (or both) of these two authorities:</para>
+ <title>Authorities for approving data</title>
+ <para>To approve data, you must be assigned a role containing one of these authorities:</para>
<itemizedlist>
- <listitem>
- <para><emphasis role="bold">Approve data</emphasis> - You may approve data for the organisation unit(s) to which you are assigned. Note that this authority does not allow you to approve data for lower-level organisation units below the organisation unit(s) to which you are assigned. This is useful to separate the users authorized to approve at one level from the users authorized to approve at levels below.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Approve data at lower levels</emphasis> - Allows you to approve data for all lower-level organisation units below the organisation units assigned to you. This is useful if, for example, you are a district-level user whose role includes approving the data for all the facilities within that district, but not for the district itself.</para>
+<?dbfo keep-together="always" ?> <listitem>
+ <para><emphasis role="bold">Approve data</emphasis> - You may approve data for the organisation unit(s) to which you are assigned. Note that this authority does not allow you to approve data for lower-levels below the organisation unit(s) to which you are assigned. This is useful to separate the users authorized to approve at one level from the users authorized to approve at levels below.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Approve data at lower levels</emphasis> - Allows you to approve data for all lower levels below the organisation units assigned to you. This is useful if, for example, you are a district-level user whose role includes approving the data for all the facilities within that district, but not for the district itself. If you are assigned this as well as the <emphasis role="italic">Approve data</emphasis> authority, you may approve data at the level of the organisation unit(s) to which you have been assigned, and for any level below.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Accept data at lower levels</emphasis> - Allows you to accept data for the level just below the organisation unit(s) assigned to you. This authority can be given to the same users as approve data. Or it may be given to different users, if you want to have some users who accept data from the level below, and a different set of users who approve data to go up to the next level above.</para>
</listitem>
</itemizedlist>
- <para>If you are assigned both of these authorities, you may approve data for the organisation unit(s) to which you have been assigned, and for all other organisation units under them.</para>
</section>
<section>
<title>Approving data</title>
- <para>To approve data, you use the data set report. When a data set report shows data that is configured for approval, it shows the approval status of the data in the report. The approval status will be one of the following:</para>
+ <para>To approve data, go to <emphasis role="italic">Reports</emphasis> and choose <emphasis role="italic">Data Approval</emphasis>. When this report shows data that is configured for approval, it shows the approval status of the data in the report. The approval status will be one of the following:</para>
<itemizedlist>
<listitem>
+ <para><emphasis role="bold">Waiting for lower level org units to approve</emphasis> - This data is not yet ready to be approved, because it first needs to be approved for all the child organisation units to this organisation unit, for the same data set and period.</para>
+ </listitem>
+ <listitem>
<para><emphasis role="bold">Ready for approval</emphasis> - This data may now be approved by an authorized user.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Approved</emphasis> - This data has already been approved.</para>
</listitem>
<listitem>
- <para><emphasis role="bold">Waiting for lower level org units to approve</emphasis> - This data is not yet ready to be approved, because it first needs to be approved for all the child organisation units to this organisation unit, for the same data set and period.</para>
- </listitem>
- </itemizedlist>
- <para>Note that the approval status will not be displayed on data set reports that are for a different period type from how the data is entered. For example, if data is entered monthly and the data set report is aggregating for a quarterly or yearly report, the approval status will not be shown.</para>
- <para>If the data is ready for approval, and if you have the authority to approve the data, you may approve the data by clicking the <emphasis role="italic">Approve</emphasis> button below the data.</para>
- </section>
- <section>
- <title>Unapproving data</title>
- <para>If data has been approved by accident, or if a problem is found with the data after approval, you may use the data set report to <emphasis role="italic">unapprove</emphasis> the data. To unapprove data, click the <emphasis role="italic">Unapprove</emphasis> button below the data in the data set report.</para>
+ <para><emphasis role="bold">Approved and accepted</emphasis> - This data has already been approved, and also accepted.</para>
+ </listitem>
+ </itemizedlist>
+ <para>If the data you are viewing is in an approval state that can be acted upon, and if you have sufficient authority, one or more of the following actions will be available to you on the <emphasis role="italic">Data Approval</emphasis> form:</para>
+ <itemizedlist>
+<?dbfo keep-together="always" ?> <listitem>
+ <para><emphasis role="bold">Approve</emphasis> - Approve data that has not yet been approved, or that was formerly approved and has been unapproved.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Unapprove</emphasis> - Return to an unapproved state data that has been approved or accepted.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Accept</emphasis> - Accept data that has been approved.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Unaccept</emphasis> - Return to an unaccepted (but still approved) state data that has been accepted.</para>
+ </listitem>
+ </itemizedlist>
<para>In order to unapprove data for a given organisation unit, you must have the authority to approve data for that organisation unit or to approve data for a higher-level organisation unit to which that data is aggregated. The reason for this is as follows: If you are reviewing data for approval at a higher organisation unit level, you should consider whether the data at lower organisation units are reasonable. If all lower-level data looks good, you can approve the data at the higher level. If some lower-level data looks suspect, you can unapprove the data at the lower level. This allows the data to be reviewed again at the lower level, corrected if necessary, and re-approved up through the organisation unit levels according to the hierarchy.</para>
- <para>If you want to unapprove data, and it has already been approved at higher levels above this organisation unit, it will be unapproved also for those higher-level organisation units. In this case, you must also have the authority to unapprove at any higher levels that are already approved. If you do not have this authority, you must seek someone with authority at the higher levels to unapprove at those levels.</para>
+ </section>
+ <section>
+ <title>Approving by category option group set</title>
+ <para>When defining an approval level, you specify the organisation unit level at which data will be approved. You may also optionally specify a category option group set. This is useful if you are using category option groups to define additional dimensions of your data, and you want approvals to be based on these dimensions. The following examples illustrate how this can be done within a single category option group set, and by using multiple category option group sets.</para>
+ <section>
+ <title>Approving by one category option group set</title>
+ <para>For example, suppose you define a category option group set to represent NGOs who serve as healthcare partners at one or more organisation units. Each category option group within this set represents a different partner. The category option group for Partner 1 may group together category options (such as funding account codes) that are used by that partner as a dimension of the data. So data entered by Partner 1 is attributed to a category option in Partner 1's category option group. Whereas data entered by partner 2 is attributed to a category option in Partner 2's category option group:</para>
+ <table frame="all">
+ <title>Example Category Option Groups</title>
+<?dbfo keep-together="always" ?> <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Category option group set</entry>
+ <entry>Category option group</entry>
+ <entry>Category options</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Partner</entry>
+ <entry>Partner 1</entry>
+ <entry>Account 1A, Account 1B</entry>
+ </row>
+ <row>
+ <entry>Partner</entry>
+ <entry>Partner 2</entry>
+ <entry>Account 2A, Account 2B</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>Each partner could enter data for their accounts independently of the other, for the same or different data sets, at the same or different facilities. So for example, data can be entered and/or aggregated at the following levels for each partner, independently of each other:</para>
+ <figure>
+ <title>Example category option groups</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="160px" align="center" fileref="resources/images/dhis2UserManual/approval_partner_example.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <tip>
+ <para>You can use the sharing feature on category options and category option groups to insure that a user can enter data (and/or see data) only for certain category options and groups. If you don't want users to see data that is aggregated beyond of their assigned category options and/or category option groups, you can assign <emphasis role="italic">Selected dimension restrictions for data analysis</emphasis>, when adding or updating a user.</para>
+ </tip>
+ <para>You can optionally define approval levels for partner data within any or all of these organisation unit levels. For example, you could define any or all of the following approval levels:</para>
+ <table frame="all">
+ <title>Example Category Option Group Set approval levels</title>
+<?dbfo keep-together="always" ?> <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Approval level</entry>
+ <entry>Organisation unit level</entry>
+ <entry>Category option group set</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>1</entry>
+ <entry>Country</entry>
+ <entry>Partner</entry>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>District</entry>
+ <entry>Partner</entry>
+ </row>
+ <row>
+ <entry>3</entry>
+ <entry>Facility</entry>
+ <entry>Partner</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section>
+ <title>Approving by multiple category option group sets</title>
+ <para>You can also define approval levels for different category option group sets. To continue the example, suppose that you have various agencies that manage the funding to the different partners. For example, Agency A funds accounts 1A and 2A, while Agency B funds accounts 1B and 2B. You could set up category option groups for Agency A, and Agency B, and make them both part of a category option group set called Agency. So you would have:</para>
+ <table frame="all">
+ <title>Example Multiple Category Option Group Sets</title>
+<?dbfo keep-together="always" ?> <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Category option group set</entry>
+ <entry>Category option group</entry>
+ <entry>Category options</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Partner</entry>
+ <entry>Partner 1</entry>
+ <entry>Account 1A, Account 1B</entry>
+ </row>
+ <row>
+ <entry>Partner</entry>
+ <entry>Partner 2</entry>
+ <entry>Account 2A, Account 2B</entry>
+ </row>
+ <row>
+ <entry>Agency</entry>
+ <entry>Agency A</entry>
+ <entry>Account 1A, Account 2A</entry>
+ </row>
+ <row>
+ <entry>Agency</entry>
+ <entry>Agency B</entry>
+ <entry>Account 1B, Account 2B</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>Now suppose that at the country level, you want each partner to approve the data entered by that partner. Once this approval is done, you want each agency to then approve the data from accounts that are managed by that agency. Finally, you want to approve data at the country level across all agencies. You could do this by defining the following approval levels:</para>
+ <table frame="all">
+ <title>Example Multiple Category Option Group Set approval levels</title>
+<?dbfo keep-together="always" ?> <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Approval level</entry>
+ <entry>Organisation unit level</entry>
+ <entry>Category option group set</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>1</entry>
+ <entry>Country</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry>2</entry>
+ <entry>Country</entry>
+ <entry>Agency</entry>
+ </row>
+ <row>
+ <entry>3</entry>
+ <entry>Country</entry>
+ <entry>Partner</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>Note that multiple approval levels can be defined for the same organisation unit level. In our example, Partner 1 would approve country-wide data at approval level 3 from category options Account 1A and Account 1B. Next, Agency A would approve country-wide data at approval level 2 from category options Account 1A (after approval by Partner 1) and Account 2A (after approval by Partner 2.) Finally, after approval from all agencies, country-wide data can be approved at approval level 1 across all category options. Note that approval level 1 does not specify a category option group set, meaning that it is for approving data across all category options.</para>
+ <para>This example is meant to be illustrative only. You may define as many category option groups as you need, and as many approval levels as you need at the same organisation unit level for different category option group sets.</para>
+ <para>If you have multiple approval levels for different category option group sets at the same organisation unit level, you may change the approval ordering in the <emphasis role="italic">Settings</emphasis> section, under <emphasis role="italic">System Approval Settings</emphasis>. Just click on the approval level you wish to move, and select <emphasis role="italic">Move up</emphasis> or <emphasis role="italic">Move down</emphasis>. If you have an approval level with no category option groups set, it must be the highest approval level for that organisation unit level.</para>
+ </section>
</section>
</chapter>
=== added file 'src/docbkx/en/resources/images/dhis2UserManual/approval_level_steps.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/approval_level_steps.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2UserManual/approval_level_steps.png 2014-04-20 19:29:40 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2UserManual/approval_partner_example.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/approval_partner_example.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2UserManual/approval_partner_example.png 2014-04-20 19:29:40 +0000 differ
