source: trunk/uk/ac/ebi/AnnotationTypeCvImporter/README.txt @ 438

Last change on this file since 438 was 438, checked in by dominic, 15 years ago

updated readme file

  • Property svn:eol-style set to native
File size: 3.7 KB
Line 
1Release Note of Anootation Types and Cv Importer
2============================================================
3General Information:
4-------------------------
5
6This plugin imports annotation types and conrolled vocabularies into base
7
8========================================================================================================
9
10To Install the plugin:
11----------------------
12  - Place AnnotationTypeCvImporter.jar into the $BASE2_HOME/www/plugins/ directory on your BASE2 server.
13  - Place ebi-plugins-utils.jar in your base installation class path : $BASE2_HOME/web-inf/lib
14   
15  1. Log in to BASE with plug-in administrative privileges, in the BASE web client, go to Administrate->Plugins->Definition
16  2. Click New to define the plugin.
17  3. Set the class and path parameters, in the dialog that opens
18    Class: enter "uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter"
19    Path: enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/AnnotationTypeCvImporter.jar
20  4. Click Save
21  The new plugins appears under the name "Annotation Type and CV Loader" in the plugins list and is now ready for use.
22 
23  5.  Proceed to configure the plugin. Information on configuring plugin is a available at :http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.configuration.html
24 
25An example tab-delimited import file is provided here: http://lev.thep.lu.se/trac/baseplugins/browser/trunk/uk/ac/ebi/AnnotationTypeCvImporter/sampleimportfile.txt.
26 
27  6. Do verify that the configuration can import the tab - delimited file. For instructions on doing this go to: http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.configuration.html#plugins.configuration.testwithfile
28 
29  7. For other base users to use the plugin as detailed in the next section, please share them to the appropriate users by manually setting the permissions on the  plugin (sharing it to group 'Everyone' should be sufficient in most cases).
30
31  General Installation instruction is available at: 
32http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
33
34===============================================================================================
35To use the plugin:
36--------------------
37 
38  1. Upload the file to import into base2.
39  2. Go to Administrate - > Types - >Annotation Types,
40  3. On the list page, select the import tab.
41  4. On the screen that appears, select the "Annotation Type and CV Loader" from the drop down list, leave the file format as auto-detect  and click Next
42  5. Select the file containing the annotation types and cv using the browse button. Click Next
43  6. On the next screen, you can accept the default for file, updating existiing annotation types, data separator and character set.
44    - file : is the file name you want to import from, as set on the previous page
45    - updating existing annotation types: set to false by default, do set this to true if an existing annotation type should be updated
46    - character set : is the character set of the file to be imported, the default is ISO-8859-1
47    - data separator: the data separator for multiple values in a data columns. If the import file contains more than one value per data column, do specifiy the data         separator, the default is colon. Only semi-colon, colon and comma are allowed.
48  7. On the next screen click Finish and wait for the job to complete. You will be shown the progress of the import in the dialog, with the page refreshing itself regularly.
49 
50Presto!! The plugin create all the annotation types. Do refresh the Annotation Type page to see the newly created annotation types and cv.
51
52====================================================================================================
Note: See TracBrowser for help on using the repository browser.