Unipro UGENE Online User Manual v. 33
Page tree

Versions Compared

Old Version 22

changes.mady.by.user Olga Golosova

Saved on

compared with

New Version 23

changes.mady.by.user Dmitrii Sukhomlinov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • name - the external tool name as it should be displayed in the UGENE GUI. This XML element is mandatory.
  • id - the external tool unique identifier. The following characters are allowed: letters ('A'-'Z'), digits ('0'-'9), '_', '-'. This XML element is mandatory. 
  • executableName - the name of the tool executable file (with the file extension, if it is present). This XML element is mandatory.
  • executableFullPath - a full path to the external tool executable. This XML element is optional. If the "executableFullPath" value is not specified, UGENE searches for a file with the specified "executableName" name in the same folder as the XML config file and sets the tool path accordingly. One can also specify either an absolute path to a file or a path, relative to the XML config. The path is displayed near the tool in the "Application Settings" dialog. It can be also manually set up by a user.
  • description - a detailed description of the external tool. This XML element is optional.
  • version - a version of the tool executable. This XML element is optional.

  • launcherId - if the tool is supposed to be run with some script interpreter or it is a java application, then this element should contain an appropriate ID. Currently, UGENE supports the following launchers IDs: UGENEUSUPP_PYTHON2, UGENEUSUPP_PERL, UGENEUSUPP_RSCRIPT, UGENEUSUPP_JAVA. If the launcher is specified, it would be added to the launch command explicitly whenever you try to launch the external tool. The path to the launcher will be taken from the "Application Settings" (see the corresponding tools in the "Supported tools" group). If the element is not specified or it is empty, no additional launcher will be added to the command that will run the tool. This XML element is optional.

  • dependencies - a comma-separated list of other external tool IDs the new tool is dependent from. If the dependency is not satisfied, then the dependent tool is marked as "not valid" in UGENE. This XML element is optional.

...