Implementation > EBICS > EBICS Server > EBICS Server tools > Injector

Injector

Overview

Prerequisites

How does it work?

Basic settings

Sentinel settings

Gateway settings

Database settings

XML input file

Overview

The injector enables you to manage objects on the EBICS Server repository. You can create, delete and update server objects such as banks, customers, users, accounts, order types and so on, along with the associated links between them. The input is provided in an XML file.

Prerequisites

How does it work?

The injector is a standalone Java application that connects to EBICS Server and executes the updates as requested by the XML file provided as input.

The program runs only as long as it has data to process (to inject) from the input file. At the end of the procedure, the program ends and must be run again for further injection.

The script <INJECTOR_INSTALL_DIR>/scripts/injector.sh (or injector.bat for Windows platforms) enables you to start the injector.

The injector does not require stopping. It stops by itself at the end of each processing cycle.

Related logs can be found in <INJECTOR_INSTALL_DIR>/logs/injector.log.

Injection modes

There are two ways to feed the XML input file to the injector:

Note: The file specified on the command line overrides the one specified in the parameters.properties configuration file.

Basic settings

The injector requires some basic settings in order to access the EBICS Server. Configure the injector in the parameters.properties file in the block labeled "EBICS":

Property Description
ebics.server.host Hostname of the EBICS Server (or IP address).
ebics.server.port Port to connect to the EBICS Server (bootstrap port on WAS, http port for WebLogic).
ebics.server.type JBOSS, WAS or WEBLOGIC
ebics.server.user Username to log in to the EBICS Server.
ebics.server.pass Password to authenticate the EBICS Server.
ebics.server.usePassportAM Set to true if PassPort AM integration is used. Otherwise false.

In addition to the above settings, the password must be encoded according to the value of the general.encoding.type property whose values can be: NONE, AES, B64. For details, see Encryptor command line.

Sentinel settings

The injector can feed data into Sentinel. The configuration is done in the parameters.properties file in the conf directory, in the block labeled "Sentinel":

Property Description
sentinel.active Activate Sentinel connectivity or not (true or false).
sentinel.host Hostname (or IP) of Sentinel Server.
sentinel.port JBOSS, WAS or WEBLOGIC
sentinel.objectname Tracked object to use in Sentinel.
sentinel.objectvers Tracked object version.

If you want Sentinel connectivity to work, you must specify the following cylceid to be used on the command line after the -cycleid parameter: Injector.sh –in myInjectedFile.xml -cycleid cycleIdToUse

The injector fills in the following fields of XFBTRANSFER: cycleid, eventdate, eventtime, returncode, returnmessage

IsAlert, IsException and IsEnded can be set according to the termination status of the injection.

Gateway settings

The injector can have all its actions in Gateway to create a matching configuration. Such a configuration is defined in the conf directory in parameters.properties, in the block labeled "Gateway":

Property Description
gtw.active Activate the Gateway connector or not (true or false)
gtw.dir Directory to the root of the Gateway installation
gtw.interface.port Gateway port

Database settings

The injector can have all its actions in an external database repository (such as the one in the Generic Process).

When activated, the injector runs the following stored procedures at the appropriate time:

You also need to configure the access to the database in the parameters.properties file in the "BDD" section:

Property Description
bdd.active Activate the connectivity to the external database.
bdd.type MYSQL or ORACLE.
bdd.host Host to the database (or IP).
bdd.port Port to access the database.
bdd.user User to connect to the database.
bdd.pass Password to authenticate on the database.
bdd.instance Instance of the database to which to connect.

XML input file

To complete the XML input file, refer to the XSD file (schema.xsd) delivered in the conf directory of the injector hierarchy.

Note: The order of the elements in the xml is important. It must respect the XSD file.

Injector object actions

The following is a list of possible actions for each object in the XML input file:

Object Action
Banks/bank CREATE: Creating a new bank
UPDATE: Updating a bank
SELECT: Selecting the bank of the database. Reference to this object is made in the actions that follow. This is the case when updates need to me made to bank objects (customers, users, etc.) but not to bank properties
DELETE: Deleting the bank and all its associated objects (customers, users, etc.)
Banks/bank/account CREATE: Creating a new account
UPDATE: Updating an account
DELETE: Deleting an account
Banks/bank/fileFormat or Banks/bank/ebics/orderType CREATE: Creating a new fileFormat or orderType (FUL.xxxx ou HPB)
DELETE: Deleting a fileFormat or ordeType
Banks/bank/ebics/customer CREATE: Creating a new customer
UPDATE: Updating a customer
SELECT: Selecting the customer of the database. Reference to this object is made in the actions that follow. This is the case when updates need to be made to customer objects (users, etc.) but not to customer properties
DELETE: Deleting the customer
Banks/bank/ebics/customer/orderType or Banks/bank/ebics/customer/fileFormat CREATE: Creating a link between the orderType and the customer. The customer is authorized to use this orderType. The orderType must exist in the database (either already present or previously created).
DELETE: Deleting the link orderType – customer.
UPDATE: The link fileFormat (send) – customer is updated. It affects only the Send fileFormat. It does not effect the Fetch fileFormat.
Banks/bank/ebics/customer/account CREATE: Creating a link between the account and the customer. The account must exist in the database (either already present or previously created).
DELETE: Deleting the link account – customer.
Banks/bank/ebics/customer/user CREATE: Creating a new user
UPDATE: Updating a user
SELECT: Selecting the user of the database. Reference to this object is made in the actions that follow.
DELETE: Deleting the user
Banks/bank/ebics/customer/user/orderType or Banks/bank/ebics/customer/user/fileFormat CREATE: Creating a link between the orderType and the user. The user is authorized to use this orderType. The orderType must exist in the database (either already present or previously created).
DELETE: Deleting the link orderType – user.
UPDATE: The link fileFormat – user is updated. It affects only the Send fileFormat. It does not effect the Fetch fileFormat.

Supported values for Handler tag

The supported values for the Handler tag in the properties.xml file are:

Send

Fetch

Related topics

Encryptor command line

Installing EBICS Server: Start here

Specific application server configuration