Host Technical Reference / WS Hosts
Parent topic: WS Hosts

WS Command Reference

CONNECT

Initializes new connection to host, if necessary. 

CONNECT name=value,...
name =value
WS method parameter=value pairs. The required and optional parameters and headers (and potential values) are identified in the syntax of the host commands for the server. See WS Host: Commands Tab.  An optional parameter or header is enclosed in brackets ([...]).

PUT

Send one or more files to the host. 

PUT -DEL "source" name=value,...
–DEL
If the PUT command is successful, delete local file(s).
"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 ("...").
name=value
WS method parameter=value and header=value pairs
The required and optional parameters and headers (and potential values) are identified in the syntax of the host commands for the server. See WS Host: Commands Tab.  An optional parameter or header is enclosed in brackets ([...]).

GET 

Receive one or more files from the host 

GET -DIR -CON -DEL –UNI|-APE "destination" name=value,...
-DIR
Receive one or more files from the host
If the DIR command is not supported on the server (see Configuration ), the -DIR argument is not applicable and cannot be used.
-CON
If GET is successful, confirm on host that file received.
If the CONFIRM command is not supported on the server (see Configuration), the -CON argument is not applicable and cannot be used.
-DEL
If GET is successful, delete host files.
If the DELETE command is not supported on the server (see Configuration), the -DEL argument is not applicable and cannot be used.
–UNI
Ensure local filename unique
Cannot be used with the -APE option.
-APE
If local filename exists, append to file.
Cannot be used with the -UNI option.
"destination"
Destination path.
  • Path can be to a filename (unless you use the -DIR option) or to a directory.
  • You can use a single * within the destination path in conjunction with a canned prefix and/or suffix in the filename.
  • If you specify a relative path, the command uses the default inbox.
  • You can use macro variables. See Using macro variables (Destination File context) for a list of the applicable macros.
  • You can use the %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
WS method parameter=value and header=value pairs
The required and optional parameters and headers (and potential values) are identified in the syntax of the host commands for the server. See WS Host: Commands Tab.  An optional parameter or header is enclosed in brackets ([...]).

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"
-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.
  • If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

DIR

Get a directory listing of available files from the host.

DIR name=value,...
name =value,...
WS method parameter=value and header=value pairs
The required and optional parameters and headers (and potential values) are identified in the syntax of the host commands for the server. See WS Host: Commands Tab.  An optional parameter or header is enclosed in brackets ([...]).

CONFIRM

Confirm the receipt of one or more files on the host.

CONFIRM -DIR name=value,...
-DIR
Confirm file(s) received using directory listing from the host.
If the DIR command is not supported on the server (refer to Configuration ), the -DIR argument is not applicable and cannot be used.
name=value
WS method parameter=value and header=value pairs
The required and optional parameters and headers (and potential values) are identified in the syntax of the host commands for the server. See WS Host: Commands Tab.  An optional parameter or header is enclosed in brackets ([...]).

DELETE

Delete one or more files on the host.

DELETE -DIR name=value,...
-DIR
Delete files using directory listing from the host.
If the DIR command is not supported on the server (see HTTP Configuration ), the -DIR argument is not applicable and cannot be used.
name=value
WS method parameter=value and header=value pairs
The required and optional parameters and headers (and potential values) are identified in the syntax of the host commands for the server. See WS Host: Commands Tab.  An optional parameter or header is enclosed in brackets ([...]).

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

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: WS Hosts
© 2018 Cleo. All rights reserved.