About the supplier command line tool
Configuring the supplier command line tool
Using the supplier command line tool
The supplier command line tool enables you to deposit data in the EBICS repository in a quick and easy way. This is useful if you want to supply a single file, for example for maintenance or testing.
For production usage, you should use the supplier service. The supplier service is an automated process that can handle several files at the same time.
The supplier command line tool is included in the EBICS Server installation. After installation, you can execute the script supplier/bin/supplier.sh or, on Windows platforms, supplier\bin\supplier.bat.
The command line tool is configured when you install EBICS Server. You can reconfigure the command line tool at any time by running the Axway Installer in Configuration mode.
Alternatively, you can modify the properties file <SUPPLIER_INSTALL_DIR>/conf/supply.properties manually. The following table describes the properties:
| Property | Description |
|---|---|
| database settings | To configure your database setting, see Database settings. |
|
security.encoding.active |
Activates (true or false) the encoding of the passwords. This property acts on both of the passwords provided in this file. For more information about encrypting the password, see Encryptor command line. |
|
security.encoding.type |
Sets the type of encoding used in this file (B64 or AES). For more information about encrypting the password, see Encryptor command line. |
| server.host | Host on which the EBICS Server is located |
| server.port | Port on which the EBICS Server is listening |
| server.user | User login for the EBICS Server |
| server.pass | Password to connect to the EBICS Server |
| server.type | Type of application server on which the EBICS Server is running (JBOSS, WL or WAS) |
Before you can use the supplier command line tool in a WebSphere or WebLogic environment, you must perform some additional configuration steps. For details, see Specific application server configuration.
The supplier command line tool enables you to execute command lines from the machine where you install the EBICS Server tools.
This section provides information about the principal commands you execute using the supplier command line tool.
For additional details about supplier commands, refer to the command help available in the command line interface.
The general syntax of the supplier line command is:
supplier.[bat|sh] --[parameter 1] --[parameter 2] –[parameter n]
| Parameter short name | Parameter long name | Value(s) |
|---|---|---|
| -am | --useAM | PassPort AM will be used if the option is set |
| -b | --bank |
<bankName> |
| -ct | --connectionType |
Connection type used to connect to the server. Possible values:
|
| -d | --date |
<date> The date of the supply operation |
| -f | --file |
<file> The file to supply |
| -ff | --fileFormat |
<fileFormat> The file format involved in the supply operation |
| -h | --help |
Display command line help for this command |
| -ib | --iban |
<iban> The IBAN involved in the supply operation |
| -l | --login |
<login> The login of the EBICS Server |
| -ot | --orderType |
<orderType> The order type involved in the supply operation |
| -p | --port |
<port> The port of the EBICS Server |
| -pwd | --password |
<password> The password of the EBICS Server. The password can be encrypted using the Encryptor tool. |
| -enc | --encoding |
<NONE|AES|B64> The algorithm used to encrypt the password. For more information about encrypting the password, see Encryptor command line. |
| -s | --supply |
If set, only the database will be updated |
| -sz | --size |
<size> The size of the supplied file |
| -szm | --sizeMode |
[check|fixed|compute] Sets the method to compute and size to fetch parameter |
| -hstid | --bankhostid | <ebicsHostId> Bank EBICS host-id. If both a bank name and a host-id are given, the host-id is used |
| -host | --hostname | <url> The URL of the EBICS Server |
| -r | --retries | <n> Number or retries (in case of lock file encounters) |
| -t | --timeout | <delayInMilliseconds> Time delay between retries (in milliseconds) |
| -rb | --rollback | If set, roll back last supply using provided parameters |
| -frb | --force | If set, roll back even if file was already fetched |
| -mrb | --multiplerollback | <n> Number of rollbacks to perform |
| -rbf | --rollbackFrom | <YYYYMMDD> Date from which to roll back |
| -rbt | --rollbackTo | <YYYYMMDD> Date to which to roll back |
Specific application server configuration
Installing EBICS Server (for details of EBICS Server options)
The Axway 5 Suite Installation and Prerequisites Guide (for information about Configuration mode)