1 | <?xml version="1.0" encoding="UTF-8"?> |
---|
2 | <!DOCTYPE chapter PUBLIC |
---|
3 | "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" |
---|
4 | "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd"> |
---|
5 | <!-- |
---|
6 | $Id: user_administration.xml 3310 2007-05-09 07:18:29Z martin $ |
---|
7 | |
---|
8 | Copyright (C) Authors contributing to this file. |
---|
9 | |
---|
10 | This file is part of BASE - BioArray Software Environment. |
---|
11 | Available at http://base.thep.lu.se/ |
---|
12 | |
---|
13 | BASE is free software; you can redistribute it and/or |
---|
14 | modify it under the terms of the GNU General Public License |
---|
15 | as published by the Free Software Foundation; either version 2 |
---|
16 | of the License, or (at your option) any later version. |
---|
17 | |
---|
18 | BASE is distributed in the hope that it will be useful, |
---|
19 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
21 | GNU General Public License for more details. |
---|
22 | |
---|
23 | You should have received a copy of the GNU General Public License |
---|
24 | along with this program; if not, write to the Free Software |
---|
25 | Foundation, Inc., 59 Temple Place - Suite 330, |
---|
26 | Boston, MA 02111-1307, USA. |
---|
27 | --> |
---|
28 | |
---|
29 | <chapter id="user_administration"> |
---|
30 | <?dbhtml dir="user_administration"?> |
---|
31 | <title>Account administration</title> |
---|
32 | |
---|
33 | <sect1 id="user_administration.permissions"> |
---|
34 | <title>Permission system</title> |
---|
35 | <para> |
---|
36 | Users get their general permissions from the role they belong to and more item specific |
---|
37 | permissions from shared items in groups and projects that they are members in. An user |
---|
38 | has always full permissions on it's own items. |
---|
39 | </para> |
---|
40 | <para> |
---|
41 | As an administrator you only have to think of what kinds of tasks an user is going to work |
---|
42 | with and give he/she the appropriate role for that. |
---|
43 | </para> |
---|
44 | <para> |
---|
45 | More information about the permission system and working with projects can be found in |
---|
46 | <xref linkend="project_permission" /> |
---|
47 | </para> |
---|
48 | </sect1> |
---|
49 | |
---|
50 | <sect1 id="user_administration.users"> |
---|
51 | <title>Users administration</title> |
---|
52 | <para> |
---|
53 | The user list is accessed with |
---|
54 | <menuchoice> |
---|
55 | <guimenu>Administrate</guimenu> |
---|
56 | <guimenuitem>Users</guimenuitem> |
---|
57 | </menuchoice> |
---|
58 | and from here are users' account and contact information managed. |
---|
59 | </para> |
---|
60 | |
---|
61 | <sect2 id="user_administration.users.edit"> |
---|
62 | <title>Edit user</title> |
---|
63 | |
---|
64 | <helptext external_id="user.edit" title="Edit user account"> |
---|
65 | <sect3 id="user_administration.users.edit.properties"> |
---|
66 | <title>Properties</title> |
---|
67 | <para> |
---|
68 | These are the properties for an user account. |
---|
69 | </para> |
---|
70 | <variablelist> |
---|
71 | <varlistentry> |
---|
72 | <term> |
---|
73 | <guilabel>Name</guilabel> |
---|
74 | </term> |
---|
75 | <listitem> |
---|
76 | <para> |
---|
77 | The full name of the user that is associated with this account. |
---|
78 | (Required) |
---|
79 | </para> |
---|
80 | </listitem> |
---|
81 | </varlistentry> |
---|
82 | <varlistentry> |
---|
83 | <term> |
---|
84 | <guilabel>Login</guilabel> |
---|
85 | </term> |
---|
86 | <listitem> |
---|
87 | <para> |
---|
88 | A login name to use when logging in to this account. (Required) |
---|
89 | </para> |
---|
90 | </listitem> |
---|
91 | </varlistentry> |
---|
92 | <varlistentry> |
---|
93 | <term> |
---|
94 | <optional> |
---|
95 | <guilabel>External ID</guilabel> |
---|
96 | </optional> |
---|
97 | </term> |
---|
98 | <listitem> |
---|
99 | <para>Id used identify the user outside BASE. (Optional)</para> |
---|
100 | </listitem> |
---|
101 | </varlistentry> |
---|
102 | <varlistentry> |
---|
103 | <term> |
---|
104 | <guilabel>New password</guilabel> |
---|
105 | </term> |
---|
106 | <listitem> |
---|
107 | <para> |
---|
108 | This is used together with the login name to log in with this |
---|
109 | account. This is required for a new user or if the password |
---|
110 | should be changed. |
---|
111 | </para> |
---|
112 | </listitem> |
---|
113 | </varlistentry> |
---|
114 | <varlistentry> |
---|
115 | <term> |
---|
116 | <guilabel>Retype password</guilabel> |
---|
117 | </term> |
---|
118 | <listitem> |
---|
119 | <para> |
---|
120 | Retype the password in <guilabel>New password</guilabel>. |
---|
121 | </para> |
---|
122 | </listitem> |
---|
123 | </varlistentry> |
---|
124 | <varlistentry> |
---|
125 | <term> |
---|
126 | <optional> |
---|
127 | <guilabel>Quota</guilabel> |
---|
128 | </optional> |
---|
129 | </term> |
---|
130 | <listitem> |
---|
131 | <para>Set disk quota for this account.(Required)</para> |
---|
132 | </listitem> |
---|
133 | </varlistentry> |
---|
134 | <varlistentry> |
---|
135 | <term> |
---|
136 | <optional> |
---|
137 | <guilabel>Quota group</guilabel> |
---|
138 | </optional> |
---|
139 | </term> |
---|
140 | <listitem> |
---|
141 | <para> |
---|
142 | Set this if the account should belong to a group with specified |
---|
143 | quota. With this set the user's possibilities to save items to |
---|
144 | disk will also depends on how much the rest of the group has |
---|
145 | saved.(Optional) |
---|
146 | </para> |
---|
147 | </listitem> |
---|
148 | </varlistentry> |
---|
149 | <varlistentry> |
---|
150 | <term> |
---|
151 | <optional> |
---|
152 | <guilabel>Home directory</guilabel> |
---|
153 | </optional> |
---|
154 | </term> |
---|
155 | <listitem> |
---|
156 | <para> |
---|
157 | Set the account's home directory. A new directory, either empty |
---|
158 | or from a template, can be created if editing a new |
---|
159 | user.(Optional) |
---|
160 | </para> |
---|
161 | </listitem> |
---|
162 | </varlistentry> |
---|
163 | <varlistentry> |
---|
164 | <term> |
---|
165 | <optional> |
---|
166 | <guilabel>Expiration date</guilabel> |
---|
167 | </optional> |
---|
168 | </term> |
---|
169 | <listitem> |
---|
170 | <para> |
---|
171 | Define a date in this field if the account should expire on a |
---|
172 | certain day. The account will be disabled after this |
---|
173 | date.(Optional) |
---|
174 | <tip> |
---|
175 | <para> |
---|
176 | Use |
---|
177 | <guibutton>Calendar…</guibutton> |
---|
178 | to pick a date from a calendar-pop-up window. |
---|
179 | </para> |
---|
180 | </tip> |
---|
181 | </para> |
---|
182 | </listitem> |
---|
183 | </varlistentry> |
---|
184 | <varlistentry> |
---|
185 | <term> |
---|
186 | <guilabel>Multi-user account</guilabel> |
---|
187 | </term> |
---|
188 | <listitem> |
---|
189 | <para> |
---|
190 | This checkbox should be ticked if the account should be used by |
---|
191 | more one user. It will block the users of the account to change |
---|
192 | password, contact information and other personal information. |
---|
193 | </para> |
---|
194 | </listitem> |
---|
195 | </varlistentry> |
---|
196 | <varlistentry> |
---|
197 | <term> |
---|
198 | <guilabel>Disabled</guilabel> |
---|
199 | </term> |
---|
200 | <listitem> |
---|
201 | <para> |
---|
202 | Disable the account to be used. |
---|
203 | </para> |
---|
204 | </listitem> |
---|
205 | </varlistentry> |
---|
206 | </variablelist> |
---|
207 | </sect3> |
---|
208 | <para> |
---|
209 | Go to the other tabs if there are any changes to do otherwise press |
---|
210 | <guibutton>Save</guibutton> |
---|
211 | to save the values or |
---|
212 | <guibutton>Cancel</guibutton> |
---|
213 | to abort. |
---|
214 | </para> |
---|
215 | <seeother> |
---|
216 | <other external_id="user.edit.contact">Edit user's contact information</other> |
---|
217 | <other external_id="user.edit.membership">Edit user's membership</other> |
---|
218 | </seeother> |
---|
219 | </helptext> |
---|
220 | <helptext external_id="user.edit.contact" title="Edit user's contact information"> |
---|
221 | <sect3 id="user._administration.users.edit.contact"> |
---|
222 | <title>Contact information</title> |
---|
223 | <para> |
---|
224 | Information how get in contact with the user that is connected to the |
---|
225 | account. All fields on this tab are optional and do not necessarily need to |
---|
226 | have a value. |
---|
227 | </para> |
---|
228 | <variablelist> |
---|
229 | <varlistentry> |
---|
230 | <term> |
---|
231 | <optional> |
---|
232 | <guilabel>Email</guilabel> |
---|
233 | </optional> |
---|
234 | </term> |
---|
235 | <listitem> |
---|
236 | <para> |
---|
237 | User's email address.There is some verification of the value but |
---|
238 | their is no check if the email really exists. |
---|
239 | </para> |
---|
240 | </listitem> |
---|
241 | </varlistentry> |
---|
242 | <varlistentry> |
---|
243 | <term> |
---|
244 | <optional> |
---|
245 | <guilabel>Organisation</guilabel> |
---|
246 | </optional> |
---|
247 | </term> |
---|
248 | <listitem> |
---|
249 | <para> |
---|
250 | The company or organisation that the user works for. |
---|
251 | </para> |
---|
252 | </listitem> |
---|
253 | </varlistentry> |
---|
254 | <varlistentry> |
---|
255 | <term> |
---|
256 | <optional> |
---|
257 | <guilabel>Address</guilabel> |
---|
258 | </optional> |
---|
259 | </term> |
---|
260 | <listitem> |
---|
261 | <para> |
---|
262 | User's address. Use the magnifying glas down to the right, to |
---|
263 | edit this property in a larger window - opened in a pop-up |
---|
264 | window. |
---|
265 | </para> |
---|
266 | </listitem> |
---|
267 | </varlistentry> |
---|
268 | <varlistentry> |
---|
269 | <term> |
---|
270 | <optional> |
---|
271 | <guilabel>Phone</guilabel> |
---|
272 | </optional> |
---|
273 | </term> |
---|
274 | <listitem> |
---|
275 | <para> |
---|
276 | User's phone number(s) |
---|
277 | <note> |
---|
278 | <para> |
---|
279 | There is no special field for mobile phone, but it works |
---|
280 | fine to put more then one number in this field. |
---|
281 | </para> |
---|
282 | </note> |
---|
283 | </para> |
---|
284 | </listitem> |
---|
285 | </varlistentry> |
---|
286 | <varlistentry> |
---|
287 | <term> |
---|
288 | <optional> |
---|
289 | <guilabel>Fax</guilabel> |
---|
290 | </optional> |
---|
291 | </term> |
---|
292 | <listitem> |
---|
293 | <para>User's fax number.</para> |
---|
294 | </listitem> |
---|
295 | </varlistentry> |
---|
296 | <varlistentry> |
---|
297 | <term> |
---|
298 | <optional> |
---|
299 | <guilabel>Url</guilabel> |
---|
300 | </optional> |
---|
301 | </term> |
---|
302 | <listitem> |
---|
303 | <para>Fill in any URL associated with the user here.</para> |
---|
304 | </listitem> |
---|
305 | </varlistentry> |
---|
306 | <varlistentry> |
---|
307 | <term> |
---|
308 | <optional> |
---|
309 | <guilabel>Description</guilabel> |
---|
310 | </optional> |
---|
311 | </term> |
---|
312 | <listitem> |
---|
313 | <para> |
---|
314 | Other useful contact information or description about the user should be |
---|
315 | written in this field. Use the magnifying glass to edit the information in |
---|
316 | a pop-up window with a larger text-area. |
---|
317 | </para> |
---|
318 | </listitem> |
---|
319 | </varlistentry> |
---|
320 | </variablelist> |
---|
321 | </sect3> |
---|
322 | <para> |
---|
323 | Go to the other tabs if there are any changes to do otherwise press |
---|
324 | <guibutton>Save</guibutton> |
---|
325 | to save the values or |
---|
326 | <guibutton>Cancel</guibutton> |
---|
327 | to abort. |
---|
328 | </para> |
---|
329 | <seeother> |
---|
330 | <other external_id="user.edit">Edit account</other> |
---|
331 | <other external_id="user.edit.membership">Edit user's membership</other> |
---|
332 | </seeother> |
---|
333 | </helptext> |
---|
334 | |
---|
335 | <helptext external_id="user.edit.membership" title="Edit user's membership"> |
---|
336 | <sect3 id="user_administration.users.edit.membership"> |
---|
337 | <title>User's membership</title> |
---|
338 | <para> |
---|
339 | An user's membership in groups and roles can be set on this tab. The |
---|
340 | membership can also be changed by adding/removing the user to/from a |
---|
341 | group's/role's list of members that is described in |
---|
342 | <link linkend="user_administration.groups.edit">edit group</link> |
---|
343 | and |
---|
344 | <link linkend="user_administration.roles.edit">edit role</link> |
---|
345 | </para> |
---|
346 | <para> |
---|
347 | Use |
---|
348 | <guibutton>Add groups…</guibutton> |
---|
349 | or |
---|
350 | <guibutton>Add roles…</guibutton> |
---|
351 | to add a membership in a group or a role. Mark the checkboxes for those |
---|
352 | groups or roles that the user should become a member in. |
---|
353 | </para> |
---|
354 | <para> |
---|
355 | Use |
---|
356 | <guibutton>Remove</guibutton> |
---|
357 | to delete membership(s) from selected groups and roles in the list. The |
---|
358 | selected items will then disappear from the list of memberships. |
---|
359 | </para> |
---|
360 | </sect3> |
---|
361 | <para> |
---|
362 | Go to the other tabs if there are any changes to do otherwise press |
---|
363 | <guibutton>Save</guibutton> |
---|
364 | to save the values or |
---|
365 | <guibutton>Cancel</guibutton> |
---|
366 | to abort. |
---|
367 | </para> |
---|
368 | <seeother> |
---|
369 | <other external_id="user.edit">Edit account</other> |
---|
370 | <other external_id="user.edit.contact">Edit user's contact information</other> |
---|
371 | </seeother> |
---|
372 | </helptext> |
---|
373 | </sect2> |
---|
374 | </sect1> |
---|
375 | |
---|
376 | <sect1 id="user_administration.groups"> |
---|
377 | <title>Groups administration</title> |
---|
378 | <para> |
---|
379 | Groups in BASE are ment to represent physical groups that are working with the program. |
---|
380 | It can be departments in an organisation or some kind of lab teams, just to mention some |
---|
381 | examples. An user's group-membership is set when the user is added to BASE and shouldn't |
---|
382 | normaly have to be changed later. |
---|
383 | </para> |
---|
384 | <para> |
---|
385 | There is one pre-installed group in BASE, a system group, called Everyone. It is, like |
---|
386 | the name says, a group in which everyone(all users) are members. The users with a role |
---|
387 | that allows sharing to everyone can easily share items to all users by using this group |
---|
388 | to share to. |
---|
389 | </para> |
---|
390 | |
---|
391 | <sect2 id="user_administration.groups.edit"> |
---|
392 | <title>Edit group</title> |
---|
393 | <para></para> |
---|
394 | <helptext external_id="group.edit" title="Edit group"> |
---|
395 | <sect3 id="user_administration.groups.edit.properties"> |
---|
396 | <title>Properties</title> |
---|
397 | <variablelist> |
---|
398 | <varlistentry> |
---|
399 | <term> |
---|
400 | <guilabel>Name</guilabel> |
---|
401 | </term> |
---|
402 | <listitem> |
---|
403 | <para>Group's name.(Required)</para> |
---|
404 | </listitem> |
---|
405 | </varlistentry> |
---|
406 | <varlistentry> |
---|
407 | <term> |
---|
408 | <optional> |
---|
409 | <guilabel>Description</guilabel> |
---|
410 | </optional> |
---|
411 | </term> |
---|
412 | <listitem> |
---|
413 | <para> |
---|
414 | Description about the group. The magifying glass, down to the |
---|
415 | right, can be used to open the text in a larger text area. |
---|
416 | </para> |
---|
417 | </listitem> |
---|
418 | </varlistentry> |
---|
419 | <varlistentry> |
---|
420 | <term> |
---|
421 | <optional> |
---|
422 | <guilabel>Quota</guilabel> |
---|
423 | </optional> |
---|
424 | </term> |
---|
425 | <listitem> |
---|
426 | <para> |
---|
427 | With this property it's possible to limit the quota of total |
---|
428 | disk space for the group members. Select |
---|
429 | <guilabel>-none-</guilabel> |
---|
430 | from the dropdown list if the group shouldn't have any quota. |
---|
431 | There are some presets of quotas that comes with the BASE2 |
---|
432 | installation, besides a couple with different size of total disk |
---|
433 | space there are one called |
---|
434 | <guilabel>No quota</guilabel> |
---|
435 | and one with |
---|
436 | <guilabel>Unlimited quota</guilabel> |
---|
437 | . Their names speak for them self. |
---|
438 | </para> |
---|
439 | </listitem> |
---|
440 | </varlistentry> |
---|
441 | </variablelist> |
---|
442 | </sect3> |
---|
443 | <para> |
---|
444 | Go to the other tab, |
---|
445 | <guilabel>Members</guilabel> |
---|
446 | , if there are any changes to do otherwise use |
---|
447 | <guibutton>Save</guibutton> |
---|
448 | to save the settings or |
---|
449 | <guibutton>Cancel</guibutton> |
---|
450 | to abort. |
---|
451 | </para> |
---|
452 | <seeother> |
---|
453 | <other external_id="group.edit.membership">Edit group members</other> |
---|
454 | </seeother> |
---|
455 | </helptext> |
---|
456 | |
---|
457 | <helptext external_id="group.edit.membership" title="Edit group members"> |
---|
458 | <sect3 id="user_administration.groups.edit.members"> |
---|
459 | <title>Group members</title> |
---|
460 | <para> |
---|
461 | A group can have both single users and whole groups as members. Group |
---|
462 | members have access to those items that are shared to the group. Each user |
---|
463 | in the group has the possibility to share their own items to one or more of |
---|
464 | the other members or to the whole group. |
---|
465 | </para> |
---|
466 | <para> |
---|
467 | The listbox shows the group's members, both users and other groups. |
---|
468 | |
---|
469 | Removing members from a group are done by first select one or several |
---|
470 | members in the list and then click on |
---|
471 | <guibutton>Remove</guibutton> |
---|
472 | . The selected items will then disappear from the list. |
---|
473 | </para> |
---|
474 | </sect3> |
---|
475 | <para> |
---|
476 | Go to the other tab if there are any changes to do, otherwise use |
---|
477 | <guibutton>Save</guibutton> |
---|
478 | to save the values or |
---|
479 | <guibutton>Cancel</guibutton> |
---|
480 | to abort. |
---|
481 | </para> |
---|
482 | <seeother> |
---|
483 | <other external_id="group.edit">Edit group properties</other> |
---|
484 | </seeother> |
---|
485 | </helptext> |
---|
486 | </sect2> |
---|
487 | </sect1> |
---|
488 | |
---|
489 | <sect1 id="user_administration.roles"> |
---|
490 | <title>Roles administration</title> |
---|
491 | <para> |
---|
492 | Roles are different kinds of working positions that users can have, like server |
---|
493 | adminstrator or regular user just to mention two. The permissions for a role are set |
---|
494 | depending on what it is going to do in BASE. |
---|
495 | </para> |
---|
496 | <para> |
---|
497 | Users are normally assigned a role, perhaps more then one, when they are |
---|
498 | created and registered in BASE. |
---|
499 | </para> |
---|
500 | |
---|
501 | <sect2 id="user_administration.roles.edit"> |
---|
502 | <title>Edit role</title> |
---|
503 | <para> |
---|
504 | Creating a new role or editing the system-roles are something that don't needs to be |
---|
505 | done very often. The existing roles will normaly be enough but there can be some |
---|
506 | cases when they need to be complemented, either with a new role or with different |
---|
507 | permissions. |
---|
508 | </para> |
---|
509 | <helptext external_id="role.edit" title="Edit role"> |
---|
510 | <sect3 id="user_administration.roles.edit.properties"> |
---|
511 | <title>Properties</title> |
---|
512 | <para></para> |
---|
513 | <variablelist> |
---|
514 | <varlistentry> |
---|
515 | <term> |
---|
516 | <guilabel>Name</guilabel> |
---|
517 | </term> |
---|
518 | <listitem> |
---|
519 | <para>The role's name. (Required)</para> |
---|
520 | </listitem> |
---|
521 | </varlistentry> |
---|
522 | <varlistentry> |
---|
523 | <term> |
---|
524 | <guilabel>System-level permissions</guilabel> |
---|
525 | </term> |
---|
526 | <listitem> |
---|
527 | <itemizedlist> |
---|
528 | <listitem><simpara> |
---|
529 | With |
---|
530 | <guilabel>Share to Everyone</guilabel> |
---|
531 | set the role is allowed to share items to the system-group |
---|
532 | 'Everyone'.</simpara> |
---|
533 | </listitem> |
---|
534 | <listitem><simpara> |
---|
535 | <guilabel>Act as another user</guilabel> |
---|
536 | - property makes it possible for the one with this role to |
---|
537 | login from the menu bar as another user. This is used by job |
---|
538 | agents when they should act as the user who started the job.</simpara> |
---|
539 | </listitem> |
---|
540 | </itemizedlist> |
---|
541 | </listitem> |
---|
542 | </varlistentry> |
---|
543 | <varlistentry> |
---|
544 | <term> |
---|
545 | <guilabel>Description</guilabel> |
---|
546 | </term> |
---|
547 | <listitem> |
---|
548 | <para>Description and information about the role.(Optional)</para> |
---|
549 | </listitem> |
---|
550 | </varlistentry> |
---|
551 | </variablelist> |
---|
552 | <para> |
---|
553 | Set the properties and procceed then to either one of the other tabs or by |
---|
554 | clicking on one of the buttons: |
---|
555 | <guibutton>Save</guibutton> |
---|
556 | to save the changes or |
---|
557 | <guibutton>Cancel</guibutton> |
---|
558 | to abort. |
---|
559 | </para> |
---|
560 | </sect3> |
---|
561 | <seeother> |
---|
562 | <other external_id="role.edit.permissions">Role permissions</other> |
---|
563 | <other external_id="role.edit.members">Role members</other> |
---|
564 | </seeother> |
---|
565 | </helptext> |
---|
566 | |
---|
567 | <helptext external_id="role.edit.permissions" title="Edit role permissions"> |
---|
568 | <sect3 id="user_administration.roles.edit.permissions"> |
---|
569 | <title>Permissions</title> |
---|
570 | <para> |
---|
571 | A role's permissions are defined for each item type within BASE 2. Set the |
---|
572 | role's permission on an item type by first selecting the item(s) in the |
---|
573 | list and then tick those permissions that should be applied. Not all |
---|
574 | permissions can be applied to every item type, that's why permission |
---|
575 | checkboxes becomes disabled when selecting some of the item types |
---|
576 | </para> |
---|
577 | <para> |
---|
578 | After each item type is a string inside square brackets that shows what kind |
---|
579 | of permissions the current role has on that particular item type. The |
---|
580 | permissions that don't have been set are viewed with '-' inside the square |
---|
581 | brackets and those which have been set are represented with characters that |
---|
582 | are listed below. |
---|
583 | </para> |
---|
584 | <itemizedlist spacing="compact"> |
---|
585 | <listitem> |
---|
586 | <simpara> |
---|
587 | <guilabel>DENIED</guilabel> |
---|
588 | = Deny access to the selected item. This exclude all the other |
---|
589 | permissions by unchecking the other check boxes. |
---|
590 | </simpara> |
---|
591 | </listitem> |
---|
592 | <listitem> |
---|
593 | <simpara> |
---|
594 | <guilabel>C</guilabel> |
---|
595 | = Create |
---|
596 | </simpara> |
---|
597 | </listitem> |
---|
598 | <listitem> |
---|
599 | <simpara> |
---|
600 | <guilabel>R</guilabel> |
---|
601 | = Read |
---|
602 | </simpara> |
---|
603 | </listitem> |
---|
604 | <listitem> |
---|
605 | <simpara> |
---|
606 | <guilabel>U</guilabel> |
---|
607 | = Use |
---|
608 | </simpara> |
---|
609 | </listitem> |
---|
610 | <listitem> |
---|
611 | <simpara> |
---|
612 | <guilabel>W</guilabel> |
---|
613 | = Write |
---|
614 | </simpara> |
---|
615 | </listitem> |
---|
616 | <listitem> |
---|
617 | <simpara> |
---|
618 | <guilabel>D</guilabel> |
---|
619 | = Delete |
---|
620 | </simpara> |
---|
621 | </listitem> |
---|
622 | <listitem> |
---|
623 | <simpara> |
---|
624 | <guilabel>O</guilabel> |
---|
625 | = Take ownership |
---|
626 | </simpara> |
---|
627 | </listitem> |
---|
628 | <listitem> |
---|
629 | <simpara> |
---|
630 | <guilabel>P</guilabel> |
---|
631 | = Set permission |
---|
632 | </simpara> |
---|
633 | </listitem> |
---|
634 | </itemizedlist> |
---|
635 | <para> |
---|
636 | Set the role's permission on each one of the item types and procceed then to |
---|
637 | one of the other tabs or click on one of the buttons: |
---|
638 | <guibutton>Save</guibutton> |
---|
639 | to save the changes or |
---|
640 | <guibutton>Cancel</guibutton> |
---|
641 | to abort. |
---|
642 | </para> |
---|
643 | </sect3> |
---|
644 | <seeother> |
---|
645 | <other external_id="role.edit">Edit properties</other> |
---|
646 | <other external_id="role.edit.members">Role members</other> |
---|
647 | </seeother> |
---|
648 | </helptext> |
---|
649 | |
---|
650 | <helptext external_id="role.edit.members" title="Role members"> |
---|
651 | <sect3 id="user_administration.roles.edit.members"> |
---|
652 | <title>Members</title> |
---|
653 | <para> |
---|
654 | Users that are members of a role are listed in the listbox located on this |
---|
655 | tab.Members can be added or removed with the two buttons, located to the |
---|
656 | right of the listbox, |
---|
657 | <guibutton>Add users…</guibutton> |
---|
658 | and |
---|
659 | <guibutton>Remove</guibutton> |
---|
660 | . |
---|
661 | </para> |
---|
662 | <variablelist> |
---|
663 | <varlistentry> |
---|
664 | <term>Add users to list</term> |
---|
665 | <listitem> |
---|
666 | <para> |
---|
667 | Click on |
---|
668 | <guibutton>Add users…</guibutton> |
---|
669 | and select the users that should be added from the list in the |
---|
670 | pop-up window. Press then on |
---|
671 | <guibutton>Ok</guibutton> |
---|
672 | button to close the pop-up window and add the selected users. |
---|
673 | Use |
---|
674 | <guibutton>Cancel</guibutton> |
---|
675 | or just close the pop-up to abort and return to main window. |
---|
676 | </para> |
---|
677 | </listitem> |
---|
678 | </varlistentry> |
---|
679 | <varlistentry> |
---|
680 | <term>Remove users from list</term> |
---|
681 | <listitem> |
---|
682 | <para> |
---|
683 | Members are removed from the list by first selecting them and |
---|
684 | then pressing |
---|
685 | <guibutton>Remove</guibutton> |
---|
686 | . The selected user(s) are removed immediately. |
---|
687 | </para> |
---|
688 | </listitem> |
---|
689 | </varlistentry> |
---|
690 | </variablelist> |
---|
691 | <para> |
---|
692 | Press |
---|
693 | <guibutton>Save</guibutton> |
---|
694 | to save the role or go to one of the other tabs if there are more that needs |
---|
695 | to be set. Use |
---|
696 | <guibutton>Close</guibutton> |
---|
697 | to abort and close the window without saving the changes. |
---|
698 | </para> |
---|
699 | </sect3> |
---|
700 | <seeother> |
---|
701 | <other external_id="role.edit">Edit properties</other> |
---|
702 | <other external_id="role.edit.permissions">Role permissions</other> |
---|
703 | </seeother> |
---|
704 | </helptext> |
---|
705 | </sect2> |
---|
706 | |
---|
707 | <sect2 id="user_administration.roles.defaultroles"> |
---|
708 | <title>Default roles</title> |
---|
709 | <para> |
---|
710 | There are some default roles that come with BASE2. These are configured to cover the |
---|
711 | normal user roles that can appear. A more detailed description of the different |
---|
712 | roles and when to use them follows here. |
---|
713 | </para> |
---|
714 | <variablelist> |
---|
715 | <varlistentry> |
---|
716 | <term>Administrator</term> |
---|
717 | <listitem> |
---|
718 | <para> |
---|
719 | This role gives the user full permission to do everything in BASE and |
---|
720 | also possibility to share items with the system-group 'Everyone'. Users |
---|
721 | that are supposed to administrate the server, user accounts, groups etc. |
---|
722 | should have this role. |
---|
723 | </para> |
---|
724 | </listitem> |
---|
725 | </varlistentry> |
---|
726 | <varlistentry> |
---|
727 | <term>Supervisor</term> |
---|
728 | <listitem> |
---|
729 | <para> |
---|
730 | Users that are members of this role has permission to read everything in |
---|
731 | BASE. This role doesn't let the members to actually do anything in BASE |
---|
732 | except read and supervise. |
---|
733 | </para> |
---|
734 | </listitem> |
---|
735 | </varlistentry> |
---|
736 | <varlistentry> |
---|
737 | <term>Power user</term> |
---|
738 | <listitem> |
---|
739 | <para> |
---|
740 | This role allows it's members to do some things that an ordinary user |
---|
741 | not is allowed to. This role can be proper for those users that are in |
---|
742 | some kind of leading position over workgroups or projects. |
---|
743 | </para> |
---|
744 | </listitem> |
---|
745 | </varlistentry> |
---|
746 | <varlistentry> |
---|
747 | <term>User</term> |
---|
748 | <listitem> |
---|
749 | <para> |
---|
750 | A role that is suitable for any ordinary users. This allows the members |
---|
751 | to do common things in BASE as analysis, creating biomaterials and |
---|
752 | experiments and so on. |
---|
753 | </para> |
---|
754 | </listitem> |
---|
755 | </varlistentry> |
---|
756 | <varlistentry> |
---|
757 | <term>Guest</term> |
---|
758 | <listitem> |
---|
759 | <para> |
---|
760 | This is a role with limited access to create new things. It is useful |
---|
761 | for those who wants to have peek at the program. |
---|
762 | </para> |
---|
763 | </listitem> |
---|
764 | </varlistentry> |
---|
765 | <varlistentry> |
---|
766 | <term>Job agent</term> |
---|
767 | <listitem> |
---|
768 | <para> |
---|
769 | This role is given to the job agents and allows them to read and execute |
---|
770 | jobs. Job agents always runs the jobs as the user who created the job |
---|
771 | and therefore it have to be able to act as another user. No more |
---|
772 | permissions then these are needed for job agents. |
---|
773 | </para> |
---|
774 | </listitem> |
---|
775 | </varlistentry> |
---|
776 | </variablelist> |
---|
777 | </sect2> |
---|
778 | </sect1> |
---|
779 | |
---|
780 | <sect1 id="user_administration.quota"> |
---|
781 | <title>Disk space/quota</title> |
---|
782 | <para> |
---|
783 | The administrator can control the maximum size of disk space that each user should be |
---|
784 | able to use. Also groups can have limited disk quota and this will effect when an user |
---|
785 | is saving something to the database that is disk consuming. The most restricted one of |
---|
786 | the group's quota and user's quota will be valid and the user will be denied to store |
---|
787 | the item on the server if one of the disk quotas is filled. |
---|
788 | </para> |
---|
789 | <para> |
---|
790 | More about a user's quota and quota group can be found in |
---|
791 | <xref linkend="user_administration.groups.edit" /> |
---|
792 | and |
---|
793 | <xref linkend="user_administration.users.edit" /> |
---|
794 | </para> |
---|
795 | <para> |
---|
796 | The list of quotas in BASE can be found by using the menu |
---|
797 | <menuchoice> |
---|
798 | <guimenu>Administrate</guimenu> |
---|
799 | <guimenuitem>Quota</guimenuitem> |
---|
800 | </menuchoice> |
---|
801 | . |
---|
802 | </para> |
---|
803 | |
---|
804 | <sect2 id="user_administration.quota.edit"> |
---|
805 | <title>Edit quota</title> |
---|
806 | <para> |
---|
807 | The edit window has two tabs, one with information about the quota and one |
---|
808 | where the limits are defined. |
---|
809 | </para> |
---|
810 | <helptext external_id="quota.edit" title="Edit properties"> |
---|
811 | <sect3 id="user_administration.quota.edit.properties"> |
---|
812 | <title>Properties</title> |
---|
813 | <variablelist> |
---|
814 | <varlistentry> |
---|
815 | <term> |
---|
816 | <guilabel>Name</guilabel> |
---|
817 | </term> |
---|
818 | <listitem> |
---|
819 | <para>Name of the quota (Required).</para> |
---|
820 | </listitem> |
---|
821 | </varlistentry> |
---|
822 | <varlistentry> |
---|
823 | <term> |
---|
824 | <optional> |
---|
825 | <guilabel>Description</guilabel> |
---|
826 | </optional> |
---|
827 | </term> |
---|
828 | <listitem> |
---|
829 | <para> |
---|
830 | Description of the quota(Optional). It could be a good idea to |
---|
831 | describe the quota's details here. Use the magnifying glas to |
---|
832 | edit the text in a larger text area. |
---|
833 | </para> |
---|
834 | </listitem> |
---|
835 | </varlistentry> |
---|
836 | </variablelist> |
---|
837 | <para> |
---|
838 | Go to the other tab if there are values that haven't been set. |
---|
839 | Otherwise use |
---|
840 | <guibutton>Save</guibutton> |
---|
841 | to save the settings or |
---|
842 | <guibutton>Cancel</guibutton> |
---|
843 | to abort. |
---|
844 | </para> |
---|
845 | </sect3> |
---|
846 | </helptext> |
---|
847 | |
---|
848 | <helptext external_id="quota.edit.values" title="Edit values"> |
---|
849 | <sect3 id="user_administration.quota.edit.values"> |
---|
850 | <title>Values</title> |
---|
851 | <para> |
---|
852 | The quota values are defined here, both for the primary location and the |
---|
853 | secondary location. Use the check box to the right of the input fields to |
---|
854 | set unlimited quota. |
---|
855 | </para> |
---|
856 | <variablelist> |
---|
857 | <varlistentry> |
---|
858 | <term> |
---|
859 | <guilabel>Total</guilabel> |
---|
860 | </term> |
---|
861 | <listitem> |
---|
862 | <para> |
---|
863 | Limit of total quota. The sum of the other three quotas doesn't |
---|
864 | have to be the same as this, it is always the most restricted |
---|
865 | value that is used.(Required) |
---|
866 | </para> |
---|
867 | </listitem> |
---|
868 | </varlistentry> |
---|
869 | <varlistentry> |
---|
870 | <term> |
---|
871 | <optional> |
---|
872 | <guilabel>Files</guilabel> |
---|
873 | </optional> |
---|
874 | </term> |
---|
875 | <listitem> |
---|
876 | <para>Limit of disk space to save files in.(Optional)</para> |
---|
877 | </listitem> |
---|
878 | </varlistentry> |
---|
879 | <varlistentry> |
---|
880 | <term> |
---|
881 | <optional> |
---|
882 | <guilabel>Raw data</guilabel> |
---|
883 | </optional> |
---|
884 | </term> |
---|
885 | <listitem> |
---|
886 | <para>Disk space to save Raw data in.(Optional)</para> |
---|
887 | </listitem> |
---|
888 | </varlistentry> |
---|
889 | <varlistentry> |
---|
890 | <term> |
---|
891 | <optional> |
---|
892 | <guilabel>Experiments</guilabel> |
---|
893 | </optional> |
---|
894 | </term> |
---|
895 | <listitem> |
---|
896 | <para> |
---|
897 | Limit of disk space that can be used by experiments.(Optional) |
---|
898 | </para> |
---|
899 | </listitem> |
---|
900 | </varlistentry> |
---|
901 | </variablelist> |
---|
902 | <para> |
---|
903 | When everything have been set the quota is saved by using |
---|
904 | <guibutton>Save</guibutton> |
---|
905 | . To discard changes use |
---|
906 | <guibutton>Cancel</guibutton> |
---|
907 | . |
---|
908 | </para> |
---|
909 | </sect3> |
---|
910 | </helptext> |
---|
911 | </sect2> |
---|
912 | </sect1> |
---|
913 | </chapter> |
---|