The 'failErrorLevel' Parameter

 Default Behavior 

When the failErrorLevel parameter is set to DEFAULT, the behavior of the exit codes stays the same.

Modifying the Default Behavior 

When the failErrorLevel parameter is set to ALL, the Unified Agent returns an error code for all errors in the scan, rather than SUCCESS. This can be useful for customers migrating from the plugins (NPM, MAVEN etc.) to the Unified Agent.

The parameter sets additional scenarios to error instead of success.The following cases are considered as 'Failure':

• resolver.runPrepStep failed (at least one)

• Error in collecting/running dependencies (at least one)

• When ‘productName’ and ‘productToken’ are missing, and no ‘projectToken’ is defined in the configuration file.

Examples:

• npm.resolveDependencies=true, but resolve dependencies failed

• nuget.runPreStep=true, but the pre-step failed

• mvn dependency:tree failed or partial data was retrieved
  

When the ignore resolver errors parameters are set to true (e.g., ‘npm.ignoreNpmLsErrors’ is set to true) the scan will not fail. If all of these parameters are set to false, then they will fail the scan.

In case there are multiple resolvers and at least one failed, then all resolvers are considered as a failure.