Not all HTTP servers will support or require the full set of host commands allowed by VersaLex. At a minimum, the server must support PUT and/or GET. The underlying HTTP method that the command uses is dependent on the specific HTTP server. The following action commands are available in VersaLex:
Command | Purpose | Underlying HTTP method | |
---|---|---|---|
Host commands | CONNECT | Connect (log in) to the host | Always POST |
PUT | Send one or more files to the host | Either POST or PUT | |
GET | Receive one or more files from the host | Either POST or GET | |
PUT+GET | Send one or more files to the host and receive one or files from the host in return | Always POST | |
DIR | Get a directory listing of available files from the host | Either POST or GET | |
CONFIRM | Confirm, on the host, the receipt of one or more files | Always POST | |
DELETE | Delete one or more files on the host | Either POST or DELETE | |
Local commands | SET | Change an action property value | - |
CLEAR | Clears an action string property value | - | |
SYSTEM | Execute a local system command | - | |
WAIT | Pause | - | |
LCOPY | Copy one or more local files | - | |
LDELETE | Delete one or more local files | - | |
LREPLACE | Replaces bytes in one or more local files | - | |
CHECK | Check for a transfer, file, or directory (VLTrader and Harmony only) | - | |
SCRIPT | Execute a JavaScript File (VLTrader and Harmony only) | - |
HTTP Configuration
First activate either a trading partner specific host or the generic HTTP or HTTP/s pre-configured host (see below). The generic HTTP host provides an interface over non-secure HTTP. If interfacing to a server that requires use of the Secure Socket Layer (SSL) over HTTP, then the generic HTTP/s host must be used.
- Click the Templates tab in the tree pane.
- If necessary, expand the Hosts tree in the Templates tab to find the host you want to use.
- 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.
- Enter host-level configuration information.
- Click the new host in the tree pane.
- Enter host-level configuration information on the tabs in the content pane. See HTTP Host.
- Click Apply to save your work.
- Enter mailbox-level configuration information.
- Click the mailbox under your host in the tree pane.
- Enter mailbox-level configuration information on the tabs in the content pane. See HTTP Mailbox.
- Click Apply to save your work.
- For Cleo LexiCom users only: Enter trading partner configuration information.
- Click the new host in the tree pane.
- Enter trading partner configuration information on the Indentifier tab in the content pane. See HTTP Trading Partner.
- Click Apply to save your work.
- Enter action-level configuration information.
- Click an existing mailbox action to display its configuration tabs. Alternatively, right-click the mailbox and select New Action.
- Edit action information on the tabs in the content pane. See HTTP Command Reference.
- Click Apply to save your work.
- Click Apply to save your work.
HTTP Host
A host's parameters specify its location and how it is reached.
The product uses the information you provide in the General and HTTP tabs to build HTTP URLs when an action is run.
HTTP Host: General Tab
The product uses the information you provide in the General and HTTP to build HTTP URLs when an action is run.
- Server Address
- Either a fully qualified name (recommended) or an IP address for the HTTP host.
- Port
- The HTTP command port. You can specify either a specific port number or -1 to indicate the default port for HTTP (80) or HTTP/s (443).
- Connection Type
- The kind of connection you want to use for this host.
- Forward Proxy
- The address of the forward proxy you want to use for this host.
- 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 Harmonyapplications, 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 VersaLex applications and not shown here.
- Inbox
- Default directory for incoming files. Enter a value directly or click … to navigate to and select a directory.
- Outbox
- Default directory for outgoing files. Enter a value directly or click … to navigate to and select a directory.
- Sentbox
- If specified, default directory for retaining sent files. Files are a copy of the original source file; any file manipulations performed as part of the send are not reflected in the sentbox copies. Enter a value directly or click … to navigate to and select a directory.
- Receivedbox
- If specified, default directory for retaining received files. Files are a copy of the final destination file; any file manipulations performed as part of the receive are reflected in the receivedbox copies. Enter a value directly or click … to navigate to and select a directory.
HTTP Host: HTTP Tab
The product uses the information you provide in the General and HTTP to build HTTP URLs when an action is run.
- HTTP/HTTPs
- For HTTPs servers only.
- Check certificate server name
- Only available if you select
HTTPs
. Verifies that the server name in the received SSL server certificate matches the server name actually connected to. - Method
- Select a method for each command supported by the server. See HTTP and HTTP/s Hosts.
- The server might not require CONNECT (login) because:
- The server may not need to identify the client, or
- Instead, the other commands may have parameters that identify the client, or
- Over SSL, the server may make use of client certificates to identify the client.
- The server must at least support PUT and/or GET.
- If the server supports GET, it usually will support DIR; otherwise it is difficult to get files without first knowing which files to get.
- The server might support CONFIRM or DELETE (usually not both).
- The server might support REQUEUE.
- The server might not require CONNECT (login) because:
- Path
- Supply the server Path for each of the commands. Depending on the server implementation and the methods used, some or all the paths might be the same or some or all might be different.
- Parameters
- Headers
- Specify required and optional Parameters and Headers for each of the commands.
HTTP 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 HTTP or HTTP/s 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.
- 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.
- Add Mailbox Alias Directory to Receivedbox
- Appends a subdirectory at the end of the host's configured receivedbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- Add Mailbox Alias Directory to Sentbox
- Appends a subdirectory at the end of the host's configured sentbox directory. This allows files that have been sent through different mailboxes to be kept separate.
- 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.
- 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.
- Connection Timeout
- The amount of time allowed for each read operation.
- Delete Zero Length Files
- Indicates whether files received that are zero-length (<= 5 bytes) should be deleted rather than processed.
- Disable TE Headers
- When selected, disables the TE and Transfer Encoding request headers.
- 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. - 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.
- 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.
- Email On Fail
- If an error occurs during a command, email the error condition. See Email/Execute Based on Results.
- Email On Flag
- If a flagged event occurs, email the event. See Configuring email or execute based on results.
- 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.
- Email On Successful Copy
- Send an email notification after copying a file using LCOPY. See Configuring email or execute based on results.
- Email On Successful Receive
- Send an email notification after successfully receiving a file. See Configuring email or execute based on results.
- Email On Successful Send
- Send an email notification after successfully sending a file. See Configuring email or execute based on results.
- 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.
- 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.
- Execute On Fail
- If an error occurs during a command, run a system command. See Configuring email or execute based on results.
- 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. - 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.
- Execute On Successful Receive
- After successfully receiving a file, run a system command. This command may be used for post-processing the file. See Configuring email or execute based on results.
- 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.
- Fixed Record EOL Characters
- End-of-line characters to be inserted and/or deleted.
- Fixed Record Incoming Delete EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to look for and delete EOL characters while receiving a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- Fixed Record Incoming Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while receiving a file.
Fixed Record Incoming Delete EOL and Fixed Record Incoming Insert EOL are mutually exclusive properties.
- Fixed Record Length
- The fixed record length after which end-of-line characters need to be inserted and/or deleted.
- Fixed Record Outgoing Insert EOL
- If Fixed Record EOL Characters has been specified and Fixed Record Length is greater than 0, indicates to insert EOL characters while sending a file.
Note: When using FTP ASCII mode, standard EOL characters may already be changing if transferring between Windows and Unix platforms.
- Get Number of Files Limit
- Limits the number of files retrieved from a server directory listing by one GET command.
- High Priority
- Indicates whether incoming and/or outgoing transfers through the host should be treated as high priority. When both high priority and regular priority transfers are active, the high priority transfers get a larger portion of the available bandwidth. Go to
High Priority Transfers Percentage Available Bandwidth
(defaults to 75). See Other system options for more information.
to set the
- 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.
- LCOPY Archive
- If specified, contains the directory for archiving LCOPY source files.
- Log Full HTML PUT Response
- Allows the full HTML response from the server to be logged rather than just the return status.
- 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. - Macro Date Format
- Specifies the date format to be used when the
%date%
macro is used. - Macro Time Format
- Specifies the time format to be used when the
%time%
macro is used. - Maximum Incoming Transfer Rate (kbytes/s)
- Sets the maximum incoming transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of
0
does not limit the transfer rate. The Maximum Incoming Transfer Rate system setting might also limit the transfer rates. The system Maximum Incoming Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers also affects individual transfer rates. See Advanced system options. - Maximum Outgoing Transfer Rate (kbytes/s)
- Sets the maximum outgoing transfer rate in Kbytes (1024 bytes) per second for each mailbox or host. The default value of
0
does not limit the transfer rate. The system setting might also limit the transfer rates. The system Maximum Outgoing Transfer Rate value is used unless this setting is more restrictive. For simultaneous transfers, the number of active transfers will also affect individual transfer rates. See Advanced system options for more information about Maximum Outgoing Transfer Rate. - Next File On Fail
- When a download fails, indicates whether a wildcarded GET should proceed to the next available file rather than terminate if the server is still connected.
- Omit Name Parameter From Content Type
- When selected, the applicable file name is not included in the Content-Type header.
- Only Download If Directory Line Changed
- When selected, the application only downloads a file as part of a GET -DIR command if the server's directory entry for the file has changed since the last download. If you cannot delete a file off the server after it is downloaded AND the directory listing returns a file's last modified time/date and size, then this will prevent it from re-downloading the file.
For this property to work properly, the same action must be used for each download, as the previous directory listing is saved with the specific action.
- 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 tab takes precedence. ForAlphabetical
ordering, the file extensions are not used to determine the sorted order unless they are needed to make the filenames unique. - Outgoing Insert EOL Between Interchanges
- If
Fixed Record Outgoing Insert EOL
is active, indicates to also insert EOL characters between EDI interchanges while sending the file. - 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.
- PGP Compression Algorithm
- Compression method used when OpenPGP packaging (with compression) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Default
is specified, the value set on the tab is in effect. - PGP Encryption Algorithm
- Encryption method used when OpenPGP packaging (with encryption) is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. If
System Default
is specified, the value set on the tab takes precedence. - PGP Hash Algorithm
- Signing method used when OpenPGP packaging (with signing) is requested through the Configuring mailbox packaging. If
System Default
is specified, the value set on the tab takes precedence. - PGP Integrity Check
- When OpenPGP encrypting (see Configuring mailbox packaging), include an integrity check on encrypted data. Can be disabled for compatibility with certain OpenPGP implementation.
- PGP Signature Verification
- Indicates whether or not signed inbound PGP messages should verified when inbound OpenPGP packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging. In general, this property should be enabled.
- PGP V3 Signature
- Post Parameters On Request Line
- Indicates that web server does not accept POST parameters via application/form-data or application/x-www-form-urlencoded content-types but instead requires that the POST parameters be on the HTTP request line.
- Reset Connection After Timeout On Response
- When enabled will cause an immediate reset on the socket (instead of a graceful close) when a SocketTimeoutException occurs.
- Retry Delay
- The amount of time (in seconds) before a retry should be attempted.
- Reuse SSL Sessions Across Actions
- If selected, SSL sessions from previous connections to the same destination (address and port number) may be resumed to avoid costly negotiation. If unselected, only SSL sessions used in the current action to the same destination may be resumed. When unselected, a new SSL session is created for the initial command port connection.
- Server Type
- Indicates a specific HTTP server that requires special processing of the outbound message or the returned response.
- SSL Allow Legacy Renegotiation
- When selected, legacy renegotiation is allowed. If this property is not selected, the extension described in RFC5746 is used for renegotiation and the server must also support this extension. See RFC5746 for a description of the extension and the vulnerability it addresses.
- SSL Cipher
- Indicates a specific cipher to be used with the server for SSL key exchange, encryption, and hashing. If not set, the list of supported ciphers is presented to the server and the server picks one.
- SSL Maximum Protocol Version
- Specifies the maximum protocol version allowed. By default, this field is blank, designating that Cleo Harmony, Cleo VLTrader, or Cleo LexiCom will select the most recent version (currently TLS 1.2).
- SSL Minimum Encryption Key Size
- Specifies the minimum encryption key size allowed when selecting an SSL cipher. To prevent use of low- or medium-strength ciphers, change from the default value of
0
to112
,128
, or256
(depending on the requirement). Note that if this value is set too high, all ciphers are filtered out causing theNo suitable cipher suites are enabled
exception to occur. - SSL Minimum Protocol Version
- Specifies the minimum protocol version allowed. SSL 3.0 is the default value for compatibility with servers that do not support the more recent TLS versions 1.0, 1.1, and 1.2.
- SSL Use Record Splitting
- Indicates whether to use 1/n-1 record splitting in CBC mode as a countermeasure against the Rizzo/Duong BEAST (Browser Exploit Against SSL/TLS) attack against the SSL 3.0 / TLS 1.0 protocol. Must be turned off if the SSL library on the other side of the connection does not support the feature.
- Store Raw Sent Message
- When this property is enabled, a copy of the outbound message is stored in the HTTP/sent directory.
- Successful Put Response Phrase
- Even if the server response code is a 200 level response, if the configured phrase is not found anywhere in the content of the server response, the PUT is not considered successful.
- 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
andExecute On Fail
, if set, are processed, and then the action stops. WhenTerminate On Fail
is off, if a command fails,Email On Fail
andExecute On Fail
, if set, are processed, and the action continues.Regarding CHECK commands:
Terminate On Fail
is only honored if theConditionsMet
parameter is set and the result of the CHECK is classified asError
. The CHECK command is only available in the Cleo Harmony and Cleo VLTrader applications. - 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.
- 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.
- XML Encryption Algorithm
- The method used to encrypt/decrypt files when XML Encryption packaging is requested through the Mailbox Packaging tab. See Configuring mailbox packaging . If
System Default
is specified, the value set on the tab takes precedence. - Zip Comment
- Specifies the comment to be added to the zip archive file in LCOPY -ZIP operations.
- Zip Compression Level
- Controls the level of compression for LCOPY -ZIP operations. If
System Default
is specified, the value set on the takes precedence - 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.
HTTP Mailbox
A mailbox's parameters allow you access to the host system.
HTTP Mailbox: HTTP Tab
Specify default values for various command parameters and headers.
The parameters and headers listed are those identified in the host HTTP tab that have neither static values nor special %file and %dirassociations.
Provide Default Values for any of the parameters and headers for mailbox-level actions. Unless an overriding value is specified within the command in an action, these default values are used.
HTTP Mailbox: Authenticate Tab
If the target server requires WWW authentication, select the appropriate type and provide the required username and password and optionally realm.
HTTP Mailbox: Security Tab
The HTTP and HTTP/s radio buttons are read-only. They reflect the settings from the host HTTP tab.
If HTTP is selected, no further action is necessary on this tab.
If HTTP/s is selected, the target server can issue client certificates. In this case, import the client certificate using Certificate Manager (see Certificate management) and then specify (or browse for) the imported Certificate Alias and Password.
HTTP Mailbox: Packaging Tab
See Configuring mailbox packaging for information about payload file packaging.
HTTP Trading Partner
A trading partner's parameters define a unique identifier on the host system. Create a new trading partner under the host.
- Right-click the host in the active tree pane.
- Select New Trading Partner to create a new lower branch. Then, optionally, type a new alias in the content pane panel and clickApply.
HTTP Trading Partner: Identifier Tab
Trading partners are provided as a convenience. Rather than having to repeat the trading partner's identifier perhaps multiple times in various commands, the identifier can be specified once and the trading partner alias referenced as needed.
The trading partner alias is more human-readable and in the command dialog editor, trading partner aliases are available through pull-down menus.
HTTP Action
An action's parameters capture a repeatable transaction for your mailbox on the host system. Create a new action under the mailbox.
HTTP Action: Action Tab
Use the Action tab to configure commands within an action.
The commands specified on the host HTTP tab (plus the local commands) are available for use. See Composing an action and HTTP Command Reference.
If a parameter or header value on the host HTTP tab has been marked with the keyword %tp
, the value specified for the parameter or header in the action can be %trading partner
, where trading partner is the alias of one of the trading partners under the host (LexiCom) or a Trading Partner from the Trading Partners Table (VLTrader and Harmony). When the command is run, the trading partner's identifier is filled in for the value.
\s
must be used to represent the space within the command For example, %OPQ\scompany
represents %OPQ company
. This is done automatically in the dialog editor. If a space is left in the value, the command is not parsed correctly.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 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 in Cryptographic Services 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 home directory.
- See Using operating system commands in actions for additional information
WAIT
Pause execution.
WAIT seconds
- Seconds
- Number of seconds to pause.
Comments
0 comments
Please sign in to leave a comment.