Welcome to the CxTuneMaster User Documentation. This guide is designed to help you understand and utilize CxTuneMaster effectively. Whether you are a first-time user or an experienced professional, this documentation will provide step-by-step instructions, feature explanations, and best practices to optimize your customer experience (CX) strategies.
To use CxTuneMaster, you need to create an OAuth Client through the Checkmarx One portal. This client will enable secure authentication and allow CxTuneMaster to interact with your Checkmarx One environment. When setting up the OAuth Client, ensure that it is configured with the appropriate permissions to allow seamless access to the necessary resources. The required permissions are listed below, and granting them correctly is essential for CxTuneMaster to function properly.
For further information about setting up an Checkmarx OAuth Client, please refer to the following documentation.
Before using CxTuneMaster, you need to configure the connection to your Checkmarx One environment. This can be done within the Settings page, accessible through the side menu under Settings > Checkmarx Configuration. On this page, you will be required to enter the following details:
Your organization's tenant name in Checkmarx One.
The region where your Checkmarx One instance is hosted (EU or US).
The Client ID generated when setting up the OAuth Client.
The corresponding Client Secret for authentication.
Once you have entered and saved this information, you can test the connection by clicking the Test Connection button in the top-right corner of the screen. If the connection is successful, you can proceed to onboard projects within CxTuneMaster.
User management in CxTuneMaster is handled by the Account Owner, who has full administrative control over the tenant. The Users Management page, accessible via Settings > Users Management, allows the Account Owner to add, modify, or remove users within the system.
Each CxTuneMaster tenant can have only one Account Owner, and new users can be assigned one of the following roles:
| Role | Description |
|---|---|
User
|
Can onboard new projects, trigger scans, and perform security-related actions. |
Reader
|
Has read-only access and can view information but cannot initiate actions. |
When a new user is added, an email is automatically sent to the provided address, prompting them to complete their account registration. Once registered, the user can log in and perform actions according to their assigned role.
Once the tenant connection is successfully configured, users can onboard Checkmarx projects into CxTuneMaster via the Onboarding page, accessible from the side menu. This page displays all Checkmarx projects that have not yet been onboarded into CxTuneMaster.
To be eligible for onboarding, a project must have a primary branch configured, as CxTuneMaster exclusively analyzes scans performed on the primary branch. If this requirement is met, the user can onboard the project by simply clicking the play button in the corresponding project row.
Once a project is onboarded, its scan results can be viewed in the Projects page. Additionally, to maintain scan accuracy over time, automated analysis is triggered whenever a new scan is performed on onboarded projects.
The Projects page displays all Checkmarx projects that have been onboarded into CxTuneMaster. This page provides key insights into each project’s scan status and analysis results. The following information is available for each project:
Indicates whether the project is in a SCANNED, SCANNING, or FAILURE state.
Shows the last time an analysis was performed.
Represents the reliability of the scan results. A higher confidence level means the scan is more accurate and reliable, whereas a lower confidence level suggests potential inconsistencies or issues in the analysis.
The Checkmarx scan's ID subject to analysis.
From this page, users can delete projects, manually trigger an analysis, or review analysis results. Additionally, at the top of the screen, a set of indicators provide a quick overview of the distribution of projects based on their confidence levels. This helps users easily assess and manage their projects to maintain an efficient and reliable security posture.
From the Projects page, users can review the analysis results of a specific project by clicking on the eye icon in the project row. This action opens the Results page, which provides key insights into the scan’s reliability and accuracy.
The Results page includes several important indicators:
Measures how much of the project's code was analyzed.
Shows the number of lines that were excluded from the scan due to parsing errors.
Highlights files that were not processed correctly.
Number of issues detected during the Checkmarx analysis that could affect the scan’s reliability.
These indicators are crucial in assessing the accuracy and effectiveness of the scan results. Additionally, users can review detailed findings, which provide explanations of potential issues along with actionable remediation steps. These findings may highlight problems related to execution queries, lack of optimization, or scan scope limitations. By addressing these findings, users can significantly improve scan efficiency and enhance the overall reliability of their security analysis.
Users can access the CxTuneMaster Dashboard through the side menu. This page provides a high-level overview of scan reliability across all onboarded projects by aggregating key metrics and insights.
The Dashboard allows users to:
Helping to assess the overall reliability of scans.
Percentage of Checkmarx projects onboarded into CxTuneMaster.
Impacting scan accuracy, such as execution queries, optimization gaps, or scan scope issues.
By leveraging these insights, users can quickly identify areas of improvement, monitor trends over time, and optimize scan efficiency for better security outcomes.
The Request Service section, accessible via the side menu, enables CxTuneMaster end-users to directly contact our team for assistance. Whether it's a feature request, optimization support, or onboarding services, our experts are available to help customers maximize the efficiency of their Checkmarx integration.
By leveraging this service, users can ensure they are getting the most out of Checkmarx One, improving scan accuracy, optimizing configurations, and addressing any challenges they may encounter in their operational workflows. Our team is committed to assisting customers in fully utilizing Checkmarx’s capabilities for enhanced security and performance.