Configuring Server Using Properties in server.properties
You can use the server.properties file for comprehkensive configuration of Logi Report Server. Server automatically generates the file in <install_root>\bin when it starts for the first time. This topic describes how you can use the properties in the server.properties file.
Some properties have corresponding UI options. For such options, you can specify the values either via UI or in the property file.
| Property Name | Default Value (Range) | Mapped UI Option | Description |
|---|---|---|---|
| CLUSTER | |||
| cluster.enable | false | Administration > Configuration > Cluster > Configuration > Enable Cluster | Set cluster.enable to true if you want to activate the Cluster feature on the server. This property is available only when the license key you use for your Logi Report Server is Cluster enabled. The default value of the property varies with different situations:
When you activate the cluster feature on a clustered server, the server calls the remote methods to accomplish tasks. However, using RMI, the server's performance and reliability will be affected. Therefore, when you want a clustered server to work individually that is not in a Cluster environment, you can turn off its Cluster feature by setting this property to false. |
| cluster.enable_notify_server_down | false | Administration > Configuration > Cluster > Configuration > Notify via E-mail When a Server Is Down | Set this property to true if you want to notify somebody via email when a server in the cluster is down. You can specify the email address by the cluster.notify_server_down_address property in the same property file.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.member.id | - | - | Specify the member ID for the clustered server. Each clustered server should have a unique member ID. The value of this property should be an integer no less than 1. However, you should not change the auto generated cluster member ID in a Logi Report Server Cluster, because distributed storage uses the member ID to recognize on which clustered server it stores the physical files.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.name | logireport-cluster | Administration > Configuration > Cluster > Configuration > Cluster Name | Specify the name of the cluster. When you set the cluster.enabled property to true, you must provide a unique cluster name for the servers that will join the Cluster. |
| cluster.notify_server_down_address | - | Administration > Configuration > Cluster > Configuration > E-mail Address | Specify the email addresses of the people to whom you want to send a notification email when a server in the Cluster is down. This property takes effect only when the cluster.enable_notify_server_down property is true.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.scheduler.lease.active_time | 2 | Administration > Configuration > Cluster > Configuration > Cluster Scheduler Lease Active Count | Specify the active lease number in a Cluster. The property value should be an integer.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.scheduler.lease.check_interval | 30 | Administration > Configuration > Cluster > Configuration > Cluster Scheduler Lease Check Interval | Specify the time interval that the Cluster will use to check the number of active leases. The property value should be an integer in seconds.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.scheduler.lease.enabled | false | Administration > Configuration > Cluster > Configuration > Cluster Scheduler Lease | Set this property to true if you want to enable lease for a distributed scheduler in the Cluster. If you enable a distributed scheduler with lease, it becomes an active scheduler and will compete to trigger the schedule.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.scheduler.lease.valid_time | 300 | Administration > Configuration > Cluster > Configuration > Cluster Scheduler Lease Valid Time | Specify the period that the clustered server can hold a lease before releasing it. The property value should be an integer in seconds.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.share_memory.node_number | 2 | Administration > Configuration > Cluster > Configuration > Cluster Memory Storage Number of Copies | Specify the number of memory copies you want to share in the Cluster. The property value should be a positive integer.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.storage.crd.result.copy_number | 2 | Administration > Configuration > Cluster > Configuration > Cluster Storage CRD Result Number of Copies | Specify the number of copies you want to make in the Cluster when a new file or folder is added to the cached report data (CRD) folder. The property value should be an integer.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.storage.history.copy_number | 2 | Administration > Configuration > Cluster > Configuration > Cluster Storage History Number of Copies | Specify the number of copies you want to make in the Cluster when a new file or folder is added to the history folder. The property value should be an integer.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| cluster.storage.realm.copy_number | 2 | Administration > Configuration > Cluster > Configuration > Cluster Storage Realm Number of Copies | Specify the number of copies you want to make in the Cluster when a new file or folder is added to the realm folder. The property value should be an integer.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| loadbalance.custom_class | - | - | Specify the class name of the load balancer. For more information, see Writing Customized Load Balancing Algorithm.
By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| loadbalance.type | 1 (0 ~ 3) |
Administration > Configuration > Cluster > Configuration > Load Balancer Type | Set the load-balance type to 0, 1, 2, or 3.
For more information, see Built-In Load Balancing Algorithms. Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| ENGINE | |||
| engine.default_encoding | - | - | You use this property to encode parameters' displaying values as well as report data in the HTML, PDF, RTF, XLS, and email outputs. |
| engine.priority | 2 (0 ~ 4) |
Administration > Configuration > Advanced > Engine Priority | Specify the CPU utilization priority for the engine. The CPU usage that Logi Report Engine can occupy influences the performance of Logi Report Server. A larger share of CPU usage speeds up performance. To tune Logi Report Server to the best performance, you can modify this option to enable the engine to share a larger part of CPU usage when it is running. |
| engine.single_thread | true | - | The value true means that there should be only one thread when the engine is running. |
| engine.sort.buffer_size | 16 | Administration > Configuration > Cache > Report Cache > Report Buffer Size for Sort Action | Specify the buffer size in MB in the RAM for each report when sorting on page reports in Page Report Studio. The minimal size is 4 MB. The value -1 means that the system controls the buffer size automatically. |
|
|
false | - | By default, Server applies the time zone you set in server preferences to Date/Time/DateTime field values in built-in functions. If you want to retain the time zone of the field values in built-in functions, set engine.timezone.function_apply_offset in the server.properties file to "true", and then run reports via URL while adding "CustomOffset=true" in the URL. |
| FTPS | |||
| ftps.keymanager.algorithm | - | - | Specify the FTPS key manager algorithm. |
| ftps.keystore.file | - | - | Specify the FTPS key store file. |
| ftps.keystore.npassword | - | - | Specify the FTPS key store password. |
| ftps.keystore.type | - | - | Specify the FTPS key store type. |
| ftps.trustmanager.algorithm | - | - | Specify the FTPS trust manager algorithm. |
| ftps.truststore.file | - | - | Specify the FTPS trust store file. |
| ftps.truststore.npassword | - | - | Specify the FTPS trust store password. |
| ftps.truststore.type | - | - | Specify the FTPS trust store type. |
| HTTPSERVER | |||
| httpserver.backlog | 50 | - | Specify the maximum number of Client sockets that can queue when waiting to be accepted by the Logi Report Server socket. |
| httpserver.cache_control.css | public, max-age=604800 | Specify the directives of the HTTP Request/Response header field Cache-Control for caching CSS files. | |
| httpserver.cache_control.image | no-cache, must-revalidate, max-age=0 | Specify the directives of the HTTP Request/Response header field Cache-Control for caching image files. | |
| httpserver.cache_control.js | public, max-age=604800 | Specify the directives of the HTTP Request/Response header field Cache-Control for caching JavaScript files. | |
| httpserver.host.all | true | Administration > Configuration > Service > All Network Addresses | The value true means Logi Report Server listens on all network addresses.
httpserver.host.all=false |
| httpserver.host.name | * | Administration > Configuration > Service > Network Address At | If httpserver.host.all=false, use this property to specify the IP addresses that Logi Report Server listens on.
By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| httpserver.max.connections | 1000 (1 ~ 2147483647) |
Administration > Configuration > Service > Maximum Number of Connections | Specify the maximum number of connections that a standalone server can accept. The standalone server refuses any new requests when the connection request total exceeds this number. |
| httpserver.max.handlers | 50 (1 ~ 2147483647) |
Administration > Configuration > Service > Maximum Number of Handlers | Specify the maximum number of user handlers that Server can hold. Server can respond to requests from the client simultaneously. The number of the running requests is in inverse proportion to the speed of the response. The more requests that Server are running, the slower the speed. To improve the running speed, you can set the maximum number of user handlers to a comparatively small number. |
| httpserver.name | JREntServer/1.1 | - | Specify the HTTP Server name. |
| httpserver.port | 8888 (1 ~ 65535) |
Administration > Configuration > Service > Port | Specify the TCP port on which Logi Report Server listens when it starts. This port can be an integer between 1 and 65535. However, the system usually reserves the numbers less than 1024, so you should use a number larger than 1024. |
| httpserver.redirect.propfile | <install_root>\bin\redirect.properties | - | Specify the path and file name of the redirect property file. |
| httpserver.servlet.admin.propfile | <install_root>\bin \admin.properties |
- | Specify the path and file name of the RcServlet property file. |
| httpserver.servlet.propfile | <install_root>\bin \servlet.properties |
Administration > Configuration > Service > Servlet Properties File Name | Specify the path and file name of the servlet property file. The core of Logi Report Server is jet.server.servlets.JRServlet, which implements the interface of javax.servlet.http.HttpServlet. You can install jet.server.servlet.JRServlet to any web server that supports servlets. This turns the web server into a Logi Report Server. |
| httpserver.shutdown.timeout | 0 | - | Specify a time limit for shutting down the HTTP Server, in seconds. When the time exceeds the specified duration when shutting down the HTTP Server, it will be forced to terminate. The HTTP Server will never be forced to terminate if you set the property to 0. |
| httpserver.socket.timeout | 0 | - | Specify the Socket timeline, in seconds. The default value 0 means infinite. |
| httpserver.ssl.algorithm | sunx509 | Administration > Configuration > Service > Keystore Algorithm | Specify the X509 algorithm you want to use. This defaults to the Sun implementation (SunX509). For IBM JVMs you should use IbmX509. |
| httpserver.ssl.enable | true | Administration > Configuration > Service > Enable Secure Socket Layer Connection | By default, the property value is true, and you can use HTTPS schema to visit the Logi Report Server UI in the standalone mode. |
| httpserver.ssl.keystore | <install_root>\bin\keystore | Administration > Configuration > Service > Keystore File Path | Specify the location of the keystore file. |
| httpserver.ssl.keystore.npassword | logireport | Administration > Configuration > Service > Keystore Password | Specify the password you use to protect the integrity of the keystore. |
| httpserver.ssl.keystore.type | JKS | Administration > Configuration > Service > Keystore Type | Specify the type of keystore you want to instantiate. The valid values are JKS and PKCS12. |
| httpserver.ssl.port | 6888 | Administration > Configuration > Service > Secure Port | Specify the port you use for visiting the Server Console via the HTTPS schema. It should be different from the port for the HTTP schema. |
| httpserver.ssl.protocol | SSL | Administration > Configuration > Service > Keystore Protocol | Specify the encryption/decryption protocol you want to use on the socket. The valid values are SSL and TLS. |
| httpserver.timeout | 500 (1 ~ 2147483647) |
Administration > Configuration > Service > Connection Timeout in | Specify the time in milliseconds that Server can block a request from the client side before refusing it. If no connection handler is free after the time, Server refuses the request back to the client. |
| httpserver.use_old_forward_method | false | - | Set the property to true if you want to use the old implementation for javax.servlet.RequestDispatcher.forward(), otherwise use the new implementation. |
| JSP | |||
| jsp.webapp.sendfile | /servlet/sendfile | - | Specify the sendfile servlet mapping path. |
| LOG | |||
| log.config.filename | <install_root>\bin\LogConfig.properties | - | Specify the location (full absolute path and file name) of the logging configuration file. |
| log.config.update | false | - | Set the property to true if you want to enable auto-update of logging configuration changes (by manually modifying the configuration file) at runtime. Any changes to the logging configuration file at runtime will automatically take effect after the specified update interval. When the property is false, any changes to the configuration file will not take effect until you restart Logi Report Server. |
| log.config.update.interval | 60000 | - | Specify the interval (in milliseconds) for automatically updating the logging configuration changes. This property only works after you set the log.config.update property to true. |
| MONITOR | |||
| monitor.cluster.refresh.interval | 10000 (1 ~ 9223372036854775807) |
- | Specify the time interval (in milliseconds) for updating the monitor statistics of the clustered server. |
| monitor.interval | 60 (1 ~ 9223372036854775807) |
- | Specify the time interval (in milliseconds) for the monitor thread. |
| monitor.maxminute.savereport | 2 (1 ~ 2147483647) |
- | Specify the maximum time (in minutes) for displaying a report status in the Finished tab. |
| monitor.maxnumber.savereport | 20 | - | Specify the maximum number of completed reports that you want to keep in the cache. |
| monitor.number.savereport | 2 (1 ~ 2147483647) |
- | Specify the maximum number of completed reports that you want to display in the Finished tab. |
| monitor.overtime.running | 30000 (1 ~ 9223372036854775807) |
- | Specify the time limit (in milliseconds) of overtime running reports. For example, Server marks a report as a large report when its running time exceeds the time limit. |
| monitor.refresh.interval | 10000 (1 ~ 9223372036854775807) |
- | Specify the time interval (in milliseconds) for updating the monitor statistics of the server. |
| PERFORMANCE | |||
| performance.cacheallimg | true | Administration > Configuration > Cache > Image Cache > All Used Images | The value true means to cache all the images in reports. |
| performance.cachecat | true | Administration > Configuration > Cache > Report Cache > Cache Loaded Catalogs | The value true means to cache catalogs in the memory. For more information, see performance.cachecat and performance.cacherpt. |
| performance.cacheimg | true | Administration > Configuration > Cache > Image Cache > Cache Images | The value true means to enable the image cache function. |
| performance.cacherpt | true | Administration > Configuration > Cache > Report Cache > Cache Loaded Reports | The value true means to cache reports in the memory. For more information, see performance.cachecat and performance.cacherpt. |
| performance.catpoolsize | 10 | Administration > Configuration > Cache > Report Cache > Maximum Number of Catalogs to Be Cached | Specify the maximum number of catalogs you want to cache in the server. Server cannot cache any more catalogs if the number of cached catalogs reaches this number. |
| performance.commit.interval | 60 | - | Specify the time interval for Logi Report Server to commit the changes in the Version list, Schedule list, or Completed list. For more information, see performance.commit.thread and performance.commit.interval. |
| performance.commit.thread | false | - | Set the property to true if you want to commit every change in the Version list, Schedule list, or Completed list. For more information, see performance.commit.thread and performance.commit.interval. |
| performance.compressio | false | Administration > Configuration > Performance > Compress Swap Files | Set the property to true if you want to compress the temporary data generated during runtime before Server swaps it to hard drive. Compressing the swap files may considerably reduce the I/O efforts in certain circumstance, which improves the overall performance.
|
| performance.exe_gc | false | - | Set the property to true if you want Logi Report to control garbage collection. |
| performance.html.pipeline | false | - | Set the property to true if you want to enable the HTML pipeline function. For more information, see performance.html.pipeline. |
| performance.imgpoolsize | 10 | Administration > Configuration > Cache > Image Cache > Maximum Image Cache Size | Specify the maximum size for caching images, in MBs. |
| performance.loadfont | false | Administration > Configuration > Performance > Preload Fonts | Set the property to true if you want to preload fonts when Logi Report Server starts. |
| performance.max.reports | 0 | - | Specify the maximum number of concurrent reports in the running queue. This number must be less than or equal to the number that the license permits. Additional requested reports have to wait until the running queue is available. For more information, see performance.max.reports. |
| performance.preloadcatcls | true | Administration > Configuration > Performance > Preload Catalog Referred Classes | The value true means to load catalog related Java classes when Logi Report Server starts. |
| performance.preloadedcats | - | Administration > Configuration > Performance > Catalogs to Be Preloaded | Specify the catalogs you want to load when Logi Report Server starts. |
| performance.preloadedrpts | - | Administration > Configuration > Performance > Reports to Be Preloaded | Specify the reports that you want to load when Logi Report Server starts. |
| performance.preloadenginecls | true | Administration > Configuration > Performance > Preload Engine Referred Classes | The value true means to load engine related Java classes when Logi Report Server starts. |
| performance.preloadrptcls | true | Administration > Configuration > Performance > Preload Report Referred Classes | The value true means to load reports related Java classes when Logi Report Server starts. |
| performance.rptpoolsize | 10 | Administration > Configuration > Cache > Report Cache > Maximum Number of Reports to Be Cached | Specify the maximum number of reports you want to cache in the server. Server cannot cache any more reports if the number of cached reports reaches this number. For more information, see performance.rptpoolsize. |
| performance.showimgdetail | true | Administration > Configuration > Cache > Image Cache > Show Details | The value true means to display the detailed status of the cached images. |
| QUEUE | |||
| queue.accelerated | 10,9 | - | Specify the priority levels of the waiting tasks that you want to promote to accelerated tasks. Accelerated tasks have higher priority than other tasks and run in a separate accelerated queue.
Set one or more priority levels separated by comma as the property value. The priority levels are from 1 to 10 in an ascending order. 10 has the highest priority. By default, Server processes priority 9 and 10 tasks in the accelerated queue, not the normal running queue. |
| queue.accelerated.size | 0 | - | Specify the maximum number of accelerated tasks in the accelerated queue. |
| queue.policy | 0 | - | Specify the way of controlling the queue. The valid property values are:
|
| queue.policy.readjust | 4 | - |
You need to set this property when queue.policy=3. Specify the number of tasks after which completed the priority level of waiting tasks increases. |
| queue.policy.waitingtime | 1200 | - |
You need to set this property when queue.policy=2. Specify the period in seconds after which the priority level of waiting tasks increases. |
| RESOURCE | |||
| resource.default_public_catalog | /SampleReports/SampleReports.cat | - | Specify the default public catalog that displays automatically when you access Logi Report Server in a web browser. |
| resource.result.life | 86400 | Administration > Configuration > Advanced > Temporary Files Life | Specify the period you want to keep the temporary report files for. By default, it is 86400 seconds (24 hours). 300 is the minimum number.
Server deletes all the files from the temp folder except those in use when time is out. The clock starts to count from 0 again periodically. |
| resource.root | %ReportHome%\jreports | Administration > Configuration > Cluster > Configuration > Resource Root |
Specify the root directory of the report resources on the server. You'd better set a different root directory for the report resources on each clustered server. Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| resource.share.hist.dir | %ReportHome%\history | Administration > Configuration > Cluster > Configuration > History Directory | Specify the history directory of the report resources on the server. You'd better set a different history folder to store the parameter information and versioning report files on each clustered server.
Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| resource.share.properties.dir | %ReportHome%\properties | Administration > Configuration > Cluster > Configuration > Properties Directory | Specify the properties directory of the report resources on the server.
This property redirects the <install_root>\properties folder in a Logi Report Server Cluster environment. Each clustered server should use this property to redirect the properties folder to its own location. Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| resource.share.realm.dir | %ReportHome%\realm | Administration > Configuration > Cluster > Configuration > Realm Directory | Specify the realm directory of the report resources on the server.
Each clustered server should use an individual realm folder to store its security information, such as ACLs, groups, realms, and users. Server organizes realms and users in a folder tree structure. Server only creates this property in the server.properties file when it starts in a Cluster environment. |
| resource.share.temp.dir | %ReportHome%\temp | Specify the temporary directory of the report resources on the server.
Server uses temp folder to store its temporary files generated during its working process, such as the report files generated when you run a report. Server deletes all the files from the temp folder when it restarts. |
|
| resource.undefine.free | true | - | The value true means any resource nodes that are not bound with an ACL are accessible.
By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| SERVER | |||
| server.auto_recover_task.interval | 30 | - | Specify the retry interval in seconds before trying to recover a task. |
| server.auto_recover_task.max_times | 0 | - | Specify the maximum retry times when trying to recover a task. |
| server.auto_recover_task.recreate_all_results | false | - | Set the property to true if you want to recreate all the report files when recovering a task. |
| server.autocache.enabled | false | Administration > Configuration > Cache > Data Cache > Cached Report Data > Cache Configuration > Automatic Cache | Set the property to true if you want to automatically cache report data. |
| server.autocache.expired.time | 0 | Administration > Configuration > Cache > Data Cache > Cached Report Data > Cache Configuration > Expires > Custom | Specify the period you want to keep an automatic cached data for. This property takes effect when server.autocache.enabled=true and server.autocache.never.expire=false. |
| server.autocache.max.disk.usage | 512 | Administration > Configuration > Cache > Data Cache > Cached Report Data > Cache Configuration > Maximum Disk Usage | Specify the maximum hard drive space for automatic cached data. The value should be between 4 MB and 1024*1024 MB. This property takes effect when server.autocache.enabled=true. |
| server.autocache.never.expire | true | Administration > Configuration > Cache > Data Cache > Cached Report Data > Cache Configuration > Expires > Never | The value true means that automatic cached data never expires. This property takes effect when server.autocache.enabled=true. |
| server.completed.max_count | 3000 (1 ~ 2147483647) |
- | Specify the maximum number of completed records you want to keep in the Completed table. Set the value to 0 if you don't want to limit the number. |
| server.completed.write_in_queue | false | - | Before it finishes, a scheduled task writes a record into the completed task table. If a number of scheduled tasks are running concurrently, it is possible that many tasks try to write records into the completed task table at the same time. It will become a bottleneck because Server synchronizes the operations, and may block new tasks. To avoid this case, set server.completed.write_in_queue=true, all operations of writing into the completed task table will perform in a separate thread one by one, and the scheduled tasks need not wait for the operation results to return.
By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| server.connection.keepalive | true | Administration > Configuration > Advanced > Keep Connection Alive | The value true means to keep the connection alive after it connects to Logi Report Server. Set this property to false to disconnect the connection once it has received the response. That is, Internet Explorer will not hold the connection open. |
| server.crd.memory.usage | 4 | Administration > Configuration > Cache > Data Cache > Cached Report Data > Cache Configuration > Maximum Memory Usage | Specify the maximum memory usage when running a report using cached report data. The minimum value is 4 MB and can increase up to 80% of the total Java maximum heap size (for example, the -Xmx value in JRServer.bat). All cached report data being used to run reports will share the same memory space. |
| server.cube.maxmemory | 0.0 | Administration > Configuration > Cache > Cube > Configuration > Maximum Cube Memory Allowed | Specify the maximum memory size in megabytes for all in-memory cubes. The total allocated memory for each cube cannot exceed this value. It does not take into consideration the actual memory used by the in-memory cubes or if some of the cubes swap to disk. This value should not be larger than 80% of your Java Heap size.
|
| server.cube_log.max_count | 3000 | - | Specify the number of the records you want to display in the Administration > Configuration > Cache > Cube > Log tab on the Server Console. |
| server.derby.embedded.enable | false | - |
By default, Derby runs in Network Server mode as the default server system database. You can run it in Embedded mode by adding this property manually and setting its value to true: server.derby.embedded.enable=true. |
| server.derbytip.show | true | - |
By default, Server displays the following information about Derby in the Server command console or the log: The Derby database is provided for testing and evaluation purposes only and should not be used in a production system. You can hide the information by adding this property manually and setting its value to false: server.derbytip.show=false. |
| server.dynamic.class.dir | <install_root>\dynamicclasses | - | Specify a folder location on the server computer to hold all the UDS jar files, so that you can load the classes from that folder. |
| server.enable.cachedreportbursting | true | - | Specify the mode when scheduling to publish a report with cached report bursting to the HTML and Page Report Result formats:
For more information, see Scheduling to HTML/Page Report Result to Version. |
| server.enableDynamicResource | false | - |
Set the property to true if you want to enable getting server resources from their real paths. However, when installing Logi Report Server, if you choose Custom Installation for Standalone Server and clear Enable Resources from Real Paths, the default value of this property will be true. |
| server.enableMultipleLogin | true | Administration > Configuration > Advanced > Enable Multiple Users to Login Using the Same User Name | The property true means that multiple sessions for one user can exist simultaneously.
If the value is true, you can sign in to Logi Report Server repeatedly without having to terminate any of your former sessions until the number of sessions reaches the number permitted by the license. If the value is false, only the newly created session is active, and Server automatically terminates all the other former sessions you created. |
| server.font.path | <install_root>\font | - | Specify a font location for server resources.
By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| server.get_remote_host | false | - | Set the property to true if you want Logi Report Server to automatically record and transmit the IP address of a client who has delivered a request to the engine. |
| server.http.only_https_apply_cookie_settings | true | - | The value true means that the Samesite and Secure cookie attributes, that you set using the server.http.samesite_cookie and server.http.secure_cookie=true properties, only take effect on the Set-Cookie header of HTTPS response. Set server.http.only_https_apply_cookie_settings to false if you want the two cookie attributes to take effect on the Set-Cookie header of both HTTP and HTTPS response. |
| server.http.output_encoding | - | - | Specify the encoding of Logi Report internal servlets. By default, jrservlet uses the JVM's encoding. |
| server.http.param_values.delimiter | semicolon (;)+ | - |
Specify a delimiter to separate values when a parameter of a report contains multiple values. Valid delimiters include blank space ( ), comma (,), semicolon (;), quotes ("), colon (:), and braces ({}). By default, this property is not in the server.properties file. To use a different delimiter from the default, add this property to the server.properties file, and then set a value to it. |
| server.http.samesite_cookie | None | - | Specify the Samesite cookie attribute to prevent CSRF attacks. The value could be Strict, Lax, or None. The property works when Logi Report Server runs as a standalone server. |
| server.http.secure_cookie | true | - | Server sets the Secure attribute to cookies by default. Generally, only when using a secure protocol, such as HTTPS and SSL, can the browser send back the cookies with the "Secure" flag to Server.
For non-secure protocols like HTTP, the browser cannot send back the secure cookies. This prevents unauthorized parties from observing secure cookies. Therefore, if you are using a protocol like HTTP, you can set this property to false. |
| server.invalidate_httpsession_when_logout | true | - | The value true means to invalidate the session when you sign out. |
| server.language | en | - | Specify the language Server uses. |
| server.mail.send_size | 2000 | - | Specify the maximum size in kilobytes of the attachments in an email Server sends. |
| server.ondemandlist.clearrecord_lagging_time | 300 | - | Specify the lagging time in seconds after which Logi Report Server clears up the UID's Background Tasks list after the last user who signed in with the UID signs out. |
| server.ondemandlist.user_max_records | 100 | - | Specify the maximum number of records to display in the Background Tasks list. Server removes the oldest records when records exceed the specified number. Set the value to 0 if you want to display unlimited records in the Background Tasks list. |
| server.permission.algorithm | 0 (0 and 1) |
Administration > Configuration > Advanced > Permission Algorithm | Specify an algorithm for calculating a principal's permission. Set the value to 0 if you want to use the permission accumulation algorithm, or 1 to use the user permission replacement algorithm. For more information, see server.permission.algorithm. |
| server.profiling.enable | false | - | Set the property to true if you want to enable the profiling system. Server collects and stores report running information in the profiling database. You can view profiling report from Logi Report Server Monitor. |
| server.realm.active | defaultRealm | Administration > Configuration > Service > Active Realm | Specify the realm that takes effect when the server starts up.
If the specified realm does not exist, Server uses an existing realm as the active realm. It then records a warning message in the log file, and sets the active realm by this property in the server.properties file. |
| server.resource.cleanup_user_folder | true | - | Set the property to true if you want Server to remove a user's My Reports node (/USERFOLDERPATH/UserID) from the server resource tree when deleting the user from the security system. |
| server.resource.enable_linked_catalog | false | Administration > Configuration > Advanced > Enable Linked Catalog | Set the property to true if you want to predefine a linked catalog on the server level for the My Components, Public Components, My Reports, and Public Reports folders to inherit. By default, the property is false. The four folders cannot inherit linked catalog. |
| server.restore.task | false | - | Set the property to true if you want to rerun all interrupted tasks when restarting the server after it stops responding. |
| server.rmi.auth_file | - | - |
Specify a directory for the rmi.auth file, for example, By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| server.rmi.host | localhost IP address | Administration > Configuration > Cluster > Configuration > Server's RMI Host | Specify the RMI IP address or host name of the local server. |
| server.rmi.port | 1129 (1 ~ 65535) |
Administration > Configuration > Cluster > Configuration > Server's RMI Port | Specify the RMI port that the local server uses. |
| server.rmiadminservice.enable | false | - | Set the property to true if you want to administer Server from a remote client via RMI APIs. |
| server.rmimonitor.enable | true | - | Set the property to true if you want to monitor Server by a Server Monitor.
|
| server.rmiserver.enable | false | - | Set the property to true if you want to enable the remote method invocation server. |
| server.rmiserver.fixed_port | 0 | - | Specify a port for exporting server remote objects. If the value is 0, Server uses an anonymous port.
When Logi Report Server resides behind a firewall, the only way to pass through the firewall to obtain the remote objects from the client side is to use an open port while enabling the remote method invocation server. Use this property to specify a fixed port that you can open in the firewall setting. |
| server.rolebased.authorization | false | - | Set the property to true if you want to activate the role-based security, rather than using the default applied security of setting permissions for users, groups, and roles. In the role-based security, you define permissions on roles only and map users and groups to roles. |
| server.security | true | Administration > Configuration > Advanced > No Security Check | Set the property to true if you want to enable security checking on remote requests. When it is false, Server makes responses without any security checking. This does not apply to Remote Configuration and Administration. |
| server.security.advanced_password.contains_lowercase | false | Administration > Configuration > Advanced > Logi Report Password Rule > Lowercase | Set the property to true if you want to include lowercase letters in the password when applying Logi Report's built-in password rule. Then the password must contain at least one lowercase letter. |
| server.security.advanced_password.contains_number | true | Administration > Configuration > Advanced > Logi Report Password Rule > Number | The default value true means to include numbers in the password when applying Logi Report's built-in password rule. Then the password must contain at least one Arabic numeral. |
| server.security.advanced_password.contains_symbol | false | Administration > Configuration > Advanced > Logi Report Password Rule > Symbol | Set the property to true if you want to include symbols in the password when applying Logi Report's built-in password rule. Then the password must contain at least one character that is not a letter, numeral, or space. |
| server.security.advanced_password.contains_uppercase | true | Administration > Configuration > Advanced > Logi Report Password Rule > Uppercase | The default value true means to include uppercase letters in the password when applying Logi Report's built-in password rule. Then the password must contain at least one uppercase letter. |
| server.security.advanced_password.enabled | true | Administration > Configuration > Advanced > Advanced Password | The default value true means to enable the advanced password rule for Server. |
| server.security.advanced_password.limited_min_length | true | - | The default value true means to enable setting minimum number of characters that you can use in the password when applying Logi Report's built-in password rule. |
| server.security.advanced_password.min_length | 8 | Administration > Configuration > Advanced > Logi Report Password Rule > Min Length | Specify the minimum number of characters that you can use in the password when applying Logi Report's built-in password rule. The number should be larger than the password minimum length defined for all users created in the Security - User page. |
| server.security.advanced_password.user_defined_rule | false | - | Set the property to true if you want to enable the user defined password rule. If it is false, Server applies the built-in password rule. |
| server.security.check_csrf | true | - | The default value true means to enable Cross Site Request Forgery (CSRF) checking for Server. |
| server.security.expose_my_folders | false | - | Set the property to true if you want administrators to access other users' personal folders to manage them.
By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| server.security.group.cache.size | 50 | Administration > Configuration > Cache > Security Cache > Number of Group Objects | Specify the number of group objects that you can store in the security cache. The value should be an integer. |
| server.security.protection.cache.size | 100 | Administration > Configuration > Cache > Security Cache > Number of ACL Objects | Specify the number of ACL (Access Control List) objects that you can store in the security cache. The value should be an integer. |
| server.security.role.cache.size | 50 | Administration > Configuration > Cache > Security Cache > Number of Role Objects | Specify the number of role objects that you can store in the security cache. The value should be an integer. |
| server.security.use_csrf_token | false | - | Set the property to true if you want to use CSRF token to prevent CSRF attacks. It works when server.security.check_csrf is true. |
| server.security.user.cache.expiretime | 180 (seconds) | Administration > Configuration > Cache > Security Cache > Expire Time (seconds) | Indicates the expiration time of the user/role/group/ACL object in the security cache. An object will be removed from the cache if it has not been accessed for a period longer than the expiration time since its last access. A value of 0 means that no object will be removed from the cache, providing optimal performance when the built-in security system and all security cache sizes are larger than the actual object number. |
| server.security.user.cache.size | 1000 | Administration > Configuration > Cache > Security Cache > Number of User Objects | Specify the number of user objects that you can store in the security cache. The value should be an integer. |
| server.session.timeout | 1800000 | Administration > Configuration > Advanced > User Session Timeout | Specify the time you can have to gain access to Server or not to perform any operations on the Server, before Server signs you out. The default session timeout is 1800000 seconds, which is 500 hours. |
| server.temp.max_file_per_folder | 500 | - |
Logi Report Server creates folders in the <install_root>\temp directory to put temporary files for holding bursting data only. This property controls the maximum number of temporary files in one folder.
By default, this property is not in the server.properties file. You need to add it manually if you want to use it. |
| server.ui.set_permission.group | false | - | Set the property to true if you want to display group permissions in the permission setting UI for the server resource tree node and Version Properties, and the Scheduling to Version and Advanced Run dialog boxes. |
| server.ui.set_permission.role | true | - | The default true means to display role permissions in the permission setting UI for the server resource tree node and Version Properties, and the Scheduling to Version and Advanced Run dialog boxes. |
| server.ui.set_permission.user | false | - | Set the property to true if you want to display user permissions in the permission setting UI for the server resource tree node and Version Properties, and the Scheduling to Version and Advanced Run dialog boxes. |
| server.url.help | /help/userguide/server/index.htm | - | Specify the URL of the Logi Report Server Guide. |
| server.url.tutorial | /help/tutorial/index.htm | - | Specify the URL of the Logi Report Tutorial documentation. |
| server.url.website | https://www.logianalytics.com | - | Specify the URL of the Logi Report Home Page. |
| server.use_original_default_parameter_value | false | - | Set the property to true if you want to use the original default parameter values for running/scheduling a report/dashboard via URL when you do not specify the parameter value.
|
| server.version.from.temp | false | Administration > Configuration > Advanced > Enable "Publish to Versioning System" for Background Tasks View | Set the property to true if you want to enable the "Publish to Versioning System" option when running a report in the Advanced mode in a format other than the Page Report or Web Report format. For more information, see another way to publish a report to version. |
| server.version.max_amount_per_subfolder | 3000 | - | Specify the maximum number of subfolders in each folder in the history folder. For more information, see server.version.max_amount_per_subfolder. |
| server.version.retain.paramfile | false | - | Set the property to true if you want to retain the parameter file (if there is one) when you remove an archive version from the version table. Server keeps the parameter file in the history folder. |
| server.version.show.paramcontents | false | - | Set the property to true if you want to show the parameter contents in the version table. Then Server adds a new column named Parameter Contents to the version table. |
| server.version.subfolder_amount | 100 | - | Specify the number of folders in the server history folder. |
| TASK | |||
| task.duration.check_cycle | 30 | Administration > Configuration > Advanced > Status Refresh Interval |
Specify task duration check frequency in seconds. By default, Server checks task duration every 30 seconds.
|
| task.duration.enable | false | Administration > Configuration > Advanced > Enable Task Duration | Set the property to true if you want to enable setting a time duration for a task and asking Server to cancel the task or to notify you or someone else of the task status via email if the task has not yet finished running when the task duration is up.
When it is true, Server displays the Duration tab in the Advanced Run and Schedule dialog boxes. |
| task.initial.priority.ondemand | 7 | Server Console > Resources > Advanced Run > General > Priority | Specify the default priority level for the direct or advanced running tasks. The priority levels are from 1 to 10 in ascending order of lowest priority to highest priority. This property is available to administrators. By default, Server ignores this property unless you set queue.policy not equal to 0 in the server.properties file. |
| task.initial.priority.schedule | 5 | Server Console > Resources > Schedule > General > Priority | Specify the default priority level for the scheduled running tasks. The priority levels are from 1 to 10 in ascending order of lowest priority to highest priority. This property is available to administrators. By default, Server ignores this property unless you set queue.policy not equal to 0 in the server.properties file. |
| WEB | |||
| web.design_servlet_path | /webreporting | - | Specify the web design servlet mapping path. |
| web.dhtml_jsp_path | /dhtmljsp | - | Specify the mapping path of the Page Report Studio JSP files. |
| web.dhtml_servlet_path | /dhtml | - | Specify the Page Report Studio servlet mapping path. |
| web.force_excel_download_dialog box | false | - | Set the property to true if you want to display a File Download dialog box asking whether to either open the report or save the report file after activating a direct running task or submitting an advanced running task in Excel.
If false, the report opens directly. |
| web.force_pdf_download_dialog box | false | - | Set the property to true if you want to display a File Download asking whether to either open the report or save the report file after activating a direct running task or submitting an advanced running task in PDF.
If false, the report opens directly. |
| web.force_ps_download_dialog box | false | - | Set the property to true if you want to display a File Download dialog box asking whether to either open the report or save the report file after activating a direct running task or submitting an advanced running task in PostScript.
If false, the report opens directly. |
| web.force_rtf_download_dialog box | false | - | Set the property to true if you want to display a File Download dialog box asking whether to either open the report or save the report file after activating a direct running task or submitting an advanced running task in RTF.
If false, the report opens directly. |
| web.force_text_download_dialog box | false | - | Set the property to true if you want to display a File Download dialog box asking whether to either open the report or save the report file after activating a direct running task or submitting an advanced running task in Text.
If false, the report opens directly. |
| web.force_xml_download_dialog box | false | - | Set the property to true if you want to display a File Download dialog box asking whether to either open the report or save the report file after activating a direct running task or submitting an advanced running task in XML.
If false, the report opens directly. |
| web.help_servlet_path | /help | - | Specify the Page Report Studio help servlet mapping path. |
| web.ie.login.use_new_realm_name | false | - | Web browser remembers username and password automatically, which enables you to sign in without having to type username and password. When this property is true, Server requires a new realm name, then the username and password that web browser remembers cannot sign in. |
| web.jreport_servlet_path | /jrserver | - | Specify the Logi Report servlet mapping path. |
| web.monitor.link.enable | true | - | The default value true means that Server enables and displays Monitor on the Server Console > Administration > Other menu. You can select Monitor to access the Server Monitor UI from the Server. |
| web.page.option.convert.encoding | true | - | The default value true means to display the Enable Converting Encoding option in the Advanced Run and Schedule dialog boxes. |
| web.page.option.db | true | - | The default value true means to display the report's DB setting options in the Advanced Run and Schedule dialog boxes. |
| web.page.option.encoding | true | - | The default value true means to support encoding in the Advanced Run mode. |
| web.page.option.rootdir_of_folder_selector | - | - | Specify a valid folder path in which you can browse folders through a JSP folder selector when publishing resources locally from a client computer as an administrator. If the value is null, you can browse the whole file system. When publishing resources, you need to be an administrator to browse the server computer's file system by folder selector. |
| web.page.option.show_catalog | false | - | Set the property to true if you want users who are not system admin to see catalogs in the server resource tree on the Server Console. |
| web.page.option.show_name_with_postfix | true | Administration > Configuration > Advanced > Show Resource Name Extension > Logi Report Server | The default value true means to show the resource name extension in the resource tree on the Server Console. |
| web.page.option.stylegroup | true | - | The default value true means to display the Enable Style Group option in the Advanced Run and Schedule dialog boxes. |
| web.page.option.tasklistener | true | - | The default value true means to support task listener. |
| web.page.option.to_dhtml | true | - | The default value true means to support running reports in the Page Report format in the Advanced Run mode. |
| web.page.option.to_excel | true | - | The default value true means to support running reports in Excel in the Advanced Run mode. |
| web.page.option.to_html | true | - | The default value true means to support running reports in HTML in the Advanced Run mode. |
| web.page.option.to_pdf | true | - | The default value true means to support running reports in PDF in the Advanced Run mode. |
| web.page.option.to_ps | true | - | The default value true means to support running reports in PostScript in the Advanced Run mode. |
| web.page.option.to_rtf | true | - | The default value true means to support running reports in RTF in the Advanced Run mode. |
| web.page.option.to_text | true | - | The default value true means to support running reports in Text in the Advanced Run mode. |
| web.page.option.to_xml | true | - | The default value true means to support running reports in XML in the Advanced Run mode. |
| web.page.option.use_relative_app_url | true | - | The default value true means to use relative paths in the URL contained in the HTML contents Server returns, to avoid problems caused by you having a proxy server between Logi Report Server and your clients. |
| web.skin.dir | /skin | - | The skin folder in <install_root>\public_html contains all files concerning Page Report Studio skin. In an integration environment, this folder changes with context path. For example, after you deploy jreport.war to an application server, the property value changes to /jreport/skin automatically. |
| web.timeouts.report_wait | 170 | Administration > Configuration > Advanced > Time Before Moving to Background | Specify the time limit (in seconds) for trying to run a report (submitted using the Run or Advanced Run command) before regarding it as a large report and putting it into the Background Tasks list. |
| web.version.mark_unviewed | true | - | The default value true means to mark the report versions you haven't viewed in bold. |
| web.viewer.option.show_name_with_postfix | true | Administration > Configuration > Advanced > Show Resource Name Extension > Web Report Studio/Page Report Studio/JDashboard | The default value true means to show the resource name extension in the resource tree in Web Report Studio, Page Report Studio, and JDashboard. |
performance.cachecat and performance.cacherpt
The process of viewing reports is a combination of both loading reports from the hard drive and generating report files. It is obvious that skipping either of the two steps will shorten the elapsed time. Server enables you to cache reports and catalogs in memory, so that you do not have to load them from the hard drive, thereby improving performance.
performance.commit.thread and performance.commit.interval
When the value of the performance.commit.thread property is false, Server commits every change in the Version list, Schedule list, and Completed list immediately. For example, upon deleting a scheduled task from the Schedule list, Server will commit the action and refresh the Schedule list. If the property value is true, Server only commits changes in the Version list, Schedule list, or Completed list in the specified interval. By doing this, you can avoid frequently overwriting any related files in Server, thereby improving performance.
The performance.commit.interval property takes effect only when the performance.commit.thread property value is true.
This property enables you to customize the maximum number of concurrent reports, including background run reports and scheduled reports.
It is meaningful to set this property if your license permits a large number of concurrent reports and you want a smaller maximum number of concurrent reports. Typically, the Logi Report license enables an unlimited number of concurrent reports which can cause too many reports to complete for system resources at the same time.
The valid value range is between 0 and the maximum number of concurrent reports permitted by the license. Setting the property to a suitable value in accordance with your computer's usage will lead to marked improvement in performance. For example, if you have an unlimited license and you do not use queue control, the running speed may be comparatively slow. To achieve better performance, you can set performance.max.reports=4, so that only four reports run at the same time, while the other reports wait in the queue until one of the four has finished.
By default, the property value is 0, which means that the maximum number of concurrent reports depends on the license you purchased. For example, if you have a 20-report license, it will be up to 20 reports that can be running concurrently. Server places additional report requests into a waiting queue.
To speed up report delivery, Server delivers a single page of contents at a time. Logi Report Engine outputs the report contents in an HTML file to the web browser as soon as a single page has finished processing, while the rest of the report continues to process.
Data such as Total Page Number displayed in one page is temporary and is called dirty data. When data in a chart spans across one page, Server also displays it with dirty data. Server refreshes dirty data when Logi Report Engine finishes processing.
Each cached report uses some heap memory. If the heap memory is used up, Server throws an OutOfMemoryException.
Use the flag -Xms to specify the initial heap size and the flag -Xmx to specify the maximum heap size. For example, -Xms256m -Xmx4096m means that the initial heap size is 256M and the maximum heap size is 4096M.
You can refer to the Java Virtual Machine documentation for more information.
Specify an algorithm for calculating a role, user, or group's permission. Server supports two algorithms:
-
The permission accumulation algorithm
Server applies the permission accumulation algorithm if server.permission.algorithm=0.In this algorithm, a principal's permission is the sum of permissions assigned by the administrator and those inherited from its permission inherit tree. If the administrator does not set permissions or set no permission for the principal, the principal's permissions will be those inherited from the permission inherit tree.
-
The user permission replacement algorithm
Server applies the user permission replacement algorithm if server.permission.algorithm=1.In this algorithm, if the administrator does not set permissions for the principal, the principal's permission will be those inherited from its permission inherit tree. However, if the administrator sets permissions for the principal, the principal's permission will be those set by the administrator.
server.version.max_amount_per_subfolder
Specify the maximum number of subfolders in each folder in the history folder.
By default, Server creates 100 folders in the history folder (<install_root>\history), and each of these folders can further contain 3000 subfolders (also set by this property). However, these subfolders cannot hold any further subfolders.
First, Server puts the history information, such as archive versions and parameter files, in folder 1. When the number of subfolders in folder 1 has reached the maximum subfolder amount, Server starts to put files in folder 2. When folder 2 is filled up, Server uses folder 3, then folder 4, folder 5, and so on, until it fills up all the 100 folders.
When filling up all 100 folders with subfolders, Server creates another 100 folders, named 101 to 200, and continues storing the history information in these folders, starting with folder 101. When the second 100 folders are full, Server creates another 100 folders, then a fourth 100 folders, a fifth 100 folders, and so on.