Skip to content

Commit 939601d

Browse files
committed
updated the structure and links
1 parent f84d15f commit 939601d

19 files changed

Lines changed: 168 additions & 142 deletions

_modules/calendar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The Monthly view shows the user which Tasks and/or Events are scheduled for each
4242

4343
Generally when you create an event or task in the system, this will create links within the calendar dynamically showing you the start and finish dates within that month. Each link in the calendar is dynamic, so you can click on it and it will take you to the details of that object. This is particularly useful when you want a snap shot view of what’s on the agenda for the entire month.
4444

45-
Depending on how the administrator has the system configured, you can use filters to view calendar details for other [Departments](/modules/departments.html) or [Users](/modules/user-admin.html), in addition to your own.
45+
Depending on how the administrator has the system configured, you can use filters to view calendar details for other [Departments](/modules/departments.html) or [Users](/modules/users.html), in addition to your own.
4646

4747
From this page you can:
4848

_modules/companies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ By default, the tabs include:
4242
1. View Active Projects
4343
1. View Archived projects
4444
1. View [Departments](/modules/departments.html)
45-
1. View [Users](/modules/user-admin.html)
45+
1. View [Users](/modules/users.html)
4646
1. View [Contacts](/modules/contacts.html)
4747
1. View [Events](/modules/calendar.html)
4848
1. View [Files](/modules/files.html)

_modules/user-admin.md

Lines changed: 0 additions & 140 deletions
This file was deleted.

_modules/users.md

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
layout: module
3+
title: User Administration Module
4+
5+
category: core-module
6+
status: cleanup
7+
8+
module_name: User Administration
9+
module_path: users
10+
module_creator: dotProject
11+
module_devs: web2project
12+
module_version: 3.3
13+
module_source: https://github.com/web2project/web2project
14+
module_download: http://github.com/web2project/web2project/archive/master.zip
15+
---
16+
17+
## Module Overview
18+
19+
Now that you have a Company and a Project in your system, it is time to create your a User. Remember that more than anything Web2project is a collaborative tool and the goal of it is to share information. However, it is quite common that you will need to keep certain aspects private to protect the confidential or proprietary information of your customers. Therefore, the creation of Users and setting their permissions become some of the most important aspects of its day to day usage. Unfortunately, it can also be quite difficult to understand at first glance. The basics of Permissions are covered here, but for a more rigorous discussion, please review “Permissions 201” in the System Administration section.
20+
21+
From the user admin module you can:
22+
23+
* Add, Edit, Delete users
24+
* View important information about the user
25+
* Change permissions to the user
26+
* Activate or deactivate a user account
27+
* Search for users
28+
* View a user's access logs
29+
30+
We recommended that you disallow access to this module to basic users in the permissions or roles administration.
31+
32+
33+
### Create a User
34+
35+
Creating your first User can be a confusing experience if you do not understand the process in the beginning. First click “User Admin” in the main navigation and then “add user”.
36+
37+
From here, all the standard user fields are available including username, password, and email address. You must also assign the User to a specific Company. This does not determine any permissions, but it does begin to build the associations. Once you save this information, the User account will be created along with the corresponding Contact record. The user now has an account with no Roles or permissions and can therefore do nothing, not even log into Web2project.
38+
39+
{% include icon-question.html %} The Web2project permissions system assigns zero privileges by default.
40+
41+
Before a new User can log in, they must be assigned a Role in the User Administration Module.
42+
43+
### Assign Roles
44+
45+
To let the User log in for the first time, he must be assigned a Role. The four roles at installation are Administrator, Project Worker, Guest, and Anonymous and grant progressively more and more restrictive permissions.
46+
47+
* Administrator – An Administrator can do anything they choose within the system. This includes creating, editing or deleting any information along with assigning Tasks, changing Users’ passwords, or even creating other Administrators.
48+
* Project Worker – A Project Worker can create, edit, or delete any non-administrative information throughout the system. They can create Companies or Projects, assign Tasks, and log time against any task in the system. Most users will be a variation of this role.
49+
* Guest – A Guest can view any non-administrative information. They cannot create, edit, or delete anything and therefore this works well as a basis for a Customer Role.
50+
* Anonymous – An Anonymous can see the navigation and nothing else. While this role may seem silly at first glance, it can serve as a reasonable basis for highly limited Users who should only view specific Tasks. By assigning this role as a start, no existing information in the system is made available whatsoever.
51+
52+
### Add / Deny Permissions
53+
54+
There are five attributes which can be connected with any Module to expand or limit these basic Roles as needed. The attributes are Access, Add, Delete, Edit, and View and can be assigned to the Module as a whole or to specific aspects of the Module. For example, a Resource Manager type user might have a Project Worker role supplemented with Allow permissions to Access, Add, View in the User Admin. This would give him access to create new users as necessary without the ability to delete users. To further safeguard against abuse of this account, the System Administrator could add Deny permissions to anything done by the Resource Manager user to the System Administrator account.
55+
56+
For more details and examples of permissions, please read Permissions 201 below.
57+
58+
### Active Users
59+
60+
<a href="/assets/docs/users/active.png"><img src="/assets/docs/users/thumb-active.png" /></a>
61+
62+
The active users page displays a number of filters you can use to search or display information
63+
64+
* Enter users first, last, or user name in the search field.
65+
* Click on a letter in the alphabet to search for a user’s name
66+
67+
The table in the center of the stage contains a number of columns.
68+
69+
### User Information
70+
71+
Field | Description
72+
----- | -----
73+
Icons | Edit-Permissions-Delete
74+
Login History | Displays the history
75+
Login Name | User Name
76+
Real Name | Actual Name with email icon
77+
Type | Type specified in add page
78+
Company | Company for user
79+
Department | User department
80+
81+
### Inactive Users
82+
83+
<a href="/assets/docs/users/inactive.png"><img src="/assets/docs/users/thumb-inactive.png" /></a>
84+
85+
Inactive users are usually users who do not have a user role or permissions assigned to them
86+
87+
By default, when a user first registers in the system they are set to an inactive state. An email is sent to the system administrator and they must assign a role to the user before the user can be active.
88+
89+
See Permissions for more information
90+
91+
### Add/Edit User Preferences
92+
93+
<a href="/assets/docs/users/user_prefs.png"><img src="/assets/docs/users/thumb-user_prefs.png" /></a>
94+
95+
You can change the user preferences just as you can change the default user preferences for unregistered users.
96+
97+
Changing the user specific preferences will override the default user’s preferences.
98+
99+
To change the preferences for the user click on the yellow lock icon in the far left column. By default this will take you to the permission page. At the top of the window is a button to edit the user preferences.
100+
101+
For more information see Default User Preferences in the System Administration Module.
102+
103+
### Add/Edit User
104+
105+
<a href="/assets/docs/users/addedit.png"><img src="/assets/docs/users/thumb-addedit.png" /></a>
106+
107+
<b>To Add a New User</b>
108+
109+
To add a new user from within the user administration click on the “new user” button.
110+
111+
The Add user page contains a short form for creating a new user. After filling our the form fields you can mark the “Inform new user of their account details” to notify that user they are registered.
112+
113+
Keep in mind that users can register themselves by clicking on the “I want to register for a new account” link on the main login page.
114+
115+
After you create the user, you must remember to give that user a role or they will not be able to login.
116+
117+
<b>To Edit an Existing User</b>
118+
119+
To edit a user click on the notepad icon in the table on the stage.
120+
121+
You will notice this page has less form fields than the add user page.
122+
123+
Here you can change:
124+
125+
* The user type
126+
* Name
127+
* Company
128+
* Department
129+
* Email
130+
* Email Signature
131+
132+
Do to security issues you can not change the password. If the user can’t remember his or her password it is best to have them click on the “help I have forgotten my password” link in the main login.
133+
134+
### View User
135+
136+
<a href="/assets/docs/users/view.png"><img src="/assets/docs/users/thumb-view.png" /></a>
137+
138+
Click the users login name from the user administration to access the View User page.
139+
140+
The view user page contains a table showing the users details. From this page you can:
141+
142+
* Go back to the user list
143+
* Edit this user
144+
* Edit this users preferences
145+
* View the user’s log
146+
* View the user’s permissions
147+
* View the users Role
148+
* View the users Projects & Gantt
149+
150+
### User Log
151+
152+
<a href="/assets/docs/users/userlog.png"><img src="/assets/docs/users/thumb-userlog.png" /></a>
153+
154+
The user log by default contains two calendars you can set to view the users login history. After setting the dates a table will display highlighting that users activity.
155+
156+
First Name | Last Name | IP Address | Date & Time IN | Date & Time OUT
157+
----- | -----
158+
|
159+
160+
### Sessions
161+
162+
<a href="/assets/docs/users/sessions.png"><img src="/assets/docs/users/thumb-sessions.png" /></a>
163+
164+
Active Sessions is the last tab located in the user list page. Here you can end a user session or force the user to logout.
165+
166+
This helps when you have multiple users logged in at once and need to free system resources, or for security issues.

0 commit comments

Comments
 (0)