Creating Templates

Reference:        Script Editor
                        Template Workspace Window

Templates are simply scripts that may or may not include special commands that capture information from the script designer as the template is inserted in the script.  The capability allows predefined scripts to be tailored to specific environments.  The following template commands are available:

1.   The caret “^” - This symbol may be placed before any script command, and will cause the appropriate command form to be displayed.  For example:

^:Repeat_Time:

This will display the Repeat_Time command form.  Commands not prefaced by the caret will be copied directly into the script without change.

2.   ^Input(<description>,<default value>) - This command will display a captioned edit field containing the default value.  The result will be inserted into the script.  For example, instead of a Repeat_Time command, you could enter:

:Repeat_Time: ^Input(Repeat interval in seconds,30) Seconds

This will capture a number and include it in the script between :Repeat_Time: and Seconds.

3.   ^Combo(<description>,[<item1>,<item2>,...<item n>],<default item>) - This command will display a captioned list of the various items, with the <default item> already selected.  For example:

:Repeat_Time: ^Combo(Repeat interval in seconds,[15,30,45,60],30) Seconds

This will capture the selection and include it in the script between :Repeat_Time: and Seconds.

4.   ^:Browse: - This command loads the Beyond FTP browser window.  This browser displays Beyond FTP servers, and is similar to the File Viewer window.  The resulting file or directory is entered into the script.  For example:

:Assign:  SourceFile = “^:Browse:”

This will capture a file name and assign it to the variable SourceFile.

When you create a new template, but sure to save it with the .TPL file extension.