plugins/base2/net.sf.basedb.agilent/trunk/INSTALL

Code
Comments
Other
Rev Date Author Line
1199 06 Mar 10 jari 1 $Id$
1199 06 Mar 10 jari 2
1199 06 Mar 10 jari 3 = Install and upgrade instructions for the Agilent plug-ins package for BASE. =
1199 06 Mar 10 jari 4
1199 06 Mar 10 jari 5
1199 06 Mar 10 jari 6 == Requirements ==
1199 06 Mar 10 jari 7
1199 06 Mar 10 jari 8  1. BASE 2.14.0 or later.
1199 06 Mar 10 jari 9
1199 06 Mar 10 jari 10
1199 06 Mar 10 jari 11 == Installation ==
1199 06 Mar 10 jari 12
1200 08 Mar 10 jari 13  1. Unpack the tar.gz file to a directory inside your BASE plug-in
1200 08 Mar 10 jari 14     installations directory structure (defined in
1200 08 Mar 10 jari 15     `<basedir>/www/WEB-INF/classes/base.config' parameter
1200 08 Mar 10 jari 16     ''plugins.dir''.
1199 06 Mar 10 jari 17     [[br]]
1199 06 Mar 10 jari 18     '''Note''' If the job agents are running from a different
1199 06 Mar 10 jari 19     directory than the BASE server you must copy the jar file to the
1199 06 Mar 10 jari 20     directory used by the job agents.
1200 08 Mar 10 jari 21  2. Stop the Tomcat server running BASE and all associated job agents.
1200 08 Mar 10 jari 22  3. From the `config` directory, copy `agilent-raw-data-types-xml`
1199 06 Mar 10 jari 23     to `<basedir>/www/WEB-INF/classes/raw-data-types/`
1200 08 Mar 10 jari 24  4. Update the database with Agilent specific tables and columns by
1199 06 Mar 10 jari 25     running the `updatedb.sh` script, located in directory
1199 06 Mar 10 jari 26     `<basedir>/bin`.
1200 08 Mar 10 jari 27  5. The display name of the Agilent 1-channel raw data type is
1199 06 Mar 10 jari 28     `AgilentGE1ch` and the unique ID is
1199 06 Mar 10 jari 29     `RawDataAgilent1ch`. You can change the display name of the
1199 06 Mar 10 jari 30     Agilent 2-channel data from the generic `Agilent` to more
1199 06 Mar 10 jari 31     specific `AgilentGE2ch` by change the name attribute for the
1199 06 Mar 10 jari 32     Agilent 2-channel tag in file
1199 06 Mar 10 jari 33     `<basedir>/www/WEB-INF/classes/raw-data-types.xml`. Loog for
1199 06 Mar 10 jari 34     {{{
1199 06 Mar 10 jari 35     <raw-data-type
1199 06 Mar 10 jari 36       id="agilent"
1199 06 Mar 10 jari 37       channels="2"
1199 06 Mar 10 jari 38       name="Agilent"
1199 06 Mar 10 jari 39       table="RawDataAgilent"
1199 06 Mar 10 jari 40       >
1199 06 Mar 10 jari 41     }}}
1199 06 Mar 10 jari 42     and replace `Agilent` with `AgilentGE2ch`.
1200 08 Mar 10 jari 43  6. Restart the Tomcat server.
1200 08 Mar 10 jari 44  7. Log in to BASE with administrator privileges and run the plug-in
1199 06 Mar 10 jari 45     auto-installation wizard by selecting ''Administrate -> Plugins ->
1199 06 Mar 10 jari 46     Definitions'' in the menu and click on the 'New' button.
1200 08 Mar 10 jari 47  8. Select the 'Automatically' option.
1213 26 Mar 10 jari 48  9. The auto-detection should find the plug-in listed below. Change
1213 26 Mar 10 jari 49     the 'Install' value to 'yes' and click on the 'Save' button.
1199 06 Mar 10 jari 50      * Agilent 1 channel expression background correction
1213 26 Mar 10 jari 51  10. Verify that the 'Use permissions' option for the plug-ins is set
1213 26 Mar 10 jari 52     to 'no' and remember to share the plug-in appropriately.
1213 26 Mar 10 jari 53  11. Install the 'Raw data importer' plug-in configuration included in
1199 06 Mar 10 jari 54     this package.
1199 06 Mar 10 jari 55     - Upload the configuration file
1199 06 Mar 10 jari 56       (`config/Agilen1chFull-plugin-configuration.xml`) to BASE.
1199 06 Mar 10 jari 57     - Select ''Administrate -> Plugins -> Configurations'' and click on
1199 06 Mar 10 jari 58       the 'Import...' button. Select 'Plugin configuration importer'
1199 06 Mar 10 jari 59       in the Plugin list, click 'Next', select the uploaded file for
1199 06 Mar 10 jari 60       'XML file'. Run the plug-in.
1199 06 Mar 10 jari 61     - In the plugin configuration list view find 'Agilent 1 channel
1199 06 Mar 10 jari 62       raw data import (full format files)'
1199 06 Mar 10 jari 63     - Share the new configuration (and the 'Raw data importer'
1200 08 Mar 10 jari 64       plug-in) appropriately, e.g, to an Agilent group or group
1199 06 Mar 10 jari 65       Everyone with 'RU' privileges.
1213 26 Mar 10 jari 66  12. If applicable restart job agents.
1213 26 Mar 10 jari 67  13. Done. The Agilent plug-ins are now installed.
1199 06 Mar 10 jari 68
1199 06 Mar 10 jari 69
1199 06 Mar 10 jari 70 == Upgrade ==
1199 06 Mar 10 jari 71
1213 26 Mar 10 jari 72  1. Unpack the tar.gz file to a directory inside your BASE plug-in
1213 26 Mar 10 jari 73     installations directory structure (defined in
1213 26 Mar 10 jari 74     `<basedir>/www/WEB-INF/classes/base.config' parameter
1213 26 Mar 10 jari 75     ''plugins.dir''.
1213 26 Mar 10 jari 76     [[br]]
1213 26 Mar 10 jari 77     '''Note''' If the job agents are running from a different
1213 26 Mar 10 jari 78     directory than the BASE server you must copy the jar file to the
1213 26 Mar 10 jari 79     directory used by the job agents.
1213 26 Mar 10 jari 80  2. Remove or move away the already installed version of the plug-in.
1213 26 Mar 10 jari 81  3. Log in to BASE with administrator privileges and run the plug-in
1213 26 Mar 10 jari 82     auto-installation wizard by selecting ''Administrate -> Plugins ->
1213 26 Mar 10 jari 83     Definitions'' in the menu and click on the 'New' button.
1213 26 Mar 10 jari 84  4. Select the 'Automatically' option.
1213 26 Mar 10 jari 85  5. The auto-detection should find the plug-in listed below and
1213 26 Mar 10 jari 86     highlight it as new. Change the 'Install' value to 'yes' and click
1213 26 Mar 10 jari 87     on the 'Save' button.
1213 26 Mar 10 jari 88      * Agilent 1 channel expression background correction
1213 26 Mar 10 jari 89  6. Verify that the 'Use permissions' option for the plug-ins is set
1213 26 Mar 10 jari 90     to 'no'.
1213 26 Mar 10 jari 91  7. If applicable restart job agents.
1213 26 Mar 10 jari 92  8. Done. The Agilent plug-ins are now upgraded.
1199 06 Mar 10 jari 93
1199 06 Mar 10 jari 94
1199 06 Mar 10 jari 95 == Important ==
1199 06 Mar 10 jari 96
1199 06 Mar 10 jari 97 Make sure that the job agents have access to the same (or an identical
1199 06 Mar 10 jari 98 copy) agilent-plugins.jar file as the Tomcat server. If the job agents
1199 06 Mar 10 jari 99 are not running from the same BASE installation directory, you must
1199 06 Mar 10 jari 100 copy the files to a proper location. We recommend that you always put
1199 06 Mar 10 jari 101 the agilent-plugins.jar inside the BASE server plug-in directory as
1199 06 Mar 10 jari 102 defined by `plugins.dir` in the `base.config` configuration file. If
1199 06 Mar 10 jari 103 you do BASE will automatically find the JAR file for the job agents,
1199 06 Mar 10 jari 104 otherwise you may have to configure the JAR path manually for each job
1199 06 Mar 10 jari 105 agent.
1199 06 Mar 10 jari 106
1199 06 Mar 10 jari 107 ----------------------------------------------------------------------
1199 06 Mar 10 jari 108 {{{
1199 06 Mar 10 jari 109 Copyright (C) 2010 Jari H√§kkinen
1199 06 Mar 10 jari 110
1199 06 Mar 10 jari 111 This file is part of the Agilent plug-in package for BASE
1199 06 Mar 10 jari 112 (net.sf.based.agilent).
1199 06 Mar 10 jari 113 The package is available at http://baseplugins.thep.lu.se/
1199 06 Mar 10 jari 114 BASE main site is http://base.thep.lu.se/
1199 06 Mar 10 jari 115
1199 06 Mar 10 jari 116 This is free software; you can redistribute it and/or
1199 06 Mar 10 jari 117 modify it under the terms of the GNU General Public License
1199 06 Mar 10 jari 118 as published by the Free Software Foundation; either version 3
1199 06 Mar 10 jari 119 of the License, or (at your option) any later version.
1199 06 Mar 10 jari 120
1199 06 Mar 10 jari 121 The software is distributed in the hope that it will be useful,
1199 06 Mar 10 jari 122 but WITHOUT ANY WARRANTY; without even the implied warranty of
1199 06 Mar 10 jari 123 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1199 06 Mar 10 jari 124 GNU General Public License for more details.
1199 06 Mar 10 jari 125
1199 06 Mar 10 jari 126 You should have received a copy of the GNU General Public License
1199 06 Mar 10 jari 127 along with this program. If not, see <http://www.gnu.org/licenses/>.
1199 06 Mar 10 jari 128 }}}
1199 06 Mar 10 jari 129 ----------------------------------------------------------------------