help/html/webServices/webServicesPrefs.html

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