Host Technical Reference / OFTP Hosts
Parent topic: OFTP Hosts

OFTP Command Reference

Information about commands available to OFTP hosts and mailboxes

PUT

Send one or more files to the host

PUT –TEX|-UNS|-FIX|-VAR|-RET –DEL "source" "destination" RecordDelimiter=0x.. StripDelimiter=True|False PadCharacter=0x.. TranslateToEBCDIC=True|False FileDescription=...
–TEX
Transfer file in OFTP text format:
There are several other parameters available for this format:
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
See Additional PUT parameters for more information.
-UNS
Transfer file in OFTP unstructured format:
There are several other parameters available for this format:
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
See Additional PUT parameters for more information.
-FIX
Transfer file in OFTP fixed format.
There are several other parameters available for this format:
  • RecordDelimiter= - Optional
  • StripDelimiter= - Optional
  • PadCharacter= - Optional
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
See Additional PUT parametersAdditional PUT parameters for more information.
-VAR
Transfer file in OFTP variable format.
There are several other parameters available for this format:
  • RecordDelimiter= - Required
  • StripDelimiter= - Optional
  • TranslateToEBCDIC= - Optional
  • FileDescription= - Optional
See Additional PUT parametersfor more information.
-RET
Transfer return receipt. See OFTP Configuration.
-DEL
If PUT is successful, delete the local file.
"source"

Source path

  • Path can be to a filename or to a directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default outbox.
  • Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"

The file’s Virtual Filename (SFIDDSN)

  • Use of macro variables is supported. See Using macro variables (Destination File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
  • If no destination is specified, the command uses Default Virtual Filename under the OFTP Mailbox > OFTP Tab. If the Default Virtual Filename also not specified, the command uses the source filename.

Additional PUT parameters

RecordDelimiter=
The character or set of characters that logically separate records.  Use a 0x prefix to specify hexadecimal character values.
StripDelimiter=
When a RecordDelimiter is specified, indicates whether the delimiters should be excluded from the file transfer.  Defaults to False.
PadCharacter=
The character or set of characters to be used when necessary to pad a record to the needed fixed length.  Use a 0x prefix to specify hexadecimal character values.
TranslateToEBCDIC=
Indicates that outgoing characters should be translated from ASCII to EBCDIC.  The “EBCDIC Encoding” property under the OFTP Host > Advanced Tab specifies the encoding character set.  Defaults to False. See OFTP Host
FileDescription=
Specify an optional description.  This is set to the SFIDDESC field when sending a file.  This field only pertains to OFTP2.
Note: During OFTP2 transfers where the file is encrypted, compressed, or signed, the file type is forced to unstructured (-UNS) regardless of the settings specified.

GET

Receive one or more files or receipts from the host 

GET

The GET command has no options for two reasons:

  • Whether files or receipts (EERP) are received cannot be controlled
  • In OFTP, files and receipts can be received either solicited or unsolicited

You can use the Incoming options under OFTP Host > OFTP Tab can be used to configure the special destination and parameters for all received files, both solicited and unsolicited. See OFTP Host

SYSTEM

Execute a local system command.

SYSTEM "path"
"path"
Local command path with arguments.

SET

Change an action property value. The new value only affects the commands that follow the SET.

SET property=value
property = value
Action property and new value
  • The property name must have no embedded spaces.
  • The value specified remains in effect until it is set again or until the end of action.  
  • To reset property back to default value (host-level or system-level), specify 
    SET property

    or

    SET property=
  • To clear a string property, use the CLEAR command

You can also use the SET command to override any property in the OFTP Host > Advanced Tab (see OFTP Host) at action runtime.  There are also a number of OFTP parameters in the OFTP Host > OFTP Tab and OFTP Mailbox > OFTP Tab that you can override at runtime, including:

  • mailbox.SSIDSDEB
  • mailbox.SSIDCRED
  • mailbox.SSIDCMPR
  • mailbox.SFIDLRECL
  • mailbox.SFIDDSN
  • mailbox.SFIDORIG
  • mailbox.SFIDDEST

CLEAR

Clear an action property string value. The cleared value only affects the commands that follow the CLEAR.

CLEAR property
property
Action property name with no embedded spaces.

WAIT

Pause execution.

WAIT seconds
Seconds
Number of seconds to pause.

LCOPY

Copy one or more files locally.

LCOPY –DEL -REC {–UNI|–APE} {-ZIP|-UNZ} "source" "destination"
-DEL
If the command is successful, delete the local file.
-REC
Recursively search all subdirectories.
You cannot use this option with the -UNZ option.
-UNI
Ensure the copied filename is unique.
-APE
Append copied file to existing destination file.
-ZIP
Zip all the files into one or more ZIP archive files, depending on the destination specified.
  • Specify ZIP comment and compression level through Zip Comment and Zip Compression Level properties. See Setting advanced host properties.
  • The ZIP archive files created through the LCOPY command conform to the standard ZIP file format. Visit http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html. The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the VersaLex application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
  • In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Cryptographic Services.
-UNZ
Unzip the source file(s).
  • All source files must be ZIP archive files.
  • You cannot use this option with the -REC option.
  • Use ZIP entry paths if Unzip Use Path is set. See Setting advanced host properties.
  • The ZIP archive files created through the LCOPY command conform to the standard ZIP file format (reference http://docs.oracle.com/javase/6/docs/api/java/util/zip/package-summary.html). The ZIP file format should not be confused with other popular file compression/archive formats such as GZIP, TAR, RAR, etc. The LCOPY command works only with ZIP-formatted files. In addition to the application, there are many other software packages that can read/write ZIP-formatted files, for example, WinZip (Windows), File Roller (Linux), PKZIP and Info-ZIP (Windows/Linux/other Unix).
  • In addition to standard ZIP-formatted archives, the VersaLex application also supports password-based AES- encrypted ZIP files (128-bit, 192-bit, and 256-bit). See Encryption of Zip Files for more information on this capability.
"source"
Source path
  • Path can be to a filename or to a directory
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
Destination path.
  • Path can be to a filename or to a directory.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • You can use a single * within the destination path. In this context, it is not a wildcard. Rather, it is used to substitute a source file name or a source subdirectory name. When * is used in conjunction with both the -REC and -ZIP options, and Zip Subdirectories Into Individual Zip Files is enabled, then * is substituted with each first-level subdirectory name. When * is not used for bundling zipped subdirectories, then it is used as a shortcut for the %sourcefilename% or %srcfilename% macro. Only one * is allowed in the destination path. See Setting advanced host properties.
  • When copying a file without the -APE option, or when copying a file with the -APE option where the destination file does not already exist, a temporary file name is used while the copy operation is taking place. This temporary file is placed in the destination directory. Its name begins with the product name and ends with .tmp. Once the copy completes successfully, the temporary file is renamed to the destination name.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LDELETE

Delete one or more files locally.

LDELETE "source"
"source"
Source path.
  • Path can be a filename or a directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • Use of macro variables is supported. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

LREPLACE

Replace bytes in one or more files locally.

LREPLACE "source" Replace="input bytes" With="output bytes"
"source"
Source path.
  • Path can be to a filename or to a directory.
  • You can use * and ?, or a regular expression when you specify a filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Source File context) for a list of the applicable macros.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"input bytes"
List of bytes to be replaced.
  • Comma separated list of byte values (0-255).
  • All bytes in comma-separated list must be found in the file in listed sequence in order to be replaced.
"output bytes"
List of bytes to be substituted for original input bytes.
  • Comma separated list of byte values (0-255).
  • If With parameter is omitted, then the input bytes are deleted from the file.

CHECK

See CHECK Command for information about this command.

SCRIPT

See SCRIPT command for information about this command.

Comment

# text...

Lines in the action starting with a # character are considered comments and will be ignored when the action executes. Lines starting with # are generally used for documentation purposes.

Parent topic: OFTP Hosts
© 2018 Cleo. All rights reserved.