Configuration Variables

This topic explains the purpose and structure of the AppConfig.yaml file used by BigFix UI. This configuration file enables administrators to manage application behavior and environment-level settings.

The BigFix UI supports a set of configuration variables that administrators can enable or disable to adjust functionality. These variables let you fine-tune the environment, enable advanced reporting features, or provide additional controls to end users.

Configuration variables are typically set in the application configuration file or as part of the environment setup. Once applied, the changes take effect immediately and influence how the application behaves.

The file follows YAML (YAML Ain’t Markup Language) syntax, which uses indentation to define hierarchy. Each setting is represented as a key–value pair that determines specific application behavior. Maintaining correct indentation and data types (for example, Boolean, string, or integer) is essential for proper operation.

Purpose

The AppConfig.yaml file lets administrators enable, disable, or customize BigFix UI features without modifying the underlying code or restarting the entire environment. These variables help configure system behavior, report management, and feature access dynamically.

Configuration Variables Reference

Table 1. AppSettings
Key Property Name Data Type Default Value Description
AppSettings AllowCustomJsonDefinitionReportsView bool false Enable to view custom JSON-based reports; disable to restrict to default reports.
AppSettings AllowCustomJsonDefinitionReportsCreation bool false Enable to create custom JSON-based reports; disable to restrict creation.
AppSettings AllowCustomJsonDefinitionReportsExecution bool false Enable to execute custom JSON-based reports; disable to block execution.
AppSettings AllowUseQna bool true Enable to allow QnA usage; disable to block it.
AppSettings LogVerbose bool false Enable to print debug logs; disable to hide them.
AppSettings LogAuditToSeparateFile bool true Enable to print Audit logs in a dedicated log file separate from main Application logs; disable to hide them.
AppSettings LogConsoleOnlyMsg bool false Enable to log only to console; disable to log to console and file
Table 2. AppConfig
Key Property Name Data Type Default Value Description
AppConfigType ByPassCertificateVerification bool true Enable to skip SSL/TLS certificate checks; disable to enforce verification.
AppConfigType WebServer string 127.0.0.1 Web server host/address to bind (e.g., 0.0.0.0, localhost).
AppConfigType CorsAllowedOrigins string * List of allowed origins for CORS requests. The default value * (all origins) is intended for initial setup only; set the allowed origins according to your organization's security policy before production use. For guidance, see CORS allowed origins configuration.
AppConfigType FIPSModeEnabled string "off" Enables FIPS-compliant Cryptography;Important for deployment that must meet US government Standards
AppConfigType DBConnectionMaxRetries int 100 Maximum retries for database connection on failure.
AppConfigType DBConnectionBackoffInterval int 2 0, 1, 2 correspond to immediate, short, and long backoff intervals between DB retries
AppConfigType DBConnectionMaxBackoffInterval int 4 sets the max DB retry backoff.
AppConfigType DbSchemaName string bfui Name of the database schema the application will use.
AppConfigType LogMaxSizeMb int 10 Maximum size (in MB) of a log file before it is rotated.
AppConfigType LogMaxBackups int 100 Maximum number of rotated log files to keep.
AppConfigType LogMaxAgeDays int 15 Maximum number of days to retain old log files before deletion.
AppConfigType LogCompression bool true Enable to compress rotated log files; disable to keep them uncompressed.
AppConfigType LogFormatJSON bool false Enable to output logs in JSON format; disable for plain text logs.
AppConfigType AccessTokenDurationInMins int 15 Duration in minutes before an access token expires.
AppConfigType RefreshTokenDurationInMins int 30 Duration in minutes before a refresh token expires.
AppConfigType EnableRenewalRefreshToken bool true Controls automatic renewal of refresh tokens when users request a new access token near expiration.
AppConfigType AutoRenewalRefreshTokenTimeInMins int 10 Time, in minutes, before refresh token expiration at which the token is automatically renewed. Applies when EnableRenewalRefreshToken is set to true.
AppConfigType DisableJobLogs bool false Enable to turn off job execution logging and reduce log volume; disable when troubleshooting job-related issues.
AppConfigType EnableDynamicPortSelectionIfInUse bool false Enable to allow the NATS server and other microservices to automatically find and bind to an available port if the configured port is already in use.
Note: If the default port is busy or occupied in your environment, you can enable dynamic port selection. When active, the system will automatically allocate and start on a new available port within the 8,000 to 9,000 port series.
Table 3. AsyncConfig
Key Property Name Data Type Default Value Description
AsyncConfig AsyncReportExpirySeconds int 900 Time, in seconds, after which a completed asynchronous report expires and is removed from the cache.
AsyncConfig AsyncReportWorkerCount int 8 Number of workers that process asynchronous report requests in parallel.
AsyncConfig AsyncReportWorkerTimeoutSeconds int 1800 Maximum time, in seconds, that an asynchronous report worker can run before it times out.
AsyncConfig AsyncReportsConsumerLag int 50 Maximum number of pending requests (consumer lag) allowed in the asynchronous reports queue.
AsyncConfig CachePurgeFrequencyMinutes int 180 Frequency, in minutes, at which expired asynchronous reports are purged from the cache.
AsyncConfig LagMonitorIntervalSeconds int 300 Interval, in seconds, at which the consumer lag of the asynchronous reports queue is monitored.
AsyncConfig MaxAsyncReportsPerUser int 4 Maximum number of asynchronous reports that a single user can run concurrently.

This will be applicable only when you do bulk processing, which will be upcoming in the future.
Table 4. LockBoxConfig
Key Property Name Data Type Default Value Description
LockBoxConfigType Port int 9010 Port number used by the LockBox service.
LockBoxConfigType WebServer string 127.0.0.1 Web server host/address to bind (e.g., 0.0.0.0, localhost).
LockBoxConfigType IntegrityAuditFrequencyInMinutes int 1440 Frequency, in minutes, of automated integrity audits that check all protected tables for data tampering.
Table 5. ColMgrConfigs
Key Property Name Data Type Default Value Description
ColMgrConfigs ContextTimeoutSeconds int 60 Maximum time, in seconds, allowed for a Collection Manager request context before it is cancelled.
Table 6. ColMgrSettings
Key Property Name Data Type Default Value Description
ColMgrSettings EnableLegacyScriptedReportsCreateAndModify bool false Allows creating and modifying legacy scripted reports in the Collection Manager.
ColMgrSettings RelevanceQueryMaxProperties int 20 Maximum number of properties allowed in a single relevance query.
ColMgrSettings RelevanceQueryMaxPropertyLength int 500 Maximum length, in characters, of each property in a relevance query.
Table 7. AuthConfigs
Key Property Name Data Type Default Value Description
AuthConfigs port int 9012 Handles authentication, token generation, and validation.
AuthConfigs BESUserCompositionPollingIntervalInMin int 5 Interval, in minutes, at which BigFix UI polls the BES server for changes to BES user composition.
Table 8. NotifConfigs
Key Property Name Data Type Default Value Description
NotifConfigs Port int 9224 Notification service starts on this port and enables notification center.
NotifConfigs KeepaliveIntervalSeconds int 15 Interval, in seconds, at which keepalive messages are sent to maintain open notification connections.
NotifConfigs NotifSoftDelIntervalMinutes int 240 Interval, in minutes, at which notifications are soft deleted (marked as deleted but retained in the database).
NotifConfigs NotifHardDelIntervalMinutes int 1440 Interval, in minutes, at which soft-deleted notifications are permanently removed from the database.
Table 9. Miscellaneous Configs
Key Property Name Data type Default value Description
LbUnsecureConfigs port int 9011 Handles unsecured load balancer service that routes HTTP traffic between internal components.
RnsConfigs port int 9013 Relay Notification Service — manages event propagation and notifications.
sqlRetConfigs port int 9016 SQL Return Service — handles SQL-based queries, fixlet streams, or analytics results.
ExpRetConfigs port int 9018 Export/Reports Return service — processes and serves reporting data.
DexRetSettings MaxConcurrentCalls int 8 DEX Retriever Service — maximum number of concurrent calls that the DEX Retriever service can process.

Editing Configuration Variables

  1. Navigate to data/config/.

  2. Open the AppConfig.yaml file in a text editor such as Notepad++ or VS Code.

  3. Locate the relevant section and modify the desired property.

  4. Save the file.

  5. Restart the BigFix UI service for the changes to take effect.

    Note:

    When you modify variables under the AppSettings section in the AppConfig.yaml file, restarting the BigFix UI service is not required. The changes take effect immediately after the file is saved.

Note:
  • Use lowercase Boolean values (true or false).
  • Verify correct YAML indentation; syntax errors can prevent startup.
  • Back up the configuration file before editing.
  • Apply changes before starting the application.