source: extensions/net.sf.basedb.reggie/trunk/README @ 1425

Last change on this file since 1425 was 1371, checked in by Nicklas Nordborg, 11 years ago

Fixes #318: Remove references to lib copying in reggie README

  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.4 KB
RevLine 
[1282]1== Requirements ==
2
[1361]3 1. BASE 2.17.1 or later.
[1282]4 
5== Introduction ==
6
7This package is an extension package to BASE that can be used to
8simplify biosource and sample registration.
9
10 * The homepage for this extension:
11   http://baseplugins.thep.lu.se/wiki/net.sf.basedb.reggie
12
13== Installation ==
14
15 1. Download the reggie-*.tar.gz file.
16 2. Unpack the downloaded file to a directory of your choice.
[1371]17 3. Copy the 'reggie.jar' file to your BASE extensions directory:
18    WEB-INF/extensions
[1301]19 4. Run the 'Extensions->Manual scan' command if you have disabled automatic
[1282]20    installation. Otherwise, just wait a bit and the automatic installation will
21    find and install the new extension.
[1310]22 5. Log in as a user with Administrator priviliges.
23 6. Create a project and set it as the active project. This step is
24    optional but is recommended. Running Reggie without an active project
25    will generate warning messages later on.
[1334]26 7. Go to the Extensions->Reggie menu. Select the 'Installation wizard'
27    If the 'Reggie' menu is not visible try BASE->Reload permissions menu.
[1310]28 8. It should display a list with several error message about missing items.
29    Click on the "Create missing items" button to create them. If no project
30    was created in step 6, all annotatation types will be shared with the
31    'PatientCurator' group, otherwise only some will be shared to the
32    group and some will be shared to the active project.
33 9. Done.
[1301]34
[1282]35 
[1301]36== Using ==
37 
[1282]38Reggie appears as a menu entry in the Extensions menu. All operations
[1301]39are available on that page.
[1282]40
[1334]41 * Installation wizard:
[1301]42   This entry is available if the logged in user is an 'Administrator' and
43   will perform some basic checks that items that are needed by Reggie
44   exists and have been properly configured. Items that doesn't exists can
45   be created automatically.
46   
[1334]47 * Personal information registration wizard:
[1301]48   This entry is available for 'Administrators' and members of the
49   'PatientCurator' group. It is used to register new patients and
50   cases and connect this information to (already existing)
[1334]51   specimen tubes. It can also be used to update missing information
52   on existing cases and specimen tubes.
[1337]53   
54 * Referral form registration wizard:
55   This entry is available for 'Administrators' and members of the
56   'PatientCurator' group. It is used to connect scanned referral
57   forms (eg. pdf files) to already existing cases.
[1301]58
[1355]59 * Consent form registration wizard:
60    This entry is available for 'Administrators' and members of the
61   'PatientCurator' group. It is used to connect register consent
62   for participating in the study.
[1301]63
[1282]64== Compiling ==
65
66To compile this package you also need:
67 
68 1. Ant 1.6
69 2. Java 1.6
70
71Follow these instructions:
72
73 1. Download the source code from the subversion repository. See
74    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.reggie for instructions.
75 
76 2. Type `ant download-lib` to automatically download the BASE core JAR files that
77    are neeed for compilation. You can also do this manually by copying the
[1301]78    BASE2Core.jar, BASE2Webclient.jar and BASE2WSClient.jar
[1282]79    from the BASE installation directory (<basedir>/www/WEB-INF/lib/) to the
80    ./lib/compile directory.
81
82 3. Type 'ant' to compile the code and generate the 'reggie.jar' file
83    in the project directory.
84
85 4. Use 'ant package' to create a downloadable tar.gz package.
86 
87Tip: If you need different values for any of the properties defined in
88the 'build.xml' file, create a file named 'build.properties' and set
89the values there.
90
Note: See TracBrowser for help on using the repository browser.