End of transfer callback variables
The embedded EBICS Client is a process that runs continuously, waiting for Transfer Requests.
EBICS requests are defined as an XML file set inside the working/incoming directory.
During the processing of this file, the file will be moved from the incoming to processing then to the done directory, or to the error directory if an error occurs.
If an error occurs, the error description is added to the XML file for diagnosis purposes. Each error is tagged with the error date.
An incoming request may also contain a script name (and parameters) to be launched when the transfer is terminated, successfully or not. XML file requests contain several fields that allow to link to the origin of the transfer, being a Gateway reference or Sentinel notifications.
There are two XML schemas that define the XML request:
Samples of XML files are provided with the XML schema.
| Tag name | Description |
|---|---|
|
Send or Fetch |
Root tag of the XML request.
|
| Send@test or Fetch@test | Defines the transfer as being a test transfer. This information is sent to the EBICS Server as an OrderParam value. This information is used and relevant only for the OrderTypes FUL.* and FDL.*. |
| initialTransferReference | Identifies the transfer from the back office point of view. It is used to transfer the Gateway LocalId for Automated File Transfer. |
| bankName | Bank name |
| orderType | Order type. For example: FUL.camt.001.001.02 |
| customerId | Customer ID |
| countryCode | Country code |
| filePath | File name to read for a Send request or name to be used to write the Fetched data. |
|
userId |
Send: EBICS User name used to sign the transfer. There might be several user IDs for Send requests.
|
| systemID | User name that is used to transport the files without any signature responsibility involved. |
| SentinelReferences\TrackingObject | Sentinel reference of the EBICS Transfer |
| SentinelReferences\CycleId | Sentinel reference of the EBICS Transfer |
| orderParams\name | Name of each optional Order Parameter that is sent within the transfer |
| orderParams\value | Value of each optional Order Parameter that is sent within the transfer |
| fromDate | Starting date to retrieve data from. Time granularity is the day. Format is YYMMDD. |
| toDate | Ending date to retrieve data to. Format is YYMMDD. |
| Results\result\@date | Date of the error detection |
| results\result\ebicsReturnCode\errorSymbol | EBICS error as a Symbol defined inside the Standards, such as EBICS_INVALID_USER_STATE or EBICS_NO_DOWNLOAD_DATA_AVAILABLE |
| results\result\ebicsReturnCode\errorDescription | String description of the EBICS error |
| results\result\ebicsReturnCode\errorCode | Code of the error, such as 091004 or 090005 |
| results\result\stackTrace | Java Stack trace of the anomaly, for analysis purposes |
| endOfTransferCallBack | Program name and parameters to be launched at the end of the transfer. |
| originalReferences | Not currently used |
|
signatureFile |
Full path name of the externally-generated signature file of the transferred data.
|
The end of transfer script is launched in a process that has these variables defined.
Most of the variables are a copy from the initial XML request, some are the result of the transfer.
| Variable name | Description |
|---|---|
| EBICSVAR_TEST Y|N | Y if transfer is a test transfer. N otherwise. |
| EBICSVAR_BANK | Bank name |
| EBICSVAR_OP_* | Order parameters (optional) |
| EBICSVAR_FILEFORMAT | File format |
| EBICSVAR_ORIGINAL_CYCLEID | Cycle ID of the EBICS transfer |
| EBICSVAR_ORIGINAL_TRANSFERID | Identifier of the original transfer (Local ID of Gateway transfer) |
| EBICSVAR_TRACKINGOBJECT | Tracked Object of the EBICS transfer |
| EBICSVAR_FILENAME | Full path name of the data file |
| EBICSVAR_CUSTOMER | EBICS Customer ID |
| EBICSVAR_ORDERNUMBER | EBICS Order number of the generated transfer |
| EBICSVAR_ORDERTYPE | EBICS Order type |
| EBICSVAR_ERROR_CODE | 0 if no error. Different otherwise. |
| EBICSVAR_ERROR_MESSAGE | Error message |
| EBICSVAR_EBICS_ERROR_CODE | EBICS error code. Refer to EBICS standards specifications. |
Configuring Gateway for Electronic Signature
Configuring Gateway for Send and Fetch