Reviewing code analysis results

As a Bot Creator (RPA developer) or Citizen Developer, you can use code analysis to check and fix any coding errors in your bots. You can develop automation based on configured code analysis policies and predefined rules.

With code analysis, you can improve the reliability of your bots by implementing coding best practices such as variable naming conventions, comment coverage, and error handling. Building bots conforming to the predefined guidelines or rules helps you to identify possible errors during bot development. This reduces bot failures in the production environment. You can run code analysis in both your private and public workspaces and view the results.

With code analysis (available from the Bot editor), you get the following benefits:

Run code analysis as required.
Get tooltip guidance for compliance with rules
Integration with Bot Assistant for accounting and guidance.

Code analysis results

To view the results of code analysis, go to the Automation page, and check the Code Analysis results, This column shows a summary status of the code analysis results for each automatoin file. The following details of each status are available:

N/A: Code analysis does not apply to the object because the object is a folder or is not a bot file.
Not Scanned: Code analysis has not been run on the bot.
High severity: The bot has at least one high severity violation.
Low severity: The bot has at least one low severity violation, but no high severity violations.
No violations: There are no code analysis violations in the bot.

The following image shows an example result from code analysis:

注： The status of the bots in the code analysis results column is set to not scanned for the following scenarios:

The bot is edited in the private workspace.
Code analysis is disabled by the administrator or there is a change in any of the rule configuration.

Reviewing results in Bot editor

When you create a bot or modify an existing bot and then save the bot in the Bot editor, code analysis is initiated in the background, and the results are displayed in the Bot Assistant. The code analysis header shows the total count of violations in the bot. You can expand the code analysis option, select a specific object and view the following attributes:

Applicable object: Displays the bot, variable, action, and action attribute.
Rule code: Unique RULE_CODE ID.
Severity: High or low.
Rule text: Description to indicate the nature of evaluation to be performed on the code.

The following image shows an example of code analysis displayed in the Bot Assistant:

The code analysis results are displayed in the following order:


Attribute	Rules violated
Bot	Mandatory header comment Comment coverage Action maximum
Variable	Variable name pattern Variable name length No unused variables
Action	No hard-coded delay No hard-coded file path No hard-coded email address No empty catch Mandatory catch logging Mandatory catch screen capture

The code analysis header displays the count of objects with a violation error within the bot. Each object can have either low or high severity. The violation is displayed with the attribute followed by the line number and the severity. All the high severity errors are displayed first. Navigate to the corresponding line in the bot that has the violation, rectify the violation, and save the bot.

You must save the bot to see the latest code analysis results in the Bot Assistant.

System-created variables

Variables created by the system such as input or output variables, package-suggested variables, or auto-generated variables (window variables) use the default variable naming case convention from code analysis or Pascal case if no format is defined in code analysis rule.

Audit log

When code analysis is initiated either by saving a bot or running code analysis in the Bot editor, the information is captured in the audit log. The following details are captured:

Bot name
User information
The method through which code analysis is initiated (save option or run code analysis option)
Time taken for the code analysis to run including details such as the number of code lines if captured by code analysis process
Total number of violations
Details of the violations

Automation 360