Configuring Detect General Properties 6.4.0

In Synopsys Detect, you use properties to configure how the scan runs.

This page describes properties that are more global or general in nature and not detector specific and the use and configuration of values that are assigned to those properties when used with Synopsys Detect.

Detect general properties

Black Duck property configuration

Black Duck API token

The Black Duck API token.

The API token used to authenticate with the Black Duck Server.

Offline Mode

Use to disable any Black Duck communication; if true, Detect will not upload BDIO files, it will not check policies, and it will not download and install the signature scanner.

Black Duck password

Black Duck password

Black Duck URL

URL of the Black Duck server

Black Duck username

Black Duck username

Report generation timeout

The amount of time in seconds Detect will wait for scans to finish and to generate reports (i.e. risk and policy check). When changing this value, keep in mind the checking of policies might have to wait for scans to process which can take some time.

Test Connection to Black Duck

Test the connection to Black Duck with the current configuration.

Black Duck timeout (Advanced)

The time to wait for network connections to complete (in seconds).

Trust all SSL certificates (Advanced)

If true, automatically trust the certificate for the current run of Detect only.

Black Duck Hub property configuration (Deprecated)

Blackduck Hub Api token (Deprecated)

This is the Hub API Token.

DEPRECATED: This property is changing. 
Use --blackduck.api.token in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub offline mode (Deprecated)

This disables any Hub communication. If true, Detect does not upload BDIO files, does not check policies, and does not download and install the signature scanner.

DEPRECATED: This property is changing. 
Use --blackduck.offline.mode in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub password (Deprecated)

This is the Black Duck Hub password.

DEPRECATED: This property is changing. 
Use --blackduck.password in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub proxy host (Deprecated)

This is the Hub proxy host.
DEPRECATED: This property is changing. 
Use --blackduck.proxy.host in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub Proxy ignored hosts (Deprecated)

A comma-separated list of host patterns that should not use the proxy.

DEPRECATED: This property is changing. 
Use --blackduck.proxy.ignored.hosts in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub proxy Ntlm domain (Deprecated)

This is the NTLM Proxy domain.

DEPRECATED: This property is changing. Please use --blackduck.proxy.ntlm.domain in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub proxy Ntlm workstation (Deprecated)

This is the NTLM Proxy workstation.

DEPRECATED: This property is changing. 
Use --blackduck.proxy.ntlm.workstation in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub proxy password (Deprecated)

This is the proxy password.

DEPRECATED: This property is changing. 
Use --blackduck.proxy.password in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub proxy port (Deprecated)

This is the proxy port.

DEPRECATED: This property is changing. 
Use --blackduck.proxy.port in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub proxy username (Deprecated)

This is the proxy username.

DEPRECATED: This property is changing. 
Use --blackduck.proxy.username in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub timeout (Deprecated)

The time to wait for rest connections to complete in seconds.

DEPRECATED: This property is changing. 
Use --blackduck.timeout in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub trust cert (Deprecated)

If true, automatically trusts the certificate for the current run of Detect only.

DEPRECATED: This property is changing. 
Use --blackduck.trust.cert in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub URL (Deprecated)

This is the URL for the Hub server.

DEPRECATED: This property is changing. 
Use --blackduck.url in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Blackduck Hub username (Deprecated)

This is the Hub username.

DEPRECATED: This property is changing. 
Use --blackduck.username in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Check For valid Black Duck connection (Deprecated)

If true, during initialization Detect checks for Black Duck connectivity and exits with status code 0 if it cannot connect.

DEPRECATED: This property is changing. 
Use --detect.ignore.connection.failures in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect disable without Hub (Deprecated)

If true, during initialization Detect will check for Hub connectivity and exit with status code 0 if it cannot connect.

DEPRECATED: This property is changing. 
Use --detect.ignore.connection.failures in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Cleanup property configuration

Cleanup output

If true, the files created by Detect will be cleaned up.

Detector property configuration

Required Detect types

The set of required detectors.

If you want one or more detectors to be required (must be found to apply), use this property to specify the set of required detectors. If this property is set, and one (or more) of the given detectors is not found to apply, Detect will fail.

Detector types excluded (Advanced)

By default, all detectors will be included. If you want to exclude specific detectors, specify the ones to exclude here. If you want to exclude all detectors, specify "ALL". Exclusion rules always win.

If Detect runs one or more detectors on your project that you would like to exclude, you can use this property to prevent Detect from running them.

Detector types included (Advanced)

By default, all tools will be included. If you want to include only specific tools, specify the ones to include here. Exclusion rules always win.

If you want to limit Detect to a subset of its detectors, use this property to specify that subset.

Detect excluded BOM tool types (Deprecated)

By default, all tools will be included. If you want to exclude specific detectors, specify the ones to exclude here. If you want to exclude all tools, specify ALL. Exclusion rules always win.

DEPRECATED: This property is changing.
Use --detect.excluded.detector.types in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect included BOM tool types (Deprecated)

By default, all tools will be included. If you want to include only specific tools, specify the ones to include here. Exclusion rules always win.

DEPRECATED: This property is changing.
Use --detect.included.detector.types in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect required BOM tool types (Deprecated)

If set, Detect will fail if it does not find the BOM tool types supplied here.

DEPRECATED: This property is changing.
Please use --detect.required.detector.types in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

General property configuration

Buildless mode

If set to true, only Detectors capable of running without a build will be run.

Wait for results

If set to true, Detect will wait for Synopsys products until results are available or the detect.report.timeout is exceeded.

Force success (Advanced)

If true, Detect will always exit with code 0.

Detect ignore connection failures (Advanced)

If true, Detect will ignore any products that it cannot connect to. If true, when Detect attempts to boot a product it will also check if it can communicate with it - if it cannot, it will not run the product.

Detect parallel processors (Advanced)

The number of threads to run processes in parallel, defaults to 1, but if you specify less than or equal to 0, the number of processors on the machine will be used.

Logging property configuration

Logging level

Detect logging level

Logging level shorthand

Shorthand for the logging level of Detect. Equivalent to setting logging.level.com.synopsys.integration.

Detect suppress configuration output (Deprecated)

If true, the default behavior of printing your configuration properties at startup will be suppressed.

DEPRECATED: This property is being removed.
Configuration can no longer be suppressed individually. Log level can be used. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect suppress results output (Deprecated)

If true, the default behavior of printing the Detect Results will be suppressed.

DEPRECATED: This property is being removed.
Results can no longer be suppressed individually. Log level can be used. It will cause failure in 6.0.0 and be removed in 7.0.0.

Logging level (Deprecated)

The logging level of Detect.

DEPRECATED: This property is changing.
Use --logging.level.com.synopsys.integration in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Path property configuration

Bash executable

Path to the Bash executable.

If set, Detect will use the given Bash executable instead of searching for one.

BDIO 2 enabled

The version of BDIO files to generate. If set to false, BDIO version 1 will be generated. If set to true, BDIO version 2 will be generated.

BDIO output directory

The path to the output directory for all BDIO files. 
If not set, the BDIO files are placed in a BDIO subdirectory of the output directory.

Detector Search Depth

Depth of subdirectories within the source directory to which Detect searches for files that indicate whether a detector applies. A value of 0 (the default) tells Detect not to search any subdirectories, a value of 1 tells Detect to search first-level subdirectories.

Git executable 

Path to the git executable.

Java executable 

Path to the java executable. If set, Detect will use the given java executable instead of searching for one. 

Detect output path

The path to the output directory. If set, Detect uses the given directory to store files that it downloads and creates, instead of using the default location (~/blackduck).

Resolve tilde in paths 

If set to false Detect will not automatically resolve the '~/' prefix in a Mac or Linux path to the user's home directory.

Scan output path 

The output directory for all signature scanner output files. If not set, the signature scanner output files will be in a scan subdirectory of the output directory.

Source path 

The path to the project directory to inspect. Detect will search the given directory for hints that indicate which package manager(s) the project uses, and will attempt to run the corresponding detector(s).

Swift executable

Path of the swift executable.

Detect tools included

The tools Detect should allow in a comma-separated list. Tools in this list (as long as they are not also in the excluded list) will be allowed to run if all criteria of the tool is met. Exclusion rules always win. This property and detect.tools.excluded provide control over which tools Detect runs.

Detect tools excluded

The tools Detect should not allow, in a comma-separated list. Excluded tools will not be run even if all criteria for the tool are met. Exclusion rules always win. This property and detect.tools provide control over which tools Detect runs.

Detector search continue (Advanced)

If true, the BOM tool search will continue to look for nested BOM tools of the same type to the maximum search depth, see the detailed help for more information.

If true, Detect will find Maven projects that are in subdirectories of a Maven project and Gradle projects that are in subdirectories of Gradle projects, etc. If false, Detect will only find BOM tools in subdirectories of a project if they are of a different type such as an Npm project in a subdirectory of a Gradle project. 

Detector directory exclusions (Advanced)

A comma-separated list of directory names to exclude from detector search. While searching the source directory to determine which detectors to run, subdirectories whose name appears in this list will not be searched.

Detector exclude default directories (Advanced)

If true, the BOM tool search will exclude the default directory names. See the detailed help for more information. If true, the following directories will be excluded from the detector search: bin, build, .git, .gradle, node_modules, out, packages, target.

Detector file exclusions (Advanced)

A comma-separated list of file names to exclude from detector search.

Detector directory path exclusions (Advanced)

A comma-separated list of directory paths to exclude from detector search, for example,  foo/bar/biz will only exclude the biz directory if the parent directory structure is foo/bar/.

This property performs the same basic function as detect.detector.search.exclusion, but lets you be more specific. 

Detector directory patterns exclusions (Advanced)

A comma-separated list of directory name patterns to exclude from detector search.

While searching the source directory to determine which detectors to run, subdirectories whose name match a pattern in this list will not be searched. These patterns are file system glob patterns ('?' is a wildcard for a single character, '*' is a wildcard for zero or more characters). For example, you're running in bash on Linux, you've set --detect.detector.search.depth = 1, and have a subdirectory named blackduck-common (a Gradle project) that you want to exclude from the detector search. Any of the following would exclude it: 

• --detect.detector.search.exclusion.patterns = blackduck-common

• --detect.detector.search.exclusion.patterns = blackduck-common

• --detect.detector.search.exclusion.patterns = blackduck-*

Project name/version detector (Advanced)

The detector that is used to determine the project name and version when there are multiple detector types. This property should be used with the detect.project.tool.

If Detect finds that multiple detectors apply, this property can be used to select the detector that will provide the project name and version. When using this property, you should also set detect.project.tool=DETECTOR

Detector tool priority (Advanced)

Detect tools output path (Advanced)

The path to the tools directory where detect should download and/or access things like the Signature Scanner that it shares over multiple runs. If set, Detect will use the given directory instead of using the default location of output path plus tools.

Detect BOM tool search continue (Deprecated)

If true, the BOM tool search will continue to look for nested BOM tools of the same type to the maximum search depth, see the detailed help for more information.

If true, Detect will find Maven projects that are in subdirectories of a Maven project and Gradle projects that are in subdirectories of Gradle projects, etc. If false, Detect will only find BOM tools in subdirectories of a project if they are of a different type such as an Npm project in a subdirectory of a Gradle project .

DEPRECATED: This property is changing.
Use --detect.detector.search.continue in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect BOM tool search depth (Deprecated)

Depth of subdirectories within the source directory to search for files that indicate whether a detector applies.

A value of 0 (the default) tells Detect not to search any subdirectories, a value of 1 tells Detect to search first-level subdirectories, etc.

DEPRECATED: This property is changing.
Use --detect.detector.search.depth in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect BOM tool search exclusion (Deprecated)

A comma-separated list of directory names to exclude from the BOM tool search.

DEPRECATED: This property is changing.
Use --detect.detector.search.exclusion in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect BOM tool search exclusion defaults (Deprecated)

If true, the BOM tool search will exclude the default directory names. See the detailed help for more information. If true, these directories will be excluded from the BOM tool search: bin, build, .git, .gradle, node_modules, out, packages, target.

DEPRECATED: This property is changing.
Use --detect.detector.search.exclusion.defaults in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Detect project BOM tool (Deprecated)

The detector to choose when multiple detector types are found and one needs to be chosen for project name and version. This property should be used with the detect.project.tool.

DEPRECATED: This property is changing.
Use --detect.project.detector in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Polaris property configuration (Deprecated)

Detect Polaris enabled (Deprecated)

Set to false to disable the Synopsys Polaris Tool.

DEPRECATED: This property is changing.
Use --detect.tools and POLARIS in the future. It will cause failure in 6.0.0 and be removed in 7.0.0.

Polaris access token (Deprecated)

The access token for your polaris instance.

DEPRECATED: This property is being removed.
Detect will no longer invoke the Polaris CLI. It will cause failure in 7.0.0 and be removed in 8.0.0.

Polaris arguments (Deprecated)

Additional arguments to pass to Polaris separated by space. The polaris.command takes precedence.

DEPRECATED: This property is being removed. Detect will no longer invoke the Polaris CLI. It will cause failure in 7.0.0 and be removed in 8.0.0.

Polaris command (Deprecated)

A replacement command to pass to polaris separated by space. Include the analyze or setup command itself. If specified, polaris.arguments will be ignored and this will take precedence.

DEPRECATED: This property is being removed. Detect will no longer invoke the Polaris CLI. It will cause failure in 7.0.0 and be removed in 8.0.0.

Polaris URL (Deprecated)

The URL of your Polaris instance.

DEPRECATED: This property is being removed. Detect will no longer invoke the Polaris CLI. It will cause failure in 7.0.0 and be removed in 8.0.0.