Property Reference

Property Files

A property file is used for various configuration of the server application and the client application.

Types of property files

There are following types of property files available.

How to reflect change of each property file

The values modified in the property files become effective accordingly when the tool (server or studio) is restarted.
If the tool is not restarted, the modifications do not take effect .

Property files for server

dslog.properties

Settings pertaining to logging feature can be modified.

File location: Properties defined in this file are explained in the following table.
Properties
Key Description Target logs Remarks
dslog Log kevel for target logs can be modified
  • ${NOTICE}:
    Logs severe errors that cause premature termination or unexpected conditions that are critical.
  • ${INFO}:
    Logs informative runtime events occurred but the messages are kept at its minimum.
  • ${FINFO}:(default)
    Usually it provides more information than INFO Log Level.
  • ${FINEST}:
    Shows more detailed messages than FINFO Log Level.
  • ${DEBUG}:
    Provides messages useful for debugging.
 Server Log, Server CLI Console Log
  • See Log Level for any details regarding Log level.
  • The FTP server and the web container log (a log starts with "org.apache") are not relied on this setting.
dslog.file.size The log file is rotated when file size reaches the size specified. Server Log, Server CLI Console Log
  • You can select either "KB", "MB", or "GB". If no unit is specified, data will be handled as byte.
  • Defaults to 2048KB.
  • You can select the value from "0" to the below numerical values (integer only).
    • 9223372036854775807
    • 9007199254740991KB
    • 8796093022207MB
    • 8589934591GB
    The maximum value of the log file to output varies depending on the operated OS of DataSpiderServer.
dslog.file.backup The log file is rotated when number of existing log files reaches the size specified. Server Log, Server CLI Console Log
  • Defaults to 5.
  • A number from 0 to 2147483647 (integer) can be specified.
dslog.dir Absolute file path to the log file directory.
Example: dslog.dir=d:/dslog/logs		 Server Log, Execution Log, XML Log, Launch Log, Launch Process Log, Server CLI Console Log, Access Log
  • The log file directory defaults to $DATASPIDER_HOME/server/logs.
  • If '\' is used as directory separator in a file path, be sure to escape the '\' character as '\\'.
  • Specifying invalid file path will cause premature termination of DataSpiderServer(e.g. specifying non existing drive letter or specifying unauthorized resources)
execlog Log kevel for target logs can be modified
  • ${EXECLOG_OFF}:(default)
    Disables logging.
  • ${EXECLOG_ALL}:
    Logs the start and end timestamp of the execution of scripts
  • ${EXECLOG_RESULT}:
    Logging is done only when scripts exit.
  • ${EXECLOG_ERROR}:
    Logging is done only when script fails during the execution.
 Execution Log($DATASPIDER_HOME/server/logs/exec.log)
  • The content of the output log is the same as the exec log.
  • This property is intended exclusively for $DATASPIDER_HOME/server/logs/exec.log.
    The exec log to output under the date directory ($DATASPIDER_HOME/server/logs/<Date directory(yyyyMMdd)>/exec.log) will not be affected by this setting.
execlog.file.size the log file is rotated when file size reaches the size specified. Execution Log($DATASPIDER_HOME/server/logs/exec.log)
  • This property is intended exclusively for $DATASPIDER_HOME/server/logs/exec.log.
    The exec log to output under the date directory ($DATASPIDER_HOME/server/logs/<Date directory(yyyyMMdd)>/exec.log) will not be affected by this setting.
  • Defaults to 2048KB(MB can also be used for mega bytes).
execlog.file.backup the log file is rotated when number of existing log files reaches the size specified. Execution Log($DATASPIDER_HOME/server/logs/exec.log)
  • This property is intended exclusively for $DATASPIDER_HOME/server/logs/exec.log.
    The exec log to output under the date directory ($DATASPIDER_HOME/server/logs/<Date directory(yyyyMMdd)>/exec.log) will not be affected by this setting.
  • Defaults to 5
accesslog Log kevel for target logs can be modified
  • ${ACCESSLOG_OFF}:(default)
    Disables logging.
  • ${ACCESSLOG_ALL}:
    An access log from the client to DataSpiderServer is output.
 Access Log
  • The access log is rotated by date with the file name of "access.log.yyyy-MM-dd".
  • The rotated file is not deleted.

system.properties

Settings pertaining to system can be modified.

File location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
http.proxyHost Host name or IP address Http proxy server to set up for http protocol connections  
http.proxyPort 0-65535 Http proxy server port to set up for http protocol connections  
https.proxySet true or false Set to 'true' to enable https when using the proxy server configured  
https.proxyHost Host name or IP address Http proxy server to set up for https connection.  
https.proxyPort 0-65535 The server port to set up for https connections  
java.rmi.server.hostname Host name or IP address Specify the host name or the IP address of the server that client connects
  • If a server is equipped with multiple NICs or the server's IP address is DHCP obtained, client may fail to connect to it.However, this can be prevented by specifying server's hostname to this property.
  • Specify only one IP address or server hostname.
ds.rmi.port TCP port used by application Specify TCP port used by server and client for the rmi connection.TCP port is automatically selected if not specified.
  • Use if specifying a static port number if necessary.
merge.trim.result true or false Specify whether to trim any white space from the beginning and end of strings when they are merged together using Merge Mapper
  • Whitespace and new line characters are removed if 'true' is specified.
  • Whitespace and new line characters are not removed if 'false' is specified.
  • Defaults to false.
xmlfw.daterenderingformat Date format supported by java.text.SimpleDateFormat Specify date format used when Date Type date is transformed to String Type.  
default.desktop.background.color hex triplet Specify DataSpider Studio's desktop background color.RGB is expressed in a pound sign pretended hex.
  • This property is for client only.
default.desktop.icon.text.color hex triplet Specify DataSpider Studio's desktop background color.RGB is expressed in a pound sign pretended hex.
  • This property is for client only.
ds.system.tmp.dir String Absolute file path to directory used as $DATASPIDER_HOME/server/tmp.
Example:ds.system.tmp.dir=d:/tmp_dir/tmp
  • The path to the directory defaults to $DATASPIDER_HOME/server/tmp.
  • If '\' is used as directory separator in a file path, be sure to escape the '\' character as '\\'.
  • If the specified path does not exist, $DATASPIDER_HOME/server/tmp is selected by default.
texteditor.read.max.size 0-9223372036854775807 Maximum file size which can be opened and edited with the DataSpider Studio's text editor in byte.
  • This property is for client only.
mylogs.download.threshold.size 0-9223372036854775807 In My Logs search result, specify the dialog display threshold in which the confirm method of execution history is selected in byte.
  • This property is for client only.
user.timezone Timezone ID Specify the user's time zone
Example:user.timezone=Asia/Tokyo
  • Overrides the default time zone setting
  • Both server and client should have the same value.
execution.normallog.delete.enabled true or false Configures whether you delete the XML log of the script after normal exit.
  • The XML log will be deleted after the script termination
  • The XML log of the normal exit script will be deleted if "true" is specified.
  • The XML log will not be deleted if "false".
  • If the XML log is set as disable and "true" is specified, a log will be output to the server log at the log level of "WARN".
  • Defaults to false.
execution.errorlog.dest.dir String Specifies the directory to move the XML log of the error script as an absolute path.
Example:execution.errorlog.dest.dir=d:/dest_dir
  • The XML log will be moved after the script is terminated.
  • If the specified path is not found, a directory of the specified path will be generated.
  • If the XML log is set as disable, a log will be output to the server log as a log level of "WARN".

DataSpiderServer.lax

Memory allocation to the DataSpiderServer and the destination for its standard output can be changed in DataSpiderServer.lax.

File Location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
-Xms A value that is smaller than the maximum heap size. Specify the initial heap size. By setting this property, the specified amount of memory will be allocated when starting DataSpiderServer. Specify in "lax.nl.java.option.additional=".
  • The value must be a multiple of 1024.
  • Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.
-Xmx A value that is greater than the initial heap size. Specify the maximum heap size. Specify in "lax.nl.java.option.additional=".
  • The value must be a multiple of 1024.
  • Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.
-XX:MaxMetaspaceSize Optional Numeric Value Set maximum of native memory that can possibly be allocated for class and metadata. Ensures OS memory apart from heap size. It is set up inside "lax.nl.java.option.additional=".
  • In x86 version the default value is "128MB", and in x64 version is "256MB".
  • The value must be a multiple of 1024
  • Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.
lax.stderr.redirect String Specify the relative path to the Server Error Log
  • Defaults to $DATASPIDER_HOME/server/logs/server.error.log.
  • The recommended value is default value.

To activate the "Access Log" feature, specify the below option.
Properties
Option Description Remarks
-javaagent:../system/common/lib/aspectjweaver.jar Specify in "lax.nl.java.option.additional=".
  • When the access log feature is activated, DataSpiderServer consumes 200MB more of memory than usual. If there is no more than 200MB of space in the memory usage, please change the heap size of DataSpiderServer.

Property files for client

dslog.properties

Settings pertaining to logging feature can be modified.

File Location: $DATASPIDER_HOME/client/conf/dslog.properties
Properties
Key Description Target logs Remarks
dslog Log kevel for target logs can be modified
  • ${NOTICE}:
    Logs severe errors that cause premature termination or unexpected conditions that are critical.
  • ${INFO}:
    Logs informative runtime events occurred but the messages are kept at its minimum.
  • ${FINFO}:(default)
    Usually it provides more information than INFO Log Level.
  • ${FINEST}:
    Shows more detailed messages than FINFO Log Level.
  • ${DEBUG}:
    Provides messages useful for debugging.
 Studio Log, Client CLI Console Log
  • See Log Level for any details regarding Log level.
dslog.file.size The log file is rotated when file size reaches the size specified. Studio Log, Client CLI Console Log
  • You can select either "KB", "MB", or "GB". If no unit is specified, data will be handled as byte.
  • Defaults to 2048KB.
  • You can select the value from "0" to the below numerical values (integer only).
    • 9223372036854775807
    • 9007199254740991KB
    • 8796093022207MB
    • 8589934591GB
    The maximum value of the log file to output varies depending on the operated OS of DataSpider Studio.
dslog.file.backup The log file is rotated when number of existing log files reaches the size specified. Studio Log, Client CLI Console Log
  • Defaults to 5
  • A number from 0 to 2147483647 (integer) can be specified.
dslog.dir Absolute file path to the log file directory.
Example: dslog.dir=d:/dslog/logs 		Studio Log, Client CLI Console Log
  • The log file directory defaults to $DATASPIDER_HOME/server/logs.
  • If '\' is used as directory separator in a file path, be sure to escape the '\' character as '\\'.
  • Specifying invalid file path will cause premature termination of DataSpider Studio(e.g. specifying non existing drive letter or specifying unauthorized resources).

boot.properties

Setting pertaining to server connection.

File Location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
server.port 0-65535 Specify a port number DataSpiderServer listens for client connections.  
server.host server's host name or its IP address Specify DataSpiderServer's host name or IP address  
connect.retry.interval a none negative numeric value Connect back-off time in milliseconds before attempting to reconnect to DataSpiderServer if connecting has failed to establish.  
connect.retry.count 0-65535 Number of connect attempts to be performed  

system.properties

Settings pertaining to system can be modified.

File Location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
http.proxyHost Host name or IP address Http proxy server to set up for http protocol connections.  
http.proxyPort 0-65535 Http proxy server port to set up for http protocol connections.  
https.proxySet true or false Set to 'true' to enable https when using the proxy server configured.  
https.proxyHost Host name or IP address Http proxy server to set up for https connection.  
https.proxyPort 0-65535 The server port to set up for https connections.  
java.rmi.server.hostname Host name or IP address Specify the host name or the IP address of the client host
  • If a client is equipped with multiple NICs or the client's IP address is DHCP obtained, server may fail to acknowledge the client.However, this can be prevented by specifying client's hostname to this property.
  • Specify only one IP address or client's hostname.
ds.rmi.port TCP port used by application Specify TCP port used by server and client for the RMI connection.TCP port is automatically selected if not specified.
  • Use if specifying a static port number if necessary.
merge.trim.result true or false Specify whether to trim any white space from the beginning and end of strings when they are merged together using Merge Mapper
  • White space and new line characters are removed if 'true' is specified.
  • Whitespace and new line characters are not removed if 'false' is specified.
  • This property is for server only.
xmlfw.daterenderingformat Date format supported by java.text.SimpleDateFormat. Specify date format used when Date Type date is transformed to String Type.
  • This property is for server only.
default.desktop.background.color hex triplet Specify DataSpider Studio's desktop background color.RGB is expressed in a pound sign pretended hex.
  • Defaults to #99CCFF
default.desktop.icon.text.color hex triplet Specify DataSpider Studio's desktop background color.RGB is expressed in a pound sign pretended hex.
  • Defaults to #FFFFFF
ds.system.tmp.dir String Absolute file path to directory used as $DATASPIDER_HOME/tmp .
  • The path to the directory defaults to $DATASPIDER_HOME/client/tmp.
  • Example:ds.system.tmp.dir=d:/tmp_dir/tmp
  • If the specified path does not exist, $DATASPIDER_HOME/client/tmp is selected by default.
texteditor.read.max.size 0-9223372036854775807 Maximum file size which can be opened and edited with the DataSpider Studio's text editor in byte.
  • Defaults to 1048576(1MB)
mylogs.download.threshold.size 0-9223372036854775807 In My Logs search result, specify the dialog display threshold in which the confirm method of execution history is selected in byte.
  • If the log size exceeds this threshold, a dialog to select if downloading the log in text or opening a log viewer.
  • Defaults to 131072(128KB).
user.timezone Timezone ID Specify the user's time zone
Example:user.timezone=Asia/Tokyo
  • Overrides the default time zone setting.
  • If timezone of a client differs from that of a server, you should set the server timezone to this property.

locale.properties

Sets up the language used in DataSpider Studio and Client CLI Console.

File location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
user.language The language used in DataSpider Studio and Client CLI Console
  • ja:
    Uses Japanese.
  • en:
    Uses English.
 Specifies the language used in DataSpider Studio and Client CLI Console.
Used for executing scripts on designer, showing screen, logging, etc.
  • By default, "the language selected in installer" is set.
  • It's set as [language] selected in the login screen when you launching DataSpider Studio.

DataSpiderStudio.lax

Memory allocation to the DataSpider Studio and the destination for its standard output can be changed in DataSpiderStudio.lax

File Location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
lax.nl.java.option.java.heap.size.max A value that is greater than the initial heap size. Specify the maximum heap size.
  • Defaults to 536870912(512MB).
  • The value must be a multiple of 1024.
  • Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.
  • The heap size greater than 2G cannot be allocated on Windows 64bit platforms(x64 version and Itanium2 version).
    2To setup the heap size more than 2GB, please specify the heap size to the Java start option (lax.nl.java.option.additional). The value must be a multiple of 1024.
lax.nl.java.option.java.heap.size.initial A value smaller than the maximum heap size. Specify the initial heap size. By setting this property, the specified amount of memory will be allocated when starting DataSpider Studio.
  • Defaults to 134217728(128MB).
  • The value must be a multiple of 1024.
  • Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.
  • The heap size greater than 2G cannot be allocated on Windows 64bit platforms(x64 version and Itanium2 version).
    To setup the heap size more than 2GB, please specify the heap size to the Java start option (lax.nl.java.option.additional). The value must be a multiple of 1024.
lax.stderr.redirect String Specify the relative path to the Studio Standard Error Output
  • Defaults to $DATASPIDER_HOME/client/logs/client.error.log
  • The recommended value is default value.
lax.stdout.redirect String Specify the relative path to the Studio Standard Output
  • Defaults to $DATASPIDER_HOME/client/logs/client.log
  • The recommended value is default value.

Property files for server/client

CLI.lax

Memory allocation to the CLI condole can be changed in CLI.lax

File Location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
lax.nl.java.option.java.heap.size.max A value that is greater than the initial heap size. Specify the maximum heap size.
  • Defaults to 536870912(512MB)
  • The value must be a multiple of 1024.
  • Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.
  • The heap size greater than 2G cannot be allocated on Windows 64bit platforms(x64 version and Itanium2 version).
    To setup the heap size more than 2GB, please specify the heap size to the Java start option (lax.nl.java.option.additional). The value must be a multiple of 1024.
lax.nl.java.option.java.heap.size.initial A value smaller than the maximum heap size. Specify the initial heap size. By setting this property, the specified amount of memory will be allocated when starting CLI Console.
  • Defaults to 134217728(128MB).
  • The value must be a multiple of 1024.
  • Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.
  • The heap size greater than 2G cannot be allocated on Windows 64bit platforms(x64 version and Itanium2 version).
    To setup the heap size more than 2GB, please specify the heap size to the Java start option (lax.nl.java.option.additional). The value must be a multiple of 1024.

ScriptRunner.lax

Settings pertaining to ScriptRunner can be modified.

File location: Properties defined in this file are explained in the following table.
Properties
Key Value Description Remarks
sun.net.client.defaultReadTimeout Whole number above "1000" Specify the waiting time for exit status returning from the script, after script execution.
Set in "lax.nl.java.option.additional=".
  • Defaults to "-1". The time out upon specifying below "0" is limitless.
  • The unit is millisecond.
  • Setting example:
    -Dsun.net.client.defaultReadTimeout=600000

Appendix

Memory size conversion table

MB bytes
128M 134217728
256M 268435456
512M 536870912
1024M 1073741824
1536M 1610612736
2048M 2147483648