Zoomdata Version

Configuration Property Files and Their Corresponding Variables

Zoomdata leverages the following configuration files to ensure successful deployment in your operating environment:

  • The zoomdata.properties file defines variables and parameters related to Zoomdata specifically.
  • The zoomdata.env file defines configurations and variables that help Zoomdata connect to and communicate with your network.
  • The scheduler.properties file defines variables and parameters related to Zoomdata Scheduler process.
  • The scheduler.env file defines variables and parameters related to Zoomdata Scheduler process.
  • The spark-proxy.properties file defines variables and parameters related to Zoomdata SparkIT process .
  • The spark-proxy.env file defines variables and parameters related to Zoomdata SparkIT process.
  • Zoomdata's data connectors each have their own property file containing variables and parameters related to Zoomdata connector servers. For more information, see Connector Properties.
  • Beginning with Zoomdata v2.2, the zoomdata configuration file was renamed from zoomdata.conf to zoomdata.properties . Starting in v2.3, the .conf filename was no longer supported so if you deployed earlier versions of Zoomdata Server and used zoomdata.conf , please copy configurations to zoomdata.properties .
  • Before editing these property files, be sure to log off Zoomdata from your web browser. When you have completed your edits, restart Zoomdata to ensure your changes take effect.
For the security-related properties, you can refer to spring.io's Appendix A covering common application properties.

zoomdata.properties variables

Property Name Default Value Description
access.control.allow.origin * By default, CORS is set to --- in the Zoomdata Server. You can set CORS to restrict access:

access.control.allow.origin= user_defined

http.port 8080 Sets the alternative http port that can accept connections. This property can be disabled by leaving an empty string as the value. See 'server.port' property for additional information.

Example: http.port=8080

This property is only applicable when server.ssl.enabled is set to 'true'.
http.redirect.port undefined Sets the https port to send browser redirect from http connection request. This property can be disabled by leaving an empty string as the value.

Example: http.redirect.port= Enter_Redirect_Port

This property is only applicable when server.ssl.enabled is set to 'true'.
logs.dir ZD_Install_dir /logs Path to Zoomdata logs. The placeholder install.dir is replaced with the actual location where Zoomdata is installed.

Example: logs.dir=/opt/ zoomdata /logs).

multipart.maxFileSize 500Mb

Example: multipart.maxFileSize=500Mb

multipart.maxRequestSize 500Mb

Example: multipart.maxRequestSize=500Mb

proxyHost user defined For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server host to be returned for calls, and identifies the proxy host server that will provide internet access.
proxyPort user defined For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server port to be returned for calls, and identifies the proxy port server that will provide internet access.
saml.maxAuthAge 86400 Sets the timeout for SAML, in seconds. The default is 24 hours.

Example: saml.maxAuthAge=86400

server.compression.enabled spring.http.gzip.enabled

Enables gzip compression for http requests.

Example: server.compression.enabled=spring.http.gzip.enabled

server.contextPath /zoomdata

Example: server.contextPath=/zoomdata

server.port 8443 Sets the default http / https port. If SSL is enabled, then this port will be https and the 'http.port' property will be an alternative http port.

Example: server.port=8443

server.session-timeout 1800 Sets when your Zoomdata session will timeout (in seconds).

Example: server.session-timeout=1800

source.attribute.values.limit 1000 Sets the limit for the number of attribute values that can be displayed in the Filter list.

Example: source.attribute.values.limit=1000

scheduler.service.url http://localhost:3333 Points to the scheduler service that Zoomdata uses to clear caches.

Example: scheduler.service.url=http://localhost:3333

Default Account Configurations
supervisor.password user defined Allows the account administrator to set the password for the supervisor role.

Example: supervisor.password= YourSupervisorPassword

admin.password user defined Allows the account administrator to set the password for the admin role.

Example: admin.password= YourAdminPassword

disable.auth false Allows the account administrator to disable authentication completely, allowing for auto login using only the specified username identified in the property file 'autologin.username'. (with no password requirement).

Example: disable.auth=false

autologin.username admin Sets the username that can be automatically logged into Zoomdata (used in conjunction with the property file 'disable.auth'.

Example: autologin.username=admin

Keystore Properties
keystore.location classpath:security/zoomkeystore.jks Zoomdata uses symmetric encryption. You can point to a new keystore to strengthen security.

Example: keystore.location=classpath:security/zoomkeystore.jks

Refer to the article Creating a Symmetric Key for further guidance.
keystore.password zoomkey Lets you set up a unique password for the keystore.

Example: keystore.password=zoomkey

keystore.key.alias zoomkey

Example: keystore.key.alias=zoomkey

keystore.key.password zoomkey

Example: keystore.key.password=zoomkey

Server SSL Properties
server.ssl.ciphers user defined

Example: server.ssl.ciphers= YourCipher

server.ssl.client_auth user defined

Example: server.ssl.client-auth= YourClientAuth

server.ssl.enabled true Toggle switch to determine whether the ssl connection for the default port is enabled or not.

Example: server.ssl.enabled=true

server.ssl.key-store HOME/conf/keystore Sets the path for the keystore location.

Example: server.ssl.key-store=HOME/conf/keystore

server.ssl.key_store_password user defined Stores the keystore password.

Example: server.ssl.key-store-password= YourPassword

server.ssl.key_store_type user defined

Example: server.ssl.key-store-type= YourKeystoreType

server.ssl.trust_store user defined

Example: server.ssl.trust-store= YourTrustStore

server.ssl.trust_store_password user defined

Example: server.ssl.trust-store-password= YourTrustStorePassword

server.ssl.trust_store_type user defined

Example: server.ssl.trust-store-type= YourTrustStoreType

Security Properties
saml.artifactBindingDefault true

Example: saml.artifactBindingDefault=true

saml.useMultiValueList true

Example: saml.useMultiValueList=true

saml.stringDelimiter-,

Example: saml.stringDelimiter-,=

saml.lb.enabled

saml.lb.scheme

saml.lb.contextPath

saml.lb.serverName

saml.lb.port

saml.lb.includePort

false

https

/zoomdata

www.myserver.com

8443

false

SAML settings when Zoomdata Server is behind a load balancer.

Example: saml.lb.enabled=false

Kerberized PostgreSQL Properties
spring.datasource.connection-properties:jaasApplicationName com.sun.security.jgss.initiate Property that identifies the library to use for secure connection between PostgreSQL and the Zoomdata Server.

Example: spring.datasource.connection-properties:jaasApplicationName=com.sun.security.jgss.initiate

spring.datasource.url jdbc:postgresql:// your_IP_address :5432/zoomdata Property to identify PostgreSQL URL.

Example: spring.datasource.url=jdbc:postgresql:// your_IP_address :5432/zoomdata

spring.datasource.username zoomdata Property to identify the username in PostgreSQL.

Example: spring.datasource.username=zoomdata

Source Sampling Properties
source.sampling.count.default 1000

Example: source.sampling.count.default=1000

source.sampling.fetchsize.default 10000

Example: source.sampling.fetchsize.default=10000

source.sampling.max.cardinality 10000000

Example: source.sampling.max.cardinality=10000000

source.attribute.values.limit 1000

Example: source.attribute.values.limit=1000

System Log Properties
syslog.log.level OFF Sets the message logging function. The following options are available for this property:
  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR

Example: syslog.log.level=DEBUG

syslog.host 127.0.0.1 Sets the host IP address for message logging.

Example: syslog.host=127.0.0.1

syslog.port 1514 Sets the port for message logging.

Example: syslog.port=1514

syslog.suffix local Specifies a suffix that is appended at the end of the log entry that Zoomdata generates.

Example: syslog.suffix=local

Screenshot Properties
screenshot.webdriver.timeout 180

Example: screenshot.webdriver.timeout=180

screenshot.daemon.schedule.rate 24h

Example: screenshot.daemon.schedule.rate=24h

screenshot.daemon.retry.attempts 1

Example: screenshot.daemon.retry.attempts=1

screenshot.daemon.enabled false Toggle the screenshot function to enable or disable in the background.

Example: screenshot.daemon.enabled=true

screenshots.dashboards.enabled true

Example: screenshots.dashboards.enabled=true

screenshots.datasource-charts.enabled true

Example: screenshots.datasource-charts.enabled=true

screenshot.height

screenshot.width

588

1000

Set the size of the screenshot.

Example: screenshot.height=704

MongoDB Configuration
zoomdata.db.name zoom Creates a name for the MongoDB database.

Example: zoomdata.db.name=zoom

zoomdata.db.host localhost:27017 Identifies the host IP for MongoDB.

Example: zoomdata.db.host=localhost:27017

zoomdata.db.username anadmin Sets the username for accessing MongoDB.

Example: zoomdata.db.username=anadmin

zoomdata.db.password user defined Sets the password for accessing MongoDB.

Example: zoomdata.db.password= YourPassword

zoomdata.db.meta.connections 50

Example: zoomdata.db.meta.connections=50

zoomdata.db.data.connections 200

Example: zoomdata.db.data.connections=200

Password Policy (available starting in Zoomdata 2.5.12
auth.password.policy.specialCharacters [email protected]#$%^&*()-_=+,.:;<>  
auth.password.policy.minCharacters 9  
auth.password.policy.maxCharacters 255  
auth.password.policy.minLowercaseCharacters 1  
auth.password.policy.minUppercaseCharacters 1  
auth.password.policy.minNumericCharacters 1  
auth.password.policy.minSpecialCharacters 1  
auth.password.policy.helpMessage Password must contain at least 9 characters including 1 lowercase, 1 uppercase, 1 number and 1 special ([email protected]#$%^&*()-_=+,.:;<>). Text is not enclosed in quotation marks.

Spark-proxy.properties Variables

Property Name Default Value Description
hadoop.distro cdh5

Example: hadoop.distro=cdh5

logs.level INFO

Example: logs.level=INFO

logs.root.level WARN

Example: logs.root.level=WARN

proxy.partition.rows.min 100000 Minimum number of rows to load into a Spark executor partition.

Example: proxy.partition.rows.min=100000

proxy.partition.rows.max 2000000 Maximum number of rows to load into a Spark executor partition.

Example: proxy.partition.rows.max=2000000

rmi.host localhost

Example: rmi.host=localhost

rmi.port 9292

Example: rmi.port=9292

spark.master local[*]

Example: spark.master=local[*]

spark.ui.port 4041 Ports that should be opened for communication between the spark driver and spark cluster nodes.

Example: spark.ui.port=4041

spark.blockManager.port 19001

Example: spark.blockManager.port=19001

spark.broadcast.port 19002

Example: spark.broadcast.port=19002

spark.driver.port 19003

Example: spark.driver.port=19003

spark.executor.port 19004

Example: spark.executor.port=19004

spark.fileserver.port 19005

Example: spark.fileserver.port=19005

spark.replClassServer.port 19006

Example: spark.replClassServer.port=19006

spark.yarn.am.port 19007

Example: spark.yarn.am.port=19007

spark.shuffle.service.port 19008

Example: spark.shuffle.service.port=19008

spark.driver.maxResultSize 256m

Example: spark.driver.maxResultSize=256m

syslog.host 127.0.0.1

Example: syslog.host=127.0.0.1

syslog.log.level OFF

Example: syslog.log.level=OFF

syslog.port 514

Example: syslog.port=514

syslog.suffix local

Example: syslog.suffix=local

Spark-proxy.env Variables

Environment Property Name Default Value Description
HADOOP_DISTRO cdh5 Sets the default version of the sparkLib.

Example: HADOOP_DISTRO=cdh5

JAVA_OPTS -Xss256k -Xms512m -Xmx2048m Java-related options for JVM specifically for a standalone Spark Proxy component. Refer to Oracle's article on Java HotSpot VM Options for information.

Example: JAVA_OPTS=-Xss256k -Xms512m -Xmx2048m

SPARK_LOCAL_IP 127.0.0.1 Identifies the location of the Spark driver; must be a public IP address since Zoomdata needs to connect to it. Refer to the Spark Configuration article.

Example: SPARK_LOCAL_IP=127.0.0.1

SPARK_PUBLIC_DNS localhost Provides the hostname your Spark Proxy will share with other servers.

Example: SPARK_PUBLIC_DNS=localhost

TMP_DIR /opt/zoomdata/temp/spark-proxy Specifies the path to the directory where Spark Proxy holds temp data.

Example: TMP_DIR=/opt/zoomdata/temp/spark-proxy

KERBEROS_CONFIG /etc/krb5.conf Kerberos config location
KERBEROS_PRINCIPAL [email protected] Kerberos principal name
KERBEROS_KEYTAB /etc/zoomdata/zoomdata.keytab Kerberos keytab location

Zoomdata.env Variables

Environment Property Name Default Value Description
DEBUG_ENABLED 0/false Toggle switch to enable or disable the Java debug capability. To enable, enter '1' or 'true'.

Example: DEBUG_ENABLED=false

DEBUG_PORT 9393 The default port for the Java debug capability.

Example: DEBUG_PORT=9393

JAVA_OPTS -Xss256k -Xms2048m -Xmx8192m Java-related options for JVM. Refer to Oracle's article on Java HotSpot VM Options for information.
KERBEROS_CONFIG /etc/krb5.conf Default location for the Kerberos configuration details. However, the path to the file may be different in your environment. Refer to Oracle's article on File Formats for information.
KERBEROS_PRINCIPAL [email protected] Kerberos principal name
KERBEROS_KEYTAB /etc/zoomdata/zoomdata.keytab Kerberos keytab location
PROXY_HOST user defined For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server host to be returned for calls, and identifies the proxy host server that will provide internet access.
PROXY_PORT user defined For cloud-based connectors (including Google Analytics and Salesforce) being used in a proxy configuration, this property specifies the server port to be returned for calls, and identifies the proxy port server that will provide internet access.

Scheduler.properties Variables

Property Name Default Value Description
server.port 3333 Sets the default port for the scheduler service.

Example: server.port=3333

spring.datasource.url jdbc:postgresql://localhost:5432/zoomdata-scheduler Identifies the JDBC URL where the Scheduler service resides. If on the same server as the Zoomdata Server, will be 'localhost'.
  • 5432 is the default port for the PostgreSQL metadata store
  • 'zoomdata-scheduler' is the default name stored in the Postgres metadata store
spring.datasource.name zoomdata Sets the username access credential for the Scheduler service.

Example: spring.datasource.name=zoomdata

spring.datasource.password YourSchedulerPassword Sets the password access credential for the Scheduler service.

Example: spring.datasource.password= YourSchedulerPassword

syslog.log.level OFF
syslog.host 127.0.0.1 Identifies the host IP for the system log.

Example: syslog.host=127.0.0.1

syslog.port 1514 Identifies the port ID for the system log.

Example: syslog.host=1514

Scheduler.env Variables

Environment Property Name Default Value Description
JAVA_OPTS -Xms512m -Xmx1024m Java-related options for JVM specifically for the Scheduler component. Refer to Oracle's article on Java HotSpot VM Options for information.