Karaf configuration basics

General information about Karaf's own configuration and how to configure OSGi bundles can be found on the Basic Configuration of osgi-runner page in our Common Documentation space.

Configuring a DataSource for the MDA Database in the PID org.clazzes.jdbc.provider

The MDA server's database has to be configured as DataSource in the PID org.clazzes.jdbc.provider.

We suggest to use "MDA" as DataSource name, like this:

datasource.MDA.url = jdbc:sqlserver://mssql-server;databaseName=MDA
datasource.MDA.username = foo
datasource.MDA.password = bar
datasource.MDA.validationQuery = SELECT 1

More information about the Connection-Pool-Managing JDBC-Provider can be found at Clazzes.org: Multi-DataSource pooling with JDBC-Provider.

Configuring MDA Server Core in the PID at.iteg.mda.impl

The core configuration directives for MDA are in it's main PID, at.iteg.mda.impl.

Key	Description	Value Examples
adminGroupName	Name of authentication backend group for application level MDA Administrators	`mda-admins`
`datasourceName`	Name of the JDBC-Provider DataSource, like used above	`MDA`
`loginMechanism`	Authentication backend to use. See DomainPasswordLoginService implementations and backends for a full list of backend adaptors and their configuration.	`org.clazzes.login.ldap`
`deviceXMLParseMode`	For quality control the measurement tour files uploaded by measurement clients can be checked strict or loose. Production environments should always use `strict`. In case of unexpected refusal of measurement tour data, ITEG's support stuff can recover the file from the `tempDir`, fix and re-post it.	`strict`,`weak`
`readerGroupName`	Name of authentication backend group for measurement readers, i.e. the employees that actually take measurements. Those do not need to access the Web UI so far.	`mda-measurement-readers`
`tempDir`	Directory to place temporary files into. For debugging purposes, most imports, exports, and measurement round data are kept in this directory. To keep it managable, it is highly recommended to explicitly configure a dedicated directory.	`C:\Tmp\MDA`
`userGroupName`	Name of authentication backend group for MDA Officers. Those may use normal functions of the Web UI, like the managers of the local teams walking measurements tour.	`mda-officers`

In Active Directory environments, be sure to use the “account name” of the groups, not the display name if that differs, i.e. “mda-admins”, not “MDA Application Admins”.

Configuring MDA Server Web UI in the PID at.iteg.mda.web

The Web UI specific configuration directives for MDA are in a separate PID, at.iteg.mda.web.

Key	Description	Value Examples
`deliverUncompressed`	Usually all JavaScript code of the DOJO based HTML5 interface are delivered to the browser in one size optimized (but yet large) file. When debugging browser specific JavaScript problems it is far more convenient to deliver all `.js` components separately, by setting this directive to `true`.	`false`
`loginMechanism`	Authentication backend to use. See DomainPasswordLoginService implementations and backends for a full list of backend adaptors and their configuration.	`org.clazzes.login.ldap`
sessionTimeout	Timeout of HTTP session in minutes, i.e. the idle time after which a user has to login again.	`180`

Restart Karaf

For all configuration changes to apply it is now time to restart the Karaf service the OS's way.

First login

When Karaf is up again, after maybe 2 minutes, MDA's Web UI should be available at http://127.0.0.1:8081/mda-web/ (change 8081 to the HTTP port you chose for karaf).

Once a successful login is possible, the MDA server is installed, and you or an end user may contiue with MDA Server User Guide (English) resp. Benutzer-Handbuch MDA-Server (German).

Measurement clients (like our MDA Client for Android) may try to connect, but will fail to do anything useful before someone takes care of master data and tour definitions.