Sign in
< Back to User Guide Top

FASP host

The Fast and Secure Protocol (FASP) is a network-optimized proprietary data transfer protocol.

FASP does not expect any feedback on every packet sent. The recipient only need request those packets marked as lost.

fasp Configuration

  1. Click the Templates tab in the tree pane.
  2. If necessary, expand the Hosts tree in the Templates tab to find the host you want to use.
  3. Right-click the host and select Clone and Activate. 
    The entire pre-configured host branch (including a mailbox and actions) is copied and activated, the Active tab is selected in the tree pane, and the new active host is selected in the tree.  If necessary, you can append the new active host alias with a number to make it unique. 
    Note: The original pre-configured host remains in the pre-configured tree.
  4. Enter host-level configuration information.
    1. Click the new host in the tree pane.
    2. Enter host-level configuration information on the tabs in the content pane. See fasp Host.
    3. Click Apply to save your work.
  5. Enter mailbox-level configuration information.
    1. Click the mailbox under your host in the tree pane.
    2. Enter mailbox-level configuration information on the tabs in the content pane. See fasp Mailbox.
    3. Click Apply to save your work.
  6. Enter action-level configuration information.
    1. Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and select New Action.
    2. Edit action information on the tabs in the content pane. See fasp Action .
    3. Click Apply to save your work.
  7. Click Apply to save your work.
Important: If you leave any of these panels without clicking Apply, your work will not be saved. You can configure the native UI to prompt to you click Apply when changes are made. See Other system options. However, in the web UI, this is not valid. In the web UI, if you make updates to a host and then click a part of the product not related to a host, for example any of the buttons in the banner, the product will not prompt you to click Apply and your updates will not be saved.

fasp Host

A host's parameters specify its location and how it is reached.

fasp Host: General Tab

SSH Connection
Server Address
Either a fully qualified name (recommended) or an IP address for the host.
Port
The fasp command port. You can specify either a specific port number or -1 to indicate the default port for fasp (22).
Connection Type
The kind of connection you want to use for this host.
Possible values:
  • System Default - See for information about setting the system default.
  • Direct Internet Access or VPN -
Default value: System Default
UDP Connection
Port
Specifies the fasp data port and can be either a specific port number or -1 to indicate the default port for fasp (33001).
Forward Proxy
The address of the forward proxy you want to use for this host.
Select the System Default check box to use the default proxy. See Configuring for a proxy for information about specifying a default proxy.
Default Directories
Modify the default directories, if necessary.  You can use macro variables from the drop-down lists.  See Using Macro Variables for a list of the applicable macros (Default Host Directory context) and example usage.  For the Cleo VLTrader and Cleo Harmony applications, see URI File System interface overview for information about you can use a Cleo-provided or custom URI for the Inbox and/or Outbox.  See Specifying default host directories for information about setting up system-level directories and custom directory macro variables.
Note: If the host has an external association, the default directories might be managed outside of Cleo Harmony, Cleo VLTrader and Cleo LexiCom, and not shown here.
Inbox
Default directory for incoming files. Enter a value directly or click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: inbox\
Outbox
Default directory for outgoing files. Enter a value directly or click … to navigate to and select a directory.
Possible values: Any local or shared directory.
Default value: outbox\

fasp Host: Advanced Tab

See Setting advanced host properties for information about how to use and set the properties supported in all protocols. Properties available for fasp include:

Add Mailbox Alias Directory to Inbox
Appends a subdirectory at the end of the host's configured inbox directory.  This allows files received through different  mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Add Mailbox Alias Directory to Outbox
Appends a subdirectory at the end of the host's configured outbox directory.  This allows files to be sent through different mailboxes to be kept separate.
Possible values: On or Off
Default value: Off
Allow Actions To Run Concurrently
Normally, actions and host actions within the same host are allowed to run concurrently. You can use this property to not allow actions and host actions to run concurrently.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: On or Off
Default value: On
Command Retries
If an error or exception occurs during a command, the number of times the command should be retried.
Note: Command Retries does not apply to exceptions related to TCP/IP or ISDN dial-up connections. This is because dial-up connections are managed by the framework so that they can be shared across actions.
Possible values: 0 - n
Default value: 0
Connection Timeout
The amount of time allowed for each read operation.
Possible values: 0 - n seconds

0 indicates no timeout

Default value: 150 seconds
Create Target Path
Create a target directory if it does not already exist.
Possible values: On or Off
Default value: Off
Delete Zero Length Files
Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
Possible values: On or Off
Default value: Off
Do Not Send Zero Length Files
Indicates whether zero length files to be sent to the server should be ignored rather than processed. If the -DEL option is being used, any zero length file ignored will also be deleted.
Possible values: On or Off
Default value: Off
Email On Check Conditions Met
Send an email notification after running a CHECK command where the overall conditions of the check are met.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Check Conditions Not Met
Send an email notification after running a CHECK command where the overall conditions of the check are not met. See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Fail
If an error occurs during a command, email the error condition.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Flag
If a flagged event occurs, email the event. See Configuring email or execute based on results.
Email addresses separated by commas (,), semicolons (;) or colons (:). The first address should be an internal email address.
Possible values: Email addresses separated by commas (,), semicolons (;), or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Repetitive Action Failures
When "Email On Fail" is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses emailing of the same alert multiple times.  If the same email alert continues to be suppressed after 24 hours, the suppressed email alert will be sent every 24 hours and after every system restart if the failure occurs again. When the failure is resolved an email alert will be sent.
Note: This feature only suppresses multiple emails if the same failure occurs multiple times in a row. Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Email On Successful Copy
Send an email notification after copying a file using LCOPY.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Receive
Send an email notification after successfully receiving a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Email On Successful Send
Send an email notification after successfully sending a file.  See Configuring email or execute based on results.
Possible values: Email addresses separated by commas (,), semicolons (;) or colons ( : ).  The first address should be an internal email address.
Default value:The value specified for this property on the Options > Advanced panel (if set).
Execute On Check Conditions Met
After executing a CHECK command where the overall conditions are met, run a system command.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Note: Note that if multiple files contribute to the conditions being met, and one of the file macros is in the command (e.g., %file%),  the system command will be executed repeatedly - once for each file.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Check Conditions Not Met
After executing a CHECK command where the overall conditions are not met, run a system command.  See Configuring email or execute based on results.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Fail
If an error occurs during a command, run a system command.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Repetitive Action Failures

When Execute On Fail is enabled and the same failure occurs each time an action is run for a specific host, leaving this option unchecked suppresses multiple executions of the Execute On Fail command.  If suppression of execution of the command for this failure continues after 24 hours, the suppressed Execute On Fail command will be executed every 24 hours and after a system restart if the failure occurs again.  When the failure is resolved, the Execute On Fail command will be executed again.  Users must account for this by including the %status% macro variable for the Execute On Fail command (see Using macro variables) and then checking for a success or failure.    

Note: This feature only suppresses multiple executions of the Execute On Fail command if the same failure occurs multiple times in a row.  Suppression is not maintained across synchronized hosts.
Possible values: On or Off
Default value: On
Execute On Successful Copy
After successfully copying  a file using LCOPY, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Successful Receive
After successfully receiving a file, run a system command.  This command may be used for post-processing the file.  SeeConfiguring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Execute On Successful Send
After successfully sending a file, run a system command.  This command may be used for post-processing the file.  See Configuring email or execute based on results.
Possible values: System command to be executed.
Default value: The value specified for this property on the Options > Advanced panel (if set).
Include Failure In Subject Of Email
When specified, the exception message will be included in the email that is generated on failure.
Note: If the exception message exceeds 256 characters, it will be truncated.
Possible values: On or Off
Default value: The value specified for this property on the Options > Advanced panel
LCOPY Archive
If specified, contains the directory for archiving LCOPY source files.
Possible values: Any local or shared directory. Macros can be used.  See Using macro variables (LCOPY Archive context).
Default value: The value specified for this property on the Options > Advanced panel, if any.
Log Individual LCOPY Results To Transfer Logging
When this option is enabled, a <send> and <receive> result is logged to the transfer log for each file copied.
Note: This is a Cleo Harmony and Cleo VLTrader option.
Possible values: On or Off
Default value: Off
Macro Date Format
Specifies the date format to be used when the %date% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
Macro Time Format
Specifies the time format to be used when the %time% macro is used.
Possible values: See Using macro variables for information about usage and possible date/time formats.
Default value: The value specified for this property on the Options > Advanced panel, if any.
Minimum Rate (kilobits/s)
The minimum desired transfer rate in kilobits per second (kbps).
Possible values: 0 - n
Default value: 0
Only Retrieve First Available File
Indicates a GET * should only retrieve the first available file from the server.
Possible values: On or Off
Default value: Off
Only Retrieve Last Available File
Indicates a GET * should only retrieve the last available file from the server.
Possible values: On or Off
Default value: Off
Outbox Sort
Controls the order in which multiple files are transferred for a PUT command.  If System Default is specified, the value set on the Configure > Options > Advanced tab takes precedence.  For Alphabetical ordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique.
Possible values:
  • System Default
  • Alphabetical
  • Date/Time Modified
Default value: System Default
Overwrite
Policy used to overwrite existing files at the destination. See Overwrite and Resume Check properties for more information.
Possible values:
  • Always - Always re-transfer the file.
  • Different - Overwrite only if the existing file is different.
  • Different and Older - Overwrite only if the existing file is both different and older.
  • Never - Do not overwrite - skip transferring the file.
  • Older - Overwrite only if the existing file is older.
Default value: Always
Partner Email Address
The email address of the trading partner for this trading relationship.  When set, this address is automatically used to send your local profile information and/or certificates to your trading partner. See Emailing a profile to your trading partner.
Possible values: Email address(es) separated by commas (,), semicolons (;) or colons ( : ). 
Note: This is a Cleo LexiCom only option. For Cleo Harmony and Cleo VLTrader, this information is stored in the trading partner management table. See Managing Trading Partners.
Policy
Transfer rate policy with respect to other simultaneous transfers.
Possible values:
  • Adaptive - Transfer using adaptive mode for being fair to other flows.
  • Fixed - Transfer using fixed mode for constant transfer at the specified rate.
  • Trickle - Transfer using trickle mode for utilizing unused bandwidth.
Default value: Adaptive
Post Get Command
Post Put Command

In an action, specify commands to be executed only after a successful GET or PUT as post-get or post-put commands, respectively.  When using this property, use a SET command within the action before the GET or PUT command rather than the Advanced tab.

The Post Put Command can be set to QUIT, which allows a disconnect and reconnect between file uploads when necessary.

If multiple FTP commands are needed after the GET or PUT, set this property to all of the commands separated by semicolons (;).  If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes (").  Use of macro variables is supported.  Refer to Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Pre Get Command
Pre Put Command
In an action, specify commands to be executed before a GET or PUT as pre-get or pre-put commands, respectively.  This has the benefit of keeping the log results relative to just GETs and PUTs (especially important for Cleo VLTrader and Cleo Harmony GETtransfer logging). In addition, for the PUT, it avoids connecting and logging into the server when there are no files to send.  When using this property, use a SET command within the action before the GET or PUT command rather than the Advanced tab.
If multiple FTP commands are needed prior to the GET or PUT, set this property to all of the commands separated by semicolons (;).  If a specific FTP command needs to contain a semicolon, enclose that specific FTP command in quotes (").  Use of macro variables is supported.  See Using macro variables (Post/Pre Command context) for a list of the applicable macros.
Pre Put Command For First File Only
If a Pre Put Command is specified, indicates whether to execute them before each file being transferred by the PUT or only before the first file transfer.
Possible values: On or Off
Default value: On
Preserve Dates
Preserve file date attributes.
Possible values: On or Off
Default value: Off
Resume Check
Resume policy used for partially transferred files. See Overwrite and Resume Check properties for more information.
Possible values:
  • File Attributes- If the sizes of both files match, do not re-transfer
  • Full Checksum - If the full checksums of both files match, do not re-transfer.
  • Off - Replace the file.
  • Sparse Checksum - If the sparse checksums of both files match, don't re-transfer.
Default value: Off
Retry Delay
The amount of time (in seconds) before a retry should be attempted.
Possible values: Any value greater than zero.
Default value: 60 seconds
Target Rate (kilobits/s)
The target transfer rate in kilobits per second (kbps). A value of zero uses the default Aspera rate, typically 10000.
Possible values: 0 - n
Default value: 0
Terminate On Fail
If an error occurs during a command, stop the action. 
Note:

Regarding non-CHECK commands:  When Terminate On Fail is on, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and then the action stops.  When Terminate On Fail is off, if a command fails, Email On Fail and Execute On Fail, if set, are processed, and the action continues.

Regarding CHECK commands:  Terminate On Fail is only honored if the ConditionsMet parameter is set and the result of the CHECK is classified as Error. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications.

Possible values: On or Off
Default value: On
Transport Encryption
Specifies the encryption cipher to be used on the UDP transport.
Possible values:None or AES128
Default value: None
Unzip Use Path
Indicates whether or not zip entry paths should be used for LCOPY -UNZIP operations.  When enabled, the entry's path is added to the destination path, unless the entry contains an absolute path. In this case, the absolute path is used in place of the destination path. 
Possible values: On or Off
Default value: On
Wait For Execute On
Indicates whether execution should wait for processing to complete within an Execute On Fail, Execute On Successful Copy,Execute On Successful Receive, or Execute On Successful Send command.  Note that this option does not apply to native AS400 execution.
Possible values: On or Off
Default value: On
Zip Comment
Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
Default value: The value specified for this property on the Options > Advanced panel, if set.
Zip Compression Level
Controls the level of compression for LCOPY -ZIP operations. If System Default is specified, the value set on the Configure > Options > Advanced takes precedence 
Possible values:
  • System Default
  • 9 - (Best Compression)
  • 8
  • 7
  • 6
  • 5
  • 4
  • 3
  • 2
  • 1
  • 0 - (No Compression)
Default value: System Default
Zip Subdirectories Into Individual Zip Files
Indicates whether or not subdirectories should be bundled for LCOPY –ZIP –REC operations.  When enabled, each first-level subdirectory (and all of its descendents) will be bundled together into an individual zip file.  The name of this zip file may optionally reflect the subdirectory name if an asterisk (*) is placed in the destination path.  Any files that are directly off the source root directory will not be copied. 
Possible values: On or Off
Default value: On
Overwrite and Resume Check properties

The values of the Overwrite and Resume Check properties determine whether the destination file is overwritten. The influence of each property is shown in the following table.

 
Overwrite Resume Check
Off File Attributes Full Checksum Sparse Checksum
Always Yes Yes Yes Yes
Different Yes ? ? ?
Different and Older ? ? ? ?
Never No No No No
Older ? ? ? ?

For combinations marked with ‘?’, the destination file is overwritten if the destination file is not identical according to the criteria selected.

fasp Mailbox

A mailbox's parameters allow access to the host system.

fasp Mailbox: fasp Tab

You can configure the fasp mailbox using a Password and/or one of two Public Key Authentication (PKA) methods. Your Trading Partner should specify the required type(s) of authentication necessary to access your account.

To use PKA, you must create your authentication certificate (see Creating and providing your signing/encryption certificates) and then export an SSH FTP key to send to your trading partner in either OpenSSH FTP Public Key or SSH FTP Public Key (IETF) format. See Certificate management and Exporting certificates. See also Private key authentication.

User Name
Password
Credentials for authentication to the remote server.
Use Public Key Authentication
Enables fields necessary to use public key authentication with a user certificate. See Private key authentication.
Certificate Alias
Certificate Password
Credentials used to access the user certificate for PKA.
Use Key From File
Enables fields necessary to use PKA with an existing SSH private key file. This option is only available when you select Use Public Key Authentication. See Private key authentication.
Private Key File
Private Key Password
Name of and the password protecting the SSH private key file to use for PKA.
Private key authentication

 

Private key authentication (PKA) allows you to connect to your Trading Partner's remote server without exchanging your password over the Internet. PKA uses two keys: a private key that only you have, and a public key placed on the accessing server, usually by your Trading Partner's system administrator when the account is set up. In the VersaLex application, the private key portion is maintained securely in a User Certificate protected with the Certificate Password. The Certificate Alias specifies the desired User Certificate to use for PKA.
Note: You must provide your Trading Partner with the corresponding SSH Public Key using the Certificate Manager. Using options Export >OpenPGP or SSH FTP Keys select either the OpenSSH FTP Public Key or SSH FTP Public Key (IETF) format. Do not select and send the SSH FTP Private Key format to your Trading Partner.

Alternatively, you can use an existing private key file. This file should be stored in a secure place and protected with a password. This feature is applicable only if you have an existing SSH private key for authentication with your Trading Partner and you are using JRE1.3. SSH private keys have no standard format. OpenSSH, SSH FTP Public Key (IETF), PuTTY, and ssh.com all have different proprietary formats. A private key generated with one cannot immediately be used with another. The VersaLex application supports both OpenSSH and SSH FTP Public Key (IETF) private key file formats. If the private key is in a format not supported by the VersaLex application, you should export if from the application that created it in an OpenSSH format. To determine the format of your key you can simply open it using a text editor and compare it to the partial example formats listed below.

Table 1. Supported Private Key Formats
Type Partial Example
IEFT (DSA)  
---- BEGIN SSHTOOLS ENCRYPTED PRIVATE KEY ----
Comment: 1024-bit DSA
Subject: John Doe
AAAACDNERVMtQ0JD3yrqcRRh1OwAAAFQof0uP52Ya5iOnuVm1+G+o9TpQwXrOQfjPp0w8+GQ9uJ7
IETF (RSA) 
---- BEGIN SSHTOOLS ENCRYPTED PRIVATE KEY ----
Comment: 1024-bit RSS
Subject: Jonh Doe
AAAACDNERVMtQ0JDEOMMw0wR0TwAAAEoUYoVJjvLn7lEnvusvbovpjscf1EDkJOMLX7HUddw8k9f
OpenSSH (RSA)  
-----BEGIN RSA PRIVATE KEY-----
MIICWwIBAAKBgQDzl7h/4lkzqSPR5GhpwYr5MmUL6IeiY9TAsA24dA3Xa45a0JIQ
 
OpenSSH (DSA)  
-----BEGIN DSA PRIVATE KEY-----
MIIBuwIBAAKBgQD42waNRIv7eJQoTR1PSQt+A2o8F9P1pGKLaLyw/rAg8N4FEHIN
Table 2. Unsupported Private Key Formats
Type Partial Example
PuTTY 
PuTTY-User-Key-File-2: ssh-rsa
Encryption: none
Comment: rsa-key-20070808
Public-Lines: 4
AAAAB3NzaC1yc2EAAAABJQAAAIBw8VeSCq0goiOwWqrlMu7H+N1QXAcBPdmvYttw
SSH.COM 
---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----
Comment: "rsa-key-20070808"
P2/56wAAAiwAAAA3aWYtbW9kbntzaWdue3JzYS1wa2NzMS1zaGExfSxlbmNyeXB0e3JzYS

fasp Mailbox: Packaging Tab

You can configure packaging when you want content protection (encryption at rest).

Encrypt Outbound
Encrypt the payload sent to your Trading Partner.
Decrypt Inbound
Decrypt the payload retrieved from your Trading Partner.
Password
The password required to encrypt or decrypt.

fasp Action

An action's parameters capture a repeatable transaction for your mailbox on the host system. 

fasp Command Reference

Note: Use of absolute remote paths is recommended and might be required. Relative remote paths might result in undesired operation unless the user configuration in your Trading Partner’s Aspera has an absolute path defined (non-default value).

PUT

Send one or more files to the host.

PUT -DEL -APE "source" "destination"
-DEL
If the PUT is successful, delete the local file.
-APE
Append file to existing destination file.
"source"

Local source path.

  • Path can be to a filename or to a directory.
  • * and ?, or a regular expression, are supported in filename. See Using wildcards and regular expressions for additional information.
  • If you specify a relative path, it 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
  • 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 ("...").

GET

Receive one or more files from the host

GET –DEL –UNI|–APE "source" "destination"
-DEL
If the GET is successful, delete the remote file.
-UNI
Ensure the local filename is unique.
-APE
Append to existing destination file.
"source"

Remote source path.

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 a relative path, it uses default inbox.
  • 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 (including file size, permissions, etc.) of available files from the host.

DIR "source" ["destination"]
"source"
Remote source directory path. If not specified, the current working directory applies.
"destination"
If not specified, the directory listing is logged rather than saved to a file. If specified, use “.” to indicate the current working directory.

LS

Get a listing of available files and directory names from the host

LS "source" ["destination"]
"source"
Remote source directory path. If not specified, the current working directory applies.
"destination"
If not specified, the filename listing is logged rather than saved to a file. If specified, use “.” to indicate the current working directory.

CD

Changes the current working directory on the host.

CD "directory"
"directory"
The new working directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

PWD

Returns the name of the current working directory on the host.

PWD

MKDIR

Creates a new directory on the host.

QUOTE MKDIR "directory"
"directory"
The name of the new directory. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

MV

Renames a file or directory on the host.

QUOTE MV "source" "destination"
"source"
The source file/directory to rename. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").
"destination"
The destination file/directory name. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

RM

Removes a file on the host.

QUOTE RM "path"
"path"
The path of the file or directory to remove. If the path contains a space, dash (-), comma (,), or equal sign (=), it must be enclosed with double quotes ("...").

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.

Related articles

Comments

0 comments

Please sign in to leave a comment.