Changeset 3313
- Timestamp:
- May 9, 2007, 1:22:17 PM (14 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/src/docbook/admindoc/user_administration.xml
r3310 r3313 30 30 <?dbhtml dir="user_administration"?> 31 31 <title>Account administration</title> 32 32 33 33 <sect1 id="user_administration.permissions"> 34 34 <title>Permission system</title> 35 35 <para> 36 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. 37 permissions from shared items in groups and projects they are members in. An user has 38 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 42 work with and give he/she the appropriate role for that. The rest of the permissions 43 should the user normally get from the projects he/she is a member in. 43 44 </para> 44 45 <para> … … 56 57 <guimenuitem>Users</guimenuitem> 57 58 </menuchoice> 58 and from here are users' account and contact information managed.59 and from here are the users' account and contact information managed. 59 60 </para> 60 61 61 62 <sect2 id="user_administration.users.edit"> 62 <title>Edit user</title> 63 63 <title>Edit user</title> 64 <para> 65 The pop-up window where information and settings for an user can be edit has three 66 tabs, one for the account related, one with information about the user and one that 67 shows the user's memberships. 68 </para> 64 69 <helptext external_id="user.edit" title="Edit user account"> 65 70 <sect3 id="user_administration.users.edit.properties"> 66 71 <title>Properties</title> 67 <para> 68 These are the properties for an user account. 69 </para> 72 <para>These are the properties for an user account.</para> 70 73 <variablelist> 71 74 <varlistentry> … … 75 78 <listitem> 76 79 <para> 77 The full name of the user that is associated with th isaccount.80 The full name of the user that is associated with the account. 78 81 (Required) 79 82 </para> … … 86 89 <listitem> 87 90 <para> 88 A login name to use when logging in to th isaccount. (Required)91 A login name to use when logging in to the account. (Required) 89 92 </para> 90 93 </listitem> … … 97 100 </term> 98 101 <listitem> 99 <para>Id used identify the user outside BASE. (Optional)</para> 102 <para> 103 An id that is used to identify the user outside BASE. (Optional) 104 </para> 100 105 </listitem> 101 106 </varlistentry> … … 106 111 <listitem> 107 112 <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. 113 This is used together with the login name to log in to the 114 account. This is a required field for a new user or if the 115 password should be changed. If the field is left empty the 116 password will be unchanged 111 117 </para> 112 118 </listitem> … … 118 124 <listitem> 119 125 <para> 120 Retype the password in <guilabel>New password</guilabel>. 126 Retype the password that is written in 127 <guilabel>New password</guilabel> 128 . 121 129 </para> 122 130 </listitem> … … 129 137 </term> 130 138 <listitem> 131 <para>Set dis k quota for thisaccount.(Required)</para>139 <para>Set disc quota for the account.(Required)</para> 132 140 </listitem> 133 141 </varlistentry> … … 142 150 Set this if the account should belong to a group with specified 143 151 quota. With this set the user's possibilities to save items to 144 dis k will also dependson how much the rest of the group has152 disc will also depend on how much the rest of the group has 145 153 saved.(Optional) 146 154 </para> … … 156 164 <para> 157 165 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) 166 or from a template, can be created if editing a new user. Select 167 <guilabel>- none -</guilabel> 168 if there shouldn't be any home directory asocciated with the 169 account.(Optional) 160 170 </para> 161 171 </listitem> … … 170 180 <para> 171 181 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)182 certain day. The account will be disabled after this date. Leave 183 this empty if the account should be continuous. (Optional) 174 184 <tip> 175 185 <para> 176 186 Use 177 187 <guibutton>Calendar…</guibutton> 178 to pick a date from a calendar -pop-up window.188 to pick a date from a calendar in a pop-up window. 179 189 </para> 180 190 </tip> … … 188 198 <listitem> 189 199 <para> 190 This checkbox should be ticked if the account should be used by200 This checkbox should be checked if the account should be used by 191 201 more one user. It will block the users of the account to change 192 password, contact information and other personal information. 202 password, contact information and other settings that will mess 203 up the use of the account. 193 204 </para> 194 205 </listitem> … … 200 211 <listitem> 201 212 <para> 202 Disable the account to be used. 213 Disable the account for further use by check this. The account 214 can't be used until this is unchecked. 203 215 </para> 204 216 </listitem> … … 222 234 <title>Contact information</title> 223 235 <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. 236 Information about how to get in contact with the user that is asocciated 237 with the account. All fields on this tab are optional and do not necessarily 238 need to have a value but some can be good to set, like email or phone 239 number. 227 240 </para> 228 241 <variablelist> … … 235 248 <listitem> 236 249 <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> 250 User's email address. There is some verification of the value 251 but there is no check if the email really exists. 252 </para> 253 </listitem> 254 </varlistentry> 255 <varlistentry> 256 <term> 257 <optional> 258 <guilabel>Organization</guilabel> 259 </optional> 260 </term> 261 <listitem> 262 <para>The company or organization that the user works for.</para> 252 263 </listitem> 253 264 </varlistentry> … … 260 271 <listitem> 261 272 <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. 273 User's mail address. Use the magnifying glass down to the right, 274 to edit this property in a larger window. 265 275 </para> 266 276 </listitem> … … 301 311 </term> 302 312 <listitem> 303 <para> Fill in any URL associated with the user here.</para>313 <para>An URL that is associated with the user.</para> 304 314 </listitem> 305 315 </varlistentry> … … 312 322 <listitem> 313 323 <para> 314 Other useful contact information or description about the user should be315 written in this field. Use the magnifying glass to edit the information in316 a pop-up window with a larger text-area.324 Other useful contact information or description about the user 325 can be written in this field. Use the magnifying glass to edit 326 the information in a pop-up window with a larger text-area. 317 327 </para> 318 328 </listitem> … … 340 350 membership can also be changed by adding/removing the user to/from a 341 351 group's/role's list of members that is described in 342 < link linkend="user_administration.groups.edit">edit group</link>352 <xref linkend="user_administration.groups.edit" /> 343 353 and 344 < link linkend="user_administration.roles.edit">edit role</link>354 <xref linkend="user_administration.roles.edit" /> 345 355 </para> 346 356 <para> … … 349 359 or 350 360 <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 361 to add a membership in a group or a role. Mark the check-boxes for those 362 groups or roles that the user should become a member in. Using the 363 <guibutton>Ok</guibutton> 364 will add the selected items to the list of memberships. 365 </para> 366 <para> 367 Memberships are removed by selecting items from the list of memberships and 368 the pressing 356 369 <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. 370 . The selected items will then disappear from the list of memberships. 359 371 </para> 360 372 </sect3> … … 377 389 <title>Groups administration</title> 378 390 <para> 379 Groups in BASE are me nt to represent physical groups that are working with the program.380 It can be departments in an organi sation or some kind of lab teams, just to mention some381 examples. An user's group-membership is set when the user is added to BASE and shouldn't382 normaly have to be changed later.391 Groups in BASE are meant to represent physical groups that are working with the program. 392 It can be departments in an organization or some kind of lab teams, just to mention some 393 examples. An user's group-membership is normally set when the user is added to BASE and 394 has no needs to be changed later , except when the company is re-organizing. 383 395 </para> 384 396 <para> 385 397 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 role387 that allows sharing to everyone can easily share items to all users by using this group388 t o share to.398 the name says, a group in which everyone(all users) are members. The users that are 399 allowed to share to everyone can easily share items to all users by sharing the item to 400 this group. 389 401 </para> 390 402 391 403 <sect2 id="user_administration.groups.edit"> 392 404 <title>Edit group</title> 393 <para></para> 405 <para> 406 The pop-up window where a group can be edit has two tabs, 407 <guilabel>Group</guilabel> 408 and 409 <guilabel>Members</guilabel> 410 </para> 394 411 <helptext external_id="group.edit" title="Edit group"> 395 412 <sect3 id="user_administration.groups.edit.properties"> … … 412 429 <listitem> 413 430 <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. 431 Description about the group. The magnifying glass, down to the 432 right, can be used to open and edit the text in a larger text 433 area. 416 434 </para> 417 435 </listitem> … … 426 444 <para> 427 445 With this property it's possible to limit the quota of total 428 dis kspace for the group members. Select446 disc space for the group members. Select 429 447 <guilabel>-none-</guilabel> 430 from the drop down list if the group shouldn't have any quota.448 from the drop-down list if the group shouldn't have any quota. 431 449 There are some presets of quotas that comes with the BASE2 432 installation, besides a couple with different size of total dis k450 installation, besides a couple with different size of total disc 433 451 space there are one called 434 452 <guilabel>No quota</guilabel> … … 465 483 </para> 466 484 <para> 467 The list box shows the group's members, both users and other groups.485 The list-box shows the group's members, both users and other groups. 468 486 469 487 Removing members from a group are done by first select one or several … … 491 509 <para> 492 510 Roles are different kinds of working positions that users can have, like server 493 admin strator or regular user just to mention two. The permissions for a role are set511 administrator or regular user just to mention two. The permissions for a role are set 494 512 depending on what it is going to do in BASE. 495 513 </para> 496 514 <para> 497 Users are normally assigned a role, perhaps more then one, when they are 498 created andregistered in BASE.515 Users are normally assigned a role, perhaps more then one, when they are created and 516 registered in BASE. 499 517 </para> 500 518 … … 503 521 <para> 504 522 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 normal y be enough but there can be some523 done very often. The existing roles will normally be enough but there can be some 506 524 cases when they need to be complemented, either with a new role or with different 507 525 permissions. … … 510 528 <sect3 id="user_administration.roles.edit.properties"> 511 529 <title>Properties</title> 512 <para> </para>530 <para>These are the properties that can be defined for a role.</para> 513 531 <variablelist> 514 532 <varlistentry> … … 526 544 <listitem> 527 545 <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> 546 <listitem> 547 <simpara> 548 With 549 <guilabel>Share to Everyone</guilabel> 550 set the role allows the user to share items to the 551 system-group 'Everyone'. 552 </simpara> 533 553 </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> 554 <listitem> 555 <simpara> 556 <guilabel>Act as another user</guilabel> 557 - property makes it possible for the one with this role 558 to login from the menu bar as another user. This is used 559 by job agents when they should act as the user who 560 created the job. 561 </simpara> 539 562 </listitem> 540 563 </itemizedlist> … … 551 574 </variablelist> 552 575 <para> 553 Set the properties and proc ceed then to either one of the other tabs or by576 Set the properties and proceed then to either one of the other tabs or by 554 577 clicking on one of the buttons: 555 578 <guibutton>Save</guibutton> … … 564 587 </seeother> 565 588 </helptext> 566 589 567 590 <helptext external_id="role.edit.permissions" title="Edit role permissions"> 568 591 <sect3 id="user_administration.roles.edit.permissions"> … … 570 593 <para> 571 594 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 all574 permissions can be applied to every item type, that's why permission575 checkboxes becomesdisabled when selecting some of the item types576 </para> 577 <para> 578 After each item type i s a string inside square brackets that shows what kind579 of permissions the current role has on that particular item type. The580 permissions that don't have been set are viewed with '-' inside the square581 brackets and those which have been set are represented with characters that582 are listed below.583 </para> 584 <itemizedlist spacing="compact">595 role's permission on an item type by first selecting the item(s) in the list 596 and then tick those permissions that should be applied. Not all permissions 597 can be applied to every item type, that's why permission check-boxes becomes 598 disabled when selecting some of the item types 599 </para> 600 <para> 601 After each item type in the list is a string inside square brackets that 602 shows what kind of permissions the current role has on that particular item 603 type. The permissions that don't have been set are represented with '-' 604 inside the square brackets and those which have been set are represented 605 with characters that are listed below. 606 </para> 607 <itemizedlist> 585 608 <listitem> 586 609 <simpara> 587 610 <guilabel>DENIED</guilabel> 588 = Deny access to the selected item . This exclude all the other611 = Deny access to the selected item type. This exclude all the other 589 612 permissions by unchecking the other check boxes. 590 613 </simpara> … … 634 657 </itemizedlist> 635 658 <para> 636 Set the role's permission on each one of the item types and proc ceed then to659 Set the role's permission on each one of the item types and proceed then to 637 660 one of the other tabs or click on one of the buttons: 638 661 <guibutton>Save</guibutton> … … 647 670 </seeother> 648 671 </helptext> 649 672 650 673 <helptext external_id="role.edit.members" title="Role members"> 651 674 <sect3 id="user_administration.roles.edit.members"> 652 675 <title>Members</title> 653 676 <para> 654 Users that are members of a role are listed in the list box located on this655 tab. Members can be added or removed with the two buttons, located to the656 right of the list box,677 Users that are members of a role are listed in the list-box located on this 678 tab. Members can be added or removed with the two buttons, located to the 679 right of the list box, 657 680 <guibutton>Add users…</guibutton> 658 681 and … … 668 691 <guibutton>Add users…</guibutton> 669 692 and select the users that should be added from the list in the 670 pop-up window. Press then on 693 pop-up window. Press then on the 671 694 <guibutton>Ok</guibutton> 672 695 button to close the pop-up window and add the selected users. … … 704 727 </helptext> 705 728 </sect2> 706 729 707 730 <sect2 id="user_administration.roles.defaultroles"> 708 731 <title>Default roles</title> … … 748 771 <listitem> 749 772 <para> 750 A role that is suitable for a nyordinary users. This allows the members773 A role that is suitable for all ordinary users. This allows the members 751 774 to do common things in BASE as analysis, creating biomaterials and 752 775 experiments and so on. … … 777 800 </sect2> 778 801 </sect1> 779 802 780 803 <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 804 <title>Disc space/quota</title> 805 <para> 806 The administrator can control the maximum size of disc space that each user should be 807 able to use. Also groups can have limited disc quota and this will effect when an user, 808 that is member of a quota group, is saving something to the database that is disc 809 consuming. The most restricted one of the group's quota and user's quota will be used 810 and the user will be denied to store the item on the server if one of the disc quotas is 811 filled. 812 </para> 813 <para> 814 How to set an user's quota or to create a quota can be read at 791 815 <xref linkend="user_administration.groups.edit" /> 792 816 and … … 805 829 <title>Edit quota</title> 806 830 <para> 807 The edit window has two tabs, one with information about the quota and one 808 where thelimits are defined.831 The edit window has two tabs, one with information about the quota and one where the 832 limits are defined. 809 833 </para> 810 834 <helptext external_id="quota.edit" title="Edit properties"> … … 828 852 <listitem> 829 853 <para> 830 Description of the quota (Optional). It could be a good idea to831 describe the quota's details here. Use the magnifying glas to832 edit the text in a larger text area. 854 Description of the quota. It could be a good idea to 855 describe the quota's details here. Use the magnifying glass to 856 edit the text in a larger text area.(Optional) 833 857 </para> 834 858 </listitem> … … 836 860 </variablelist> 837 861 <para> 838 Go to the other tab if there are values that haven't been set. 839 Otherwise use 862 Go to the other tab if there are values that haven't been set. Otherwise use 840 863 <guibutton>Save</guibutton> 841 864 to save the settings or … … 874 897 </term> 875 898 <listitem> 876 <para>Limit of dis kspace to save files in.(Optional)</para>899 <para>Limit of disc space to save files in.(Optional)</para> 877 900 </listitem> 878 901 </varlistentry> … … 884 907 </term> 885 908 <listitem> 886 <para> Diskspace to save Raw data in.(Optional)</para>909 <para>disc space to save Raw data in.(Optional)</para> 887 910 </listitem> 888 911 </varlistentry> … … 895 918 <listitem> 896 919 <para> 897 Limit of dis kspace that can be used by experiments.(Optional)920 Limit of disc space that can be used by experiments.(Optional) 898 921 </para> 899 922 </listitem>
Note: See TracChangeset
for help on using the changeset viewer.
