help/html/webServices/webServicesPrefs.html

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