The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
step([$class: 'CxScanBuilder'])
: Execute Checkmarx ScancredentialsId : String
sastCredentialsId : String
buildStep : String
teamPath : String
sastEnabled : boolean
exclusionsSetting : String
failBuildOnNewResults : boolean
failBuildOnNewSeverity : String
useOwnServerCredentials : boolean
(optional)
serverUrl : String
(optional)
username : String
(optional)
password : String
(optional)
isProxy : boolean
(optional)
configAsCode : boolean
(optional)
projectName : String
(optional)
projectId : long
(optional)
groupId : String
(optional)
preset : String
(optional)
jobStatusOnError
(optional)
GLOBAL
, FAILURE
, UNSTABLE
presetSpecified : boolean
(optional)
excludeFolders : String
(optional)
Conversion is done as follows:
fold1, fold2 fold3
is converted to:
!**/fold1/**/*, !**/fold2/**/*, !**/fold3/**/*,
filterPattern : String
(optional)
Example: **/*.java,
**/*.html, !**\test\**\XYZ*
Pattern Syntax
A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of selectors, including special support for matching against filenames with include and exclude patterns. Only files/directories which match at least one pattern of the include pattern list, and don't match any pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded. When no selectors are supplied, none are applied.
The filename pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by File.separator
('/' under UNIX, '\' under Windows). For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", "def","ghi" and "xyz.java". The same is done for the pattern against which should be matched.
The segments of the name and the pattern are then matched against each other. When '**' is used for a path segment in the pattern, it matches zero or more path segments of the name.
There is a special case regarding the use of File.separator
s at the beginning of the pattern and the string to match:
When a pattern starts with a File.separator
, the string to match must also start with a File.separator
. When a pattern does not start with a File.separator
, the string to match may not start with a File.separator
. When one of these rules is not obeyed, the string will not match.
When a name path segment is matched against a pattern path segment, the following special characters can be used:
'*' matches zero or more characters
'?' matches one character.
May reference build parameters like ${PARAM}.
Examples:
"**\*.class" matches all .class files/dirs in a directory tree.
"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test.
"**" matches everything in a directory tree.
"**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
incremental : boolean
(optional)
fullScansScheduled : boolean
(optional)
fullScanCycle : int
(optional)
postScanActionId : int
(optional)
sourceEncoding : String
(optional)
comment : String
(optional)
skipSCMTriggers : boolean
(optional)
waitForResultsEnabled : boolean
(optional)
vulnerabilityThresholdEnabled : boolean
(optional)
highThreshold : int
(optional)
mediumThreshold : int
(optional)
lowThreshold : int
(optional)
osaHighThreshold : int
(optional)
osaMediumThreshold : int
(optional)
osaLowThreshold : int
(optional)
generatePdfReport : boolean
(optional)
enableProjectPolicyEnforcement : boolean
(optional)
thresholdSettings : String
(optional)
vulnerabilityThresholdResult : String
(optional)
avoidDuplicateProjectScans : boolean
(optional)
addGlobalCommenToBuildCommet : boolean
(optional)
generateXmlReport : boolean
(optional)
hideDebugLogs : boolean
(optional)
forceScan : boolean
(optional)
customFields : String
(optional)
dependencyScanConfig
(optional)
SASTUserName : String
(optional)
dependencyScanExcludeFolders : String
(optional)
dependencyScanPatterns : String
(optional)
dependencyScannerType
(optional)
OSA
, SCA
enableScaResolver
(optional)
SCA_RESOLVER
, MANIFEST
fsaVariables : String
(optional)
isExploitablePath : boolean
(optional)
isIncludeSources : boolean
(optional)
osaArchiveIncludePatterns : String
(optional)
osaInstallBeforeScan : boolean
(optional)
overrideGlobalConfig : boolean
(optional)
pathToScaResolver : String
(optional)
sastCredentialsId : String
(optional)
scaAccessControlUrl : String
(optional)
scaConfigFile : String
(optional)
scaCredentialsId : String
(optional)
scaEnvVariables : String
(optional)
scaResolverAddParameters : String
(optional)
scaSASTProjectFullPath : String
(optional)
scaSASTProjectID : String
(optional)
scaSastServerUrl : String
(optional)
scaServerUrl : String
(optional)
scaTeamId : String
(optional)
scaTeamPath : String
(optional)
scaTenant : String
(optional)
scaTimeout : int
(optional)
scaWebAppUrl : String
(optional)
useJobLevelSastDetails : boolean
(optional)
excludeOpenSourceFolders : String
(optional)
includeOpenSourceFolders : String
(optional)
osaArchiveIncludePatterns : String
(optional)
osaEnabled : boolean
(optional)
osaInstallBeforeScan : boolean
(optional)
thisBuildIncremental : boolean
(optional)
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.