dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #29553
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 1049: Updated user management including invite feature
------------------------------------------------------------
revno: 1049
committer: Jim Grace <jimgrace@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2014-04-22 19:09:26 -0400
message:
Updated user management including invite feature
removed:
src/docbkx/en/resources/images/dhis2UserManual/user_management.png
added:
src/docbkx/en/resources/images/dhis2UserManual/user_management_details.png
src/docbkx/en/resources/images/dhis2UserManual/user_management_fewer_options.png
src/docbkx/en/resources/images/dhis2UserManual/user_management_invite.png
src/docbkx/en/resources/images/dhis2UserManual/user_management_more_options.png
modified:
src/docbkx/en/dhis2_user_man_user_management.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_user_management.xml'
--- src/docbkx/en/dhis2_user_man_user_management.xml 2014-04-22 19:44:51 +0000
+++ src/docbkx/en/dhis2_user_man_user_management.xml 2014-04-22 23:09:26 +0000
@@ -1,144 +1,200 @@
-<?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 management</title>
- <para>DHIS2 allows for multiple users to access the system simultaneously, each with a define set of permissions. These permissions can be finely tuned so that certain users can only enter data, while others may generate reports. Multiple user roles can be created, each with their own set of permissions, and then assigned to users which grant them certain privileges within the system. This chapter describes how to manage users and user roles.</para>
- <section id="creating_new_users">
- <title>Creating new users and roles</title>
- <para>This section will describe how to add new users and manage existing users to the DHIS2 application. You can create as many user names as you need. Each user can be assigned certain privileges, and can be assigned to certain organisation units for which they will be enabled to enter data on behalf of. To access the user module, choose "Maintenance->Users" from the main menu.</para>
- <section id="user_maintenance">
- <title>User maintenance</title>
- <screenshot>
- <screeninfo>Select Users menu item</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/dhis2UserManual/select_user_menu.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>User names already registered will appear as a list as seen in the screen shot below.</para>
- <screenshot>
- <screeninfo>Search by user name</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/dhis2UserManual/search_user_by_name.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>You can search for specific user names in the user list by
- entering the name in the ‘filter by user name’ field as shown
- above.</para>
- </section>
- <section id="user_user_roles">
- <title>User role management</title>
- <para>As part of creating a user name you are required to define the user
- role. Do so by clicking on the ‘user role’ appearing on the left side of
- the displayed screen. This will lead you to the Role Management page where you will have
- to click on <guibutton>Add new</guibutton> to create a new role.</para>
- <screenshot>
- <screeninfo>Add new user role</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/dhis2UserManual/add_user_role.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>The following screen will open and here in the first text box you
- need to give Name of the Role such as Super User, Admin User, etc. The
- second text box called ‘Description’ gives more information about the
- type of User Role that is being created for e.g. State Admin User,
- District Data Entry.</para>
- <screenshot>
- <screeninfo>Role maintenance page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/dhis2UserManual/role_maintenance_page.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Next you will specify the particular data set(s) that are to be
- made available to the particular role. You will also need to specify the
- type of ‘authority’ to be given to the particular user. For each of the
- three options namely Datasets, Reports and Authorities user can select
- multiple options from the scroll down menu provided against each field.
- A user can choose multiple options either by moving them
- one-by-one.</para>
- <para>In order for particular users to be able to enter data, you must
- add them to both a dataset as well as an organisational unit level. You
- can also select multiple datasets individually by pressing the Ctrl key
- on the keyboard and clicking on individual datasets.</para>
- <para>Finally when you have entered the required fields click on
- <guibutton>Save</guibutton> which is located on the lower part of the
- displayed screen. The desired user role and related authorisation will
- be saved to the database, and can then be assigned to a particular
- user.</para>
- </section>
- <section id="user_management">
- <title>User management</title>
- <para>Under particular user role there can be more than one user. To add
- new users go to the User options under the Maintenance module.</para>
- <para>To add a new user, just follow these steps:</para>
- <itemizedlist>
- <listitem>
- <para>Click on the <guibutton>Add New</guibutton> button.</para>
- </listitem>
- <listitem>
- <para>Enter New User details like <guilabel>User name</guilabel>, <guilabel>Password</guilabel>, <guilabel>Confirm password</guilabel>, <guilabel>Surname</guilabel>, <guilabel>First name</guilabel> and <guilabel>Email</guilabel> in new user’s option tabs.</para>
- </listitem>
- <listitem>
- <para>Click on <guibutton>Add</guibutton> button for confirmation of
- new user details and follow the user error while creation of new
- user.</para>
- </listitem>
- <listitem>
- <para>The recently created new user can be seen in main’ User
- management Screen</para>
- </listitem>
- <listitem>
- <para>You can edit (like password, surname….etc) and delete the
- details of new/old users by selecting corresponding User’s
- <guibutton>Edit</guibutton> and <guibutton>Delete</guibutton>
- Buttons.</para>
- </listitem>
- <listitem>
- <para>Click on <guibutton>Save</guibutton> tab after editing all
- details of a particular selected user.</para>
- <screenshot>
- <screeninfo>User management screen</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/dhis2UserManual/user_management.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </listitem>
- <listitem>
- <para>Users must be assigned to at least one data capture organisation unit. Users will
- have access to all children of the organisational units which have been assigned to
- them. For instance, if a user has been assigned to a district which has several
- facilities contained in the district, the user would have access to the district's data,
- as well as all of the facilities contained within the district. The data approval org
- units control for which org units the user can do data entry.</para>
- </listitem>
- <listitem>
- <para>Users can be assigned to any number of data view organisation units. This controls
- which org units the user can view aggregated data for in analysis modules. Giving access
- to an org unit implicitly gives access to all org unit below it in the org unit
- hierarchy.</para>
- <para>In order for users to be able to enter data for specific organisational units, they
- must be assigned these units. If a user is responsible for entering data for all
- facilities for a given district, they should typically be assigned the district, and all
- of the facilities contained within the district.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="user_group_management">
- <title>User group management</title>
- <para>User groups allow you to send notifications to multiple users at the same time. Simply click "Add new" from the "User group" screen, provide a name for the group, and add the desired users from the "Available users" list to the "Group members" list. </para>
- </section>
- <section id="user_by_org_unit">
- <title>User by organisation unit</title>
- <para>The "User by organisation unit" function allows you see which users have been assigned to a particular organisation unit. Simply select the organisation unit from the tree on the left, and a list of users which have been assigned to this particular organisation unit will be displayed</para>
- </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>User management</title>
+ <para>DHIS2 allows for multiple users to access the system simultaneously, each with a defined set of permissions. These permissions can be finely tuned so that certain users can only enter data, while others may generate reports. Multiple user roles can be created, each with their own set of permissions, and then assigned to users which grant them certain privileges within the system. This chapter describes how to manage users and user roles.</para>
+ <section id="creating_new_users">
+ <title>Creating new users and roles</title>
+ <para>This section will describe how to add new users and manage existing users to the DHIS2 application. You can create as many user names as you need. Each user can be assigned certain privileges, and can be assigned to certain organisation units for which they will be enabled to enter data on behalf of. To access the user module, choose <emphasis role="italic">Users</emphasis> from the Apps menu.</para>
+ <section id="user_maintenance">
+ <title>User maintenance</title>
+ <screenshot>
+ <screeninfo>Select Users menu item</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/select_user_menu.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>User names already registered will appear as a list as seen in the screen shot below.</para>
+ <screenshot>
+ <screeninfo>Search by user name</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/search_user_by_name.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>You can search for specific user names in the user list by
+ entering the name in the <emphasis role="italic">Filter by name</emphasis> field as shown
+ above.</para>
+ </section>
+ <section id="user_user_roles">
+ <title>User role management</title>
+ <para>As part of creating a user name you are required to define the user
+ role. Do so by clicking on <emphasis role="italic">User Role</emphasis> on the left side of
+ the displayed screen. This will lead you to the User role management page where you can
+ click on <guibutton>Add new</guibutton> to create a new role.</para>
+ <screenshot>
+ <screeninfo>Add new user role</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/add_user_role.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>The following screen will open and here in the first text box you
+ need to give a <emphasis role="italic">Name</emphasis> of the Role such as Super User, Admin User, etc. The
+ second text box called <emphasis role="italic">Description</emphasis> gives more information about the
+ type of User Role that is being created for e.g. State Admin User,
+ District Data Entry.</para>
+ <screenshot>
+ <screeninfo>Role maintenance page</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/role_maintenance_page.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Next you will specify the particular data set(s) that are to be
+ made available to the particular role. You will also need to specify the
+ type of <emphasis role="italic">Authority</emphasis> to be given to the particular user. For each of the
+ three options namely Datasets, Reports and Authorities user can select
+ multiple options from the scroll down menu provided against each field.
+ A user can choose multiple options either by moving them
+ one-by-one.</para>
+ <para>In order for particular users to be able to enter data, you must
+ add them to both a dataset as well as an organisational unit level. You
+ can also select multiple datasets individually by pressing the Ctrl key
+ on the keyboard and clicking on individual datasets.</para>
+ <para>Finally when you have entered the required fields click on
+ <guibutton>Save</guibutton> which is located on the lower part of the
+ displayed screen. The desired user role and related authorisation will
+ be saved to the database, and can then be assigned to a particular
+ user.</para>
+ </section>
+ <section id="user_management">
+ <title>User management</title>
+ <para>Under particular user role there can be more than one user. To manage
+ users, click on <emphasis role="italic">User</emphasis> on the left side of the screen.
+ This will lead you to the <emphasis role="italic">User management</emphasis> page.</para>
+ <para>To add a new user, follow these steps:</para>
+ <orderedlist>
+ <listitem>
+ <para>Click on the <guibutton>Add New</guibutton> button.</para>
+ </listitem>
+ <listitem>
+ <para>Choose whether you want to fill in all the personal user information now, or invite the user by email to complete the
+ rest of the user information:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="italic">Create account with user details</emphasis> - Choose this if you would like to enter all the details of the new user
+ such as name, password, etc.</para>
+ <para>If you choose this action, then enter the following information: username, password, surname, first name, E-mail,
+ OpenID account (if any) and mobile phone number (if any).</para>
+ <para>After you finish adding the user, the account will be ready for them to use with the username and password
+ that you supply.</para>
+ <screenshot>
+ <screeninfo>Select Users menu item</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/user_management_details.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
+ <listitem>
+ <para><emphasis role="italic">Email invitation to create account</emphasis> - Choose this if you would like to send by email an invitation for
+ the user to return to the system and finish setting up their user account. The user will then return to the
+ system and fill in most of their personal information. The account that the user finishes setting up will be limited according to how you configure it below.</para>
+ <para>Note that you may not select this option to create an account with "critical" system authorities such as All, Scheduling Administration, Perform maintenance tasks, Merge organisation units, Eliminate duplicate data elements, Sql View Management, Change system settings, and List, Add or Delete user roles.</para>
+ <para>If you choose this action, then enter the email address to which the invitation should be sent.
+ If you want to, you may also enter the user name that the account will have. If you leave the username
+ empty, then the user may choose their own username when they respond to the invitation (as long as it
+ is not taken already for another user.)</para>
+ <para>After you finish adding the new user, two emails will be sent to the address you provided. One contains
+ a unique web link by which the user can return to the system and activate their account by entering the rest of their
+ user information. The other email contains a unique code that they must enter into the system in order to
+ complete the registration, after following the link in the first email. The user must finish setting up the account within three months, or the invitation
+ becomes invalid.</para>
+ <screenshot>
+ <screeninfo>Select Users menu item</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/user_management_invite.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis role="italic">Interface language</emphasis> for the user. You may choose a language into which fixed elements of the
+ DHIS2 user interface have been translated.</para>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis role="italic">Database language</emphasis> for the user. You may choose a language into which implementation-supplied
+ items have been translated in the database, for example data element names, organisation unit level names, etc.</para>
+ </listitem>
+ <listitem>
+ <para>Users must be assigned to at least one data capture and maintenance organisation unit. Users will
+ have access to all children of the organisation units which have been assigned to
+ them. For instance, if a user has been assigned to a district which has several
+ facilities contained in the district, the user would have access to the district's data,
+ as well as all of the facilities contained within the district. The data approval organisation
+ units control for which organisation units the user can do data entry.</para>
+ </listitem>
+ <listitem>
+ <para>Users can be assigned to any number of data view organisation units. This controls
+ which organisation units the user can view aggregated data for in analysis modules. Giving access
+ to an organisation unit implicitly gives access to all organisation unit below it in the organisation unit
+ hierarchy.</para>
+ <para>In order for users to be able to enter data for specific organisation units, they
+ must be assigned these units. If a user is responsible for entering data for all
+ facilities for a given district, they should typically be assigned the district, and all
+ of the facilities contained within the district.</para>
+ <screenshot>
+ <screeninfo>User management screen</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/user_management_fewer_options.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
+ <listitem>
+ <para>(Click on <emphasis role="italic">Show more options</emphasis>.) You may optionally assign users to user groups on this page.</para>
+ </listitem>
+ <listitem>
+ <para>(Click on <emphasis role="italic">Show more options</emphasis>.) You may optionally restrict the values this user sees in data analytics
+ by selecting dimensions that will restrict the users view. For example, let's say you have defined <emphasis role="italic">Implementing Partner</emphasis>
+ as a category option group set, and you have shared with this user only one or more specific implementing partners
+ (category option groups.) If you want to insure that the user does not see totals in analytics that include values
+ from other groups, assign <emphasis role="italic">Implementing Partner</emphasis> to this user. This insures that any data visible to the user
+ through DHIS2 analytics will be filtered to select only the Implementing Partner category option group(s) which
+ are visible to the user.</para>
+ <screenshot>
+ <screeninfo>User management screen</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/user_management_more_options.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
+ <listitem>
+ <para> Click on the <guibutton>Add</guibutton> button to complete adding the new user.</para>
+ </listitem>
+ </orderedlist>
+ <para>The recently created new user can be seen in main <emphasis role="italic">User management</emphasis> screen</para>
+ <para>You can edit (like password, surname, etc.) and delete the
+ details of new/old users by selecting corresponding User’s
+ <guibutton>Edit</guibutton> and <guibutton>Remove</guibutton>
+ menu options.</para>
+ </section>
+ <section id="user_by_org_unit">
+ <title>User by organisation unit</title>
+ <para>The <emphasis role="italic">User by organisation unit</emphasis> function allows you see which users have been assigned to a particular organisation unit. Simply select the organisation unit from the tree on the left, and a list of users which have been assigned to this particular organisation unit will be displayed</para>
+ </section>
+ </section>
+</chapter>
=== removed file 'src/docbkx/en/resources/images/dhis2UserManual/user_management.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/user_management.png 2011-01-13 16:35:18 +0000 and src/docbkx/en/resources/images/dhis2UserManual/user_management.png 1970-01-01 00:00:00 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2UserManual/user_management_details.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/user_management_details.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2UserManual/user_management_details.png 2014-04-22 23:09:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2UserManual/user_management_fewer_options.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/user_management_fewer_options.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2UserManual/user_management_fewer_options.png 2014-04-22 23:09:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2UserManual/user_management_invite.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/user_management_invite.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2UserManual/user_management_invite.png 2014-04-22 23:09:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2UserManual/user_management_more_options.png'
Binary files src/docbkx/en/resources/images/dhis2UserManual/user_management_more_options.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2UserManual/user_management_more_options.png 2014-04-22 23:09:26 +0000 differ
