Difference between revisions of "Hash parameters"

Latest revision as of 10:42, 2 August 2013

Hash parameters are URL parameters supported by BioUML web edition which can be placed after hash (#) symbol. For example, in URL http://ie.biouml.org/bioumlweb#anonymous=true the anonymous is hash parameter.

[edit] Format

Hash parameters conform regular URL query string parameters. Individual parameters are specified in the name=value manner and separated by '&'. If special symbols like '=' or '&' appear inside parameter value, they should be escaped using percent-encoding.

[edit] Known parameters

There are a number of hash parameters recognized by BioUML web edition:

anonymous

if specified and equals to 'true', anonymous login will be performed if supported by given server policy (see disableAnonymous in defines.js).

user

login via given user name (e-mail address). Parameter 'pass' must be specified as well.

pass

login via given password. Parameter 'user' must be specified as well.

perspective

perspective to set after login.

de

open the document by specified path in the repository.

docOnly

if specified together with de and equals to 'true', document will be opened, but active branch in the repository pane will not be changed.

action

(since 0.9.6) if specified together with de, will perform action with given ID for specified path. Action IDs are available in ru/biosoft/server/servlets/webservices/files/actions/tree/*.json action definition files.

Some parameters are recognized by individual document types.

[edit] Genome browser specific parameters

pos

position in the browser (chromosome:start-end)

[edit] Analysis document specific parameters

fromDE

path to the element to initialize parameters from (if this element was created by this analysis)

taskID

task identifier to initialize parameters from (if given task was a launch of this analysis)