server.config

The following sections describe the server-side modules and properties in the server.config file in the src/main/resources/ folder of your project directory:

For many of server-side properties, you can simply use the default values. For a description of the properties that should be changed for every application, see the Server Configuration topic.

Build Options

Several configurable build options allow you to specify your build version number, configure Google Guice bindings and use an alternate client-side configuration file:

Parameter Description
app.buildnumber Version number applied to your build. By default, the build creation date is appended to the number you specify.
aperture.server.config.bindnames Indicates whether to bind the Aperture server configurations to Google Guice. If this property is set to false, you must implement server-side code.

Data Access

The Data Access sections (Database Server Properties and Solr Server Properties) of the server.config file are used to connect Influent to your transaction and entity data.

For detailed instructions on setting these properties, see the Connect Your Data to Influent topic.

Config Files

Parameter Description
aperture.client.configfile Relative path to your project's client and Aperture JS configuration file. Defaults to client-config.js.
influent.midtier.property.configfile Name of the file that lists the Entity attributes passed through Solr.
influent.midtier.database.configfile Name of the file used to:
  • Map table and column names in your database to aliases used by Influent
  • Pass in other tables you want to make accessible within the application

Database Server Properties

The following properties are used to connect Influent to the database containing your transaction and entity data:

Property Description
influent.midtier.user.name Username with which to access your database
influent.midtier.user.password Password for the username with which to access your database
influent.midtier.database.type Type of database in which your transaction and entity data is stored (mssql, mysql, hsql or oracle)
influent.midtier.database.url Location of the database in which your transaction and entity data is stored (e.g., jdbc:mysql://mysql.server.come/MyDB)
influent.midtier.database.driver Location of the JDBC driver (e.g., org.hsqldb.jdbcDriver) for the type of database to which you want to connect

NOTE: If you have a Microsoft SQL Server database, you can specify its location using the following legacy properties. However, the presence of the database.url and database.driver properties will automatically override the legacy properties.

  • influent.midtier.server.name (URI)
  • influent.midtier.server.port
  • influent.midtier.database.name

Solr Server Properties

The following properties are used to connect Influent to the database containing your transaction and entity data:

Property Description
influent.midtier.solr.url URL of the Solr Server used to enable searches on your entity and transaction data.

Cache

Edit the cache options to specify advanced Ehcache configuration properties:

Cache Stores
aperture.cms.ehcache.maxSize Maximum number of web pages that can be stored in SimplePageCachingFilter. Defaults to 1000.
influent.midtier.ehcache.config Name of the file containing the Ehcache configuration settings. Defaults to ehcache.xml.
influent.persistence.cache.name Name of the persistence Ehcache. Defaults to persistenceCache.
influent.dynamic.clustering.cache.name Name of the dynamic clustering Ehcache. Defaults to dynamicClusteringCache.
influent.charts.maxAge Maximum age (in seconds) of charts stored in ChartDataCache. Defaults to 86400 (24 hours).

Authentication

The following properties control the optional Apache Shiro plugin module, which allows you to enable user authentication for you Influent application.

For detailed instruction on implement Apache Shiro, see the Server Configuration topic.

Property Description
shiro.hashAlgorithmName Specify the hash algorithm used: MD5, SHA-1, SHA-256, SHA-384, or SHA-512.
shiro.redirectUrl Redirect link (path/filename) that forces users to complete the login page. Defaults to /login.jsp.
shiro.loginUrl Direct link (path/filename) to the login page. Defaults to /login.jsp
shiro.successUrl Page (path/filename) to display upon successful login. Defaults to /.

Image Capture

The PhantomImageModule properties in the server.config file control the PhantomJS module used to export screenshots of the Influent workspace.

Property Description
aperture.imagecapture.cms.store Name. Defaults to influent.
aperture.imagecapture.phantomjs.poolsize Number of PhantomJS instances available to process image captures.
aperture.imagecapture.phantomjs.exepath Direct link (path/filename) to the PhantomJS executable. Defaults to bin/phantomjs.
aperture.imagecapture.phantomjs.ssl-certificates-path For use when user authentication is enabled. File path (path/filename) to SSL certificates required to use PhantomJS.

Pattern Search Database

To connect your plugin pattern search module to Influent, set the value of the influent.pattern.search.remoteURL parameter to the location (URL) of your pattern search server.

For detailed instructions on installing and configuring a plugin pattern search module, see the Search Configuration topic.