Maven Plugin
The scanner is also published as a Maven plugin. Run its scan goal in a Maven project to analyze the project and send the results to IZ Suite. It runs the same analysis as the command-line scanner, and the Maven build fails by itself when the scan fails or, if you ask for it, when the quality gate fails.
Requirements
Apache Maven 3.6.3 or later.
JDK 11 or later.
A
pom.xmlin the folder where you run the goal.Network access to the IZ Suite plugin repository and to your IZ Suite address.
Plugin coordinates
Group ID
com.integralzone.izsuite
Artifact ID
iz-scan-cli
Version
The scanner version, for example 26.4.1
Goal
scan
Plugin repository
https://iz-public-m2.s3.eu-west-2.amazonaws.com/releases
Add the plugin repository
Maven must find the plugin in the IZ Suite repository. Either keep a small settings file next to pom.xml and pass it with -s, as Setup does. Include the following repositories and plugin repositories in settings.xml
Run the scan
Pass the options as -D properties:
BRANCH stands for your CI/CD platform's branch-name variable, and IZ_ACCESS_TOKEN for the masked secret that holds the token. See Pipeline Access Tokens.
Parameters
serviceHost
Yes
The address of your IZ Suite workspace.
None
authToken
Yes
The access token. Pass it from a masked secret, never in pom.xml.
None
applicationKey
Yes
The unique key results are filed under. Stored in lower case.
None
source
Yes
The folder that holds the source files, usually ..
None
applicationName
No
The name shown for the application.
The application key
organization
No
The organization ID, external ID or name.
The default organization
scmBranchName
No
The branch being scanned. Stored in lower case.
master
pullRequestId
No
The pull request being scanned. When set, the branch is ignored.
None
pullRequestTargetBranch
No
The branch the pull request merges into, used as its baseline.
None
extId
No
An external reference, such as the build number, recorded with the scan.
None
abortOnQualityGateFailure
No
true fails the Maven build when the gate fails or no gate status came back.
false
sarifReport
No
File path for a SARIF 2.1.0 report of the findings.
No report
dumpIssues
No
File path for a JSON list of the findings.
No file
fixAllIssues
No
true applies automatic fixes to the source files before scanning.
false
scmCommit
No
Accepted for compatibility. Not sent.
None
The parameters behave as the command-line options of the same name. See Command-Line Scanner.
Fetching the Organization
Navigate to the main menu
Administration->OrganizationsIn the displayed list of organizations, each one will have an associated
Organization Idas shown below.Use the Organization ID when performing the CICD scan with the
-Dorganizationparameter

Build result
The goal fails the build with Scan failed when:
abortOnQualityGateFailureistrueand the quality gate failed, or no gate status came back.The scan stopped before analysis, for example because the token was refused, the organization was not found or the application key is not allowed.
Otherwise the build continues, and the log shows QUALITY GATE STATUS:: PASSED or FAILED. See Break the Build on a Quality Gate.
Proxy
Behind a proxy, add the proxy properties to the Maven command:
Next steps
Pipeline Examples: the Maven step in a pipeline.
Test Coverage Reports: send MUnit coverage with the scan.
Break the Build on a Quality Gate: when the build fails.
Command-Line Scanner: the option reference.
Last updated
Was this helpful?

