EMBL-EBI Web Services

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== DbClustal (SOAP) ======

===== Description =====

DbClustal ((Thompson J.D., Plewniak F., Thierry J. and Poch O. (2000)\\
**DbClustal: rapid and reliable global multiple alignments of protein sequences detected by database searches.**\\
Nucleic Acids Research 28(15):2919-26\\ 
PubMed: [[http://europepmc.org/abstract/MED/10908355|10908355]]\\ 
DOI: [[http://dx.doi.org/10.1093/nar/28.15.2919|10.1093/nar/28.15.2919]]\\ 
)) is a ClustalW based alignment workflow for sequences identified by a protein BLAST (NCBI BLAST or WU-BLAST) search. Unlike MView ([[MView (REST)]] or [[MView (SOAP)]]) the multiple sequence alignment created by DbClustal has the complete sequence of the hits found by BLAST, but with anchor regions in the alignment identified from the BLAST report maintained in the alignment.

For more information see:
  * Web form: [[http://www.ebi.ac.uk/Tools/msa/dbclustal/]]
  * [[.:DbClustal (REST)|REST service]]
  * [[ftp://ftp-igbmc.u-strasbg.fr/pub/DbClustal/|DbClustal FTP site]]

Web service registry entries:
  * [[http://www.biocatalogue.org/services/3117|BioCatalogue]]

===== Important ====

We kindly ask all users of EMBL-EBI Web Services to submit tool jobs in batches of up to 25 at a time and to not submit more until the results and processing has completed for these. This enables users as well as the service maintainers to deal more easily with local and remote network outages as well as scheduled or unscheduled downtime.

Service provision happens on a fair-share basis. Overzealous usage of a particular resource will be dealt with in accordance to the [[http://www.ebi.ac.uk/about/terms-of-use|EMBL-EBI's Terms of Use]].

===== Clients =====

Sample clients are provided for a number of programming languages. For details of how to use these clients, download the client and run the program without any arguments.

^ Language ^ Download ^ Requirements ^
^ C# | .NET Executable: ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/csharp/bin/DbClustalCliClient.exe|DbClustalCliClient.exe]]''; Source: ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/csharp/EBIWS2_CSharp/EbiWS/AbstractWsClient.cs|AbstractWsClient.cs]]'', ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/csharp/EBIWS2_CSharp/EbiWS/DbClustalClient.cs|DbClustalClient.cs]]'', ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/csharp/EBIWS2_CSharp/DbClustalCliClient/DbClustalCliClient.cs|DbClustalCliClient.cs]]'' | A .NET runtime environment. If building from source development tools are also required. See the [[:tutorials:06_Programming:dot_net|.NET tutorial]] for details. |
^ Java | Executable jar: ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/java/jar/DbClustal_Axis1.jar|DbClustal_Axis1.jar]]''; Source: ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/java/src/uk/ac/ebi/webservices/AbstractWsToolClient.java|AbstractWsToolClient.java]]'', ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/java/src/uk/ac/ebi/webservices/axis1/DbClustalClient.java|DbClustalClient.java]]'' | [[http://ws.apache.org/axis/|Axis 1.4]]; All dependencies, including [[http://ws.apache.org/axis/|Axis 1.4]] and [[http://commons.apache.org/cli/|Commons-CLI]], are available in ''[[http://www.ebi.ac.uk/Tools/webservices/downloads/java/lib-1.4.zip|lib-1.4.zip]]''. |
^ Perl | ''[[http://www.ebi.ac.uk/Tools/webservices/download_clients/perl/soaplite/dbclustal_soaplite.pl|dbclustal_soaplite.pl]]'' | [[http://search.cpan.org/perldoc?SOAP::Lite|SOAP::Lite]] |

For further details of these tool-kits and workflow platforms see our [[:tutorials:00_Contents|Guide to Web Services]].

===== WSDL =====

The [[http://www.w3.org/TR/wsdl|WSDL]] for the DbClustal SOAP service: http://www.ebi.ac.uk/Tools/services/soap/dbclustal?wsdl

===== Operations =====

==== getParameters() ====

Get a list of the parameter names.

Arguments: //none//

Returns: a list of strings giving the names of the parameters.

==== getParameterDetails(parameterId) ====

Get details of a specific parameter.

Arguments:
  * ''parameterId'': identifier/name of the parameter to fetch details of.

Returns: a [[#wsParameterDetails]] describing the parameter and its values.

==== run(email, title, params) ====

Submit a job to the service.

Arguments:
  * ''email'': (**required**) user e-mail address. See [[help:faq#why_do_you_need_my_e-mail_address|Why do you need my e-mail address?]]
  * ''title'': job title. Default: "".
  * ''params'': (**required**) parameters for the tool. These are described by the [[#InputParameters]] data structure.

Returns: a string containing the job identifier (''jobId'').

==== getStatus(jobId) ====

Get the status of a submitted job.

Arguments:
  * ''jobId'': (**required**) job identifier.

Returns: a string containing the status.

The values for the status are:
  * ''RUNNING'': the job is currently being processed.
  * ''FINISHED'': job has finished, and the results can then be retrieved.
  * ''ERROR'': an error occurred attempting to get the job status.
  * ''FAILURE'': the job failed.
  * ''NOT_FOUND'': the job cannot be found.
Further details can be found in [[:tutorials:01_intro#jdispatcher|Synchronous and Asynchronous Access: JDispatcher]].

==== getResultTypes(jobId) ====

Get the available result types for a finished job.

Arguments:
  * ''jobId'': (**required**) job identifier.

Returns: a list of [[#wsResultType]] data structures describing the available result types.

==== getResult(jobId, type, parameters) ====

Get the result of a job of the specified type.

Arguments:
  * ''jobId'': (**required**) job identifier.
  * ''type'': (**required**) string specifying the result type to fetch. See [[#getResultTypes(jobId)]] for details of the available types.
  * ''parameters'': optional list of [[#wsRawOutputParameter]] used to provide additional parameters for derived result types.

Returns: the result data for the specified type, base64 encoded. Depending on the SOAP library and programming language used the result may be returned in decoded form. For some result types (e.g. images) this will be binary data rather than a text string.

===== Data Types =====

==== InputParameters ====

The input parameters for the job:

^ Attribute        ^ Type    ^ Description ^
| ''output''    | string  | Output format for multiple sequence alignment. |
| ''sequence''     | string  | Input query sequence used in the BLAST. For BLAST jobs run on the EMBL-EBI services an EMBL-EBI job identifier can be used as input. |
| ''blastreport''  | string  | Input BLAST report from a BLAST search with the query sequence. For BLAST jobs run on the EMBL-EBI services an EMBL-EBI job identifier can be used as input. |
| ''idlist'' | file    | List of identifiers for selecting a set of BLAST hits for alignment. |

More detailed information about each parameter, including valid values  can be obtained using the [[#getParameterDetails(parameterId)]] operation.

==== wsParameterDetails ====

Descriptive information about a tool parameter. Returned by [[#getParameterDetails(parameterId)]].

^ Attribute       ^ Type   ^ Description ^
| ''name''        | string | Name of the parameter. |
| ''description'' | string | Description of the parameter, suitable for use in option help interfaces. |
| ''type''        | string | Data type of the parameter. |
| ''values''      | list of [[#wsParameterValue]] | List of valid values for the option. |

==== wsParameterValue ====

Description of a tool parameter value. Used in [[#wsParameterDetails]].

^ Attribute       ^ Type     ^ Description ^
| ''label''        | string  | Display name of the value, for use in interfaces. |
| ''value''        | string  | String representation of the value to be passed to the tool parameter. |
| ''defaultValue'' | boolean | Flag indicating if this value is the default. |
| ''properties''   | list of [[#wsProperty]] | List of key/value pairs providing further information. |

==== wsProperty ====

Properties of a tool parameter value. Used in [[#wsParameterValue]].

^ Attribute ^ Type   ^ Description ^
| ''key''   | string | name of property |
| ''value'' | string | value of property |

==== wsRawOutputParameter ====

Additional parameters passed when requesting a result. See [[#getResult(jobId, type, parameters)]].

^ Attribute ^ Type           ^ Description ^
| ''name''  | string         | name of parameter |
| ''value'' | list of string | values for parameter |

==== wsResultType ====

Description of a result type. Returned by [[#getResultTypes(jobId)]].

^ Attribute       ^ Type   ^ Description ^
| ''identifier''  | string | Identifier for the result type. Passed as ''type'' to [[#getResult(jobId, type, parameters)]]. |
| ''label''       | string | Display name for use in user interfaces. |
| ''description'' | string | Description of the result type, for use in help interfaces. |
| ''mediaType''   | string | MIME type of the returned data. |
| ''fileSuffix''  | string | Suggested suffix for file name, if writing data to disk. |
EMBL-EBI Web Services

EMBL-EBI

Services

Research

Training

Industry

About us
