Skip to main content
pdf?stylesheet=default
Blackboard Help

bb-config.properties File

How to Edit the bb-config.properties File

  1. Open the bb-config.properties file in the following directory:

    UNIX Syntax:

    %/usr/local/blackboard_directory/config

    Windows Syntax:

    C:\blackboard_directory\config

  2. Edit the parameters using the information provided in the appropriate section in this document or in the following table.
  3. Save and close the file.
  4. Update the configuration by running the PushConfigUpdates command. To learn more, see PushConfigUpdates.

    UNIX Example:

    %/usr/local/blackboard_directory/tools/admin/PushConfigUpdates.sh

    Windows Example:

    C:\blackboard_directory\tools\admin\PushConfigUpdates.bat

Optimization Parameters in bb-config.properties

Optimization Parameters in bb-config.properties
Parameter Name Description
Apache HTTP Server
bbconfig.unix.httpd.minspareservers Dynamic mechanism for keeping a minimum number spare of servers available to handle simultaneous requests from a browser
bbconfig.unix.httpd.maxspareservers Dynamic mechanism for keeping a maximum number of spare servers available to handle simultaneous requests from a browser
bbconfig.unix.httpd.
startservers
Number of servers to start initially
bbconfig.unix.httpd.maxclients Maximum number of servers allowed to be running

This limits the number of clients that can connect at the same time. Blackboard Learn is compiled to support as many as 5,000 clients.

To avoid keepalive issues, this parameter can be set to a value higher than bbconfig.appserver.maxthreads. To learn more, see Configuring Database Connections.

bbconfig.unix.httpd.
maxrequestsperchild
Number of requests each child process is allowed to process before the child dies

Setting this parameter to a higher value reduces delays that are caused by spawning new Apache HTTPD child processes. Prolonged use is not an issue for Blackboard Learn.

bbconfig.unix.httpd.keepalivetimeout Number of seconds to wait for the next request from the same client on the same connection
bbconfig.unix.httpd.keepalive Whether to allow persistent connections (more than one request per connection)
bbconfig.unix.httpd.
MaxKeepAliveRequests
Maximum number of requests to allow during a persistent connection
bbconfig.webserver.compression Enables HTTP compression via GZip
Microsoft IIS
bbconfig.webserver.keepalive Whether to allow persistent connections (more than one request per connection)
Always make sure to review the setting with your hardware load balancer vendor.
bbconfig.webserver.keepalivetimeout Number of seconds to wait for the next request from the same client on the same connection
bbconfig.webserver.compression Enables HTTP compression via GZip
Apache Tomcat Database Connections
bbconfig.appserver.minthreads Minimum number of threads created for Tomcat
bbconfig.appserver.maxthreads Maximum number of threads allocated to Tomcat for 32-bit 1.4 GB RAM in the heapspace
This setting limits the number of requests that can be simultaneously processed by Tomcat. This number should match the bbconfig.unix.httpd.maxclients setting for Apache on UNIX platforms.
Deviating from the suggested maximum setting can have serious repercussions when searching for users and courses with minimal filtering.
To learn more, see Sizing the Maximum Thread Count.
bbconfig.appserver.maxthreads Maximum number of threads allocated to Tomcat for 64-bit 4 GB RAM in the heapspace.
This setting limits the number of requests that can be simultaneously processed by Tomcat.
Deviating from the suggested maximum setting can have serious repercussions when searching for users and courses with minimal filtering.
This number should match the bbconfig.unix.httpd.maxclients setting for Apache on UNIX platforms.
To learn more, see Sizing the Maximum Thread Count.
bbconfig.min.heap size.tomcat Minimum heap size allocated to the Tomcat JVM
bbconfig.max.heap size.tomcat Maximum heap size allocated to the Tomcat JVM for 32-bit configurations
bbconfig.max.perm size.tomcat Maximum perm space allocated to the Tomcat JVM
bbconfig.max.stack size.tomcat Stack size for each thread in the Tomcat JVM
bbconfig.jvm.options.
extra.tomcat
Additional settings used to configure the JVM
To learn more, see Using Non-Standard (-XX) JVM Arguments.
bbconfig.database.
instance.maxpoolsize
Maximum number of connections waiting to serve database requests

The BBLEARN (legacy: BB_BB60) connection pool is the primary database connection pool interface for the Blackboard schema in Tomcat. Blackboard recommends that this value be sized conservatively based on need and usage. Start with a maximum value of 100, and then increase the maximum size as the Tomcat application threads increase.

Optimally, this value should be equal to, but not greater than, the bbconfig.appserver.maxthreads parameter setting.

JDBC connection consumption is a symptom of a performance issue or degradation. Increasing the JDBC connection count will not always solve a performance issue. Performance issues should be diagnosed with care and accuracy and identify bottlenecks at their source.

bbconfig.database.
instance.minpoolsize
Number of connections waiting to serve database requests
bbconfig.database.instance.
mssql.initpoolsize
Initial number of connections waiting to serve database requests for SQL Server
bbconfig.database.
instance.timeout
Time window in which database transactions must be processed before a timeout occurs

Recommended JVM Tuning Set

Each release of Blackboard Learn has its own recommended tuning set. To learn more, see the Release Notes for the release that you are installing.