Modifying the EBICS Server configuration file

The EBICS Server configuration.properties file contains a set of attributes that enable you to manage the EBICS Server connection to PassPort, Sentinel and Gateway tracking services. This file also enables you to set attributes for various exits.

Locating the configuration.properties file

The location of the configuration.properties file depends on the type of application server you are using.
This table shows the default file location, as installed by the Axway Installer:

Application server	configuration.properties file location
JBoss	<EBICS Server installation directory>/JBossServer/server/bankrechner/conf
WebSphere	In the /data/conf sub-directory of the EBICS Server installation directory. You can copy the file anywhere on the host, as long as the classpath indicates its location. Alternatively, you can define the environment variable "configurationPath" that contains the full path to the configuration.properties file inside the WebSphere configuration.
WebLogic	In the /data/conf sub-directory of the EBICS Server installation directory. You can copy the file anywhere on the host, as long as the classpath indicates its location.

Application server

configuration.properties file location

JBoss

<EBICS Server installation directory>/JBossServer/server/bankrechner/conf

WebSphere

In the /data/conf sub-directory of the EBICS Server installation directory.

You can copy the file anywhere on the host, as long as the classpath indicates its location.

Alternatively, you can define the environment variable "configurationPath" that contains the full path to the configuration.properties file inside the WebSphere configuration.

WebLogic

In the /data/conf sub-directory of the EBICS Server installation directory.

You can copy the file anywhere on the host, as long as the classpath indicates its location.

Configuring EBICS Server for Sentinel tracking

Set the following properties of the configuration.properties file to enable the sending of event notifications to Sentinel.

Property	Enter value
useSentinel	Activate or deactivate Sentinel tracking: false: (default) No Sentinel tracking true: Sentinel for tracking activated
trackingOptions	Use this property only if the "useSentinel" value is set to "true". Should contain either or both of the values: TRANSFER (use with XFBTransfer Tracked Object) USER_INIT (use with EBICSINI Tracked Obejct) USER_INIT will only work partially if the EBICS Server is not PassPort enabled. When you use both values, separate the values with a comma. Example: trackingOptions=TRANSFER,USER_INIT
Sentinel_hostname	Hostname of the Sentinel Server. Default = localhost Change if useSentinel is set to true.
Sentinel_port	Notification port of the Sentinel Server (auto port). Default = 1305 Change if useSentinel is set to true.
EbicsLocalSite	Enter an alias for the EBICS Server. When the EBICS Server generates notifications for Sentinel, it uses this value in the LOCATION attribute of the XFBTransferevent message. If it does not locate this value, the value defaults to the hostname of the EBICS Server configuration.
EbicsServerVersion	This value is set by default to the to the correct version for the current release. When the EBICS Server generates notifications for Sentinel, it uses this value in the MONITORVERSION attribute of the XFBTransferevent message. It is mainly intended for use by Axway Support, in the event of operating incidents.
TrackedObjectName	Name of the Sentinel Tracked Object to be used for tracking. Enter one or both of the following: XFBTRANSFER EBICSINI
TrackedObjectVersion	Version of the Sentinel Tracked Object. For detailed information about Sentinel tracking services, refer to the Axway Sentinel documentation.
overflowFile	Pathname of the overflow file. The EBICS Server must be granted write permission for this file. If the pathname is empty, the overflow file is not defined.
overflowFileMaxLength	Maximum allowed file length for the overflow file (in Megabytes). If the overflow file is full, new events will be lost.

Configuring EBICS Server for Gateway tracking

Set the following properties of the configuration.properties file to enable tracking in Gateway.

Property	Enter value
useGateway	Activate or deactivate Gateway tracking: false: (default) No Gateway tracking true: Gateway tracking activated
p_home_dir	Gateway installation directory. Change if useGateway is set to true.
mft_home_dir	FEX_Ebics_Windows_MFTServer installation directory. Change if useGateway is set to true.
client_home_dir	EBICS Client installation directory

Configuring the EBICS Server connection to PassPort

If you have deployed a version of the server EAR that enables PassPort security services (PassPort PS), or if you use PassPort AM for user registry, set the properties of the configuration.properties file to enable exchanges with PassPort. The values in this file must match the PassPort server configuration.

Property	Enter value
Properties for PassPort PS and PassPort AM:
passport_hostname	PassPort server hostname
passport_PS_Port	PassPort PS server port number Default=7000
passport_Port	PassPort server port number
passport_username	PassPort user id used to connect to the PassPort server. This user must exist in the PassPort registry. Default=system
passport_pwd	PassPort user password. This password must be the one of the PassPort connection users. The password can be encrypted by the Encryptor tool. Default=System01
passport_pwd_enc	The encryption algorithm: NONE, AES or B64. If any other value is entered, the password is considered as a clear password. For more information about encrypting the password, see Encryptor command line.
Properties for PassPort PS only:
passport_PS_ssl	Enable or disable SSL connectivity for PassPort PS. Possible values: TRUE or FALSE.
certPSLocation	Path to the JKS trustore (truststore) for PassPort PS SSL connectivity.
keyStorePSPassword	Password to the JKS trustore for PassPort PS SSL connectivity. Note: The password encryption depends on the value of the property "passport_pwd_enc".
Properties for PassPort AM only:
passport_log_file	Path of the PassPort API log file. Example: C:\\Axway\\Ebics\\server\\bankrechner\\log\\api.log
passport_log_level	Log level of the PassPort API log file. Refer to log4j level for possible values. Example: LEVEL.DEBUG
passport_max_file_size	PassPort API log file size. Example: 10MB
passport_appender	Use/do not use concatenation for PassPort API log file. Example: false
passport_max_backup_index	Maximum number of files. Example: 1
passport_default_domain	Default PassPort user domain to use if, during the login, no domain is specified. If a domain is specified during the login (domain/login), then the value set in this parameter is ignored. Note: This value is case sensitive.
passport_AM_ssl	Enable or disable SSL connectivity for PassPort AM. Possible values: TRUE or FALSE.
certAMLocation	Path to the JKS trustore (truststore) for PassPort AM SSL connectivity.
keyStoreAMPassword	Password to the JKS trustore for PassPort AM SSL connectivity. Note: The password encryption depends on the value of the property "passport_pwd_enc".

Generating a new trustore

When implementing connectivity between EBICS and PassPort, you may need to generate a new trustore (truststore).

Configuring exits

Configuring the file copy exit for the PSR Axway handler

To use the PSR file copy exit, set the following properties of the configuration.properties file:

Property	Enter value
PSRexit_class	Name of class Example: SampleExit
PSRexit_jar_file	Path to JAR file containing the class Example: C:\\sample.jar

Property

Enter value

PSRexit_class

Name of class

Example: SampleExit

PSRexit_jar_file

Path to JAR file containing the class

Example: C:\\sample.jar

Configuring the file copy exit for the Axway Generic Fetch Transaction handler

To use the Axway Generic Fetch Transaction file copy exit, set the following properties of the configuration.properties file:

Property	Enter value
exit_class	Name of class Example: SampleExit
exit_jar_file	Path to JAR file containing the class Example: C:\\sample.jar

Property

Enter value

exit_class

Name of class

Example: SampleExit

exit_jar_file

Path to JAR file containing the class

Example: C:\\sample.jar

Configuring the EBICS exit that handles the PSR

The exit handler for PSR allows you to have a specific behavior when a PSR is called.

To use the EBICS exit that handles PSR order type, set the following properties of the configuration.properties file:

Property	Enter value
PSRexit_class	Name of class
PSRexit_jar_file	Absolute path to JAR file containing the class

Configuring the EBICS exit that handles the PSR-per-user

The exit handler for PSR-per-user allows you to have a specific behavior when a PSR-per-user is called.

The exit for PSR-per-user is only called when the Customer user PSR with exit fetch handler is used.

To use the EBICS exit that handles PSR-per-user order type, set the following properties of the configuration.properties file:

Property	Enter value
CUPSRexit_class	Name of class
CUPSRexit_jar_file	Absolute path to JAR file containing the class

Configuring the EBICS exit for file copy

To use the EBICS exit that handles file copy, set the following properties of the configuration.properties file:

Property	Enter value
exit_class	Name of class
exit_jar_file	Absolute path to JAR file containing the class

Advanced EBICS Server configuration

Show/hide Servlet version

To show/hide the EBICS Server version in the servlet (https://yourserverhost:yourportnumber/ebics/EbicsServlet ), set the following property in the configuration.properties file: