Configure CLEAR Engine and Web UI settings

2024/3/7 |

This article describes the settings available for CLEAR Engine and the Web UI, their effects, and how to configure them.

In this article, you will learn how to:

  • Configure settings of CLEAR Engine.
  • Configure settings of the Web UI.

At the end, you will be able to configure settings of CLEAR Engine and the Web UI.

Configure settings of CLEAR Engine

CLEAR Engine configurations are stored in the storage configuration file (also known as the cluster configuration file). All CLEAR Engine instances in a cluster share the same configuration file.

  1. Open PowerShell as administrator and enter the following command to open the CLEAR Engine storage configuration file with the default text editor:

     (Select-Xml -Path "C:\Program Files\Lucent Sky\CLEAR Engine\SkyAnalyzer.config" -XPath "skyAnalyzer").Node.File | Invoke-Item
  2. To change a setting, locate the key representing the setting, and change its value.

  3. Enter the following command in PowerShell to restart CLEAR Engine for the changes to take effect. Repeat this on every instance in the cluster:

     Stop-Service "CLEAR Engine"; Start-Service "CLEAR Engine"

A CLEAR Engine storage configuration file has the following settings:

  • AutoArchive - Sets the threshold for automatically archiving scans. Scans created before this number of days will be archived automatically. Valid value should be an integer between 7 and 10000. When set to 0, auto archive is disabled. Default is 0.
  • AutoSuppression - When sets to true, results exist entirely in an external module are automatically suppressed. Default is false.
  • CompatibilityMode - When sets to true, results from third-party analysis reports are preprocessed to improve compatibility. Default is false.
  • Encoding - Sets the native encoding of the cluster. Valid value should be the WebName of a non-Unicode encoding, such as big5, shift_jis, or windows-1252. Default is empty.
  • Intelligence - Sets the real-time intelligence operation mode and ML-augmented analysis and remediation availability. Valid values are advanced, advanced,ml, basic, and off. Default is basic.
  • Iops - Sets IOPS of the storage. When sets to 0, the IOPS will be automatically detected the next time an instance is added to the cluster. Default is 0.
  • MaintenanceWindow - Sets the window for maintenance tasks. Valid value should be the time of the day in the format of hhmm. When set to empty, maintenance tasks will not run. Default is empty.
  • MaxDegreeOfParallelism - Sets the number of concurrent processes can be used by a core. Default is 1.
  • MaxScanQueueLength - Sets the number of scans can be held in the scan queue. Default is 10.
  • MultiFactorAuthentication - When sets to true, multi-factor authentication is enforced on all users. When sets to false, multi-factor authentication is disabled. When sets to empty, multi-factor authentication is enabled but not enforced. Default is empty.
  • OpportunisticAnalysis - When sets to true, additional source code analysis will replace binary analysis if the application failed to build, instead of failing the scan. Default is false.
  • Preview - When sets to true, preview features are enabled on instances with a preview license. Default is false.
  • ProcessIsolation - When sets to true, some build and analysis processes are executed using a service account with minimum privileges. When sets to false, all processes are executed using the same account as CLEAR Engine. Default is true.
  • ProcessMonitoring - When sets to true, unresponsive analysis processes are terminated automatically. Default is true.
  • SecurityLibraries - Sets additional security libraries to be used for remediation. Default is empty.
  • SuppressionCompatibilityMode - When sets to true, suppression signatures generated by previous versions are recognized. Default is true.
  • Utf8EmitBom - When sets to true, generated UTF-8 files will include a Unicode byte order mark. Default is false.

Configure settings of the Web UI

  1. Open PowerShell as administrator and enter the following command to open the Web UI configuration file with the default text editor:

     "C:\Program Files\Lucent Sky\CLEAR Web\web.config" | Invoke-Item
  2. To change a setting, locate the key representing the setting, and change its value.
  3. The Web UI is automatically restarted when changes are made.

A Web UI configuration file has the following settings:

  • ClientFileValidationEnabled - When sets to false, files such as source code archive are not validated by the Web UI. Default is true.
  • DefaultDomain - Sets the domain name to prefill on the sign-in page. Default is empty.
  • Help - Sets whether to use cloud-based or local help. Valid values are cloud and local. Default is cloud.
  • StorageRoot - Sets the storage root used for path length calculation.
  • SystemInformationFooter - When sets to true, system information such as the number of cores available is displayed on the bottom of the sign-in page. Default is false.
  • SystemManagement - When sets to false, system management functions on the server running CLEAR Engine are not available to users in the Administrators group. Default is true.
  • Theme - Sets the theme of the Web UI. Default is Lucent Sky.