Descriptions of commands and their options, arguments, and parameters.
ATTR
Get attributes for a file on the connector
ATTR "source"
- source
-
Source directory path
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.
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.
DELETE
Remove a file from the connector
DELETE "source"
- source
-
Source directory path
DIR
Get a directory listing of available files from the host
DIR "source"
- source
-
Source directory path
GET
Receive one or more files from the host
GET [-DIR] [-DEL] [-UNI] "source" "destination"
- -DIR
- Get one or more files using a directory listing from the host.
- -DEL
- If GET is successful, delete remote file.
- -UNI
- Ensure local filename is unique.
- source
- Remote source path.
- destination
- Local destination path.
- Path can be a filename or a directory.
- If relative path, then uses the configured Inbox.
- Use of macro variables is supported. See Using Macro Variables
(Destination File context) for a list of the applicable macros.
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 to a filename or to a directory.
- If you specify a relative path, the command uses the user's home
directory.
- You can use * and ?, or a regular
expression when you specify a filename. See Using wildcards and regular expressions
for additional information.
- 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.
MKDIR
Make a directory on the connector
MKDIR "source"
- source
-
Source directory path
PUT
Send one or more files to the host.
PUT [-DEL] [-UNI|-APE] "source" "destination"
- -DEL
- If PUT is successful, delete local file.
- -UNI
- Ensure remote filename unique
- -APE
- Append to existing destination file
- source
- Local source path
-
- Path can be a filename or a directory.
- * and ?, or a regular expression, are supported in filename. See Using wildcards and regular expressions for additional information.
- If relative path, then uses the configured Outbox.
- Use of macro variables is supported. See Using macro variables (Source File context) for
a list of the applicable macros.
- destination
- Remote destination path. Use of macro variables is supported. See Using macro variables (Destination File context) for
a list of the applicable macros.
RENAME
Remove a directory from the connector
RENAME "source" "destination"
- source
-
Source directory path.
- destination
-
Destination path.
RMDIR
Remove a directory from the connector. This command recursively deletes the specified
folder and all its subfolders and included file.
RMDIR "source"
- source
-
Source directory path
SET
Change an action property value. The new value only affects the commands that
follow the SET.
Use the SET command to set both Advanced properties and Connector
properties. To set a Connector property, the scheme name must be used as a prefix. For
example, to set the EnableDebug property to true for an SMB
connector: smb.EnableDebug=True.
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
Note:
You can use the
SET command to override the values for
setbox and
receivedbox set
on the Connector Host
General tab using the
general.Sentbox and
general.Receivedbox properties. For example, to
set the
setbox to the
sentbox2
folder, use this
command:
SET general.Sentbox=sentbox2
To disable
setbox or
receivedbox, use the
%none%
macro. For example, to turn off the
receivedbox
folder, use this
command:
SET general.Receivedbox=%none%
To set these properties back to their host-level settings, use the
SET command without any values:
SET general.Sentbox=
SET general.Receivedbox=
SYSTEM
Execute a local system command.
SYSTEM "path"
- "path"
- Local command path with arguments.
WAIT
Pause execution.
WAIT seconds
- Seconds
- Number of seconds to pause.