dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #28279
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 976: Adding section on user profiles.Updated settings.
------------------------------------------------------------
revno: 976
committer: Jason P. Pickering <jason.p.pickering@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Mon 2014-02-24 16:34:59 +0200
message:
Adding section on user profiles.Updated settings.
added:
src/docbkx/en/dhis2_user_man_profile.xml
modified:
src/docbkx/en/dhis2_user_man_settings.xml
src/docbkx/en/dhis2_user_manual_en.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
=== added file 'src/docbkx/en/dhis2_user_man_profile.xml'
--- src/docbkx/en/dhis2_user_man_profile.xml 1970-01-01 00:00:00 +0000
+++ src/docbkx/en/dhis2_user_man_profile.xml 2014-02-24 14:34:59 +0000
@@ -0,0 +1,16 @@
+<?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" "docbookV4.4/docbookx.dtd" []>
+<chapter>
+ <title>User profiles</title>
+ <para>With profiles, users can alter the appearance of their DHIS2, change the interface language, and enabled SMS and email notifications. Users can also enter information into their "Profile". </para>
+ <section>
+ <title>User settings</title>
+ <para>To access the user settings menu, select "Profile->Settings". You can select the interface language and the database language. The interface language refers to the translation of the user interface of the DHIS2 software. The database language refers to the translated content of the metadata contained in the system, for instance, data elements and indicators. Different interface styles can be set to alter the apperarnce of the system. </para>
+ <para>User can choose to receive their messages via email and/or SMS by ticking the appropriate check boxes. </para>
+ </section>
+ <section>
+ <title>User profile</title>
+ <para>Users can choose to enter more data, such as their email and phone number, job title, gender, birthday, etc into their profile. Just select "Profile->Profile" from the main menu. </para>
+ </section>
+</chapter>
=== modified file 'src/docbkx/en/dhis2_user_man_settings.xml'
--- src/docbkx/en/dhis2_user_man_settings.xml 2013-12-27 14:49:27 +0000
+++ src/docbkx/en/dhis2_user_man_settings.xml 2014-02-24 14:34:59 +0000
@@ -1,178 +1,145 @@
-<?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" "docbookV4.4/docbookx.dtd" []>
-<chapter>
- <title>Settings</title>
- <para>The settings module provides a set of application configuration options. There are two main
- groups of settings: the <emphasis role="italic">system settings</emphasis> apply to the whole
- system and all its users while the <emphasis role="italic">user settings</emphasis> apply to the
- environment of the currently logged in user. The system settings can be accessed from the
- maintenance menu, settings module. The user settings can be accessed under the profile menu,
- settings page.</para>
- <section>
- <title>User settings</title>
- <para>The user settings section provides general configuration options and options specifically for email.</para>
- <section id="userGeneralSettings">
- <title>User general settings</title>
- <itemizedlist>
- <listitem>
- <para>Interface language: Sets the locale / language of the user interface, such as labels, menus and headers. You can currently select between 18 languages.</para>
- </listitem>
- <listitem>
- <para>Database language: Sets the locale / language of the database contents in the
- system, such as the list of data elements and reports.</para>
- </listitem>
- <listitem>
- <para>Style: Sets the style / look-and-feel of the system. You can choose among four
- different styles while the <emphasis role="italic">light blue</emphasis> style is the
- default and recommended style. The user setting overrides the corresponding style system
- setting.</para>
- </listitem>
- <listitem>
- <para>Enable message email notifications: Decides whether you want to receive email
- notifications. Currently the system offers email notifications of messages received in
- the dashboard. This requires that you have entered your email address in your personal
- account details - you can access it in the "User account" page.</para>
- </listitem>
- <listitem>
- <para>Enable message SMS notifications: Decides whether you want to receive SMS
- notifications. Requires that a SMS provider has been configured for your
- deployment.</para>
- </listitem>
- </itemizedlist>
- </section>
- </section>
- <section>
- <title>System settings</title>
- <para>The system settings section provides general configuration options and options specifically for appearance and email.</para>
- <section id="systemGeneralSettings">
- <title>General settings</title>
- <itemizedlist>
- <listitem>
- <para>Cache strategy: Decides for how long reports and responses related to analysis
- should be cached. If you are using the scheduled, nightly data mart tasks it makes sense
- to put this on "Cache until 6 AM tomorrow". This is because we know that data in reports
- change at that time, and you can safely cache data up to the moment when the data mart
- is updated. If you are loading data continuously into the datamart you should set it to
- "No cache". If you load data very infrequently into data mart you should consider
- setting it to "Cache for two weeks".</para>
- </listitem>
- <listitem>
- <para>Infrastructural data elements: This setting defines a data element group where the member data elements should describe data about the infrastructure of organisation units. Examples of such infrastructural data elements could be population, doctors, beds, internet connectivity and climate. This infrastructural data can currently be viewed in the GIS module in the facility information sheet.</para>
- </listitem>
- <listitem>
- <para>Infrastructural period type: Sets the frequency for which the data elements in the
- infrastructural data elements group are captured. This will typically be yearly. When
- viewing the infrastructural data you will be able to select the time period of the data
- source.</para>
- </listitem>
- <listitem>
- <para>Feedback recipients: This setting defines a user group where the members will
- receive all messages being sent through the function for writing feedback in the
- dashboard module. This will typically be members of the super user team who are able to
- support and answer questions coming from end-users.</para>
- </listitem>
- <listitem>
- <para>Maximum offline organisation unit levels: This setting defines how many levels in
- the organisation unit hierarchy will be available offline in the organisation unit tree
- widget. Under normal circumstances you can leaves this on the lowest level, which is
- default behavior. Setting it to a higher level might be useful in order to reduce
- initial load time in cases where you have extremely many organisation units, typically
- more than 30 000.</para>
- </listitem>
- <listitem>
- <para>Data analysis std dev factor: Sets the number of standard deviations for use in the outlier analysis performed on the captured data in the data entry module. The default value is 2; a high value will catch less outlier values than a low value.</para>
- </listitem>
- <listitem>
- <para>Days after period end to qualify for timely data submission: Sets the number of days after the end of a period in which a data entry form must be marked as complete in order to be considered timely. This affects the "reporting rate" tool in the reporting module which lists forms marked as complete as well as marked as complete in time. The default value is 15.</para>
- </listitem>
- <listitem>
- <para>Phone number area code: The area code for the area in which your deployment is located. Used for sending and receiving
- SMS.</para>
- </listitem>
- <listitem>
- <para>Google Analytics (Universal Analytics) Key: Set your Google UA key here to provide analytics for your DHIS 2 instance. Most
- places are covered, but it will not be provided for custom apps. Read more about Google Analytics at
- <uri>http://google.com/analytics</uri>.</para>
- </listitem>
- <listitem>
- <para>Omit indicator values with zero numerator value in data mart: Defines whether aggregated indicator values with zero as the
- numerator value should be written to the indicator data mart table. Having such values written is required for instance when
- connecting Excel pivot tables to the data mart as Excel will need the numerator data to correctly aggregate up in the
- organisation unit hierarchy. If third-party tools like Excel are not used with the application this will reduce the total number
- of values written to the data mart (which again will improve performance) and could safely be set to omit.</para>
- </listitem>
- <listitem>
- <para>Enable multi-organisation unit forms: Enable support for entering data forms for multiple organisation units at the same
- time, in data entry, click on the parent organisation unit for the children that you want to enter data for, and the dataset
- list will include datasets that are assigned to the children of that parent.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="systemAppearanceSettings">
- <title>Appearance settings</title>
- <itemizedlist>
- <listitem>
- <para>Application title: Sets the application title on the top menu.</para>
- </listitem>
- <listitem>
- <para>Application introduction: Sets an introduction of the system. Will be visible on the
- login page.</para>
- </listitem>
- <listitem>
- <para>Application notification: Sets a notification which should be displayed to users.
- Will be visible on the front page.</para>
- </listitem>
- <listitem>
- <para>Style: Sets the style / look-and-feel of the system. The corresponding user style setting overrides this.</para>
- </listitem>
- <listitem>
- <para>Flag: Sets the flag which is displayed in the left menu of the dashboard module.</para>
- </listitem>
- <listitem>
- <para>Start page: Sets page / module which the user will be redirected to after logging in. The dashboard module is the recommended start module.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="systemEmailSettings">
- <title>Email settings</title>
- <itemizedlist>
- <listitem>
- <para>Host name: Refers to the host name of the SMTP server. For instance when using Google SMTP services this should be smtp.gmail.com.</para>
- </listitem>
- <listitem>
- <para>User name: The user name of the user account with the SMTP server. For instance mail@xxxxxxxxx.</para>
- </listitem>
- <listitem>
- <para>Password: The password of the user account with the SMTP server.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Access settings</title>
- <itemizedlist>
- <listitem>
- <para>Self registration account user role: Defines which user role should be given to self-registered user accounts. To enable
- self-registration of users, select any user role from the list. To disable it, select "Do not allow self registration". When
- enabled, a link to the self-registration form will be displayed on the login page.</para>
- </listitem>
- <listitem>
- <para>Do not use recaptcha for self registration: Whether or not to use reCAPTCHA for user registration.</para>
- </listitem>
- <listitem>
- <para>Self registration account organisation unit: Defines which organisation unit should
- be associated with self-registered users. Any organisation unit must be selected in
- order to enable self registration.</para>
- </listitem>
- <listitem>
- <para>Enable user account recovery: Defines whether users are allowed to restore the password of their account if they forgotten
- it. When enabled, a link to the account recovery form will be displayed on the front page. User account recovery requires that
- you have configured email settings (SMTP).</para>
- </listitem>
- <listitem>
- <para>Require user account password change: Require that users change their password every 3,6,12 months. Please note that for
- 2.14 release, they will have to login through the desktop to change passwords.</para>
- </listitem>
- </itemizedlist>
- </section>
- </section>
-</chapter>
+<?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" "docbookV4.4/docbookx.dtd" []>
+<chapter>
+ <title>Settings</title>
+ <para>The settings module provides a set of application configuration options. There are two main
+ groups of settings: the <emphasis role="italic">system settings</emphasis> apply to the whole
+ system and all its users while the <emphasis role="italic">user settings</emphasis> apply to the
+ environment of the currently logged in user. The system settings can be accessed from the
+ maintenance menu, settings module. The user settings can be accessed under the profile menu,
+ settings page.</para>
+ <section>
+ <title>System settings</title>
+ <para>The system settings section provides general configuration options and options specifically for appearance and email.</para>
+ <section id="systemGeneralSettings">
+ <title>General settings</title>
+ <itemizedlist>
+ <listitem>
+ <para>Cache strategy: Decides for how long reports and responses related to analysis
+ should be cached. If you are using the scheduled, nightly data mart tasks it makes sense
+ to put this on "Cache until 6 AM tomorrow". This is because we know that data in reports
+ change at that time, and you can safely cache data up to the moment when the data mart
+ is updated. If you are loading data continuously into the datamart you should set it to
+ "No cache". If you load data very infrequently into data mart you should consider
+ setting it to "Cache for two weeks".</para>
+ </listitem>
+ <listitem>
+ <para>Infrastructural data elements: This setting defines a data element group where the member data elements should describe data about the infrastructure of organisation units. Examples of such infrastructural data elements could be population, doctors, beds, internet connectivity and climate. This infrastructural data can currently be viewed in the GIS module in the facility information sheet.</para>
+ </listitem>
+ <listitem>
+ <para>Infrastructural period type: Sets the frequency for which the data elements in the
+ infrastructural data elements group are captured. This will typically be yearly. When
+ viewing the infrastructural data you will be able to select the time period of the data
+ source.</para>
+ </listitem>
+ <listitem>
+ <para>Feedback recipients: This setting defines a user group where the members will
+ receive all messages being sent through the function for writing feedback in the
+ dashboard module. This will typically be members of the super user team who are able to
+ support and answer questions coming from end-users.</para>
+ </listitem>
+ <listitem>
+ <para>Maximum offline organisation unit levels: This setting defines how many levels in
+ the organisation unit hierarchy will be available offline in the organisation unit tree
+ widget. Under normal circumstances you can leaves this on the lowest level, which is
+ default behavior. Setting it to a higher level might be useful in order to reduce
+ initial load time in cases where you have extremely many organisation units, typically
+ more than 30 000.</para>
+ </listitem>
+ <listitem>
+ <para>Data analysis std dev factor: Sets the number of standard deviations for use in the outlier analysis performed on the captured data in the data entry module. The default value is 2; a high value will catch less outlier values than a low value.</para>
+ </listitem>
+ <listitem>
+ <para>Days after period end to qualify for timely data submission: Sets the number of days after the end of a period in which a data entry form must be marked as complete in order to be considered timely. This affects the "reporting rate" tool in the reporting module which lists forms marked as complete as well as marked as complete in time. The default value is 15.</para>
+ </listitem>
+ <listitem>
+ <para>Phone number area code: The area code for the area in which your deployment is located. Used for sending and receiving
+ SMS.</para>
+ </listitem>
+ <listitem>
+ <para>Google Analytics (Universal Analytics) Key: Set your Google UA key here to provide analytics for your DHIS 2 instance. Most
+ places are covered, but it will not be provided for custom apps. Read more about Google Analytics at <ulink url="http://google.com/analytics";>http://google.com/analytics</ulink>
+ .</para>
+ </listitem>
+ <listitem>
+ <para>Omit indicator values with zero numerator value in data mart: Defines whether aggregated indicator values with zero as the
+ numerator value should be written to the indicator data mart table. Having such values written is required for instance when
+ connecting Excel pivot tables to the data mart as Excel will need the numerator data to correctly aggregate up in the
+ organisation unit hierarchy. If third-party tools like Excel are not used with the application this will reduce the total number
+ of values written to the data mart (which again will improve performance) and could safely be set to omit.</para>
+ </listitem>
+ <listitem>
+ <para>Enable multi-organisation unit forms: Enable support for entering data forms for multiple organisation units at the same
+ time, in data entry, click on the parent organisation unit for the children that you want to enter data for, and the dataset
+ list will include datasets that are assigned to the children of that parent.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="systemAppearanceSettings">
+ <title>System appearance settings</title>
+ <itemizedlist>
+ <listitem>
+ <para>Application title: Sets the application title on the top menu.</para>
+ </listitem>
+ <listitem>
+ <para>Application introduction: Sets an introduction of the system. Will be visible on the
+ login page.</para>
+ </listitem>
+ <listitem>
+ <para>Application notification: Sets a notification which should be displayed to users.
+ Will be visible on the front page.</para>
+ </listitem>
+ <listitem>
+ <para>Style: Sets the style / look-and-feel of the system. The corresponding user style setting overrides this.</para>
+ </listitem>
+ <listitem>
+ <para>Flag: Sets the flag which is displayed in the left menu of the dashboard module.</para>
+ </listitem>
+ <listitem>
+ <para>Start page: Sets page / module which the user will be redirected to after logging in. The dashboard module is the recommended start module.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="systemEmailSettings">
+ <title>Email settings</title>
+ <itemizedlist>
+ <listitem>
+ <para>Host name: Refers to the host name of the SMTP server. For instance when using Google SMTP services this should be smtp.gmail.com.</para>
+ </listitem>
+ <listitem>
+ <para>User name: The user name of the user account with the SMTP server. For instance mail@xxxxxxxxx.</para>
+ </listitem>
+ <listitem>
+ <para>Password: The password of the user account with the SMTP server.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Access settings</title>
+ <itemizedlist>
+ <listitem>
+ <para>Self registration account user role: Defines which user role should be given to self-registered user accounts. To enable
+ self-registration of users, select any user role from the list. To disable it, select "Do not allow self registration". When
+ enabled, a link to the self-registration form will be displayed on the login page.</para>
+ </listitem>
+ <listitem>
+ <para>Do not use recaptcha for self registration: Whether or not to use reCAPTCHA for user registration.</para>
+ </listitem>
+ <listitem>
+ <para>Self registration account organisation unit: Defines which organisation unit should
+ be associated with self-registered users. Any organisation unit must be selected in
+ order to enable self registration.</para>
+ </listitem>
+ <listitem>
+ <para>Enable user account recovery: Defines whether users are allowed to restore the password of their account if they forgotten
+ it. When enabled, a link to the account recovery form will be displayed on the front page. User account recovery requires that
+ you have configured email settings (SMTP).</para>
+ </listitem>
+ <listitem>
+ <para>Require user account password change: Require that users change their password every 3,6,12 months. Please note that for
+ 2.14 release, they will have to login through the desktop to change passwords.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+</chapter>
=== modified file 'src/docbkx/en/dhis2_user_manual_en.xml'
--- src/docbkx/en/dhis2_user_manual_en.xml 2014-02-16 13:26:25 +0000
+++ src/docbkx/en/dhis2_user_manual_en.xml 2014-02-24 14:34:59 +0000
@@ -33,6 +33,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mobile.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_data_dimensions.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_tracker.xml" encoding="UTF-8"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_profile.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_web_api.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_apps.xml"/>
<appendix>
