Enterprise Manager: BBjServices > Settings
To view this topic for the preceding Enterprise Manager, see EM Java App: Server Information (Environment Tab) and EM Java App: Session Pinning.
Description
The BBjServices Settings panel in Enterprise Manager allows administrators to configure a variety of server properties, including: Logging Settings, Environment, Trigger Configuration, BBjServices, Replication, Table Analysis Queue Performance, 3rd Party Database Special Settings, Java Virtual Machine, Jetty Licensing Settings, Lucene Settings, Operating System, Thin Client Performance, and Global Database Settings. It also includes access to the BBj.properties file for advanced configuration management.
To access BBjServices settings, select BBjServices > Settings and the Settings tab opens to the right.
Java Virtual Machine
64/32 Bit |
Bit mode of the system. |
Java Vendor |
JVM vendor. |
Java Version |
Current Java version installed. |
Logging Settings
Admin Keep Log (days) |
Number of days to retain the Admin Server log files. |
Admin Log |
Full path and primary filename for the Admin Server log files. Filenames will be appended with a number such as AdminServer.log.0. |
Admin Log Max Size (MB) |
Maximum size for the Admin Server log file before rolling over to a new file. Old files will be kept for the number of days specified in the “keep” setting. |
BBjServices Keep Log (days) |
Number of days to retain the BBjServer log files. |
BBjServices Log |
Full path and primary filename for the BBjServices log files. Filenames will be appended with a number such as BBjServices.log.0. |
BBjServices Log Level | Level of debug logging to output to the BBjServer log files. |
BBjServices Log Max Size (MB) |
Maximum size for the BBjServices log file before rolling over to a new file. Old files will be kept for the number of days specified in the “keep” setting. |
Config Change History |
Maintain a history of all changes made to configuration options and files. BBjServices consists of a number of components requiring a variety of configuration options and files. Maintaining a history of all changes made to these files makes it possible for administrators to better manage system. |
Debug Keep Log (days) |
Number of days to retain the Debug log files. |
Debug Log |
Full path and primary filename for the Debug log files. Filenames will be appended with a number such as Debug.log.0. |
Debug Log Level |
Level of debugging output to display in the debug log files. |
Debug Log Max Size(MB) |
Maximum size for the Debug log file before rolling over to a new file. Old files will be kept for the number of days specified in the “keep” setting. |
File Open Statistics |
Statistics of the open files. |
Filesystem Debug Level | Level of debug logging to output to the Filesystem.log files. |
Filesystem Keep Log (days) |
Number of days to retain the Filesystem Server log files. |
Filesystem Log |
Full path and primary filename for the Filesystem Server log files. Filenames will be appended with a number such as FilsystemServer.log.0. |
Filesystem Log Max Size(MB) |
Maximum size for the Filesystem Server log file before rolling over to a new file. Old files will be kept for the number of days specified in the “keep” setting. |
Heapdump Directory |
The full path to a directory to hold future BBjServices heap dump files. Heap Dump file names will follow the format. |
Max Log File Viewer (MB) |
Maximum size of log files that can be opened in the log file viewer. |
Mem Stats Freq (minutes) |
Interval in minutes between logging of the current memory statistics. If you set it to 5 min, then it logs the current memory usage every 5 minutes. This is the information that shows up in the memory usage graph. For finer control and more detailed metrics related to memory usage and other JVM-related information in BBj 18.00+, see BBj Metrics. |
PRO/5 DS Keep Log (days) |
Number of days to retain the PRO/5 DS Server log files. |
PRO/5 DS Log | Full path and primary filename for the PRO/5 DS Server log files. Filenames will be appended with a number such as Pro5DSServer.log.0. |
PRO/5 DS Log Max Size (MB) |
Maximum size for the PRO/5 DS Server log file before rolling over to a new file. Old files will be kept for the number of days specified in the “keep” setting. |
SQL Engine Debug Level |
Level of debugging output to display in the SQLEngineServer.log files. |
SQL Engine Log Level |
Level of optimization and query-related logging to display in the SQLEngineServer.log files. Note that including optimization logging will drastically increase the size of the log files. Logging levels include: Partial Optimization, Complete Optimization, and User/SQL Statement. The optimization levels include information typically useful for BASIS Support/Engineering when looking into query performance issues. User/SQL Statement logging logs all SQL statements executed and includes the user who executed the statement. |
SQL Keep Log (days) |
Number of days to retain the SQL Engine Server log files. |
SQL Log |
Full path and primary filename for the SQL Engine Server log files. Filenames will be appended with a number such as SQLServer.log.1, SQLServer.log.2, etc., as the log is rotated according to the configured size and retention settings. |
SQL Log Max Size (MB) |
Maximum size for the SQL Engine Server log file before rolling over to a new file. Old files will be kept for the number of days specified in the “keep” setting. |
Web Server Keep Log (days) |
Number of days to retain the Jetty Web Server log files. |
Web Server Log |
Full path and primary filename for the Jetty Web Server log files. Filenames will be appended with a number such as Jetty.out.0. |
Web Server Log Level |
Level of logging to include in the Jetty.out file. |
Web Server Log Max Size (MB) |
Maximum size for the Jetty Web Server log file before rolling over to a new file. Old files will be kept for the number of days specified in the “keep” setting. |
Environment
Allow Pipes |
Allow BBjServices to use pipes. |
BBj Function Debugging | Enables detailed logging of BBj function calls and execution flow. When activated, this setting assists developers in tracing and diagnosing issues within BBj programs by capturing comprehensive debug information. |
Bypass Local Dataserver Check | Skips verification for the presence of a local Data Server instance. |
Cache Directory |
Change the default location for caching. |
Dump Filesystem Cause Stack |
Dumps a stack trace to the debug log file. |
Dump Threads On Terminate Process | Triggers a thread dump before terminating one or more server processes. Useful for diagnosing issues by capturing thread activity prior to shutdown. |
*Enable TLS 1.3 | Allows the BBj server to use the latest Transport Layer Security (TLS) protocol version, providing enhanced encryption and security for network communication. |
*Exclusive File Access |
Enables or disables the restriction that allows only one process to access a file at a time. |
Flush After Each FULLTEXT Index Write |
Forces the buffer to flush after every FULLTEXT index write operation, significantly improving data reliability at the cost of reduced performance. |
Heartbeat Timeout (ms) | Set the heartbeat timeout. Default: 40000 |
Interpreter Debug |
Enable/disable to allow interpreter debugging. |
*Log Directory |
Set the default log directory. |
Max ASCII Program Size |
Defines the maximum allowable size (in bytes) for ASCII-based BBj programs, limiting how large a program can be when saved or compiled. |
NVARCHAR as Fixed Length CHAR |
Converts NVARCHAR columns received from third-party DBMS SQL channels into fixed-length CHAR fields for compatibility. |
Notify On Internal Error |
Send notification when an internal error occurs. |
PDF Font Directory |
Set the directory for PDF fonts. |
Query Printers On Startup |
Enable/disable to check for available printers. |
Release On Lost Connection |
Close open files when the connection is lost. |
Required Explicit Read-Only |
When set to true, the OPEN verb will only open files in read-only mode when the O_RDONLY option is explicitly specified. |
*SQL ENCRYPT/DECRYPT Functions Match BBj | Ensures that SQL ENCRYPT and DECRYPT functions behave consistently with BBj's native ENCRYPT and DECRYPT functions. |
Secure NTDS Encrypter |
The class that is used as the secure NTDS encrypter. |
Single Threaded Interpreters SPROC/Triggers |
Enable/disable single threaded interpreters. |
Skip Program Cache File |
Enable/disable program caching. |
Skip Query Analysis |
Enable/disable Query Analysis on a BBjServices-global level. |
Thin Client JVM Wait Time |
Set the wait time for JVM thin client. |
Thread Pool Size |
Set thread pool size Default: -1. |
Use Fork On File Creation |
Enable/disable fork for file creation. |
*Use SSL on Filesystem |
Enable/disable SSL for filesystem. |
Use Windows Permissions |
Enable/disable windows permissions. |
*User Authentication |
Enable/disable user authentication. |
*Web User |
Set default user for use with BUI. Default is "nobody". |
Working Directory |
Set BBjServices working directory. |
* Changes to this property require the administrator to manually restart BBjServices.
Trigger Configuration
Allow Trigger Debugging |
Check this box to allow debugging of triggers. |
*Config File |
Set the config file for triggers. |
*Password |
Set the password. |
*User Name |
Set the user name for the trigger. |
*Working Directory |
Set the working directory for triggers. |
* Changes to this property require the administrator to manually restart BBjServices.
BBjServices
BBj Build Date |
BBj build data and time. |
BBj Build ID |
BBj build ID. |
BBj Version |
BBj version. |
BBjServices Start Time |
Time and date that BBj Services was started. |
Browser EM Login Title |
Defines the text displayed at the top of the login screen when accessing the Enterprise Manager through a browser. |
Grafana Dashboard URL |
Specifies an optional link to a Grafana dashboard for visualizing BBjServices metrics and performance data. |
Replication
Check DB For Encryption Passwords |
Enables verification of database encryption credentials before allowing access to encrypted content. |
Deny as Replication Target |
Prevents the server from being used as a target in BBj replication configurations |
Replication Recopy Delay (min) | The number of minutes replication waits before checking to see if there are any files that need to be recopied due to changes that could not be replicated on a record basis. |
*Replication/Audit Config Directory | The config directory for replication and auditing holds the replication/audit operations log files, which contain the replication and auditing operations not yet processed by the target. These files can grow large in some cases, so this setting allows administrators to designate a specific path to better manage storage and system performance. |
Table Analysis Queue Performance
Iterations Before Pause |
Number of times a table is analyzed before it it is paused. |
Pause Time (ms) |
The length of time for each pause. |
3rd Party Database Special Settings
Java Date Types (Uncheck for MS Access) |
This is a very unusual setting but necessary for various compatibility issues. Microsoft Access deals with dates in a unique way when interacting with the BBj ODBC Driver requiring the driver to return an older integer value for DATE type columns in the metadata. This is technically not correct according to the ODBC and JDBC specifications. However, in order to function with MS Access, this value must be UNCHECKED. The default is checked because it is technically correct. |
Java Virtual Machine
Java Module Options |
A Java module is a packaging mechanism that enables you to package a Java application or Java API as a separate Java module, allowing better encapsulation, dependency management, and control over access to internal code. |
Jetty Licensing Settings
To access the Jetty Licensing Settings in Enterprise Manager:
-
Log into Enterprise Manager and connect to a BBjServices instance.
-
Expand the BBjServices node in the left tree.
-
Select the Settings node.
-
Scroll down until the Jetty License Settings section displays, as shown below:
License Attempt Timeout |
Longest time to wait (in ms) for a license. |
Max BBJSP Licenses |
Maximum number of licenses for BBJSP applications.* |
Max BBjServlet Licenses | Maximum number of licenses for Servlets.* |
Max BBxServlet Licenses | Maximum number of licenses for BBxServlets.* |
Max License Usage |
Maximum number of licenses for all servlets.* |
Max Servlet Licenses |
Maximum number of licenses for BBjServlets.* |
Max Web Service Licenses |
Maximum number of licenses for Web Services.* |
Queue Size |
How many requests can wait for a license.* |
Retry Interval |
Length of the pause, in milliseconds, between attempts to obtain a license. |
* Items marked with an asterisk (*) denote that a zero (0) value indicates that the setting is unlimited.
When servlets are executed, licenses are borrowed for the duration of the execution cycle. This can lead to license limiting factors around servlets and web services since servlets may not be able to obtain a license when under load.
-
Ability to control how many licenses are available to the web layer.
-
A timeout limit for how long a servlet or web service will wait for a license to become available.
-
The number of requests to allow to wait for a license.
If a license is not immediately available to a request, that request will wait for one to become available unless there are already the specified number of waiting requests. If a request is unable to obtain a license due to timeout waiting or no more waiting slots, then the request will receive HTTP error 503.
Make sure to check all license usage properties when making changes, because the most restrictive Max License property is the one that will take effect.
For example, if you increase the Max BBxServlet Licenses property beyond the value of the Max Licenses property, the increase will not have an effect, and the Max Licenses will continue to impose a stricter limit on the BBxServlet license usage.
Lucene Settings
Max Document Size(MB) |
Maximum size of the documents or records stored in a Lucene index. This include document indexes as well as FULLTEXT indexes in SQL. |
Max Search Results |
Maximum number of search results that a Lucene-related search can return. This applies to document indexes and FULLTEXT indexes in SQL. The larger the value, the more memory will potentially be utilized when performing search queries, which may impact performance depending on system resources. |
Operating System
OS Name |
Name of the operating system. |
OS Version |
Current version of the operating system. |
Thin Client Performance
Pin Programs and Resources |
Enable/disable BBj to keep programs and resources in memory. |
Pin by BBj Session |
Enable/disable BBj to keep the session in memory. |
Recheck Session Classpath |
Enable/disable BBj to check the session classpath. |
Suppress Client Object Errors |
Enable/disable client object messages from the sysconsole. |
Suppress Printer Ack Back |
Enable/disable printer ack back messages from the sysconsole. |
Suppres UI Ack Back |
Prevents user interface acknowledgment messages from being sent back to the client, reducing network traffic in high-performance environments. |
Use DVK License If Present |
Enable/disable to force BBj to use a DVK license. |
Global Database Settings
System Connection User |
User account used by the SQL engine for system-level database access operations such as reading/writing to data dictionary files. This is typically used when using data server syntax to access data dictionary files remotely. In most cases, this setting should be left blank unless a specific system-level SQL user is required. |
BBj.properties Tab
Select the BBj.properties tab at the bottom of the BBjServices Settings page to display a read-only version of the current contents of the BBj.properties file. This may be useful for displaying properties that exist in the file, but not standard and thus not configurable from the Enterprise Manager UI.