Converting flow templates and definitions to LSF Application Center templates

Edit online

Learn how to convert LSF Process Manager flow templates and flow definitions to LSF Application Center templates using a tool provided with LSF Process Manager version 10.2 Fix Pack 10 and later.

About the template conversion tool

The traditional LSF Process Manager template which is added through the "Insert Application" action in LSF Process Manager java client is the same function as LSF Application Center templates. To consolidate these concepts, we provide tools for converting LSF Process Manager templates to LSF Application Center templates. User can edit and insert LSF Application Center templates in Flow Editor in LSF Application center after conversion. Users should transition to the web interface through LSF Application Center after the conversion as it offers the latest features the LSF Process Manager java client does not.

Prerequisites for the template conversion tool

To use the template conversion tool, the current user must be an LSF Application Center Administrator, with the following permissions:
  • Read and write permission to the current directory
  • Read and write permission to the $GUI_CONFDIR/application/draft and $GUI_CONFDIR/application/published directory
  • Read and write permission to the $GUI_TOP/work/pm_data/flow_drafts directory
  • Read and write permission to properties files in the $GUI_CONFDIR/application/published directory

Using the conversion tools

The following describes usage of the two template conversion tools.

The convertTemplate.sh tool converts LSF Process Manager templates to LSF Application Center templates. The generated templates will be saved in the $GUI_CONFDIR/application directory after conversion, and can be found in LSF Application Center at Workload > Definitions > Templates, in the folder PM_Templates.
$ convertDefinition.sh -h
Usage: convertDefinition.sh [-h] [DIRECTORY]
Converts flow definitions of the defined DIRECTORY (the current directory by default).
The convertDefinition.sh tool converts LSF Process Manager flow definitions (which contain LSF Process Manager templates within the flow definitions) into a flow replacing the LSF Process Manager template using the newly converted LSF Application Center submission forms. The generated definitions will be saved in the $GUI_TOP/work/pm_data/flow_drafts directory after conversion, and can be found in LSF Application Center at Workload > Definitions > Flow Definitions, in the folder PM_Definitions.
$ convertTemplate.sh -h
Usage: convertTemplate.sh [-h] [-p | --publish]
Converts templates of the directory defined by JS_TEMPLATE_DIR in $JS_ENVDIR/js.conf
 	 -p,--publish	Publishes converted templates in LSF Application Center.

Limitations

The following fields are not supported by the LSF Process Manager template conversion tool. The Param field functionality can be recreated using widgets in LSF Application Center.
  • Param lookup=false
  • Param repeatable
  • Param HostDependent
  • Param SubmissionCmd, (Use fixed value: bsub)
  • Execution hasArray property
  • Exception handling
  • About

Notes about the conversion tool

  • Spaces in the template name will be replaced with an underscore (_) when it is converted. For example, "Blast Template Name" is converted to "Blast_Template_Name".
  • The parameter UserName is only effective in a flow when JS_CHANGE_FLOW_OWNER=false in $JS_ENVDIR/js.conf.
  • The convert definition script needs to create a directory temp_draft_definitions in the current directory for the purpose of saving intermediate files.
  • The convert script generates a convert.log in the current directory. If convert.log already exists, make sure you have write permission to append to the file.
  • Since the conversion process is based on OS file operations, users may need to ask the Administrator for help if errors of permission denied occurs.