help/help/html/webServices/webServicesPrefs.html

   1 <!--
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  -->
  21 <html>
  22 <head>
  23 <title>The Web Services Preferences Dialog Box</title>
  24 </head>
  25 <body>
  26   <p>
  27     <strong>The Web Services Preferences Dialog Box</strong>
  28   </p>
  29
  30   <p>
  31     Jalview includes a range of web services clients for data retrieval
  32     and analysis. The <em>Web Services</em> menu found in each alignment
  33     window provides access to some of these services, and is configured
  34     <em>via</em> the web services preference dialog box, available from
  35     the <em>Preferences</em> panel from the <strong>Tools&#8594;Preferences...</strong>
  36     menu from the Jalview Desktop window's menu bar.
  37   </p>
  38   <p>
  39   <center>
  40     <img src="wsprefs.gif" align="center"
  41       alt="Web Services Preferences Panel" width="571" height="461"><br>
  42     Web Services Preference Panel
  43   </center>
  44   </p>
  45   <p>
  46     <strong>Configuring the list of JABAWS servers</strong><br> The
  47     main area of the panel shows the list of <a href="JABAWS.html">JABAWS</a>
  48     servers that Jalview is currently aware of. The list includes a
  49     colour coded status: green indicates that all services are available
  50     for a given server, amber signifies that one or more services on the
  51     server are not fully functional, and red highlights servers that
  52     could not be contacted or are not functional for some other reason.
  53   </p>
  54   <p>
  55     A server's URL may be added, edited by double clicking on it, or
  56     deleted by selecting it and using the buttons below. After adding or
  57     editing a server's URL, you will be asked if you wish to test the
  58     server. If you wish to do so, then first ensure you can view the new
  59     server's test report, which will be output on Jalview's standard
  60     console output (you can open Jalview's built in console viewer via
  61     the <strong>Tools&#8594;Java Console</strong> menu option).
  62   </p>
  63   <p>
  64     <strong>Controlling the layout of the Web Services Menu</strong><br>
  65     The range of services that Jalview is able to access depends upon
  66     your requirements, and local computational resources. However, when
  67     a large number of resources are available, then the entries and sub
  68     menus in the <strong>web services</strong> menu can quickly become
  69     unwieldly. The options in the lower part of the dialog box enable
  70     you to control the display of each type of analysis service client
  71     in the web services menu. In addition, indexing options are provided
  72     that enable you to define the layout of the menus provided for
  73     JABAWS services by sorting them into submenus according to analysis
  74     type and/or host server.
  75   </p>
  76   <p>
  77     <em>The web services preferences panel was added in Jalview
  78       2.6, and server status indications added in Jalview 2.8.</em>
  79   </p>
  80   <p>
  81     <strong><a name="wswarnings">Web Services Invalid URL
  82         warnings</a></strong><br> Jalview may inform you of any problems
  83     contacting the web services by showing a dialog box like the one
  84     below:<br>
  85   <center>
  86     <img src="invalidurldialog.gif" align="center"
  87       alt="Web Services Invalid URL Warning dialog box" width="389"
  88       height="258"><br> Web Services Invalid URL Warning
  89     dialog box
  90   </center>
  91   <br>
  92   <strong><em>Note:</em></strong> this warning will be shown if you are
  93   running the Jalview desktop without any network connection, or if you
  94   have configured
  95   <a href="JABAWS.html">JABA services</a> which cannot be accessed from
  96   your location. Should you wish to disable these warnings, then uncheck
  97   the
  98   <em>Display warnings</em> check box in the web services preferences.
  99   </p>
 100   <p>
 101     <em>The web services warnings dialog box was added in Jalview
 102       2.6.1</em>
 103   </p>
 104 </body>
 105 </html>