AppSettings customization
CxDatabase | Node Parameter | Parameter | Required | Default Value | Validations | Action if omitted |
|---|---|---|---|---|---|---|
CxDbClient | CxDbClient | ConnectionString | Yes | N/A | The ConnectionString Object provides validation. | Error message |
EncryptionKey | Auto | Empty string | If the connection string password is encrypted, this value must contain the encrypted key used. | Error message [i] | ||
EncryptionVector | Auto | Empty string | If the connection string password is encrypted, this value must contain the encrypted vector used. | Error message [i] | ||
ElasticSearch | Host | Yes | N/A | Must be a valid URL | Error message | |
IndexName | Yes | N/A |
| Error message | ||
AuthType | Yes | N/A | Possible values are: ‘None’, ‘Basic’, and ‘ApiKey’, | Error message | ||
Identifier | Yes, if the AuthType is selected as 'ApiKey' or 'Basic'. | Empty string | N/A | If 'ApiKey' or 'Basic' is selected in the AuthType field, a value is required. | ||
Key | Yes, if the AuthType is selected as 'ApiKey' or 'Basic'. | Empty string | N/A | If 'ApiKey' or 'Basic' is s selected in the AuthType field, a value is required. | ||
ExportToLogstash | Enabled | No | False | Boolean: True or False This option changes the destination of the export feature from the Elastic search system to a disk file save system. When enabled, all scans are exported to a specified system folder. | False | |
PathToExport | If Enabled = true, the Parameter should be defined as one of two options: PathToExport or Host. | Empty string | Must be a valid disk path. | The system ignores the Logstash configuration. | ||
Host | If Enabled = true, theParameter should be defined as one of two options: PathToExport or Host. | Empty string | Should be a valid HTTP(s) API URL. | The system ignores the Logstash HTTP configuration. | ||
AuthType | Yes, if Host is defined. | Empty string | Possible values are: ‘Basic’ or 'None'. | ‘None’ | ||
Identifier | Yes, if AuthType = 'Basic'. | Empty string | Must be a valid username. | Empty string. | ||
Key | Yes, if AuthType = 'Basic'. | Empty string | Must be a valid password. | Empty string. | ||
ExportSettings | N/A | NumberOfRetries | No | 3 | 0 > Integer >= 10 | Fallback to default value |
N/A | NumberOfResultsPerDocument | No | 10 | 0 > Integer >= 100 | Fallback to default value | |
N/A | NumberOfScansToProcessInParallel | No | 4 | 0 > Integer >= 6 | Fallback to default value | |
N/A | MaxBatchSize | No | 10000 | 0 > Integer >= 100000 | Fallback to default value | |
N/A | ExportIntervalInMinutes | No | 120 | 0 > Integer > 10 800 (6 months) | Fallback to default value | |
N/A | TimeOutPerScan | No | -1 (No Timeout) | -1 > Integer > 3600 The Export scan fails after exceeding the defined timeout and processes the next scan to be exported. | No timeout is applied | |
ExportCriteria [ii] | Type | No | Scans | ‘Scans’ or ‘Projects’ | Fallback to default value | |
SelectedIds | No | N/A | List of integers | N/A | ||
ScansAgeRange.MinScanAgeInDays | No | N/A | 0 > Integer >= 5490 (15 years) | N/A | ||
ScansAgeRange.MaxScanAgeInDays | No | N/A | MinScanAgeInDays > Integer >= 5490 (15 years) | An error message. If MinScanAgeInDays is set, this value must also be set. | ||
ExcludeZeroResultsScans | No | False | Boolean: True or False If true, scans with no results are exported. If false, scans with no results are not exported. | Scans with zero results are not exported. | ||
ExportPresetInfo | No | False | Boolean: True or False If true, preset details are exported. If false, preset details are not exported. | Preset details are not exported. | ||
ExportZeroResultsQueries | No | True | Boolean: True or False If true, queries with 0 results are exported (and listed in the Path results section). If false, queries with 0 results are not exported. | Queries with zero results are not exported. | ||
SourcePaths | No | N/A | List of Strings with valid folder paths:[“C:\CxSrc2020“,[“C:\CxSrc2021“…] | The service does not search for the source code in additional folders. |
[i] In case of changes in the ConnectionString password, EncryptionKey and EncryptionVector must be set with an empty string value.
[ii] At least the SelectedIds or the ScansAgeRange property must be set for the system to match the specified export criteria.