Topic overview
The national central banks or clearing houses publish the data of all banks in the country at regular intervals. This data can be used to enter new banks in the ERP system or to update the existing ones. This bank data is imported using the batch application Import bank data.
This document describes how the Import bank data batch application is structured.
Definition of terms
Batch application
A batch application is an application that is executed without interaction with a user. In Semiramis, a batch application can be opened either by a processing job, by a CORBA call or by another application.
Application description
The batch application Import bank data is used to import external bank data. The files published by the national central banks or clearing houses can be used as the source. The bank data import can be used for setting up a new OLTP database, but also for regularly updating bank data. It supports the creation, modification and deletion of bank data as well as succession and merger announcements.
The application can be started once for each OLTP database and each country.
Parameters
The batch application Import bank data has the following parameters:
| Parameter | Explanation |
|---|---|
| Country | Select the country for which the bank data is to be imported. The following options are available: - Germany - Austria - Switzerland Note: A national central bank generally only serves the banks of the respective country. |
| Data supplier and format | Select the central bank or clearing house from which the bank data should be used. The following data providers and formats are available: - German Bundesbank, ASCII text, fixed record length - Austrian National Bank, CSV text - SIX Interbank Clearing, ASCII text, fixed record length |
| Bank identification | Specify which identification number is to be used for the imported banks. The following options are available: - Identification at the data provider - National bank identification extended by branch identification If the national bank identification is contained in several entries of the import file, it is extended by the identification of the bank branch. |
| Import quantity | Specify which bank data is to be imported from the source file. The following options are available: - Changed banks - Deleted banks - New banks - Banks that have not been changed Note: Please note that the data refers to the previous version of the file provided by the Bundesbank. If the previous version was not imported, the import scope may not meet your expectations. You can only specify the scope of the import if the data provider provides information on the change status. Otherwise the field is not ready for input. |
| Only bank main office | Use this function to specify whether only the bank data of the bank centers that manage the sort code are imported. If the function is deactivated, the bank data of the associated branches is also imported. Only the bank centers are relevant for payment transactions. |
| Encoding type | Enter an existing coding type. The coding types are recorded in the "Coding types" application. If the bank identification at the data provider provides for a region code, the coding type is used to determine this code. |
| Delimitation prefix | Enter a prefix to be placed in front of the bank identification. For example, you can use this prefix to distinguish automatically imported bank data from manually entered data. |
| Download address | Enter the full URL where the bank data file of the data provider can be downloaded. |
Import section
| Parameter | Explanation |
|---|---|
| File path and name | If you have entered a download address, enter the file path to the directory in which the downloaded file is to be stored. If you have not entered a download address, enter the path and name of the file to be imported. Enter the path according to the following scheme: "file:///" or "kstore://". |
| Filter | Enter a filter for the automatic import. The filter must be set for the business entity "com.cisag.app.fincancials.obj.Bank". The application only supports filters with the language setting "Monolingual". If you do not enter a filter, the default filter for this business entity is used with all attributes, the language setting "Monolingual" and the time format "Compact form". |
| Warnings | Specify how any warnings that occur during the import process should be handled. |
| During succesful import | When import is complete Specify whether the source file is deleted after the import. The following options are available: - Leave source file The source files are not deleted after the import. - Delete source file, leave if aborted The source files are deleted after the import. If the import is canceled before the source file has been fully processed or an error occurs when creating the error file, the source file is not deleted. |
| Logging level | Specify whether logging is to be switched on during the import process. The following options are available: - No logging - Logging activated |
Error correction import section
| Parameter | Explanation |
|---|---|
| Error file | Enter a name for the error file. You can enter the error file as an absolute URI with the scheme "file:///" or "kstore://" and a path or just a file name. path or just a file name. If you only enter a file name, the error file is created in the folder in which the source file is stored. |
| Correct | The following options are available: - Do not correct - With workflow On the basis of the event"com.cisag.pgm.bi.ImportRunCompleted", an activity can be generated that opens the "Import data" application. If workflow management is not activated, the data is not corrected. The value of this setting is always assigned to the "CorrectionMode" parameter of the event "com.cisag.pgm.bi.ImportRunCompleted" event. This allows you to decide in an activity definition whether and in which cases activities are actually generated. |
Properties
The following Java properties must be specified to configure the Internet connection via a proxy server:
- -http.proxyHost
- -http.proxyPort
If the proxy requires authorization, the following properties must also be specified:
- http.proxyUser
- http.proxyPassword
Workflow
Deleted banks
A where-used list is generated for banks with the status Deleted. If the bank is used, an event is generated and the relevant bank is transferred as a parameter. If the bank is not used, it is given a deletion indicator.
Event: com.sem.ext.app.bankimp.NationalBankIdDeleted
Parameter
| Name | Value |
|---|---|
| Bank | Object of type com.cisag.app.financials.obj.Bank |
Errors when importing bank data
If errors occur during the import, e.g. because the internet connection cannot be established, a workflow event is triggered. The event indicates that the bank data could not be imported or that errors occurred during the import. The country for which the import failed is transferred as a parameter.
Event: com.sem.ext.app.bankimp.BankImportFailed
Parameter
| Name | Value |
|---|---|
| Country | Object of type com.cisag.app.general.obj.Country |
Data providers
Austrian National Bank
The Austrian National Bank provides a daily updated file of banks registered in Austria on its homepage. The data is provided as a zipped CSV file.
A data record consists of the following fields, which are separated by a semicolon:
| No. | Name | Content | Attribute |
|---|---|---|---|
| 1 | Category | "Main office", "Branch office", "Branch" | Note: "Main institution" corresponds to the bank head office |
| 2 | Identity number | Numeric (5-7) | Bank.bankId(20) (see section "Determining the bank identification") |
| 3 | National bank code | Numeric (5) | Bank.localBankIdentification(20) (see section "Determining the bank identification") |
| 4 | Bank type | "KI", "ZW", "WS", empty | None |
| 5 | Sector | Alphanumeric | None |
| 6 | Company registry number | Alphanumeric | None |
| 7 | Name | Alphanumeric (80) | Bank.name (65) Note: Only the first 65 characters are transferred. |
| 8 | Street | Alphanumeric (40) | Bank.AddressData.street(256) |
| 9 | Postal code | Numeric (4) | Bank.AddressData.postalCode(5) |
| 10 | Place (city) | Alphanumeric (40) | Bank.AddressData.city(256) |
| 11 | District | Alphanumeric (25) | Bank.AddressData.district (256) |
| 12 | Postal address,street | Always empty | None |
| 13 | Postal address, postal code | Numeric (4) | Bank.AddressData.poBoxPostalCod e(16) |
| 14 | Postal address, city | Alphanumeric (40) | Bank.AddressData.poBoxCity(256) |
| 15 | Post office box number | Numeric (10) | Bank.AddressData.poBox(64) |
| 16 | Region (federal state) | Alphanumeric (20) | Bank.AddressData.region(3) Note: The mapping is carried out using a coding type defined for the bank import (see section "Parameters") |
| 17 | Telephone | Alphanumeric | None |
| 18 | Fax | Alphanumeric | None |
| 19 | Alphanumeric | None | |
| 20 | BIC (SWIFT-Code) | Numeric (8) | Bank.bic(11) |
| 21 | Homepage | Alphanumeric | None |
| 22 | Founding year | None | |
| 23 | Legal entity identifier | Alphanumeric | Bank.mainBank(guid) „Legal Entity Identifier“ Used for mapping the "main office" |
Determining the bank identification
Depending on your selection in the Bank identification parameter, the bank identification is made up as follows:
- Identification at the data provider: Identity number (field 2)
- National bank identification extended by branch identification: National bank code (field 3) and extended by Identity number (field 2)
If an accrual prefix has been entered, this is placed in front of the bank identification.
German Bundesbank
The bank sort code file is created by the Deutsche Bundesbank four times a year and becomes valid on the Monday following the first Saturday in the months of March, June, September and December. The file contains the data of all valid and deleted bank sort codes on the respective closing date.
The ASCII text file provided by the Bundesbank with the following format is supported as the source for the bank data import:
| No. | Content | Digits | Attributes (maximum number of digits, if applicable) |
|---|---|---|---|
| 1 | Bank code | 8 | Bank.localBankIdentification(20) (see section "Determining the bank identification") |
| 2 | Characteristic, whether payment service provider with bank code ("1") or not ("2") | 1 | 1: Bank.mainBank= null 2: Bank.mainBank= bank leading bank with the same bank code (GUID) |
| 3 | Name of the payment service provider (without legal form) | 58 | Bank.name(65) |
| 4 | Postal code | 5 | Bank.AddressData,postalCode(16) |
| 5 | City | 35 | Bank.AddressData.city(256) |
| 6 | Short name of the payment service provider with city (without legal form) | 27 | 27 Bank.shortName(40) |
| 7 | Institution number for PAN | 5 | Bank.pan(5) |
| 8 | Bank Identifier Code (BIC) | 11 | Bank.bic(11) |
| 9 | Indicator for check digit calculation method | 9 | None |
| 10 | Number of the data record | 6 | See section "Determining the bank identification". |
| 11 | Change indicator (with regard to the previous file) - "A" (addition) for new, - "D" (Deletion) for deleted, - "U" (Unchanged) for unmodified, - "M" (Modified) for modified data records | 1 | With the value "D", the status (Bank.sem_bankimp_status) is changed to "Deleted". In other cases, the status is "Released". |
| 12 | Reference to an intended deletion of a sort code: "0" (no entry), "1" (sort code in field 1 is intended for deletion) | 1 | If the value is "1", the status is changed to "Deletion announced". |
| 13 | Reference to successor bank sort code. The field contains either the value "00000000" (bank sort code is not intended for deletion or the payment service provider has not published a successor bank sort code) or the successor bank sort code. | 8 | Bank.sem_bankimp_succeedin gBank (guid), if the field contains a bank code (not equal to "00000000") is contained |
Determining the bank identification
Depending on your selection in the Bank identification parameter, the
If an accrual prefix has been entered, this will be placed in front of the bank identification.
SIX Interbank Clearing
The Swiss National Bank (SNB) provides the bank sort codes registered in Switzerland on the SIX Interbank Clearing homepage.
An ASCII text file with the following format is supported as the source for the bank data import:
| No. | Description | Content | Attributes |
|---|---|---|---|
| 1 | Bank group | Numeric, 1-9 | None |
| 2 | Bank clearing number (bcn) | Numeric, 3-5 digits | Bank.localBankIdentification(20) (see section "Determining the bank identification") |
| 3 | Subsidiary number | Numeric, "0000"= bank headquarters | See section "Determining the bank identification" |
| 4 | New bank clearing number (new bcn) | Numeric, 3-5 digits; if not empty, then bank identification from field 2 was set with the specified | Bank.sem_bankimp_succeedingB ank(guid)= "New bank clearing number "+0000 The status of the bank is changed to "Succession/merger announced" if the field is not empty. Otherwise the status is set to "Released". |
| 5 | SIC number | Numeric | None |
| 6 | Headquarter bcn | Numeric | Bank.mainBank(guid)= "Headqua rter bcn "+0000 |
| 7 | Bank clearing type | 1= Headquarters 2= Head office 3= Branch | 1: Bank.mainBank= null 2/3: Bank.mainBank= "Head- quarter bcn "+0000 (guid) |
| 8 | Record is valid from | Date | None |
| 9 | Clearing participation code for CHF | Numeric | None |
| 10 | Clearing participation code for EUR | Numeric | None |
| 11 | Language code for short description and name | 1= German 2= French 3= Italian | None |
| 12 | Short description | Alphanumeric (15) | Bank.shortName(40) |
| 13 | Name | Alphanumeric (60) | Bank.AddressData.street(256) |
| 14 | Street | Alphanumeric | Bank.AddressData.street(256) |
| 15 | Post box | Alphanumeric (25) | Bank.AddressData.poBox(256) |
| 16 | Postal code | Numeric (10) | Bank.AddressData.postalCode(16) |
| 17 | Place (City) | Alphanumeric (35) | Bank.AddressData.city(256) |
| 18 | Telephone | Alphanumeric | None |
| 19 | Fax | Alphanumeric | None |
| 20 | International dialling code | Alphanumeric | None |
| 21 | Iso country code | lpha, only foreign country, e.g. "AT", "DE", "GB", "LI"; empty= "CH" | Bank.AddressData.Country.isoCode Only Swiss banks are accepted during import. |
| 22 | Post account number | Alphanumeric | None |
| 23 | SWIFT code (international bic) | Alphanumeric, only for head offices and central offices (14) | Bank.bic(11) |
Deleted banks cannot be read from the file or can only be read implicitly; the bank clearing number may be changed to 00000. The bank data is usually retained for up to 2 years.
Determining the bank identification
Depending on the Bank identification parameter, the bank identification is made up as follows:
- Identification at the data provider: Bank clearing number (field 2)
+Subsidiary number (field 3)
- National bank identification extended by branch identification: Bank clearing number (field 2) extended by Subsidiary number (field 3)
If an accrual prefix has been entered, this is placed in front of the bank identification.
Customizing
The following setting in the Bank data import function in the Customizing application is relevant for the Import bank data application:
- Data provider and format – only the selected data providers can be used to import bank data.
Business entities
The following business entity is relevant for the Import bank data application, which you use, for example, to
- Assign authorizations,
- set up activity definitions or
- import or export data.
Bank
com.cisag.app.financials.obj.Bank
Authorizations
Authorizations can be assigned both with the help of authorization roles and by assigning an organization. The authorization concept can be found in the technical documentation Authorizations.
Special capabilities
There are no special capabilities for the Import bank data application.
Organization assignments
An organizational assignment is not required for the Import bank data application.
Special features
There are no special features for the Import bank data application.
Authorizations for business partners
The Import bank data application is not enabled for business partners.