Host Technical Reference / EBICS Hosts
Parent topic: EBICS Hosts

EBICS Command Reference

PUT

Send one or more files to the bank server.

PUT -DEL "source" OrderType=, 
[StartDate]=, [EndDate]=,[FileFormat]=, [CountryCode]=, 
[CustomParameters]=, name=value,...
-DEL
If PUT is successful, delete the local 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, the command uses the default outbox.
  • 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 ("...").
OrderType=,
This required parameter specifies the three-character code defined by the EBICS specification. The acceptable order types include the generic FUL or any supported upload request listed in Section 1 of Annex 2 to the Specification EBICS.
[StartDate]=, [EndDate]=
These optional parameters specify the start and end date, both of the form YYYY-MM-DD according to ISO 8601.  If a date range is specified, then both the StartDate and EndDate must be specified.   If the order type is not FDL or FUL, you can only specify StartDate-EndDate if CustomParameters is not specified.
[FileFormat]=,
The file format must be of the form <area>.<syntax_and_format>.<description>.  See Section 2 of the Annex 2 to the Specification EBICS.  Note that, while this parameter is only applicable to certain order types, it is required for the FUL and FDL order types.  Also, macros are allowed when FileFormat is used on the PUT command (Destination File context).
[CountryCode]=,
If you specify the FileFormat parameter, you can also specify an optional two-character country code.  All country codes should comply with the ISO 3166-1 standard, including the "exceptional reservations" category (for example, "EU" indicates European Union).
[CustomParameters],
This optional parameter can contain one-to-many generic key-value pairs, each separated by a semi-colon.  If the order type is not FDL or FUL, you can only specify CustomParameters if StartDate-EndDate are not specified.
name
HTTP parameter=value and header=value pairs

GET

Receive one file from the bank server.

GET –UNI|-APE "destination" OrderType=, 
[StartDate]=,[EndDate]=, [FileFormat]=, [CountryCode]=,
[CustomParameters]=, name=value,...
-UNI
Ensure the local filename is unique.
–APE
If local filename exists, append the file.
"destination"
Local destination 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, 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 ("...").
OrderType=,
This required parameter specifies the three-character code defined by the EBICS specification.   The acceptable order types include the generic FDL or any supported download request listed in Section 1 of Annex 2 to the Specification EBICS.
[StartDate]=, [EndDate]=
These optional parameters specify the start and end date, both of the form YYYY-MM-DD according to ISO 8601.  If a date range is specified, then both the StartDate and EndDate must be specified.   If the order type is not FDL or FUL, you can only specify StartDate-EndDate if CustomParameters is not specified.
[FileFormat]=,
The file format must be of the form <area>.<syntax_and_format>.<description>.  See Section 2 of the Annex 2 to the Specification EBICS.  Note that, while this parameter is only applicable to certain order types, it is required for the FUL and FDL order types.  Also, macros are allowed when FileFormat is used on the PUT command (Destination File context).
[CountryCode]=,
If you specify the FileFormat parameter, you can also specify an optional two-character country code.  All country codes should comply with the ISO 3166-1 standard, including the "exceptional reservations" category (for example, "EU" indicates European Union).
[CustomParameters],
This optional parameter can contain one-to-many generic key-value pairs, each separated by a semi-colon.  If the order type is not FDL or FUL, you can only specify CustomParameters if StartDate-EndDate are not specified.
name
HTTP parameter=value and header=value pairs

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.

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.

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 advanced command.

SCRIPT

See to SCRIPT command for information about this advanced command.

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