Preferences
Required role | Server Administration |
Access | Preferences |
The preferences for ARCAD CodeChecker are managed in the Preferences dialog. The preferences you can access depends on the Rights granted to your user profile.
Preferences options are not specific to a user account. If the Studio or Server are configured on a workstation, the configuration options are kept the same no matter which user account is used.
The General preferences settings section makes it possible to manage the location of all the temporary files created by the CodeChecker Server.
- Temporary files root
-
Sets a path where the CodeChecker Server creates a cctmp folder dedicated to store all the temporary files or folders.
Example./temp
Upon startup or when the preference is changed, the cctmp folder is cleared.
To save any changes made, click Apply. Click Restore Defaults to return to the default settings.
These settings are used when an automatic email is sent, if the project allows it.
- Server definition
-
Server: The name or the IP Address of the mail server.
Port: The communication port used to reach the mail server.
Use TLS: Tick to use TLS when establishing the connection to the mail server.
Connection Timeout: The time period in milliseconds within which the connection to the mail server must be established.
Charset: The charset used to encode non US-ASCII characters contained in the e-mail content.
- Server authentication
-
Use Authentication: Tick to enable this option if the mail server requires authentication.
Login / Password: The login and password used to connect to the mail server.
- Sender information
-
Sender name: The name that will be displayed in the From field of the sent e-mail.
Sender address: The e-mail address that will be displayed in the From field of the sent e-mail. This value is skipped if the Sender name is defined.
To test that the mail sender has been properly configured, enter an email address in the Send test mail to field and click the Send button. You can put several email addresses; each address must be separated by a comma. A test email is sent to the address(es) defined. Furthermore, test emails will be sent to the address(es) every time the server is started.
If you do not want to receive an email every time the server is started, remove the address(es) entered in the Send test mail to field.
To save any changes made, click Apply. Click Restore Defaults to return to the default settings.
Tick the box to Forbid groovy execution. Rules using groovy-based metrics will be ignored.
Tick the box to Disable SQL parsing. If the SQL parsing is disabled, RPG and COBOL source with SQL will still be parsed, but the resulting CAST model will not contain any SQL node. All metrics related to SQL will become irrelevant (their result will always be 0).
To save any changes made, click Apply. Click Restore Defaults to return to the default settings.
Tick the box to Enable precompiler. Any compilation launched from ARCAD Skipper RDi plug-in will be preceded by a check of a set of rules. If the precomiler returns an issue whose level is equal or greater than the Fail level defined below, the compilation will not be executed. Select a Rule set and a Fail level to configure the precompilation quality check. The rules in the rule set are executed during the precompilation.
To save any changes made, click Apply. Click Restore Defaults to return to the default settings.
Once the precompiler is enabled in the ARCAD CodeChecker preferences, it is also enabled in RDi. Any compilation executed from the ARCAD Skipper RDi plug-in will execute the rules from the rule set defined in the preferences above.
If the execution fails (ie. the maximum fail level is met by one of the issues returned by the rules), a dialog informs you that the precompilation failed because the ARCAD CodeChecker rules execution failed.
The ARCAD Skipper precompiler feature can be disabled from RDi, by setting an application variable on the ARCAD Server. This specific application variable must belong to the ARCAD_STANDARD/CODECHECKER group, be named PRECOMPILER and have the value *NO.
This application variable set in RDi overrides the ARCAD CodeChecker configuration, meaning that even if the Enable precompiler option is activated, it is not taken into account if the application variable is set with a *NO value in RDi.
The communication between the SonarQube Server and the CodeChecker Server is entirely managed by the CodeChecker Server through the following parameters:
- SonarQube URL [Mandatory]
- Sets the URL to the SonarQube server on which the results are uploaded.
- Authentication token
- Sets an authentication token used when the SonarQube server is not running on the same machine as the CodeChecker Server. The token is encrypted and stored in the ARCAD CodeChecker database.
- Custom JRE path
- Sets a JRE that can be used by putting its installation path here. By default, the Sonar Scanner is executed by using the current Java Runtime Environment.
- Max. memory allowed
-
Sets the maximum memory allowed to the Sonar Scanner to perform its operation.
In case of a Java heap space error or a java.lang.OutOfMemoryError happening during the execution, the maximum allowed memory can be increased here.
- Sonar Scanner debug mode
- Enables or disables the debug mode for the Sonar Scanner.
- Sonar Scanner update
-
Current version: Indicates the version of Sonar Scanner currently installed.
If no Sonar Scanner is installed, the status is set to not installed.
-
Click the Update button to update automatically the Sonar Scanner when it is already installed.
If the latest version is already installed, a warning dialog opens to let you know the Sonar Scanner cannot be updated, as it is installed already in its latest version.
For more information about the installation instruction for the Sonar Scanner, refer to Installing the ARCAD CodeChecker solution for SonarQube.