Skip to content

Commit

Permalink
CXFLW-1294 Updated documentation for disable clubbing of issues in SA…
Browse files Browse the repository at this point in the history
…RIF. (#1390)

* Updated documentation for disable clubbing of issues in SARIF.

* Updated documentation for disable clubbing of issues in SARIF.

---------

Co-authored-by: Satyam Chaurasia <[email protected]>
  • Loading branch information
1 parent 5503867 commit 1734132
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/Bug-Trackers-and-Feedback-Channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -710,6 +710,17 @@ Sarif as a bug tracker is used to generate a sarif report and uploading it to th

[[/Images/sarif-report-3.png]]

* CxFlow can effectively group similar issues across various bug trackers, including those using the SARIF format. This consolidation helps streamline the review process and reduces redundant efforts. However, if users prefer to analyze each issue individually, they can easily disable the clubbing feature by using the command-line argument `--checkmarx.disable-clubbing=true`. This setting allows for a more granular examination of each reported vulnerability, ensuring that no important details are overlooked.

* Example of sample before disable clubbing.

[[/Images/2.png]]

* Example of sample after disable clubbing.

[[/Images/1.png]]


## <a name="service">Service Now</a>
Integration with Incident records is available by adding the following configuration block:
```
Expand All @@ -732,6 +743,7 @@ cx-flow:
...
```


## <a name="cxxml">CxXML</a>
The XML bug-tracker (defined as CxXml) is useful, if you want to retrieve the latest scan results per project (batch mode) from Checkmarx per project, Team, or the entire instance. This is the original XML report provided by Checkmarx. When using CxXML with both CxSAST and CxSCA scanners enabled, two seprate reports will be generated, one for CxSAST report and one for CxSCA report.

Expand Down
Binary file added docs/Images/1.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Images/2.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1734132

Please sign in to comment.