HTTP Command Reference
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.
CONFIRM
Confirm, on the host, the receipt of one or more files
CONFIRM -DIR name=value,...
- -DIR
- Confirm file(s) received using directoy listing from the host.
- name =value,...
- HTTP parameter=value and header=value pair.
CONNECT
Connect (login) to the host
CONNECT name=value,...
- name =value
- HTTP parameter=value and header=value pairs
DELETE
Delete one or more files on the host.
DELETE -DIR "source" parm/header=value,...
- -DIR
- Delete one or more files using a directory listing from the host.
- "source"
- Remote source path
- If the underlying HTTP method for the command on the server is POST, the argument is not applicable and cannot be used. See HTTP Configuration.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- name =value,...
- HTTP parameter=value and header=value pair.
DIR
Get a directory listing of available files from the host.
DIR "source" "destination" name=value,...
- "source"
- Remote source path
- If the underlying HTTP method for the command on the server is POST, the argument is not applicable and cannot be used. See HTTP Configuration.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- "destination"
- Local destination path.
- Path can be to a filename (unless the
-DIR
option is used) or to a directory. - If you specify a relative path, the command uses the default inbox.
- If you do not specify a path, the command generates messges rather than files.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- Path can be to a filename (unless the
- name =value,...
- HTTP parameter=value and header=value pair.
GET
Receive one or more files from the host.
GET -DIR -CON -DEL –UNI|-APE "source" "destination" name=value,...
- -DIR
- Get one or more files using a directory listing from the host.
- -CON
- If the command is successful, confirm on the host that file was received. If the CONFIRM command is not supported on the server, the argument is not applicable and cannot be used. See HTTP Configuration.
- -DEL
- If the command is successful, delete host files. If the DELETE command is not supported on the server, the argument is not applicable and cannot be used. See HTTP Configuration
- -UNI
- Ensure the copied filename is unique.
- -APE
- If local filename exists, append copied file to existing file.
- "source"
- Remote source path
- If the underlying HTTP method for the command on the server is POST, the argument is not applicable and cannot be used. See HTTP Configuration.
- If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- "destination"
- Local destination path.
- Path can be to a filename (unless the
-DIR
option is used) or to a directory. - If you specify no path or a relative path, the command uses the default inbox.
- One
*
is supported with canned prefix and/or suffix in filename. - You can use macro variables. See Using macro variables (Destination File context) for a list of the applicable macros.
- You can use
%HTTP.header.XXXX%
macro where XXXX references an HTTP header name in the server’s response and is replaced with the header’s value. - If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- Path can be to a filename (unless the
- name =value,...
- HTTP parameter=value and header=value pair.
HTTP 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.
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.
- -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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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 VersaLexCleo HarmonyCleo VLTraderCleo LexiCom 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, andZip 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 theinput bytes
are deleted from the file.
PUT
Send one or more files to the host.
PUT -DEL -UNI "source" "destination" name=value,...
- -DEL
- If PUT is successful, delete local file.
- -UNI
- Ensure remote filename unique
- "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 default outbox.
- 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
-
Remote destination path. Use of macro variables is supported. See Using macro variables (Destination File context) for a list of the applicable macros.
- name =value
- HTTP parameter=value and header=value pairs
PUT+GET
Send one or more files to the host and receive one or more files from the host in return.
PUT+GET -DEL –UNI|-APE "source" "destination" name=value,...
- -DEL
- If the command is successful, delete the local file.
- -UNI
- Ensure the local filename is unique.
- -APE
- If local filename exists, append to existing file.
- "source"
- Local 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.
- 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"
- Local destination path.
- Path can be to a filename or to a directory.
- If you specify no path or a relative path, the command uses the default inbox.
- One
*
is supported with canned prefix and/or suffix in filename. - You can use macro variables. See Using macro variables (Destination File context) for a list of the applicable macros.
- You can use
%HTTP.header.XXXX%
macro where XXXX references an HTTP header name in the server’s response and is replaced with the header’s value. - If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
- name =value,...
- HTTP parameter=value and header=value pair.
SCRIPT
See SCRIPT command for information about this command.
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
SYSTEM
Execute a local system command.
SYSTEM "path"
- "path"
- Local command path with arguments.
- If you specify a relative path or no path, the command uses the Cleo HarmonyCleo VLTraderCleo LexiCom home directory.
- See Using operating system commands in actions for additional information
WAIT
Pause execution.
WAIT seconds
- Seconds
- Number of seconds to pause.