Skip to content

Frequently Asked Questions

johannes-tw edited this page Jul 1, 2020 · 8 revisions

Q: What is CxFlow?

CxFlow is a solution that enables creating projects automatically, scans orchestration and facilitates feedback channels in a closed loop mode.

Q: Why does it benefit customers?

Enables customs to incorporate Checkmarx into their DevOps/Release pipelines as early as possible.

Q: What are typical use cases?

Refer to CxFlow Workflows for further information.

Q: Is CxFlow supported by the product team?

CxFlow is supported by the product team. Tickets can be opened via the regular workflow. SEG will decide to whom the ticket is routed, based on the production matrix and progress. Actors & Responsibilities can be found here: Actors & Responsibilities Support page: Support

Q: Does CxFlow have Checkmarx Licensing requirements?

No. CxFlow is a tool developed interdependently from the Checkmarx product line and does not require any additions to existing customer licenses.

Q: What Integrations does CxFlow support?

The table below lists all the supported integrations, features and states the recommended versions.

Software/Services Features CxFlow Version
Jira Issue Tracking >= 1.0.0
Custom Bug Types
Custom Transitions in Workflows
Custom Fields
GitHub WebHooks >= 1.2.0
Pull Requests Scanning and Decorating
Push Events
Native Issues Tracker
GitLab WebHooks >= 1.2.0
Merge Requests Scanning and Decorating
Push Events
Native Issues Tracker
Azure DevOps WebHooks >= 1.3.0
Merge Requests
Push Events
Pipelines
Work Items
BitBucket WebHooks >= 1.4.3
Merge Requests Scanning
Pull Events
Issue Tracker
Rally Issue Tracking >= 1.5.3

Q: What are the requirements for CxFlow?

Refer to [Pre-Requisites and Requirements(https://github.com/checkmarx-ltd/cx-flow/wiki/Prerequisites-and-Requirements)

Q: When are Issues created from CxFlow into a Defect Tracking system?

Issues are only created when a Push event into a protected branch occurs. When a Pull/Merge Request is created (and CxFlow scans the new code), the vulnerability information is displayed in the Pull/Merge Request comments and does NOT create issues in the defect tracking system.

Q: How can I demo CxFlow to a customer?

Professional Services has created an easy-to-use CxFlow Demo Instance (sub-project of CxPsPowerHasks) script to assist with easy deployment and demonstration of CxFlow.

EMEA

CxFlow is installed on the TS AWS Demo Instances, which allows Sales Engineers to demo example use cases to customers.

NA

NA SEs should go through the listed labs to create their own demo environments. Please reach out to your direct manager for assistance.

APAC

To be defined.

Q: Is CxFlow open source?

Yes. The code can be found here. Connect to preview

Note: You may not want to send this to a customer as they might want to implement CxFlow themselves, hich has issues in 9 out of 10 cases. We recommend contacting Professional Services.

Q: Has CxFlow been security tested and scanned for known vulnerabilities?

Yes. CxFlow has undergone multiple test runs at several stages with various testing tools. For additional information, contact the Product Manager.

Q: If I have an issue / feature request item where can I report it?

CxFlow feature requests and issues should be reported like any other product feature request. CxFlow is available just like any other Checkmarx component.

Q: How do I obtain the latest version of CxFlow?

You can find the current release on the GitHub releases page.

Q: How do I (Checkmarx employee) get started with CxFlow?

To be defined.

Process & Workflow

Q: How does CxFlow work with multiple GitHub organizations or multiple JIRA projects?

Overrides can be used at the WebHook level and config as code can be added to the individual repos.

CxFlow Configuration

Config As Code

Q: Can a single yaml file be used to connect to multiple defect tracking systems?

Yes - with the limitation of one Jira instance. Examples will be made available.

Q: How do you manage the project creation within CxSAST when running CxFlow in WebHook mode?

Overrides can be used to assign the same name to multiple projects. Alternatively, a groovy script can be used to help decide on project names and if it should be scanned. Refer also to [CxFlow Configuration](CxFlow Configuration

Q: If a customer uses global WebHooks, can they exclude specific projects from being scanned?

Yes, this can be performed with overrides & config as code linked above.