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.
Note: Database properties are separate from the server configuration, therefore they are stored in the file
database.properties. For more information about the startup time property file
database.properties, see
Database properties.
- 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:
Windows | Spotfire Statistics Services: C:\Program Files\TIBCO\statsvcs1207\<service_name>\conf |
UNIX/Linux | /opt/TIBCO/statsvcs1207/<service_name>/conf |
Note: Not every server property documented in the reference is included in the default version of
spserver.properties. To include a property listed below in your configuration, manually insert the property into your
spserver.properties file.
Note: You must restart the
Spotfire Statistics Services service to pick up any changes that you make in the
spserver.properties file. When you restart the
Spotfire Statistics Services service, the server resumes processing queued jobs. However, because restarting the
Spotfire Statistics Services service also stops the pool of engines, any job that has not completed is marked as failed. To prevent this, we recommend that you wait until all jobs have completed before you restart the service. Alternatively, you can resubmit failed jobs after restarting the service. To monitor job status, use the jobs function. For more information about the jobs function, see the URL API documentation, available from the
Spotfire Statistics Services landing page.
- authentication.required
Setauthentication.required
to true to require remote clients to authenticate when they access Spotfire Statistics Services. - cluster.jms.port
Setcluster.jms.port
to the port number to use for cluster communication. - cluster.multicast.group.address
Setcluster.multicast.group.address
to specify the Multicast IP group address that Spotfire Statistics Services should use for cluster communication. - cluster.multicast.port
Setcluster.multicast.port
to specify the Multicast port number to use for cluster communication. - db.cleanup.run.interval.minutes
Setdb.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 theemail.from
property to the email address to use in the from field for Spotfire Statistics Services job notifications. - email.host
Set theemail.host
property to the host to use for sending notification emails. - email.reply.to
Set theemail.reply.to
property to the email address to use in the reply to field for Spotfire Statistics Services job notifications. - engine.appdata.dir
Set theengine.appdata.directory
to identify the directory used for storing TERR or open-source R packages installed to Spotfire Statistics Services viapkgutils
. - engine.args
Set the propertyengine.args
to specify command-line options to the engine on startup. - engine.init.expr
Provide toengine.init.expr
any open-source R, SAS, or MATLAB code to run when the engine first starts in Spotfire Statistics Services. - engine.init.file
Setengine.init.file
to the full path to a file containing initialization commands. - engine.java.options
Setengine.java.options
to specify the Java runtime options used when the engine process is created. - engine.max.elapsed.seconds
Setengine.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 propertyengine.type
to the statistical engine you want to use. - expression.service.enabled
Setexpression.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 propertyfunction.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 usingSpotfireConnector/execSpotfireAnalytic
. - isclustered
Setisclustered
to true to enable the server as a node in a Spotfire Statistics Services cluster. - jmxremote.enabled
Setjmxremote.enabled
to true to enable remote server monitoring and management using JMX. - jmxremote.password
Set during installation, the value forjmxremote.password
identifies the password to use with the username to access JMX remote monitoring and management.. - jmxremote.port
Setjmxremote.port
to indicate which port JMX should use for remote monitoring and management. - job.list.xslt.enabled
Setjob.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 functionjobs
. - max.jobs.to.return
Setmax.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 ofnotification.delay.time
to the notification time, in milliseconds. - notification.max.times
Setnotification.max.times
to the number of times Spotfire Statistics Services should attempt to send a notification to the client. - service.id
The propertyservice.id
distinguishes Spotfire Statistics Services instances on your local area network. Do not change this value. - service.url
The value for the propertyservice.url
is the base URL of a standalone or clustered installation of Spotfire Statistics Services. - terr.restricted.execution.mode
The propertyterr.restricted.execution.mode
is set by default totrue
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 setengine.type=TERR
). - webdav.cleanup.run.interval.minutes
Set the value ofwebdav.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
Setwebdav.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.
- authentication.required
Setauthentication.required
to true to require remote clients to authenticate when they access Spotfire Statistics Services. - cluster.jms.port
Setcluster.jms.port
to the port number to use for cluster communication. - cluster.multicast.group.address
Setcluster.multicast.group.address
to specify the Multicast IP group address that Spotfire Statistics Services should use for cluster communication. - cluster.multicast.port
Setcluster.multicast.port
to specify the Multicast port number to use for cluster communication. - db.cleanup.run.interval.minutes
Setdb.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 theemail.from
property to the email address to use in the from field for Spotfire Statistics Services job notifications. - email.host
Set theemail.host
property to the host to use for sending notification emails. - email.reply.to
Set theemail.reply.to
property to the email address to use in the reply to field for Spotfire Statistics Services job notifications. - engine.appdata.dir
Set theengine.appdata.directory
to identify the directory used for storing TERR or open-source R packages installed to Spotfire Statistics Services viapkgutils
. - engine.args
Set the propertyengine.args
to specify command-line options to the engine on startup. - engine.init.expr
Provide toengine.init.expr
any open-source R, SAS, or MATLAB code to run when the engine first starts in Spotfire Statistics Services. - engine.init.file
Setengine.init.file
to the full path to a file containing initialization commands. - engine.java.options
Setengine.java.options
to specify the Java runtime options used when the engine process is created. - engine.max.elapsed.seconds
Setengine.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 propertyengine.type
to the statistical engine you want to use. - expression.service.enabled
Setexpression.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 propertyfunction.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 usingSpotfireConnector/execSpotfireAnalytic
. - isclustered
Setisclustered
to true to enable the server as a node in a Spotfire Statistics Services cluster. - jmxremote.enabled
Setjmxremote.enabled
to true to enable remote server monitoring and management using JMX. - jmxremote.password
Set during installation, the value forjmxremote.password
identifies the password to use with the username to access JMX remote monitoring and management.. - jmxremote.port
Setjmxremote.port
to indicate which port JMX should use for remote monitoring and management. - job.list.xslt.enabled
Setjob.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 functionjobs
. - max.jobs.to.return
Setmax.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 ofnotification.delay.time
to the notification time, in milliseconds. - notification.max.times
Setnotification.max.times
to the number of times Spotfire Statistics Services should attempt to send a notification to the client. - service.id
The propertyservice.id
distinguishes Spotfire Statistics Services instances on your local area network. Do not change this value. - service.url
The value for the propertyservice.url
is the base URL of a standalone or clustered installation of Spotfire Statistics Services. - terr.restricted.execution.mode
The propertyterr.restricted.execution.mode
is set by default totrue
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 setengine.type=TERR
). - webdav.cleanup.run.interval.minutes
Set the value ofwebdav.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
Setwebdav.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.
Parent topic: Service configuration and properties
Related concepts