Configuration

Config files

The following configuration files are processed by map.apps Smart Search Extension:

  • WEB-INF/classes/default-application.properties (DO NOT EDIT)
    This file contains all configuration options of map.apps Smart Search Extension with their default values.

  • WEB-INF/classes/custom-application.properties
    If you change the working directory data.directory.location, you must adjust this file. All other adjustments are made in the following file.

  • [data.directory.location]/application.properties
    Editing this file is the recommended way to make configuration changes.
    By default, ${user.home}/.mapapps is the working directory data.directory.location of map.apps and thus automatically of the map.apps Smart Search Extension. The application.properties is not created automatically. You can use the WEB-INF/classes/application.properties file as a template. It is recommended to leave only the settings in the file that have been changed.

The format of the configuration files must correspond to the Java Properties file format .

Sample Properties file
# The files must be UTF-8 encoded, otherwise umlauts can cause errors!
# The safest way is to encode umlauts in Unicode syntax e.g: รค = \u00E4 (vgl. http://0xcc.net/jsescape/)

# Comments are preceded by a hash

# Common syntax:
key = value

# A value can reference another key
key1 = http://${key.with.server}/test
After changing one of the configuration files a restart of the web application or alternatively the entire Tomcat server is required.

Configuration parameters

This section describes the parameters that most often need to be changed in a default installation. Other parameters are described in comments in the WEB-INF/classes/default-application.properties file.

Both the client and the server have these configuration files. The following list does not distinguish between them. Stick to the respective default-application.properties file to change the parameters for the respective web application.
data.directory.location

Working directory where map.apps data (e.g. an HSQL database) is stored locally.

In case the Tomcat server is run as a Windows service, the .mapapps directory is located in the user directory of the Tomcat user who started the service. Path separators must be specified as either / or \\.

Default: data.directory.location=$\{user.home\}/.mapapps

finder.service.url

Context name of the smart.finder server.

If the name was changed during the installation of the smart.finder Server, the current name must be entered here.

Default: /smartfinder-search

solr.solr.home

Directory path to solr.home.

The path can be specified absolute or relative. You can also use placeholders that are resolved by the Web Container.

Example:

solr.solr.home = ${catalina.base}/webapps/smartfinder-server/WEB-INF/solr.home
solr.default.core.name

The standard index of the server.

This index is used if no other index is specified during job creation in the job manager.

Default: core0

Security

security.mode

Security mode of the administrative section of the smart.finder.

Access to the administrative areas of the smart.finder is protected (default value: INTEGRATED). The ONLY_AUTHN mode can only be used in conjunction with security.manager Enterprise Edition . The IDENTITY mode can only be used in conjunction with Identity Service .

Please note additional parameters for the different modi.

Allowed values: INTEGRATED, IDENTITY, ONLY_AUTHN
Default value: INTEGRATED.

security.responseHeaders.common

List of HTTP headers.

To define a list of response headers, use the following syntax: <header-name>:<header-value>,<header-name>:<header-value>. The following applies:

  • <header-name> is the name of an HTTP header. It must begin with a capital letter.

  • <header-value> is the value of an HTTP header.

The headers are written to every response from the smart.finder backend service. The configuration should only be changed if there are special security requirements.

The following headers are added by default:

X-Content-Type-Options:nosniff

Defines that the browser may only interpret server responses on the basis of the Content-Type header.
You can find more detailed information at X-Content-Type-Options .

Strict-Transport-Security:max-age=604800

Defines that the browser should remember that the host may no longer be requested via HTTP for 7 days (604800 seconds).
Only works if map.apps is used via HTTPS. You can find more detailed information at Strict-Transport-Security .

Default value: X-Content-Type-Options:nosniff,Strict-Transport-Security:max-age=604800

Additional parameters for INTEGRATED mode

The 'INTEGRATED' mode can be specified in more detail using the following parameter set:

security.user.admin.name

Username in plain text.

security.user.admin.pw

Password of the user.

This must be described according to the selected encoding.

security.user.pwenc

Encoding of the password.

This can be plain (no coding) or by means of MD5 (Message-Digest Algorithm 5) or SHA-1 (secure hash algorithm). Some web services support the generation of MD5 or SHA-1 encrypted passwords.

Allowed Values: plain, MD5, SHA-1

security.user.use_mapped_pass

Specifies whether a password encoding other than plain has been selected.

Allowed Values: true, false

security.ssl.trustAny

Specifies whether self-signed certificates are supported for HTTPS connections.

Allowed Values: true, false
Default: false

Additional parameters for IDENTITY mode

The IDENTITY mode can be specified in more detail using the following parameter set:

security.login.base

Base URL of the identity service.

esri.api.arcgisPortalUrl

URL to the used ArcGIS Online organization. The value must match the configuration for security.oauth.provider.arcgis.url in the Identity Service.

Additional parameters for ONLY_AUTHN mode

The ONLY_AUTHN mode can be specified in more detail using the following parameter set:

security.administration.url

security.manager adminstration service location

security.keystore.location

Key Store Location. This is the path to the keystore (.keystore file) shared by security.manager and smart.finder

Mailing

mailing.host

Hostname on which an SMTP server is available for sending e-mails.

mailing.port

SMTP port on the SMTP host computer.

mailing.username

Username for the SMTP server.

mailing.password

Password for the SMTP server.

mailing.senderaddress

Reply address for e-mail dispatch.

mailing.locale

Language setting for sending e-mails.

Allowed Values: de, en

Logging

The following configuration parameters are available to adjust logging settings:

logging.logger.level

Level of detail of the log.

Allowed Values: TRACE, DEBUG, INFO, WARN, ERROR
Default: INFO

logging.output.location
Deprecated since 2.0.8
Use logging.file.location instead.
logging.file.location

Location where the log file is stored.

The default value corresponds to the logs directory of Tomcat. With the value ${data.directory.location}/logs the log file is created in the working directory of smart.finder.

Default: ${catalina.base}/logs

logging.file.prefix

This parameter defines the name of the log files.

To prefix log files with the URL context path of the smart.finder installation (for example smartfinder), use the value ${webcontext.name}.

Default: ct-smartfinder

Additional logging options are described in the default-application.properties file, for example to enable or disable logging into the console, into files, and GELF logging.

Changing the location of the index

In the standard delivery, the indexes of smart.finder are stored under the following path:

%TOMCAT%\webapps\ct-finder-server-webapp-[VERSION]\WEB-INF\solr.home

The indexes of the individual cores are stored in the subdirectories located here. To change the location of the indexes you have to change the value of the variable solr.solr.home in the file application.properties.

solr.solr.home=[absolute path]

After a restart, the indexes are stored in this directory.