Page Comparison

checkPolicies 

Whether to send the check policies request before updating WhiteSource.

• If set to True, then forceUpdate must also be set to True.

• If set to False, no policy-related data will be generated.

In case of policy violation, the scan will end with ERROR exit code POLICY_VIOLATION (-2).

The scan will end with SUCCESS. Inventory will be updated regardless of policy violations.

False 

No

forceCheckAllDependencies 

Force checks all dependencies. 

NOTE: Used only if if checkPolicies  is and updateInventory is set to True. 

Checks all policies for all dependencies introduced to the WhiteSource projects.

Checks only the new dependencies introduced to the WhiteSource projects.

False

No

updateInventory 

Whether to send an update request.

Sends an update request.

Sends a check policies request to WhiteSource without sending the update request; meaning the user will perform checkpolicies request without updating its inventory in WhiteSource.

True

No

forceUpdate 

Whether to update organization inventory regardless of policy violations.

NOTE: Used only if checkPolicies is set to True.  

Updates the project even if the checkPolicies  step failed.

• App- Update

• Exit code- End with SUCCESS

• Output- No Error message

In case of a policy violation:

• App- No update

• Exit code- (-2)

• Output-end with Error

False

No

forceUpdate.failBuildOnPolicyViolation 

Determines whether the Unified Agent exit code will be the result of the policy check or the result of the scan.

NOTE: Used only if forceUpdate is set to True.

The Unified Agent exit code will be the result of the policy check, meaning if there is a failure in checkpolicies the exit code is -2.

The Unified Agent exit code will be the result of the scan. (success or failure)

False

No

updateInventory 

Sends an update request.

Sends a check policies request to WhiteSource without sending the update request; meaning the user will perform checkpolicies request without updating its inventory in WhiteSource.

True

No