plugins/base2/uk.ac.ebi.tab2mage/trunk/AnnotationTypeCvImporter/README.txt

Code
Comments
Other
Rev Date Author Line
402 17 Aug 07 dominic 1 Release Note of Anootation Types and Cv Importer
402 17 Aug 07 dominic 2 ============================================================
402 17 Aug 07 dominic 3 General Information:
402 17 Aug 07 dominic 4 -------------------------
402 17 Aug 07 dominic 5
402 17 Aug 07 dominic 6 This plugin imports annotation types and conrolled vocabularies into base
402 17 Aug 07 dominic 7
402 17 Aug 07 dominic 8 ========================================================================================================
402 17 Aug 07 dominic 9
402 17 Aug 07 dominic 10 To Install the plugin:
402 17 Aug 07 dominic 11 ----------------------
504 28 Nov 07 dominic 12   - Place AnnotationTypeCvImporter.jar and ebi-plugins-utils.jar into the $BASE2_HOME/www/plugins/ directory on your BASE2 server. 
504 28 Nov 07 dominic 13       
410 30 Aug 07 dominic 14    1. Log in to BASE with plug-in administrative privileges, in the BASE web client, go to Administrate->Plugins->Definition
402 17 Aug 07 dominic 15   2. Click New to define the plugin. 
402 17 Aug 07 dominic 16   3. Set the class and path parameters, in the dialog that opens
432 18 Sep 07 dominic 17     Class: enter "uk.ac.ebi.nugo.plugins.AnnotationTypeCvImporter"
402 17 Aug 07 dominic 18     Path: enter the path to the plugin jar file, i.e. <BASE_HOME>/www/plugins/AnnotationTypeCvImporter.jar 
402 17 Aug 07 dominic 19   4. Click Save
402 17 Aug 07 dominic 20   The new plugins appears under the name "Annotation Type and CV Loader" in the plugins list and is now ready for use. 
402 17 Aug 07 dominic 21   
402 17 Aug 07 dominic 22   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
438 17 Oct 07 dominic 23   
402 17 Aug 07 dominic 24 An example tab-delimited import file is provided here: http://lev.thep.lu.se/trac/baseplugins/browser/trunk/uk/ac/ebi/AnnotationTypeCvImporter/sampleimportfile.txt.
402 17 Aug 07 dominic 25   
402 17 Aug 07 dominic 26   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
402 17 Aug 07 dominic 27   
410 30 Aug 07 dominic 28   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).
402 17 Aug 07 dominic 29
402 17 Aug 07 dominic 30   General Installation instruction is available at:  
402 17 Aug 07 dominic 31 http://base.thep.lu.se/chrome/site/doc/html/admindoc/plugin_installation/plugins.installation.html#plugins.installation
402 17 Aug 07 dominic 32
402 17 Aug 07 dominic 33 ===============================================================================================
402 17 Aug 07 dominic 34 To use the plugin:
402 17 Aug 07 dominic 35 --------------------
402 17 Aug 07 dominic 36   
402 17 Aug 07 dominic 37   1. Upload the file to import into base2.
402 17 Aug 07 dominic 38    2. Go to Administrate - > Types - >Annotation Types, 
402 17 Aug 07 dominic 39   3. On the list page, select the import tab.
402 17 Aug 07 dominic 40   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
402 17 Aug 07 dominic 41   5. Select the file containing the annotation types and cv using the browse button. Click Next
402 17 Aug 07 dominic 42   6. On the next screen, you can accept the default for file, updating existiing annotation types, data separator and character set. 
402 17 Aug 07 dominic 43     - file : is the file name you want to import from, as set on the previous page
402 17 Aug 07 dominic 44     - updating existing annotation types: set to false by default, do set this to true if an existing annotation type should be updated
402 17 Aug 07 dominic 45     - character set : is the character set of the file to be imported, the default is ISO-8859-1
403 17 Aug 07 dominic 46     - 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.
402 17 Aug 07 dominic 47   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.
402 17 Aug 07 dominic 48   
402 17 Aug 07 dominic 49 Presto!! The plugin create all the annotation types. Do refresh the Annotation Type page to see the newly created annotation types and cv.
402 17 Aug 07 dominic 50
402 17 Aug 07 dominic 51 ====================================================================================================

Generated on Tue Nov 21 03:44:23 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)