Server properties

The server configuration properties for Spotfire Statistics Services are contained in the file spserver.properties. We use the standard Java properties file conventions to define each server property.

• In a cluster installation, the file spserver.properties is stored in the conf directory under SPSERVER_SHARE. When you install a new node in a cluster, provide this location so that all the nodes in the cluster have the same values.
• In a standalone installation, the file is stored in the conf directory under SPSERVER_HOME.

In a default installation, the full path to the spserver.properties file is:

• authentication.required
  Set authentication.required to true to require remote clients to authenticate when they access Spotfire Statistics Services.
• cluster.jms.port
  Set cluster.jms.port to the port number to use for cluster communication.
• cluster.multicast.group.address
  Set cluster.multicast.group.address to specify the Multicast IP group address that Spotfire Statistics Services should use for cluster communication.
• cluster.multicast.port
  Set cluster.multicast.port to specify the Multicast port number to use for cluster communication.
• db.cleanup.run.interval.minutes
  Set db.cleanup.run.interval.minutes to the interval for monitoring and cleaning up the Spotfire Statistics Services job queue and data/requests directory.
• db.cleanup.time.to.live.days
  Set the number of days to elapse before a job in the Spotfire Statistics Services job database and data/requests directory are considered old enough to delete when the scheduled cleanup runs.
• email.from
  Set the email.from property to the email address to use in the from field for Spotfire Statistics Services job notifications.
• email.host
  Set the email.host property to the host to use for sending notification emails.
• email.reply.to
  Set the email.reply.to property to the email address to use in the reply to field for Spotfire Statistics Services job notifications.
• engine.appdata.dir
  Set the engine.appdata.directory to identify the directory used for storing TERR or open-source R packages installed to Spotfire Statistics Services via pkgutils.
• engine.args
  Set the property engine.args to specify command-line options to the engine on startup.
• engine.init.expr
  Provide to engine.init.expr any open-source R, SAS, or MATLAB code to run when the engine first starts in Spotfire Statistics Services.
• engine.init.file
  Set engine.init.file to the full path to a file containing initialization commands.
• engine.java.options
  Set engine.java.options to specify the Java runtime options used when the engine process is created.
• engine.max.elapsed.seconds
  Set engine.max.elapsed.seconds to the maximum number of seconds since the engine was started before it is restarted.
• engine.max.requests
  Set the maximum number of requests the engine processes before it is restarted.
• engine.startup.timeout.seconds
  Set the maximum time to elapse before Spotfire Statistics Services indicates that the engine startup has failed.
• engine.type
  Set the property engine.type to the statistical engine you want to use.
• expression.service.enabled
  Set expression.service.enabled to true to be able to use the Expression Service API with Spotfire Statistics Services. Applies to any of the tested statistical engine types in your Spotfire Statistics Services installation.
• function.service.whitelist
  The property function.service.whitelist provides the means to specify the functions that can run on Spotfire Statistics Services. Applies to any of the tested statistical engine types in your Spotfire Statistics Services installation when Spotfire calls a data function using SpotfireConnector/execSpotfireAnalytic.
• isclustered
  Set isclustered to true to enable the server as a node in a Spotfire Statistics Services cluster.
• jmxremote.enabled
  Set jmxremote.enabled to true to enable remote server monitoring and management using JMX.
• jmxremote.password
  Set during installation, the value for jmxremote.password identifies the password to use with the username to access JMX remote monitoring and management..
• jmxremote.port
  Set jmxremote.port to indicate which port JMX should use for remote monitoring and management.
• job.list.xslt.enabled
  Set job.list.xslt.enabled to true if you are using a style sheet to display the results of calls to the Spotfire Statistics Services Administration Service function jobs.
• max.jobs.to.return
  Set max.jobs.to.return to specify the number of jobs to display as a result of a call to the Spotfire Statistics Services URL API.
• notification.delay.time
  Set the value of notification.delay.time to the notification time, in milliseconds.
• notification.max.times
  Set notification.max.times to the number of times Spotfire Statistics Services should attempt to send a notification to the client.
• service.id
  The property service.id distinguishes Spotfire Statistics Services instances on your local area network. Do not change this value.
• service.url
  The value for the property service.url is the base URL of a standalone or clustered installation of Spotfire Statistics Services.
• terr.restricted.execution.mode
  The property terr.restricted.execution.mode is set by default to true to ensure that executing certain operations defined as restricted generates an error. Applies only if you are using the TERR engine in your Spotfire Statistics Services installation (that is, you set engine.type=TERR).
• webdav.cleanup.run.interval.minutes
  Set the value of webdav.cleanup.run.interval.minutes to the interval to use for monitoring transient data to be cleaned out of the Spotfire Statistics Services WebDAV root directory.
• webdav.cleanup.time.to.live.minutes
  Set webdav.cleanup.time.to.live.minutes to indicate when any file is old enough to delete when cleanup runs.
• xml.version
  Set the version of XML that Spotfire Statistics Services uses. Do not change.