Genome Workbench Linkout Service
The Genome Workbench Linkout Service provides an easy way to embed
links into HTML pages that can be used to spawn Genome Workbench to
load publically available information. Using the right set of
parameters, this CGI can generate a MIME-encoded stream to load a
specific sequence, launch a specific viewer, and even retrieve BLAST
results.
Quick Launcher
To load a sequence in Genome Workbench, enter the sequence identifier
here:
To search for a BLAST request ID in Genome Workbench, enter the request
ID here:
Help! My browser doesn't handle these links!
In order to use these links, Genome Workbench must be registered as a
plugin helper for your browser. See the Browser Configuration help page for more
information.
Examples of Use
If you want to embed a link to load a sequence in Genome Workbench, the
easiest way to do this is to create a link that will send a message to
Genome Workbench. This requires a few parameters, explained below. In
particular, you need the action=message along with
the sequence identifier to load in id=, as follows:
http://www.ncbi.nlm.nih.gov/projects/gbench/service/gbench_linkout.cgi?action=message&id=NC_000001
You can also tell Genome Workbench to create a project for a particular
location. This is accomplished using the from and
to fields in conjunction with id:
http://www.ncbi.nlm.nih.gov/projects/gbench/service/gbench_linkout.cgi?action=project&id=NC_000001&from=31920000&to=31955000&label=FLJ25348
Description of Parameters
- action=
-
The action parameter describes what form of data is
returned. It must be one of project (to generate a
Genome Workbench project) or message (to generate a
Genome Workbench plugin messsage or command).
- label=
-
The label parameter is used to encode a label specific
for the project. This label will override any automatically generated
label.
- id=
-
The id parameter is used to encode a sequence
identifier. This can be any accession.version, a GenBank identifier
(gi), or a FASTA-format sequence identifier.
- from=
-
The from parameter is used to indicate the starting
point of the sequence. This parameter is in 1-based coordinates and
must be used in conjunction with the id and
to parameter
- to=
-
The to parameter is used to indicate the ending point
of the sequence. This parameter is in 1-based coordinates and must be
used in conjunction with the id and
to parameter
- rid=
-
The rid parameter is used to indicate a BLAST request
ID to retrieve. This must be used in conjunction with
action=message.
