About the purge command line tool
Configuring the purge command line tool
Using the purge command line tool
You can find the purge command line tool in the EBICS Server installation directory in the purge folder.
Execute the purge script from the purge/bin directory.
Before you can use the purge command line tool in a WebSphere or WebLogic environment, you must perform some additional configuration steps. For details, see Specific application server configuration.
The purge command enables you to purge the EBICS Repository from the machine where you install the client.
The purge operates on the following items:
The new syntax accepts all parameters as options on the command line.
This is the recommended syntax to use for the purge tool. It offers more possibilities than the older syntax. With this syntax, you do not need to complete the server.properties file.
Mandatory parameters (denoted by * in the table): The user (login), password, hostname and port parameters are mandatory. No purge can be run without these parameters being defined.
| * | Short option | Long option | Description |
|---|---|---|---|
| -b | --bank | Bank name. The Name field in the EBICS Server, neither HostID nor EbicsHostID here (only for send) | |
| -c | --customer | Customer name. The Name field in the EBICS Server, no HostID here (only for send). | |
| -ct | --connectionType |
Type of application server. Possible values:
|
|
| -enc | --encoding |
The algorithm used to encrypt the password. Possible values:
For more information about encrypting the password, see Encryptor command line. |
|
| -fth | --fetch | Performs all the purges related to fetches | |
| -fot | --fetchOrdertype | Fetch Order Type (e.g. FDL.camt.xxx.cfonb120.stm) | |
| -sot | --sendOrdertype | Send Order Type (e.g. FUL.pain.xxx.cfonb160.ddd) | |
| -fi | --fileImport |
If set, purges the import history table (purges hashes of imported files to handle duplicate files) |
|
| -fn | --fileName <file name> | If set, remove the entry with the specified file name from the hash file repository | |
| -f | --forever | Purges all data available | |
| -g | --gateway | Performs the purge of Gateway | |
| -gd | --gtwDir | Specify the Gateway installation directory | |
| * | -host | --hostname | Address of the server |
| -lck | --lock | Deletes the lock files in the data store | |
| -log | --log | Performs the purge on the logs | |
| * | -l | --login | User name to log in to the server |
| -md | --mftDir | Specify the MFT directory | |
| * | -pwd | --password |
Password to authenticate to the server. The password can be encrypted using the Encryptor tool. |
| * | -p | --port | Port of the server |
| -rf | --referenceId <refId> | If set, remove the entry with the specified reference id from the hash file repository | |
| -s | --send | Performs all the purges related to sends | |
| -n | --time | The number of days or months to keep | |
| -u | --unit | MONTH or DAY | |
| -am | --useAM | PassPort AM will be used if the option is set | |
| -z | --zipLocation | Specify the path to the zip archive location (ignored if nz or nozip is specified) | |
| -nz | --nozip | Do not perform a zip of the backup directory after a purge, and delete the backup directory |
A user can perform a purge on:
Bank and Customer parameters are only available for send.
If the bank does not exist, the send purge is not performed and a warning appears in the log file. If the customer or the order type does not exist, nothing happens.
The purge command line checks the input parameters:
These checks are performed to prevent the user from making a mistake. For example, without the checks, if the user wanted to make a fetch purge on bank (which is not possible) all the fetches would be purged regardless of the bank (ignored in this case).
The purge script returns the following return codes:
| Purge return code | Purge result |
|---|---|
| 0 | Success |
| 1 | Failure at API initialization |
| 3 | Failure during the purging of logs |
| 4 | Failure during the purging of the file import history |
| 5 | Failure during the purging of delivery information (removal from file-system of files related to send operations) |
| 6 | Failure during the purging of orders (removal from database of entries related to send operations) |
| 7 | Failure during the purging of Gateway |
| 8 | Missing argument in command-line |
The purge command line has been updated. To ensure backward compatibility, the old syntax and old configuration file have been kept.
In the conf directory of the purge tool, you must specify the environment of the EBICS Server in the server.properties file:
| Property | Value |
|---|---|
| host | Address of the server |
| port | Server port |
| conn | Type of server (JBOSS, WEBLOGIC or WAS) |
| user | User log in |
| pass | User password |
| useAM | Use PassPortAM or not (TRUE or FALSE) |
This syntax is now deprecated.
The general syntax of the purge line command is:
purge.[bat|sh] [argument 1] [argument 2]
| Argument | Enter | Description |
|---|---|---|
| [argument 1] | An integer | Defines the number of units of time (days or months) for which the results of processes are not purged from the EBICS repository. |
| [argument 2] |
One of the following:
|
Defines the unit of time (day or month) for which the results of processes are not purged from the EBICS Repository. |
purge.[bat.sh] 2 day
Purges the results of all processes on the EBICS Repository that are older than two days.