doc/src/docbook/user/project_permission.xml

Code
Comments
Other
Rev Date Author Line
3157 05 Mar 07 martin 1 <?xml version="1.0" encoding="UTF-8"?>
3159 05 Mar 07 martin 2 <!DOCTYPE chapter PUBLIC 
3159 05 Mar 07 martin 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3192 13 Mar 07 martin 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3157 05 Mar 07 martin 5 <!--
3192 13 Mar 07 martin 6   $Id$
3157 05 Mar 07 martin 7
4889 06 Apr 09 nicklas 8   Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Nicklas Nordborg, Martin Svensson
3157 05 Mar 07 martin 9
3157 05 Mar 07 martin 10   This file is part of BASE - BioArray Software Environment.
3157 05 Mar 07 martin 11   Available at http://base.thep.lu.se/
3157 05 Mar 07 martin 12
3157 05 Mar 07 martin 13   BASE is free software; you can redistribute it and/or
3157 05 Mar 07 martin 14   modify it under the terms of the GNU General Public License
4477 05 Sep 08 jari 15   as published by the Free Software Foundation; either version 3
3157 05 Mar 07 martin 16   of the License, or (at your option) any later version.
3157 05 Mar 07 martin 17
3157 05 Mar 07 martin 18   BASE is distributed in the hope that it will be useful,
3157 05 Mar 07 martin 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3157 05 Mar 07 martin 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3157 05 Mar 07 martin 21   GNU General Public License for more details.
3157 05 Mar 07 martin 22
3157 05 Mar 07 martin 23   You should have received a copy of the GNU General Public License
4509 11 Sep 08 jari 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3157 05 Mar 07 martin 25 -->
3157 05 Mar 07 martin 26
3161 06 Mar 07 martin 27 <chapter id="project_permission">
5782 04 Oct 11 nicklas 28   <?dbhtml dir="projects" filename="index.html" ?>
3197 19 Mar 07 nicklas 29   <title>Projects and the permission system</title>
3298 07 May 07 nicklas 30     <sect1 id="project_permission.permissions">
5782 04 Oct 11 nicklas 31       <?dbhtml filename="permissions.html" ?>
3298 07 May 07 nicklas 32       <title>The permission system</title>
3245 16 Apr 07 nicklas 33       <para>
3245 16 Apr 07 nicklas 34         BASE is a multi-user environment that supports cooperation
3245 16 Apr 07 nicklas 35         between users while protecting all data against unauthorized
3245 16 Apr 07 nicklas 36         access or modification. To make this possible an elaborate 
5792 07 Oct 11 nicklas 37         permission system has been developed that allows a user to
3245 16 Apr 07 nicklas 38         specify exactly the permission to give to other users and at the
3245 16 Apr 07 nicklas 39         same time makes it easy to handle the permissions of multiple
3245 16 Apr 07 nicklas 40         items with just a few interactions. For this to work smoothly there 
3245 16 Apr 07 nicklas 41         are a few recommendations that all users should follow. The first
3245 16 Apr 07 nicklas 42         and most important recommendation is:
3245 16 Apr 07 nicklas 43       </para>
3245 16 Apr 07 nicklas 44       
3245 16 Apr 07 nicklas 45       <important>
3298 07 May 07 nicklas 46         <title>Always use a project!</title>
3298 07 May 07 nicklas 47         By collecting items in a project the life
3245 16 Apr 07 nicklas 48         will be a lot easier when you want to share your data with others.
3245 16 Apr 07 nicklas 49         This is because you can always treat all items in a project as one 
3245 16 Apr 07 nicklas 50         collection and grant or revoke access to the project as a whole.
3245 16 Apr 07 nicklas 51       </important>  
3245 16 Apr 07 nicklas 52         
3298 07 May 07 nicklas 53       <sect2 id="project_permission.permissions.levels">
3245 16 Apr 07 nicklas 54         <title>Permission levels</title>
3245 16 Apr 07 nicklas 55         
3245 16 Apr 07 nicklas 56         <para>
3245 16 Apr 07 nicklas 57           Whenever you try to create or access existing items in BASE the core will
3245 16 Apr 07 nicklas 58           check that you have the proper permission to do so. There
3245 16 Apr 07 nicklas 59           are several permission levels:
3245 16 Apr 07 nicklas 60         </para>
3245 16 Apr 07 nicklas 61         
3245 16 Apr 07 nicklas 62         <variablelist>
3245 16 Apr 07 nicklas 63           <varlistentry>
3245 16 Apr 07 nicklas 64             <term>Read</term>
3245 16 Apr 07 nicklas 65             <listitem>
3298 07 May 07 nicklas 66               <para>
3245 16 Apr 07 nicklas 67               Permission to read information about the item, such
3245 16 Apr 07 nicklas 68               as the name and description.
3298 07 May 07 nicklas 69               </para>
3245 16 Apr 07 nicklas 70             </listitem>
3245 16 Apr 07 nicklas 71           </varlistentry>
3245 16 Apr 07 nicklas 72           
3245 16 Apr 07 nicklas 73           <varlistentry>
3245 16 Apr 07 nicklas 74             <term>Use</term>
3245 16 Apr 07 nicklas 75             <listitem>
3298 07 May 07 nicklas 76               <para>
3245 16 Apr 07 nicklas 77               Permission to use the information. In most cases this
3245 16 Apr 07 nicklas 78               means linking with other items. For example, if you have permission
3245 16 Apr 07 nicklas 79               to use a protocol you may specify that protocol as the extraction
3358 22 May 07 nicklas 80               protocol when creating an extract from a sample. In the case of plug-ins,
3245 16 Apr 07 nicklas 81               you need this permission to be able to execute them. 
3298 07 May 07 nicklas 82               </para>
3245 16 Apr 07 nicklas 83             </listitem>
3245 16 Apr 07 nicklas 84           </varlistentry>
3245 16 Apr 07 nicklas 85           
3245 16 Apr 07 nicklas 86           <varlistentry>
7222 04 Nov 16 nicklas 87             <term>Annotate</term>
7222 04 Nov 16 nicklas 88             <listitem>
7222 04 Nov 16 nicklas 89               <para>
7222 04 Nov 16 nicklas 90               Permission to add, update or delete annotations on an item. 
7640 11 Mar 19 nicklas 91               In addition to this permission, <guilabel>Use</guilabel> permission
7222 04 Nov 16 nicklas 92               is required on the annotation type.
7222 04 Nov 16 nicklas 93               </para>
7222 04 Nov 16 nicklas 94             </listitem>
7222 04 Nov 16 nicklas 95           </varlistentry>
7222 04 Nov 16 nicklas 96           
7222 04 Nov 16 nicklas 97           <varlistentry>
3245 16 Apr 07 nicklas 98             <term>Write</term>
3298 07 May 07 nicklas 99             <listitem>
3298 07 May 07 nicklas 100               <para>
3298 07 May 07 nicklas 101               Permission to change information about the item.
3298 07 May 07 nicklas 102               </para>
3298 07 May 07 nicklas 103             </listitem>
3245 16 Apr 07 nicklas 104           </varlistentry>
3245 16 Apr 07 nicklas 105
3245 16 Apr 07 nicklas 106           <varlistentry>
3245 16 Apr 07 nicklas 107             <term>Delete</term>
3298 07 May 07 nicklas 108             <listitem>
3298 07 May 07 nicklas 109               <para>
3298 07 May 07 nicklas 110               Permission to delete the item.
3298 07 May 07 nicklas 111               </para>
3298 07 May 07 nicklas 112             </listitem>
3245 16 Apr 07 nicklas 113           </varlistentry>
3245 16 Apr 07 nicklas 114
3245 16 Apr 07 nicklas 115           <varlistentry>
3245 16 Apr 07 nicklas 116             <term>Change owner</term>
3245 16 Apr 07 nicklas 117             <listitem>
3298 07 May 07 nicklas 118               <para>
3791 26 Sep 07 martin 119                 Permission to change the owner of an item. This is implemented as a
5705 22 Aug 11 nicklas 120                 <guilabel>Set owner</guilabel> function in the web client
4587 15 Oct 08 martin 121                 (<xref linkend="webclient.items.changeowner" />), where you can 
4587 15 Oct 08 martin 122                 change the owner of items that you have permission to do so on.
3298 07 May 07 nicklas 123               </para>
3245 16 Apr 07 nicklas 124             </listitem>
3245 16 Apr 07 nicklas 125           </varlistentry>
3245 16 Apr 07 nicklas 126
3245 16 Apr 07 nicklas 127           <varlistentry>
3245 16 Apr 07 nicklas 128             <term>Change permissions</term>
3298 07 May 07 nicklas 129             <listitem>
3298 07 May 07 nicklas 130               <para>
3332 11 May 07 martin 131               Permission to change the permissions on the item.
3298 07 May 07 nicklas 132               </para>
3298 07 May 07 nicklas 133             </listitem>
3245 16 Apr 07 nicklas 134           </varlistentry>
3245 16 Apr 07 nicklas 135           
3245 16 Apr 07 nicklas 136           <varlistentry>
3245 16 Apr 07 nicklas 137             <term>Create</term>
3245 16 Apr 07 nicklas 138             <listitem>
3298 07 May 07 nicklas 139               <para>
3298 07 May 07 nicklas 140               Permission to create new items. This permission can only be 
3298 07 May 07 nicklas 141               given to roles.
3298 07 May 07 nicklas 142               </para>
3245 16 Apr 07 nicklas 143             </listitem>
3245 16 Apr 07 nicklas 144           </varlistentry>
3245 16 Apr 07 nicklas 145           <varlistentry>
3245 16 Apr 07 nicklas 146             <term>Deny</term>
3245 16 Apr 07 nicklas 147             <listitem>
3298 07 May 07 nicklas 148               <para>
3298 07 May 07 nicklas 149               Deny all access to the item. This permission can only be given 
3298 07 May 07 nicklas 150               to roles.
3298 07 May 07 nicklas 151               </para>
3245 16 Apr 07 nicklas 152             </listitem>
3245 16 Apr 07 nicklas 153           </varlistentry>
3245 16 Apr 07 nicklas 154       
3245 16 Apr 07 nicklas 155         </variablelist>
3332 11 May 07 martin 156         <note>
5705 22 Aug 11 nicklas 157           A user's permissions need to be reloaded for the permissions that have been
3332 11 May 07 martin 158           changed should take effect. This is done either manually with the menu choice
3332 11 May 07 martin 159           <menuchoice>
5017 26 Jun 09 nicklas 160             <guimenu>BASE</guimenu>
3332 11 May 07 martin 161             <guimenuitem>Reload permissions</guimenuitem>
3332 11 May 07 martin 162           </menuchoice>
3332 11 May 07 martin 163           or automatically next time the user logs in to BASE.
3332 11 May 07 martin 164         </note>
3332 11 May 07 martin 165
3245 16 Apr 07 nicklas 166       </sect2>
3245 16 Apr 07 nicklas 167       
3298 07 May 07 nicklas 168       <sect2 id="project_permission.permissions.checks">
3358 22 May 07 nicklas 169         <title>Getting access to an item</title>
3245 16 Apr 07 nicklas 170       
3245 16 Apr 07 nicklas 171         <para>
3245 16 Apr 07 nicklas 172           There are several ways that permission to access an item can
3245 16 Apr 07 nicklas 173           be granted to you. The list below is a description of how the
3298 07 May 07 nicklas 174           permission checks are implemented in the BASE core:
3245 16 Apr 07 nicklas 175         </para>
3245 16 Apr 07 nicklas 176         
3245 16 Apr 07 nicklas 177         <orderedlist>
3245 16 Apr 07 nicklas 178           <listitem>
3298 07 May 07 nicklas 179             <para>
5792 07 Oct 11 nicklas 180             Check if you are the <emphasis>root user</emphasis>. The root user has full 
3245 16 Apr 07 nicklas 181             permission to everything and the permission check stops here.
3298 07 May 07 nicklas 182             </para>
3245 16 Apr 07 nicklas 183           </listitem>
3245 16 Apr 07 nicklas 184           
3245 16 Apr 07 nicklas 185           <listitem>
3298 07 May 07 nicklas 186             <para>
5792 07 Oct 11 nicklas 187             Check if you are a <emphasis>member of a role</emphasis> that gives you access to the
3245 16 Apr 07 nicklas 188             item. Role-based permissions can only be specified based on
3245 16 Apr 07 nicklas 189             generic item types and is valid for all items of that type.
3245 16 Apr 07 nicklas 190             The role-based permissions also include a special deny permission
5792 07 Oct 11 nicklas 191             that prevents a user from accessing any item. In that case,
3245 16 Apr 07 nicklas 192             the permission check stops here.
3298 07 May 07 nicklas 193             </para>
3245 16 Apr 07 nicklas 194           </listitem>
3245 16 Apr 07 nicklas 195           
3245 16 Apr 07 nicklas 196           <listitem>
3298 07 May 07 nicklas 197             <para>
5792 07 Oct 11 nicklas 198             Check if you are the <emphasis>owner of the item</emphasis>. As the owner you have full 
5792 07 Oct 11 nicklas 199             permission to the item and the permission check stops here. This step is not done
5792 07 Oct 11 nicklas 200             for items that doesn't have an owner.
3298 07 May 07 nicklas 201             </para>
3245 16 Apr 07 nicklas 202           </listitem>
3245 16 Apr 07 nicklas 203           
3245 16 Apr 07 nicklas 204           <listitem>
3298 07 May 07 nicklas 205             <para>
3684 17 Aug 07 jari 206             Check if you have been granted access to the item by the
5792 07 Oct 11 nicklas 207             <emphasis>sharing system</emphasis> (cf. <xref linkend="webclient.items.share"/>).
3245 16 Apr 07 nicklas 208             The sharing system can grant access to individual users, groups of
3245 16 Apr 07 nicklas 209             users and to projects. We recommend that you always use projects
5792 07 Oct 11 nicklas 210             to share your items. This step is not done for items that can't be shared.
3298 07 May 07 nicklas 211             </para>
3245 16 Apr 07 nicklas 212           </listitem>
3245 16 Apr 07 nicklas 213           
3245 16 Apr 07 nicklas 214           <listitem>
3245 16 Apr 07 nicklas 215             <para>
3245 16 Apr 07 nicklas 216             Some items implement special permission checks. 
3245 16 Apr 07 nicklas 217             For example:
3245 16 Apr 07 nicklas 218             </para>
3245 16 Apr 07 nicklas 219             
3245 16 Apr 07 nicklas 220             <itemizedlist>
3245 16 Apr 07 nicklas 221               <listitem>
3298 07 May 07 nicklas 222                 <para>
5792 07 Oct 11 nicklas 223                 <guilabel>News</guilabel>: You always have read access to news if today's date
3245 16 Apr 07 nicklas 224                 falls between the start and end date of the news item.
3298 07 May 07 nicklas 225                 </para>
3245 16 Apr 07 nicklas 226               </listitem>
3245 16 Apr 07 nicklas 227             
3245 16 Apr 07 nicklas 228               <listitem>
3298 07 May 07 nicklas 229                 <para>
5792 07 Oct 11 nicklas 230                 <guilabel>Groups</guilabel>: You have read access to all groups where you
3245 16 Apr 07 nicklas 231                 are a member.
3298 07 May 07 nicklas 232                 </para>
3245 16 Apr 07 nicklas 233               </listitem>
3245 16 Apr 07 nicklas 234             
3245 16 Apr 07 nicklas 235               <listitem>
3298 07 May 07 nicklas 236                 <para>
5792 07 Oct 11 nicklas 237                 <guilabel>Users</guilabel>: You have read permission to all users that share group
4437 02 Sep 08 nicklas 238                 membership with, excluding the <emphasis>Everyone</emphasis> group. 
4437 02 Sep 08 nicklas 239                 When a project is active, you also have read permission to all 
4437 02 Sep 08 nicklas 240                 users that are members of that project.
3298 07 May 07 nicklas 241                 </para>
3245 16 Apr 07 nicklas 242               </listitem>
3245 16 Apr 07 nicklas 243             
3245 16 Apr 07 nicklas 244             </itemizedlist>
3245 16 Apr 07 nicklas 245             
3245 16 Apr 07 nicklas 246             <para>
3245 16 Apr 07 nicklas 247               There are more items with special permission checks but
3487 13 Jun 07 peter 248               we do not list those here.
3245 16 Apr 07 nicklas 249             </para>
3245 16 Apr 07 nicklas 250             
3245 16 Apr 07 nicklas 251           </listitem>
3245 16 Apr 07 nicklas 252           
3245 16 Apr 07 nicklas 253         </orderedlist>
3245 16 Apr 07 nicklas 254       </sect2>
3358 22 May 07 nicklas 255
3298 07 May 07 nicklas 256       <sect2 id="project_permission.permissions.plugins">
3358 22 May 07 nicklas 257         <title>Plug-in permissions</title>
3298 07 May 07 nicklas 258         
3298 07 May 07 nicklas 259         <para>
3358 22 May 07 nicklas 260           Another aspect of the permission system is that plug-ins
3332 11 May 07 martin 261           may also have permissions of their own. The default is that
3358 22 May 07 nicklas 262           plug-ins run with the same permissions as the user that invoked
5792 07 Oct 11 nicklas 263           the plug-in. Sometimes this can be seen as a security risk
3358 22 May 07 nicklas 264           if the plug-in is not trusted. A malicious plug-in can, for example,
3298 07 May 07 nicklas 265           delete the entire database if invoked by the root user.
3298 07 May 07 nicklas 266         </para>
3298 07 May 07 nicklas 267         
3298 07 May 07 nicklas 268         <para>
3358 22 May 07 nicklas 269           An administrator can choose to give a plug-in only those
3358 22 May 07 nicklas 270           permissions that is required to complete it's task. If the plug-in 
3358 22 May 07 nicklas 271           permission system is enabled for a plug-in the default is to deny
5792 07 Oct 11 nicklas 272           all actions. Then, the administrator must assign permissions to
5792 07 Oct 11 nicklas 273           the plug-in. There are two variants:
3298 07 May 07 nicklas 274         </para>
3298 07 May 07 nicklas 275         
5792 07 Oct 11 nicklas 276         <itemizedlist>
5792 07 Oct 11 nicklas 277           <listitem>
5792 07 Oct 11 nicklas 278             <para>
5792 07 Oct 11 nicklas 279             A permission can be granted regardless of if the user that invoked 
5792 07 Oct 11 nicklas 280             the plug-in had the permission or not. This makes it possible to 
5792 07 Oct 11 nicklas 281             develop a plug-in that allows users to do things that they normally
5792 07 Oct 11 nicklas 282             do not have permission to do directly in the web interface.
5792 07 Oct 11 nicklas 283             </para>
5792 07 Oct 11 nicklas 284           </listitem>
5792 07 Oct 11 nicklas 285           
5792 07 Oct 11 nicklas 286           <listitem>
5792 07 Oct 11 nicklas 287             <para>
5792 07 Oct 11 nicklas 288             A permission can be granted only if the user also has the permission.
5792 07 Oct 11 nicklas 289             This is the same as not using the plug-in permission system, except that 
5792 07 Oct 11 nicklas 290             unspecified permissions are always denied.
5792 07 Oct 11 nicklas 291             </para>
5792 07 Oct 11 nicklas 292           </listitem>
5792 07 Oct 11 nicklas 293         </itemizedlist>
5792 07 Oct 11 nicklas 294                 
3298 07 May 07 nicklas 295         <note>
3358 22 May 07 nicklas 296           Plug-in developers can supply information about
3298 07 May 07 nicklas 297           the wanted permissions making it easy for the administrator to 
3298 07 May 07 nicklas 298           just check the permissions and accept them with just a single
5792 07 Oct 11 nicklas 299           click if they make sense. See <xref linkend="plugins.permissions"/> for more information.
3298 07 May 07 nicklas 300         </note>
3298 07 May 07 nicklas 301         
3298 07 May 07 nicklas 302       </sect2>
3298 07 May 07 nicklas 303       
3157 05 Mar 07 martin 304     </sect1>
3245 16 Apr 07 nicklas 305     
3245 16 Apr 07 nicklas 306     <sect1 id="project_permission.projects">
5782 04 Oct 11 nicklas 307       <?dbhtml filename="projects.html" ?>
3245 16 Apr 07 nicklas 308     
3245 16 Apr 07 nicklas 309       <title>Projects</title>
3245 16 Apr 07 nicklas 310       
3245 16 Apr 07 nicklas 311       <para>
5792 07 Oct 11 nicklas 312         Projects are an important part of BASE and the permission system for several
3245 16 Apr 07 nicklas 313         reasons:
3245 16 Apr 07 nicklas 314       </para>
3245 16 Apr 07 nicklas 315       
3245 16 Apr 07 nicklas 316       <itemizedlist>
3245 16 Apr 07 nicklas 317         <listitem>
3298 07 May 07 nicklas 318           <para>
3487 13 Jun 07 peter 319           They do not require an administrator to setup and
3245 16 Apr 07 nicklas 320           use. All regular users may create a project, add items 
3245 16 Apr 07 nicklas 321           to it and share it with other users. You are in complete 
3298 07 May 07 nicklas 322           control of who gets access to the project, the items it contains
3298 07 May 07 nicklas 323           and which permission levels to use.
3298 07 May 07 nicklas 324           </para>
3245 16 Apr 07 nicklas 325         </listitem>
3245 16 Apr 07 nicklas 326         
3245 16 Apr 07 nicklas 327         <listitem>
3298 07 May 07 nicklas 328           <para>
3245 16 Apr 07 nicklas 329           All items in a project are treated as one collection. If a
3245 16 Apr 07 nicklas 330           new member joins the team, just give the new person access
3245 16 Apr 07 nicklas 331           to the project and that person will be able to access all
3245 16 Apr 07 nicklas 332           items in the project.
3298 07 May 07 nicklas 333           </para>
3245 16 Apr 07 nicklas 334         </listitem>
3245 16 Apr 07 nicklas 335       
3245 16 Apr 07 nicklas 336         <listitem>
3298 07 May 07 nicklas 337           <para>
5370 23 Jun 10 nicklas 338           When you create new items, they are automatically shared
5370 23 Jun 10 nicklas 339           using the settings from the active project. There is almost no 
5370 23 Jun 10 nicklas 340           need to share items manually. All
3245 16 Apr 07 nicklas 341           you have to remember is to set an active project, and
3245 16 Apr 07 nicklas 342           this is easy accessible from the 
3245 16 Apr 07 nicklas 343           <link linkend="webclient.intro.menubar">menu bar</link>.
3298 07 May 07 nicklas 344           </para>
3245 16 Apr 07 nicklas 345         </listitem>
3245 16 Apr 07 nicklas 346         
3245 16 Apr 07 nicklas 347         <listitem>
3298 07 May 07 nicklas 348           <para>
3487 13 Jun 07 peter 349           Filter out items that you do not want to see. When you have set
3245 16 Apr 07 nicklas 350           an active project you may choose to only see items that are
3245 16 Apr 07 nicklas 351           part of that project and no other items
3245 16 Apr 07 nicklas 352           (<xref linkend="webclient.itemlist.presets"/>).
3298 07 May 07 nicklas 353           </para>
3245 16 Apr 07 nicklas 354         </listitem>
3245 16 Apr 07 nicklas 355         
3245 16 Apr 07 nicklas 356         <listitem>
3298 07 May 07 nicklas 357           <para>
3245 16 Apr 07 nicklas 358           It's easy to share multiple items between projects. Items
3245 16 Apr 07 nicklas 359           may be part of more than one project. If you create a new
3245 16 Apr 07 nicklas 360           project that builds on a previous one you can easily share
3245 16 Apr 07 nicklas 361           some or all of the existing items to the new project from one
3245 16 Apr 07 nicklas 362           central place, the <guilabel>Items</guilabel> tab on the project's
3298 07 May 07 nicklas 363           single-item view.
3298 07 May 07 nicklas 364           </para>
3245 16 Apr 07 nicklas 365         </listitem>
5792 07 Oct 11 nicklas 366
5792 07 Oct 11 nicklas 367         <listitem>
5792 07 Oct 11 nicklas 368           <para>
5792 07 Oct 11 nicklas 369           It is possible to assign default protocols, software, hardware 
5792 07 Oct 11 nicklas 370           and other items to a project. This makes it easier when creating
5792 07 Oct 11 nicklas 371           new items since BASE will automatically suggest, for example
5792 07 Oct 11 nicklas 372           the extraction protocol used when creating a new extract. The default
5792 07 Oct 11 nicklas 373           items are also used by the <guilabel>item overview</guilabel>
5792 07 Oct 11 nicklas 374           validation functionality, which makes it possible to spot
5792 07 Oct 11 nicklas 375           mistakes. See <xref linkend="webclient.itemoverview" />.
5792 07 Oct 11 nicklas 376           </para>
5792 07 Oct 11 nicklas 377         </listitem>
5792 07 Oct 11 nicklas 378     
3245 16 Apr 07 nicklas 379       </itemizedlist>
3245 16 Apr 07 nicklas 380       
5792 07 Oct 11 nicklas 381       <sect2 id="project_permission.projects.create">
5792 07 Oct 11 nicklas 382         <title>Creating a project</title>
5792 07 Oct 11 nicklas 383       
5792 07 Oct 11 nicklas 384         <para>
5792 07 Oct 11 nicklas 385           You can list and manage all of your projects by going to
5792 07 Oct 11 nicklas 386           <menuchoice>
5792 07 Oct 11 nicklas 387             <guimenu>View</guimenu>
5792 07 Oct 11 nicklas 388             <guimenuitem>Projects</guimenuitem>
5792 07 Oct 11 nicklas 389           </menuchoice>. Use the &gbNew; button to create a new projects.
5792 07 Oct 11 nicklas 390         </para>
5792 07 Oct 11 nicklas 391         
5792 07 Oct 11 nicklas 392       <figure
5792 07 Oct 11 nicklas 393         id="project_permission.figures.edit_project">
5792 07 Oct 11 nicklas 394         <title>Projects properties</title>
5792 07 Oct 11 nicklas 395         <screenshot>
5792 07 Oct 11 nicklas 396           <mediaobject>
5792 07 Oct 11 nicklas 397             <imageobject>
5792 07 Oct 11 nicklas 398               <imagedata
5792 07 Oct 11 nicklas 399                 fileref="figures/edit_project.png" format="PNG" />
5792 07 Oct 11 nicklas 400             </imageobject>
5792 07 Oct 11 nicklas 401           </mediaobject>
5792 07 Oct 11 nicklas 402         </screenshot>
5792 07 Oct 11 nicklas 403       </figure>
5792 07 Oct 11 nicklas 404         
5792 07 Oct 11 nicklas 405       <helptext external_id="project.edit" 
5792 07 Oct 11 nicklas 406         title="Edit project">
5792 07 Oct 11 nicklas 407         
5792 07 Oct 11 nicklas 408         <para>
5792 07 Oct 11 nicklas 409         This tab allows users to enter essential
5792 07 Oct 11 nicklas 410         information about a project.
5792 07 Oct 11 nicklas 411         </para>
5792 07 Oct 11 nicklas 412         
5792 07 Oct 11 nicklas 413         <variablelist>
5792 07 Oct 11 nicklas 414         <varlistentry>
5792 07 Oct 11 nicklas 415           <term><guilabel>Name</guilabel></term>
5792 07 Oct 11 nicklas 416           <listitem>
5792 07 Oct 11 nicklas 417             <para>
5792 07 Oct 11 nicklas 418             The name of the project. We recommend that project names are unique, since
5792 07 Oct 11 nicklas 419             at some times it may need to be referenced by name.
5792 07 Oct 11 nicklas 420             </para>
5792 07 Oct 11 nicklas 421           </listitem>
5792 07 Oct 11 nicklas 422         </varlistentry>
5792 07 Oct 11 nicklas 423         <varlistentry>
5792 07 Oct 11 nicklas 424           <term><guilabel>Default permissions</guilabel></term>
5792 07 Oct 11 nicklas 425           <listitem>
5792 07 Oct 11 nicklas 426             <para>
5792 07 Oct 11 nicklas 427             This setting specify the permissions to give to new items that
5792 07 Oct 11 nicklas 428             are created while this project is the active project. The recommended
5792 07 Oct 11 nicklas 429             setting is <guilabel>delete</guilabel> permission. Optionally,
5792 07 Oct 11 nicklas 430             a permission template may be selected, in which case the permissions
5792 07 Oct 11 nicklas 431             are copied from the template to the new item.
5792 07 Oct 11 nicklas 432             <nohelp>See <xref linkend="project_permission.templates"/>
5792 07 Oct 11 nicklas 433             for more information.</nohelp>
5792 07 Oct 11 nicklas 434             </para>
5792 07 Oct 11 nicklas 435           </listitem>
5792 07 Oct 11 nicklas 436         </varlistentry>
5792 07 Oct 11 nicklas 437           <varlistentry>
5792 07 Oct 11 nicklas 438           <term><guilabel>Description</guilabel></term>
5792 07 Oct 11 nicklas 439           <listitem>
5792 07 Oct 11 nicklas 440             <para>
5792 07 Oct 11 nicklas 441             A optional description of the project.
5792 07 Oct 11 nicklas 442             </para>
5792 07 Oct 11 nicklas 443           </listitem>
5792 07 Oct 11 nicklas 444         </varlistentry>
5792 07 Oct 11 nicklas 445         </variablelist>
5792 07 Oct 11 nicklas 446         
5792 07 Oct 11 nicklas 447         <seeother>
5792 07 Oct 11 nicklas 448           <other external_id="project.edit.members">Project members</other>
5792 07 Oct 11 nicklas 449           <other external_id="project.edit.defaults">Default items</other>
5792 07 Oct 11 nicklas 450         </seeother>
5792 07 Oct 11 nicklas 451         
5792 07 Oct 11 nicklas 452       </helptext>
5792 07 Oct 11 nicklas 453       
5792 07 Oct 11 nicklas 454       </sect2>
3245 16 Apr 07 nicklas 455     
3245 16 Apr 07 nicklas 456       <sect2 id="project_permission.projects.active">
3245 16 Apr 07 nicklas 457       
3245 16 Apr 07 nicklas 458         <title>The active project</title>
3245 16 Apr 07 nicklas 459         
3245 16 Apr 07 nicklas 460         <para>
3245 16 Apr 07 nicklas 461           The active project concept is central to the sharing system. 
3245 16 Apr 07 nicklas 462           You should always, with few exceptions, have a project active 
3245 16 Apr 07 nicklas 463           when you work with BASE. The most important reason is that 
5370 23 Jun 10 nicklas 464           new items will automatically be shared using the settings in
5370 23 Jun 10 nicklas 465           the active project. This considerably reduces 
5370 23 Jun 10 nicklas 466           the time needed for managing access permissions. Without an 
5370 23 Jun 10 nicklas 467           active project you would have to manually
3245 16 Apr 07 nicklas 468           set the permission on all items you create. If you have hundreds
3245 16 Apr 07 nicklas 469           of items this is a time-consuming and boring task best to be 
3245 16 Apr 07 nicklas 470           avoided.
3245 16 Apr 07 nicklas 471         </para>
3245 16 Apr 07 nicklas 472         
3245 16 Apr 07 nicklas 473         <para>
3245 16 Apr 07 nicklas 474           If you work with multiple projects you will probably find the
3245 16 Apr 07 nicklas 475           filtering function that hides items that are not part
3245 16 Apr 07 nicklas 476           of the active project to be useful. As a matter of fact, if you
3245 16 Apr 07 nicklas 477           try to access an item that is part of another (not active) project
3487 13 Jun 07 peter 478           you will get an error message saying that you do not have 
3245 16 Apr 07 nicklas 479           permission to access the item (unless you are the owner).
3245 16 Apr 07 nicklas 480         </para>
3245 16 Apr 07 nicklas 481       
3245 16 Apr 07 nicklas 482         <sect3 id="project_permission.projects.active.set">
3298 07 May 07 nicklas 483           <title>Selecting an active project</title>
3245 16 Apr 07 nicklas 484           
3245 16 Apr 07 nicklas 485           <para>
3332 11 May 07 martin 486             Since it's important to always have an active project
3298 07 May 07 nicklas 487             there are several ways to make a project  
3245 16 Apr 07 nicklas 488             the active one.
3245 16 Apr 07 nicklas 489           </para>
3245 16 Apr 07 nicklas 490           
3245 16 Apr 07 nicklas 491           <itemizedlist>
3245 16 Apr 07 nicklas 492             <listitem>
3298 07 May 07 nicklas 493               <para>
3791 26 Sep 07 martin 494                 The easiest way and the one you will probably use most of the time
3791 26 Sep 07 martin 495                 is to use the menu bar shortcut. Look in the menu for the project
3791 26 Sep 07 martin 496                 icon 
5792 07 Oct 11 nicklas 497                 <guiicon>
3791 26 Sep 07 martin 498                   <inlinemediaobject>
3791 26 Sep 07 martin 499                     <imageobject>
5971 17 Feb 12 nicklas 500                       <imagedata fileref="figures/project.png" format="PNG" />
3791 26 Sep 07 martin 501                     </imageobject>
5972 17 Feb 12 nicklas 502                   </inlinemediaobject></guiicon>.
3791 26 Sep 07 martin 503                 Next to it, the name of the active project is displayed. If you  see
4738 04 Feb 09 martin 504                 <guiicon>
4738 04 Feb 09 martin 505                   <inlinemediaobject>
4738 04 Feb 09 martin 506                     <imageobject>
5971 17 Feb 12 nicklas 507                       <imagedata fileref="figures/no_active_project.png" format="PNG" />
4738 04 Feb 09 martin 508                     </imageobject>
4738 04 Feb 09 martin 509                   </inlinemediaobject>
4738 04 Feb 09 martin 510                 </guiicon>
5972 17 Feb 12 nicklas 511                 <guilabel>no active project</guilabel>
4738 04 Feb 09 martin 512                 here, it means that you have not selected a project to work in. Click on the icon or
3791 26 Sep 07 martin 513                 project name to open a drop-down menu and select a project to set as
3791 26 Sep 07 martin 514                 the active project. If another project is already active it will
3791 26 Sep 07 martin 515                 automatically be inactivated.
3298 07 May 07 nicklas 516               </para>
5319 20 Apr 10 nicklas 517               <para>
5705 22 Aug 11 nicklas 518                 The most recently used projects are listed first, then the list is filled with the 
5705 22 Aug 11 nicklas 519                 rest of your projects up to a maximum of 15. If you have more projects an option to 
5705 22 Aug 11 nicklas 520                 display the remaining projects is activated.
5319 20 Apr 10 nicklas 521               </para>
5319 20 Apr 10 nicklas 522               <tip>
5319 20 Apr 10 nicklas 523                 <para>
5705 22 Aug 11 nicklas 524                 The sort order of the non-recent projects is the same as the sort order on the
5319 20 Apr 10 nicklas 525                 projects list page. If you, for example, want to sort the newest
5319 20 Apr 10 nicklas 526                 project first, select to sort by the <guilabel>Registered</guilabel> 
5319 20 Apr 10 nicklas 527                 column in descending order on the list page. The menu will automatically 
5319 20 Apr 10 nicklas 528                 use the same order.
5319 20 Apr 10 nicklas 529                 </para>
5319 20 Apr 10 nicklas 530               </tip>
3245 16 Apr 07 nicklas 531             </listitem>
3245 16 Apr 07 nicklas 532           
3245 16 Apr 07 nicklas 533             <listitem>
3298 07 May 07 nicklas 534               <para>
5017 26 Jun 09 nicklas 535               Use the <menuchoice><guimenu>BASE</guimenu>
3245 16 Apr 07 nicklas 536               <guisubmenu>Select project</guisubmenu></menuchoice>
3245 16 Apr 07 nicklas 537               menu and select the project from the submenu that opens
3245 16 Apr 07 nicklas 538               up.
3298 07 May 07 nicklas 539               </para>
3245 16 Apr 07 nicklas 540             </listitem>
3245 16 Apr 07 nicklas 541             
3245 16 Apr 07 nicklas 542             <listitem>
3298 07 May 07 nicklas 543               <para>
3245 16 Apr 07 nicklas 544               Go to the <link linkend="webclient.intro.homepage">homepage</link>
3245 16 Apr 07 nicklas 545               using the <menuchoice><guimenu>View</guimenu>
3245 16 Apr 07 nicklas 546               <guisubmenu>Home</guisubmenu></menuchoice> menu and select
3245 16 Apr 07 nicklas 547               a project from the list displayed there.
3298 07 May 07 nicklas 548               </para>
3245 16 Apr 07 nicklas 549             </listitem>
3245 16 Apr 07 nicklas 550           </itemizedlist>
3245 16 Apr 07 nicklas 551           
3245 16 Apr 07 nicklas 552           <note>
3245 16 Apr 07 nicklas 553             Only one project can be active at a time.
3245 16 Apr 07 nicklas 554           </note>
3245 16 Apr 07 nicklas 555           
5792 07 Oct 11 nicklas 556           <caution>
3245 16 Apr 07 nicklas 557             If you change the active project while viewing an item
3245 16 Apr 07 nicklas 558             that you no longer has access to in the context of the
3245 16 Apr 07 nicklas 559             new project an error message about missing permission
3245 16 Apr 07 nicklas 560             will be displayed. Unfortunately, this is all that is displayed 
3245 16 Apr 07 nicklas 561             and it may be difficult to navigate to a working page again.
3245 16 Apr 07 nicklas 562             In the worst case, you may have to go to the login page and
3245 16 Apr 07 nicklas 563             login again.
5792 07 Oct 11 nicklas 564           </caution>
3245 16 Apr 07 nicklas 565           
3245 16 Apr 07 nicklas 566         </sect3>
4690 08 Dec 08 nicklas 567
4690 08 Dec 08 nicklas 568         <sect3 id="project_permission.projects.active.autopermissions">
4690 08 Dec 08 nicklas 569           <title>Default permissions for the active project</title>
4690 08 Dec 08 nicklas 570           
4690 08 Dec 08 nicklas 571           <para>
4690 08 Dec 08 nicklas 572             When a project is active all new items you create are automatically
5370 23 Jun 10 nicklas 573             shared using the settings from the active project. If the active project 
5370 23 Jun 10 nicklas 574             has a permission template the permissions from the template are copied 
5370 23 Jun 10 nicklas 575             to the new item. If the project doesn't have a permission template, the 
5370 23 Jun 10 nicklas 576             new item is shared to the active project with the configured default
5370 23 Jun 10 nicklas 577             level. By default, projects doesn't have a permission template
5370 23 Jun 10 nicklas 578             and the default permissions are set to
4690 08 Dec 08 nicklas 579             <emphasis>read</emphasis>, <emphasis>use</emphasis>, 
4690 08 Dec 08 nicklas 580             <emphasis>write</emphasis> and <emphasis>delete</emphasis>. It is
4690 08 Dec 08 nicklas 581             possible to change the default permission level by modifying the
4690 08 Dec 08 nicklas 582             settings for the project. Simply open the edit-view page for the project
4690 08 Dec 08 nicklas 583             and select the permissions you want and save. From now on, all new
5705 22 Aug 11 nicklas 584             items will be shared with the specified permissions. Items that are
5705 22 Aug 11 nicklas 585             already in the project are not affected by the change.
4690 08 Dec 08 nicklas 586           </para>
4690 08 Dec 08 nicklas 587         </sect3>
4690 08 Dec 08 nicklas 588
3245 16 Apr 07 nicklas 589       </sect2>
3245 16 Apr 07 nicklas 590         
3245 16 Apr 07 nicklas 591       <sect2 id="project_permission.projects.share">
3245 16 Apr 07 nicklas 592         <title>How to give other users access to your project</title>
3245 16 Apr 07 nicklas 593         
3245 16 Apr 07 nicklas 594         <para>
3245 16 Apr 07 nicklas 595           First, you will need to open the <guilabel>Edit project</guilabel>
3245 16 Apr 07 nicklas 596           dialog. Here is how to do that:
3245 16 Apr 07 nicklas 597         </para>
3245 16 Apr 07 nicklas 598         
3245 16 Apr 07 nicklas 599         <orderedlist>
3245 16 Apr 07 nicklas 600           <listitem>
3298 07 May 07 nicklas 601             <para>
3298 07 May 07 nicklas 602             Navigate to the single-item view of your project 
3245 16 Apr 07 nicklas 603             from the <menuchoice><guimenu>View</guimenu>
3245 16 Apr 07 nicklas 604             <guisubmenu>Projects</guisubmenu></menuchoice> list.
3298 07 May 07 nicklas 605             </para>
3245 16 Apr 07 nicklas 606           </listitem>
3245 16 Apr 07 nicklas 607           
3245 16 Apr 07 nicklas 608           <listitem>
3298 07 May 07 nicklas 609             <para>
3394 28 May 07 martin 610             Click on the &gbEdit;
3245 16 Apr 07 nicklas 611             button to open the <guilabel>Edit project</guilabel>
3245 16 Apr 07 nicklas 612             dialog.
3298 07 May 07 nicklas 613             </para>
3245 16 Apr 07 nicklas 614           </listitem>
3245 16 Apr 07 nicklas 615           
3245 16 Apr 07 nicklas 616           <listitem>
3298 07 May 07 nicklas 617             <para>
3245 16 Apr 07 nicklas 618             Switch to the <guilabel>Members tab</guilabel>. From this
3245 16 Apr 07 nicklas 619             page you can add and remove users and change the access levels
3245 16 Apr 07 nicklas 620             of existing ones.
3298 07 May 07 nicklas 621             </para>
3245 16 Apr 07 nicklas 622           </listitem>
3245 16 Apr 07 nicklas 623         </orderedlist>
3245 16 Apr 07 nicklas 624         
3245 16 Apr 07 nicklas 625         <figure id="project_permission.projects.members">
3245 16 Apr 07 nicklas 626           <title>Manage members of a project</title>
3245 16 Apr 07 nicklas 627           <screenshot>
3245 16 Apr 07 nicklas 628             <mediaobject>
3423 31 May 07 nicklas 629               <imageobject><imagedata fileref="figures/project_members.png" format="PNG" /></imageobject>
3245 16 Apr 07 nicklas 630             </mediaobject>
3245 16 Apr 07 nicklas 631           </screenshot>
3245 16 Apr 07 nicklas 632         </figure>
3245 16 Apr 07 nicklas 633         
3245 16 Apr 07 nicklas 634         
3245 16 Apr 07 nicklas 635         <helptext external_id="project.edit.members" title="Project members">
3245 16 Apr 07 nicklas 636           
3245 16 Apr 07 nicklas 637           <variablelist>
3245 16 Apr 07 nicklas 638             <varlistentry>
3245 16 Apr 07 nicklas 639               <term><guilabel>Members</guilabel></term>
3245 16 Apr 07 nicklas 640               <listitem>
3245 16 Apr 07 nicklas 641                 <para>
3245 16 Apr 07 nicklas 642                 The members list contains users
3245 16 Apr 07 nicklas 643                 and groups that are already members of the project. The list 
3245 16 Apr 07 nicklas 644                 shows the name and the permission level. The permission level 
3245 16 Apr 07 nicklas 645                 uses a one-letter code as follows:
3245 16 Apr 07 nicklas 646                 </para>
3245 16 Apr 07 nicklas 647                 <itemizedlist>
3245 16 Apr 07 nicklas 648                 <listitem><guilabel>R</guilabel> = Read</listitem>
3245 16 Apr 07 nicklas 649                 <listitem><guilabel>U</guilabel> = Use</listitem>
3245 16 Apr 07 nicklas 650                 <listitem><guilabel>W</guilabel> = Write</listitem>
3245 16 Apr 07 nicklas 651                 <listitem><guilabel>D</guilabel> = Delete</listitem>
4587 15 Oct 08 martin 652                 <listitem><guilabel>O</guilabel> = Set owner</listitem>
3245 16 Apr 07 nicklas 653                 <listitem><guilabel>P</guilabel> = Set permission</listitem>
3245 16 Apr 07 nicklas 654                 </itemizedlist>
3245 16 Apr 07 nicklas 655               </listitem>
3245 16 Apr 07 nicklas 656             </varlistentry>
3245 16 Apr 07 nicklas 657             
3245 16 Apr 07 nicklas 658             <varlistentry>
3245 16 Apr 07 nicklas 659               <term><guilabel>Permissions</guilabel></term>
3245 16 Apr 07 nicklas 660               <listitem>
3245 16 Apr 07 nicklas 661                 <para>
3332 11 May 07 martin 662                 When you select an user or group in the
3245 16 Apr 07 nicklas 663                 list the current permission will be checked. To change the
3245 16 Apr 07 nicklas 664                 permissions just check the permissions you want to 
3245 16 Apr 07 nicklas 665                 grant or uncheck the permissions you want to revoke.
3245 16 Apr 07 nicklas 666                 You may select more than one user and/or group
3245 16 Apr 07 nicklas 667                 and change the permissions for all of them at once.
3245 16 Apr 07 nicklas 668                 </para>
3245 16 Apr 07 nicklas 669                 
3245 16 Apr 07 nicklas 670                 <note>
5792 07 Oct 11 nicklas 671                   <para>
5792 07 Oct 11 nicklas 672                   In most cases, you should give the project members
5792 07 Oct 11 nicklas 673                   <guilabel>use</guilabel> permission. This will allow a user 
5792 07 Oct 11 nicklas 674                   to use all items in the project as well as add new items to it. 
5792 07 Oct 11 nicklas 675                   If you give them <guilabel>write</guilabel> or <guilabel>delete</guilabel> 
5792 07 Oct 11 nicklas 676                   permission they will be able to modify or delete all items including 
5792 07 Oct 11 nicklas 677                   those that they do not own.
5792 07 Oct 11 nicklas 678                   </para>
5792 07 Oct 11 nicklas 679                   <para>
5792 07 Oct 11 nicklas 680                   This rule is valid for all items that are shared to the project 
5792 07 Oct 11 nicklas 681                   with the default <guilabel>delete</guilabel> permission. Items
5792 07 Oct 11 nicklas 682                   that are shared with a lower permission, for example, 
5792 07 Oct 11 nicklas 683                   <guilabel>use</guilabel>, can be accessed with at most that
5792 07 Oct 11 nicklas 684                   permission.
5792 07 Oct 11 nicklas 685                   </para>
3245 16 Apr 07 nicklas 686                 </note>
3245 16 Apr 07 nicklas 687                 
3245 16 Apr 07 nicklas 688               </listitem>
3245 16 Apr 07 nicklas 689             </varlistentry>
3245 16 Apr 07 nicklas 690             
3245 16 Apr 07 nicklas 691             <varlistentry>
3245 16 Apr 07 nicklas 692               <term><guibutton>Add users</guibutton></term>
3245 16 Apr 07 nicklas 693               <listitem>
3245 16 Apr 07 nicklas 694                 <para>
3245 16 Apr 07 nicklas 695                 Opens a popup window that allows you to add
3245 16 Apr 07 nicklas 696                 users to the project. In the popup window, mark
3394 28 May 07 martin 697                 one or more users and click on the &gbOk;
4437 02 Sep 08 nicklas 698                 button. The popup window will only list users that you have
4437 02 Sep 08 nicklas 699                 permission to read. Unless you are an administrator, this
4437 02 Sep 08 nicklas 700                 usually means that you can only see users that: 
3245 16 Apr 07 nicklas 701                 </para>
4437 02 Sep 08 nicklas 702                 <itemizedlist>
4437 02 Sep 08 nicklas 703                   <listitem>
4437 02 Sep 08 nicklas 704                     <para>
4437 02 Sep 08 nicklas 705                     you share group memberships with 
5792 07 Oct 11 nicklas 706                     (the <emphasis>Everyone</emphasis> group and groups with hidden members
5792 07 Oct 11 nicklas 707                     doesn't count)
4437 02 Sep 08 nicklas 708                     </para>
4437 02 Sep 08 nicklas 709                   </listitem>
4437 02 Sep 08 nicklas 710                   <listitem>
4437 02 Sep 08 nicklas 711                     <para>
4437 02 Sep 08 nicklas 712                     are members of the currently active project, if any.
4437 02 Sep 08 nicklas 713                     </para>
4437 02 Sep 08 nicklas 714                   </listitem>
4437 02 Sep 08 nicklas 715                 </itemizedlist>
4437 02 Sep 08 nicklas 716                 <para>
4437 02 Sep 08 nicklas 717                 Users that already have access to the project are not included in the
4437 02 Sep 08 nicklas 718                 list. If you don't see a user that you want to add to the project,
4437 02 Sep 08 nicklas 719                 you'll need to talk to an administrator for setting up the proper
4437 02 Sep 08 nicklas 720                 group membership.
4437 02 Sep 08 nicklas 721                 </para>
3245 16 Apr 07 nicklas 722               </listitem>
3245 16 Apr 07 nicklas 723             </varlistentry>
3245 16 Apr 07 nicklas 724             
3245 16 Apr 07 nicklas 725             <varlistentry>
3245 16 Apr 07 nicklas 726               <term><guibutton>Add groups</guibutton></term>
3245 16 Apr 07 nicklas 727               <listitem>
3245 16 Apr 07 nicklas 728                 <para>
3245 16 Apr 07 nicklas 729                 Opens a popup window that allows you to add
3245 16 Apr 07 nicklas 730                 groups to the project. In the popup window, mark
3394 28 May 07 martin 731                 one or more groups and click on the &gbOk;
3298 07 May 07 nicklas 732                 button. Unless you are
3245 16 Apr 07 nicklas 733                 an administrator, the popup window will only list groups 
3245 16 Apr 07 nicklas 734                 that you are a member of. It will not list groups that 
3245 16 Apr 07 nicklas 735                 are already part of the project.
3245 16 Apr 07 nicklas 736                 </para>
3245 16 Apr 07 nicklas 737               </listitem>
3245 16 Apr 07 nicklas 738             </varlistentry>
3245 16 Apr 07 nicklas 739             
3245 16 Apr 07 nicklas 740             <varlistentry>
3394 28 May 07 martin 741               <term>&gbRemove;</term>
3245 16 Apr 07 nicklas 742               <listitem>
3245 16 Apr 07 nicklas 743                 <para>
3245 16 Apr 07 nicklas 744                 Click on this button to remove the selected
3245 16 Apr 07 nicklas 745                 users and/or groups from the project.
3245 16 Apr 07 nicklas 746                 </para>
3245 16 Apr 07 nicklas 747               </listitem>    
3245 16 Apr 07 nicklas 748             </varlistentry>
3245 16 Apr 07 nicklas 749           </variablelist>
3245 16 Apr 07 nicklas 750           
3245 16 Apr 07 nicklas 751           
3245 16 Apr 07 nicklas 752           <para>
3394 28 May 07 martin 753             Use the &gbSave; button to save your
3394 28 May 07 martin 754             changes or the &gbCancel; button to
3298 07 May 07 nicklas 755             close the popup without saving.
3245 16 Apr 07 nicklas 756           </para>
5792 07 Oct 11 nicklas 757
5792 07 Oct 11 nicklas 758         <seeother>
5792 07 Oct 11 nicklas 759           <other external_id="project.edit">Project properties</other>
5792 07 Oct 11 nicklas 760           <other external_id="project.edit.defaults">Default items</other>
5792 07 Oct 11 nicklas 761         </seeother>
5792 07 Oct 11 nicklas 762
3245 16 Apr 07 nicklas 763         </helptext>
3245 16 Apr 07 nicklas 764
3245 16 Apr 07 nicklas 765       </sect2>
3245 16 Apr 07 nicklas 766       
5706 23 Aug 11 nicklas 767       <sect2 id ="project_permissions.project.defaults">
5706 23 Aug 11 nicklas 768         <title>Default items</title>
5706 23 Aug 11 nicklas 769         
5792 07 Oct 11 nicklas 770         <helptext external_id="project.edit.defaults" 
5792 07 Oct 11 nicklas 771           title="Default items">
5792 07 Oct 11 nicklas 772         <para>
5792 07 Oct 11 nicklas 773           A number of default item can be assigned to a project. It is possible to
5792 07 Oct 11 nicklas 774           select one raw data type and any number of platforms, variants, protocols,
5792 07 Oct 11 nicklas 775           hardware, software and array designs. The default items are used by BASE to
5792 07 Oct 11 nicklas 776           suggest default values. The subtype <nohelp>(see <xref linkend="subtypes" />)
5792 07 Oct 11 nicklas 777           </nohelp> of each  item is used as a filter so that, for example, an extraction protocol is
5792 07 Oct 11 nicklas 778           suggested when creating an extract, and a hybridization protocol when creating
5792 07 Oct 11 nicklas 779           a hybridization. Use the various <guibutton>Add</guibutton> buttons to add
5792 07 Oct 11 nicklas 780           items to the project and the <guibutton>Remove</guibutton> button to remove them.
5792 07 Oct 11 nicklas 781         </para>
5706 23 Aug 11 nicklas 782         
5792 07 Oct 11 nicklas 783         <note>
5792 07 Oct 11 nicklas 784           <para>
5792 07 Oct 11 nicklas 785           Make sure that the items that are selected as default items also are
5792 07 Oct 11 nicklas 786           shared to the project with at least <guilabel>use</guilabel> permission.
5792 07 Oct 11 nicklas 787           Otherwise the default items will not show up for other members of the
5792 07 Oct 11 nicklas 788           project, which may result in registering incorrect data.
5792 07 Oct 11 nicklas 789           </para>
5792 07 Oct 11 nicklas 790         </note>
5792 07 Oct 11 nicklas 791         
5792 07 Oct 11 nicklas 792         <seeother>
5792 07 Oct 11 nicklas 793           <other external_id="project.edit">Project properties</other>
5792 07 Oct 11 nicklas 794           <other external_id="project.edit.members">Project members</other>
5792 07 Oct 11 nicklas 795         </seeother>
5792 07 Oct 11 nicklas 796         
5792 07 Oct 11 nicklas 797         </helptext>
5792 07 Oct 11 nicklas 798         
5792 07 Oct 11 nicklas 799         <figure
5792 07 Oct 11 nicklas 800           id="project_permission.figures.project_defaults">
5792 07 Oct 11 nicklas 801           <title>Project default items</title>
5792 07 Oct 11 nicklas 802           <screenshot>
5792 07 Oct 11 nicklas 803             <mediaobject>
5792 07 Oct 11 nicklas 804               <imageobject>
5792 07 Oct 11 nicklas 805                 <imagedata
5792 07 Oct 11 nicklas 806                   fileref="figures/project_defaults.png" format="PNG" />
5792 07 Oct 11 nicklas 807               </imageobject>
5792 07 Oct 11 nicklas 808             </mediaobject>
5792 07 Oct 11 nicklas 809           </screenshot>
5792 07 Oct 11 nicklas 810         </figure>
5792 07 Oct 11 nicklas 811         
5706 23 Aug 11 nicklas 812       </sect2>
5706 23 Aug 11 nicklas 813       
3245 16 Apr 07 nicklas 814       <sect2 id="project_permission.projects.items">
3245 16 Apr 07 nicklas 815         <title>Working with the items in the project</title>
3245 16 Apr 07 nicklas 816         
3245 16 Apr 07 nicklas 817         <para>
3298 07 May 07 nicklas 818         If you go to the single-item view for a project you will find
3298 07 May 07 nicklas 819         that there is an extra tab, <guilabel>Items</guilabel>, on that
3966 14 Nov 07 martin 820         page. 
3966 14 Nov 07 martin 821         <figure id="project_permission.images.projecttabs">
3966 14 Nov 07 martin 822           <title/>
3966 14 Nov 07 martin 823           <screenshot>
3966 14 Nov 07 martin 824             <mediaobject>
3966 14 Nov 07 martin 825               <imageobject><imagedata fileref="figures/project_tabs.png" format="PNG" /></imageobject>
3966 14 Nov 07 martin 826             </mediaobject>
3966 14 Nov 07 martin 827           </screenshot>
3966 14 Nov 07 martin 828         </figure>
3966 14 Nov 07 martin 829         Clicking on that tab will display a page that is similar
3298 07 May 07 nicklas 830         to a list view. However there are some differences:
3245 16 Apr 07 nicklas 831         </para>
3245 16 Apr 07 nicklas 832         
3298 07 May 07 nicklas 833         <itemizedlist>
3298 07 May 07 nicklas 834           <listitem>
3298 07 May 07 nicklas 835             <para>
3298 07 May 07 nicklas 836             The list is not limited to one type of item. It can display
3298 07 May 07 nicklas 837             all items that are part of the project.
3298 07 May 07 nicklas 838             </para>
3298 07 May 07 nicklas 839           </listitem>
3298 07 May 07 nicklas 840           
3298 07 May 07 nicklas 841           <listitem>
3298 07 May 07 nicklas 842             <para>
5792 07 Oct 11 nicklas 843               It support only a limited set of columns (id, name, description,
5792 07 Oct 11 nicklas 844               owner and a few more) since these are the only properties that are common
3298 07 May 07 nicklas 845               among all items.
3298 07 May 07 nicklas 846             </para>
3298 07 May 07 nicklas 847           </listitem>
3298 07 May 07 nicklas 848           
3298 07 May 07 nicklas 849           <listitem>
3298 07 May 07 nicklas 850             <para>
5705 22 Aug 11 nicklas 851               The list cannot be sorted. This is due to a limitation in the 
5705 22 Aug 11 nicklas 852               query system used to generate the list.
3298 07 May 07 nicklas 853             </para>
3298 07 May 07 nicklas 854           </listitem>
3298 07 May 07 nicklas 855         </itemizedlist>
3298 07 May 07 nicklas 856         
3298 07 May 07 nicklas 857         <note>
3298 07 May 07 nicklas 858           The list only works for the active project. For all other
3298 07 May 07 nicklas 859           projects it will only display items that are owned by the
3298 07 May 07 nicklas 860           logged in user.
3298 07 May 07 nicklas 861         </note>
3298 07 May 07 nicklas 862         
3298 07 May 07 nicklas 863         <para>
3298 07 May 07 nicklas 864           There are also several similarities:
3298 07 May 07 nicklas 865         </para>
3298 07 May 07 nicklas 866         
3298 07 May 07 nicklas 867         <itemizedlist>
3298 07 May 07 nicklas 868           <listitem>
3298 07 May 07 nicklas 869             <para>
3298 07 May 07 nicklas 870               It supports all of the regular multi-item 
3298 07 May 07 nicklas 871               operations such as delete, restore, share
4587 15 Oct 08 martin 872               and change owner.
3298 07 May 07 nicklas 873             </para>
3298 07 May 07 nicklas 874           </listitem>
3298 07 May 07 nicklas 875           
3298 07 May 07 nicklas 876           <listitem>
3298 07 May 07 nicklas 877             <para>
3298 07 May 07 nicklas 878               Clicking on the name of the item will take you to the
3298 07 May 07 nicklas 879               single-item view of that item. Holding down <keycap>CTRL</keycap>, 
3298 07 May 07 nicklas 880               <keycap>ALT</keycap> or <keycap>SHIFT</keycap> while clicking,
3298 07 May 07 nicklas 881               will open the edit popup.
3298 07 May 07 nicklas 882             </para>
3298 07 May 07 nicklas 883           </listitem>
3298 07 May 07 nicklas 884         </itemizedlist>
3298 07 May 07 nicklas 885         
3298 07 May 07 nicklas 886         <tip>
3298 07 May 07 nicklas 887           <para>
3298 07 May 07 nicklas 888           This list is very useful when you are creating a
3298 07 May 07 nicklas 889           new project, in which you want to reuse items from 
3298 07 May 07 nicklas 890           an old project.
3298 07 May 07 nicklas 891           </para>
3298 07 May 07 nicklas 892           
3298 07 May 07 nicklas 893           <itemizedlist>
3298 07 May 07 nicklas 894             <listitem>
3298 07 May 07 nicklas 895               <para>
3298 07 May 07 nicklas 896               Activate the old project and go to this view.
3298 07 May 07 nicklas 897               </para>
3298 07 May 07 nicklas 898             </listitem>
3298 07 May 07 nicklas 899             
3298 07 May 07 nicklas 900             <listitem>
3298 07 May 07 nicklas 901               <para>
3298 07 May 07 nicklas 902                 Mark the checkbox for all items that you want to
3298 07 May 07 nicklas 903                 use in the new project.
3298 07 May 07 nicklas 904               </para>
3298 07 May 07 nicklas 905             </listitem>
3298 07 May 07 nicklas 906             
3298 07 May 07 nicklas 907             <listitem>
3298 07 May 07 nicklas 908               <para>
3394 28 May 07 martin 909                 Click on the &gbShare; button
3298 07 May 07 nicklas 910                 and share the items to the new project.
3298 07 May 07 nicklas 911               </para>
3298 07 May 07 nicklas 912             </listitem>
3298 07 May 07 nicklas 913           </itemizedlist>
3298 07 May 07 nicklas 914           <para>
3298 07 May 07 nicklas 915             If you have more than one old project, repeat the
3298 07 May 07 nicklas 916             above procedure.
3298 07 May 07 nicklas 917           </para>
3298 07 May 07 nicklas 918         </tip>
3298 07 May 07 nicklas 919         
3245 16 Apr 07 nicklas 920       </sect2>
3245 16 Apr 07 nicklas 921     
3245 16 Apr 07 nicklas 922     </sect1>
5370 23 Jun 10 nicklas 923     
5370 23 Jun 10 nicklas 924     <sect1 id="project_permission.templates">
5782 04 Oct 11 nicklas 925       <?dbhtml filename="templates.html" ?>
5370 23 Jun 10 nicklas 926       <title>Permission templates</title>
5370 23 Jun 10 nicklas 927     
5370 23 Jun 10 nicklas 928       <para>
5370 23 Jun 10 nicklas 929         A <emphasis>permission template</emphasis> is a pre-defined set of permissions
5370 23 Jun 10 nicklas 930         for users, groups and/or projects. The template makes it easy to quickly share
5370 23 Jun 10 nicklas 931         items to multiple users, groups and projects, possible with different permissions
5370 23 Jun 10 nicklas 932         for everyone. There are three major use-cases were permission templates are useful:
5370 23 Jun 10 nicklas 933       </para>
5370 23 Jun 10 nicklas 934       
5370 23 Jun 10 nicklas 935       <itemizedlist>
5370 23 Jun 10 nicklas 936         <listitem>
5370 23 Jun 10 nicklas 937           <para>
5370 23 Jun 10 nicklas 938           A permission template can be associated with project. When the project is selected
5370 23 Jun 10 nicklas 939           as the active project, the permissions from the template are copied to any new items
5370 23 Jun 10 nicklas 940           that are created. Note that the new items may or may not be shared with the active
5370 23 Jun 10 nicklas 941           project, depending on the settings in the permission template. 
5370 23 Jun 10 nicklas 942           </para>
5370 23 Jun 10 nicklas 943         </listitem>
5370 23 Jun 10 nicklas 944         <listitem>
5370 23 Jun 10 nicklas 945           <para>
5370 23 Jun 10 nicklas 946           Permission templates can be selected in the <link linkend="webclient.items.share">share dialog</link>, 
5370 23 Jun 10 nicklas 947           making it easier to manually share items to multiple users, 
5370 23 Jun 10 nicklas 948           groups and projects in just a few clicks.
5370 23 Jun 10 nicklas 949           </para>
5370 23 Jun 10 nicklas 950         </listitem>
5370 23 Jun 10 nicklas 951         <listitem>
5370 23 Jun 10 nicklas 952           <para>
5370 23 Jun 10 nicklas 953           Permission templates can be used with some batch item importers, making it easier
5370 23 Jun 10 nicklas 954           for administrators which only needs a single data file even if the data belong to
5370 23 Jun 10 nicklas 955           different projects.
5370 23 Jun 10 nicklas 956           </para>
5370 23 Jun 10 nicklas 957         </listitem>
5370 23 Jun 10 nicklas 958       </itemizedlist>
5370 23 Jun 10 nicklas 959       
5370 23 Jun 10 nicklas 960       <para>
5370 23 Jun 10 nicklas 961         Permission templates are managed from the <menuchoice><guimenu>View</guimenu>
5370 23 Jun 10 nicklas 962         <guisubmenu>Permission templates</guisubmenu></menuchoice> menu. The template is
5370 23 Jun 10 nicklas 963         a very simple item that only has a name (required) and a description (optional).
5370 23 Jun 10 nicklas 964         We recommend that the names of the templates are kept unique, but this is not
5370 23 Jun 10 nicklas 965         enforced by BASE. To assign permissions to the template use the 
5370 23 Jun 10 nicklas 966         <guibutton>Set permissions</guibutton> button. This is the same dialog as the 
5370 23 Jun 10 nicklas 967         <link linkend="webclient.items.share">share dialog</link>.
5370 23 Jun 10 nicklas 968       </para>
5370 23 Jun 10 nicklas 969       
5370 23 Jun 10 nicklas 970       <note>
5370 23 Jun 10 nicklas 971         <title>Permissions are copied</title>
5370 23 Jun 10 nicklas 972         <para>
5370 23 Jun 10 nicklas 973         When a permission template is used the permissions are <emphasis>copied</emphasis>
5370 23 Jun 10 nicklas 974         to the items. Modifications to the template that are made afterwards doesn't
5370 23 Jun 10 nicklas 975         affect the permissions for the items on which the template was used.
5370 23 Jun 10 nicklas 976         </para>
5370 23 Jun 10 nicklas 977       </note>
5370 23 Jun 10 nicklas 978     </sect1>
3675 16 Aug 07 jari 979 </chapter>

Generated on Sat Oct  7 02:27:34 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)