Enterprise Manager logoEM: BBjServices > Settings

Description

The BBjServices Settings panel centralizes configuration options for managing BBjServices operations within Enterprise Manager. It provides categorized controls for logging, environment variables, triggers, replication, performance tuning, licensing, operating system details, and database connectivity, ensuring administrators can fine-tune system behavior, security, and resource utilization in a unified interface.

Note: Items marked with an asterisk (*) denote that a zero (0) value indicates that the setting is unlimited.

Location

Enterprise Manager logoEM NavigatorBBjServicesSettings

Toolbar

Button Function
Enables to choose a folder/file from your local system.
refresh button Refreshes the displayed list of applications and their status.
Removes/deletes selected application(s) or files from the system.
Creates a new folder within currently displayed directory.


Logging Settings

The Logging Settings panel centralizes configuration for capturing and retaining system activity across administrative, service, debug, and filesystem operations, defining log file paths, retention periods, size limits, and verbosity levels while also enabling features such as configuration change tracking, file statistics monitoring, and heap dump management to support precise diagnostics and effective system auditing.

Logging Settings List


Settings Descriptions

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

Defines how much detail BBjServices records in its logs, from basic informational messages to highly detailed diagnostic entries that help with monitoring and troubleshooting.

Value Description
INFO Captures standard operational messages that confirm BBjServices activities and highlight key events without including extensive debug-level details.
CONFIG Records configuration-related details that document system settings and parameter changes, ensuring clear traceability of adjustments made within BBjServices.
FINE Log level records detailed runtime and diagnostic events beyond INFO/CONFIG, useful for debugging, while remaining less verbose than FINER and FINEST.
FINER Log level records more detailed diagnostic messages than FINE, giving clearer insights into system activity while still being less extensive than FINEST.
FINEST Log level captures the most detailed diagnostic messages available, offering maximum visibility into system processes for in-depth troubleshooting and analysis.

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

Determines how much detail is captured in debug logs, ranging from targeted configuration details to full system activity, helping administrators choose the right depth of information for monitoring and troubleshooting.

Value Description
ALL Captures every available debug message across all levels, ensuring complete visibility into system activity for the most thorough monitoring and troubleshooting.
CONFIG Records configuration-related details that document system settings and parameter changes, ensuring clear traceability of adjustments made within BBjServices.
FINE Log level records detailed runtime and diagnostic events beyond INFO/CONFIG, useful for debugging, while remaining less verbose than FINER and FINEST.
FINER Log level records more detailed diagnostic messages than FINE, giving clearer insights into system activity while still being less extensive than FINEST.
FINEST Log level captures the most detailed diagnostic messages available, offering maximum visibility into system processes for in-depth troubleshooting and analysis.

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

  • When unchecked, file-level access activity is not tracked.

  • When checked, detailed statistics on file openings are collected for performance monitoring and diagnostic purposes.

 

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 Settings

The Environment Settings define the core runtime behavior of BBjServices, giving administrators precise control over system performance, security, and error handling. Options include enabling TLS 1.3 for secure communication, enforcing exclusive file access to prevent conflicts, and configuring heartbeat timeouts to maintain stable client-server connections. Directories for cache, logs, and fonts can be explicitly set, while additional controls support debugging, error notifications, printer queries, and SQL encryption alignment. These parameters collectively provide a streamlined way to fine-tune resource management, connection stability, and system reliability in production environments.

Environment Settings List


Settings Description
Allow Pipes
  • When unchecked, interprocess communication through BBj named pipes is disabled, preventing applications from exchanging data using this method.

  • When checked, pipe functionality is enabled, allowing processes to communicate and transfer information efficiently within the BBj environment.

BBj Function Debugging
  • When unchecked, function-level debugging in BBj remains disabled, ensuring normal execution without detailed diagnostic tracking.

  • When checked, debugging is enabled, capturing granular information about BBj function calls to assist with troubleshooting and performance analysis.

Bypass Local Dataserver Check
  • When unchecked, the system verifies whether a local Data Server is available before processing database requests, ensuring standard connection validation.

  • When checked, this verification is skipped, allowing database operations to proceed without performing the local server check.

Cache Directory

Change the default location for caching.

Dump Filesystem Cause Stack
  • When unchecked, only the main filesystem error is logged, showing limited detail.

  • When checked, the complete error chain is logged, including all underlying causes, to provide clearer insight for troubleshooting.

Dump Threads On Terminate Process
  • When unchecked, process termination proceeds without generating a thread dump.

  • When checked, BBjServices captures a thread dump immediately before terminating one or more server processes to aid diagnostics.

*Enable TLS 1.3
  • When unchecked, BBj network communication relies on older Transport Layer Security (TLS) versions with lower security guarantees.

  • When checked, the server enforces TLS 1.3 to provide stronger encryption, and improved overall protection for client-server data exchange.

*Exclusive File Access
  • When unchecked, files can be opened simultaneously by multiple processes, which may increase flexibility but risks data conflicts.

  • When checked, each file is locked for exclusive access by a single process, ensuring data integrity and preventing concurrent write operations.

Heartbeat Timeout (ms) Heartbeat timeout value (milliseconds) that controls how long BBjServices waits for a heartbeat before timing out, default 40,000 ms. Increasing the value tolerates longer pauses, decreasing it detects unresponsive sessions sooner.
Interpreter Debug
  • When unchecked, the BBj interpreter runs with debugging disabled, preventing debugger attachment and avoiding any added diagnostic overhead.

  • When checked, interpreter debugging is enabled so the interpreter can be debugged from compatible tools.

*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

  • When unchecked, NVARCHAR columns retrieved from third-party SQL database channels remain variable-length fields, preserving their original behavior and storage characteristics.

  • When checked, NVARCHAR columns are automatically converted into fixed-length CHAR fields, ensuring compatibility with systems or applications that require consistent field lengths.

Notify On Internal Error
  • When unchecked, internal server errors are only written to the logs without user notification, limiting visibility to administrators reviewing log files.

  • When checked, the system actively alerts administrators of internal errors in real time, ensuring immediate awareness for faster troubleshooting.

PDF Font Directory Set the directory for PDF fonts.
Query Printers On Startup
  • When unchecked, BBjServices skips printer discovery during startup, reducing service start time but leaving the printer list to be resolved later the first time printing is used.

  • When checked, BBjServices queries the host operating system at startup and caches all available printers so they are immediately available to BBj printing features. See: BBjPrinter.

Release On Lost Connection
  • When unchecked, a dropped client session can leave its in-use resources (such as open files or locks) in place until normal cleanup occurs.

  • When checked, the server automatically frees resources held by the disconnected session, preventing stale locks and allowing other users to proceed.

Require Explicit Read-Only
  • When unchecked, files can be opened in read-only mode without requiring the explicit O_RDONLY option in the OPEN verb.

  • When checked, the OPEN verb enforces explicit use of the O_RDONLY option before granting read-only access, ensuring stricter control over file operations.

*SQL ENCRYPT/DECRYPT Functions Match BBj
  • When unchecked, SQL ENCRYPT and DECRYPT functions may follow database-specific behavior that differs from BBj’s native encryption functions.

  • When checked, SQL ENCRYPT and DECRYPT functions align with BBj’s native behavior, ensuring consistent handling of encryption and decryption across both environments.

Secure NTDS Encrypter

The class that is used as the secure NTDS encrypter.

Single Threaded Interpreters SPROC/Triggers
  • When unchecked, stored procedures and triggers can run in multi-threaded interpreters, allowing concurrent execution for higher performance.

  • When checked, stored procedures and triggers run in single-threaded interpreters, ensuring serialized execution for consistency and easier debugging.

Skip Program Cache File
  • When unchecked, program executions make use of the cache file to improve performance by reusing previously compiled versions.

  • When checked, each program execution bypasses the cache file, forcing recompilation for every run and ensuring the most current version is always executed.

Skip Query Analysis
  • When unchecked, SQL statements are analyzed and optimized before execution to improve query efficiency and performance.

  • When checked, query analysis is bypassed, and statements are executed directly without optimization, which may reduce processing overhead but can result in slower performance for complex queries.

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
  • When unchecked, file creation runs within the current process, which may slow down performance if the operation is resource-intensive.

  • When checked, file creation is handled in a forked process, improving responsiveness and isolating the operation to reduce the impact on the main server thread.

*Use SSL on Filesystem
  • When unchecked, BBjServices performs filesystem operations over a non-encrypted channel without SSL/TLS.

  • When checked, filesystem I/O is secured with SSL/TLS (property Use SSL on Filesystem) and takes effect after a BBjServices restart.

Use Windows Permissions
  • When unchecked, Windows permissions integration is disabled for BBjServices.

  • When checked, Windows permissions are enabled and enforced for the service.

*User Authentication
  • When unchecked, BBjServices does not enforce login at connection time, so sessions run without credential checks and any authorization must be handled by the application or operating-system context.

  • When checked, BBjServices requires valid user credentials and applies the configured security model (BBj Users/Groups or, if enabled, Windows permissions) before granting access.

*Web User

Set default user for use with BUI. Default is nobody.

Working Directory

Set BBjServices working directory.

Trigger Configuration

The Trigger Configuration defines the settings required to manage and secure database triggers, including authentication credentials, the trigger configuration file, the assigned user, and the working directory. These options ensure that triggers operate under controlled environments with appropriate access restrictions, while the debugging option provides developers with diagnostic insight when enabled.

Note: Changes to this property require the administrator to manually restart BBjServices.

Trigger Configuration List

Settings Description

Allow Trigger Debugging

  • When unchecked, triggers run without developer-level diagnostic output, keeping execution silent and streamlined.

  • When checked, triggers generate detailed debugging information to help identify logic or runtime issues during development or troubleshooting.

*Password

Password field secures trigger configuration access by requiring an authentication credential, ensuring only authorized administrators can define, modify, or manage trigger settings.

*Trigger Config File

Designates the location of the configuration file that defines trigger behavior, and clicking the icon opens a file selection dialog to browse and assign the desired file path directly.

*User Name

Set the user name for the trigger.

*Working Directory

Click the icon to set the working directory for triggers.

BBjServices

The BBjServices section consolidates essential runtime details, including the build date, build ID, BBj version, and the precise start time of the running services, while also providing customizable fields such as the browser login title and Grafana dashboard URL for monitoring integration. This configuration area helps administrators verify service state, confirm version alignment, and tailor the user-facing login interface, ensuring both operational accuracy and user-friendly system management.

Note: Changes to this property require the administrator to manually restart BBjServices.

BBjServices Settings List

Settings Description

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

The Replication section manages how databases synchronize across systems by controlling password validation, replication eligibility, retry timing, and configuration file locations. Options include verifying encryption passwords during replication, preventing a server from being used as a replication target, and defining the recopy delay to control retry intervals. The configuration directory field, supported by a folder selection dialog, designates where replication and audit settings are stored, ensuring consistency, security, and reliability in distributed environments.

Replication Settings List

Settings Description

Check DB For Encryption Passwords

  • When unchecked, replication proceeds without validating database encryption credentials, permitting access attempts without any credential verification.

  • When checked, replication enforces validation of encryption passwords before granting access to encrypted content.

Deny as Replication Target

  • When unchecked, the server can participate as a valid target in BBj replication configurations.

  • When checked, the server is explicitly blocked from serving as a replication target, preventing any replication data from being directed to it.

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.

Lucene Settings

Lucene Settings control the indexing and search behavior for FULLTEXT operations by defining how documents are written, stored, and retrieved within BBj. Configuration options include flushing indexes immediately after each write for consistency, limiting the maximum document size to manage storage efficiency, setting the maximum number of search results returned to ensure performance, and enabling asynchronous index writes to optimize system responsiveness.

Lucene Settings List

Settings Description
Flush After Each FULLTEXT index Write
  • When unchecked, index writes are buffered and committed in batches, improving performance at the cost of possible data loss if the system fails before flushing.

  • When checked, each FULLTEXT index write is immediately flushed to disk, ensuring maximum data safety and consistency but with potential impact on write performance.

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.

Write FULLTEXT Index Asynchronously
  • When unchecked, FULLTEXT index updates occur synchronously with data writes, ensuring immediate consistency between content and index but potentially slowing write operations.

  • When checked, index updates are performed asynchronously in the background, improving write performance while introducing a short delay before new or updated content appears in search results.

Table Analysis Queue Performance

The Table Analysis Queue Performance controls how system resources are managed during automated table analysis operations by regulating workload pacing. The Iterations Before Pause setting determines how many analysis cycles run before the process pauses, while the Pause Time (ms) setting specifies the duration of each pause. Together, these options balance performance and resource usage, ensuring that large-scale table analysis does not overload the server or impact concurrent operations.

Table Analysis Queue Performance Settings List

Settings Description

Iterations Before Pause

Number of times a table is analyzed before it is paused.

Pause Time (ms)

The length of time for each pause.

3rd Party Database Special Setting

The 3rd Party Database Special Settings section manages compatibility between BBj and external databases that do not fully comply with ODBC/JDBC standards. It ensures smooth integration by adjusting specific behaviors, such as handling of Java DATE types for Microsoft Access.

3rd Party Database Special Setting

Setting Description

Java DATE Types (Uncheck for MS Access)

  • When unchecked, DATE type columns are returned to Microsoft Access in its expected legacy integer format, ensuring compatibility with Access despite the behavior being non-standard per ODBC and JDBC specifications.

  • When checked, DATE type columns follow the correct Java DATE standard, providing specification-compliant metadata handling for all other databases and drivers.

Java Virtual Machine

The Java Virtual Machine identifies runtime details of the environment in which BBj executes, including the bit mode of the operating system (64/32 Bit), the vendor supplying the JVM implementation (Java Vendor), and the specific Java release installed (Java Version), ensuring administrators can validate compatibility and performance requirements for proper system operation.

Java Virtual Machine Settings List

Settings Description

64/32 Bit

Bit mode of the system.

Java Vendor

JVM vendor.

Java Version

Current Java version installed.

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

The Jetty Licensing Settings section manages license allocation and usage within BBjServices by defining timeout limits, maximum servlet and service license counts, queue handling, and retry intervals. These settings control how many licenses are available to the web layer, how long a servlet or web service will wait for a license, and how many requests can queue for one. If a license is not immediately available, a request will wait until one becomes free unless the maximum number of waiting requests is reached; if the timeout expires or no slots remain, the request will fail with an HTTP 503 error.

Note: 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.

Note: Items marked with an asterisk (*) denote that a zero (0) value indicates that the setting is unlimited.

Jetty Licensing Settings List

Settings Description

License Attempt Timeout

Longest time to wait (in ms) for a license. Default is 5000 ms.

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 servlet and service licenses BBjServices can allocate, ensuring balanced resource use and preventing performance issues. See: BBjServlets.*

Max Web Services 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. Default is 200 ms.

Operating System

The Operating System section provides system-level details about the environment running BBjServices, including the OS name and version reported by the host platform.

Operating System Settings List

Settings Description

OS Name

Name of the operating system.

OS Version

Current version of the operating system.

Thin Client Performance

The Thin Client Performance section provides configuration options that optimize how BBj thin clients handle program execution, resource management, and communication feedback. These settings control behaviors such as session-based resource pinning, classpath validation, error and acknowledgment suppression, and optional license use, helping balance performance efficiency with reliability during client-server interactions.

Thin Client Performance Settings List

Settings Descriptions

Pin Programs and Resources

  • When unchecked, programs and resources are released from memory after use, requiring reloading each time they are accessed.

  • When checked, programs and resources remain pinned in memory, reducing reload overhead and improving performance for repeated access.

Pin by BBj Session

  • When unchecked, BBj does not retain the session in memory, releasing resources after the session ends.

  • When checked, BBj keeps the session in memory, reducing reload overhead and improving performance for recurring session use.

Recheck Session Classpath

  • When unchecked, BBj runs the session using the existing classpath without revalidating it, reducing overhead but ignoring potential updates.

  • When checked, BBj revalidates the session classpath on each use, ensuring any changes are applied at the cost of additional processing.

Suppress Client Object Errors

  • When unchecked, client object error messages are written to the system console, making all errors visible for diagnostic purposes.

  • When checked, client object error messages are suppressed, reducing console output and avoiding unnecessary error reporting during execution.

Suppress Printer Ack Back

  • When unchecked, printer acknowledgment messages are written to the system console, providing confirmation of printer communication.

  • When checked, printer acknowledgment messages are suppressed, reducing console output and avoiding unnecessary logging during normal operation.

Suppres UI Ack Back

  • When unchecked, user interface acknowledgment messages are sent back to the client, confirming UI actions but increasing network traffic.

  • When checked, acknowledgment messages are suppressed, lowering network overhead and improving performance in environments with frequent UI interactions.

Use DVK License If Present

  • When unchecked, BBj operates without using a DVK license, even if one is available.

  • When checked, BBj automatically consumes a DVK license when present, ensuring that DVK-licensed features are enabled.

Global Database Settings

The Global Database Settings section defines system-wide connection properties for BBjServices database operations. The System Connection User field specifies the default user account employed for internal processes and administrative database interactions, ensuring consistent authentication and management across all database instances.

Global Database Settings

Setting Description

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.

See Also

BBjAdminBase

Java Settings

Log Files

Memory Usage

Processes

Scheduling

Servers

EM Java App: Server Information

EM Java App: Session Pinning