AppSettings customization
CxDatabase | Section | Required | Default Value | Validations | Action if omitted |
|---|---|---|---|---|---|
CxDbClient | ConnectionString | Yes | N/a | 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’, ‘ApiKey’ | Error message | |
Identifier | No | Empty string | N/a | If ApiKey or Basic is chosen on AuthType field, value is required | |
Key | No | Empty string | N/a | If ApiKey or Basic is chosen on AuthType field, value is required | |
ExportSettings | NumberOfRetries | No | 3 | 0 > Integer >= 10 | Fallback to default value |
NumberOfResultsPerDocument | No | 10 | 0 > Integer >= 100 | Fallback to default value | |
NumberOfScansToProcessInParallel | No | 4 | 0 > Integer >= 6 | Fallback to default value | |
MaxBatchSize | No | 10000 | 0 > Integer >= 100000 | Fallback to default value | |
ExportIntervalInMinutes | No | 120 | 0 > Integer > 10 800 (6 months) | Fallback to default value | |
TimeOutPerScan | No | -1 (No Timeout) | -1 > Integer > 3600 Export scan fails after exceeding the defined timeout and the service takes 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) | Error message. If the MinScanAgeInDays is set, this value must also be set. | |
ExportPresetInfo | No | false | Boolean: true or false If true, preset details are exported. If false, preset details are not exported. | false | |
ExportZeroResultsQueries | No | true | Boolean: true or false If true, queries having 0 results are exported (and listed in the Path results section). If false, queries having 0 results are not exported. | false | |
ExportToLogstash | Enabled | No | false | Boolean: true or false This option replaces the exportation for Elastic search system by a disk file save system. When it is enabled, the system exports all the scans to a specified system folder. | false |
PathToExport | Yes, if Enabled = true | Empty string | Must be a valid disk path. | The system ignores the Logstash configuration. | |
Host | No | Empty string | Should be a valid HTTP(s) API URL | The system will ignore 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. |
[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.