spacer


spacer
EBIEBI Web Servicesservicesdalilite
Table of Contents

DaliLite

Description

DaliLite is a tool for pairwise structure comparison.

For more information on this tool see:

Web service registry entries:

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: wsdalilite.exe; Source: wsdalilite.cs A .NET runtime environment. If building from source development tools are also required. See the .NET tutorial for details.
Java Executable jar: WSDaliLite.jar; Source: WSDaliLiteClient.java Axis 1.4; All dependencies, including Axis 1.4 and Commons-CLI, are available in lib-1.4.zip.
Perl dalilite.pl SOAP::Lite
Taverna 1.x EBI_DaliLite Taverna

For further details see DaliLite Clients.

WSDL

http://www.ebi.ac.uk/Tools/webservices/wsdl/WSDaliLite.wsdl

Service API

runDaliLite(params)

Submits a DaliLite job to the service.

Arguments:

  • params an instance of the inputParams data structure.

Returns: a string containing the job ID (jobid).

checkStatus(jobId)

Get the status of a job.

Arguments:

  • jobid the job identifier of the job to check status of.

Returns: a string indicating the status of the job. Current values are:

  • DONE: job has finished, and the results can then be retrieved.
  • ERROR: the job failed or no results where found
  • NOT_FOUND: the job id is no longer available (job results are deleted after 24 h)
  • PENDING: the job is in a queue waiting processing
  • RUNNING: the job is currently being processed

getResults(jobid)

Get details of the result types available.

Arguments:

  • jobid the job identifier of the job to get result types for.

Returns: an array of WSFile structures describing the available result types for the job.

poll(jobid, type)

Wait until the job has finished and get the specified type of result data.

Arguments:

  • jobid the job identifier of the job to get result from.
  • type a string specifying the type of result to retrieve. See getResults(jobid) and WSFile for details of how to obtain valid values.

Returns: a base64 encoded string containing the result data. Depending on the SOAP library and programming language used the result may be returned in decoded form.

inputParams

A structure containing the parameters required to run the job.

Attribute Type Description Default
async boolean Asynchronous submission (recommended) false
email string Valid email address. See Why do you need my e-mail address? required
sequence1 string Structure one: PDB identifier or structure in PDB format required
chainid1 string Chain in structure one to align.
sequence2 string Structure two: PDB identifier or structure in PDB format required
chainid2 string Chain in structure two to align.

WSFile

Structure describing a result type. Returned by the getResults(jobid) method.

Attribute Type Description
type string Symbolic name of the result type. Used with the poll(jobid, type) method.
ext string Recommended file extension for this result type.

Contact

If you have any questions or comments, or you plan to use this service as part of a course or for a high number of submissions, please contact us EBI Support.

 
services/dalilite.txt · Last modified: 2011/03/30 08:12 by hpm
spacer
spacer