help/html/webServices/webServicesPrefs.html

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