Code quality check in RPA Hub
Summarize
Summary of Code Quality Check in RPA Hub
A code quality check evaluates automation files or scripts to ensure they meet coding standards, best practices, and maintainability. This process is crucial in the RPA development life cycle to create robust and efficient automation projects, minimizing future errors.
Show less
Key Features
- Code Quality Check Rules: RPA release managers or admins select rules from a predefined set in the RPA Hub instance.
- In-Built Checks: The RPA Desktop Design Studio conducts code quality checks before a package is published.
- Proactive Checks: Developers can inspect a package for issues using the Code Quality Check feature in the RPA Desktop Design Studio.
- Error Management: Decisions on package publishing depend on the severity of errors or warnings, guided by the system property configuration.
- Configuration Options: Key system properties must be set to enable and configure the code quality check feature effectively.
Key Outcomes
By implementing code quality checks, RPA customers can enhance the efficiency and reliability of their automation processes, ensure compliance with coding standards, and reduce the risk of errors. The ability to manage and customize code quality rules helps maintain high-quality automation outputs and supports better governance of RPA projects.
A code quality check refers to the process of evaluating the automation file or script to assess its adherence to coding standards, best practices, maintainability, and overall quality.
Code quality check overview
Code quality checks are essential in RPA development life cycle, to ensure that the automation file is robust, efficient, and free from common issues that could lead to errors or difficulties in the future.
RPA release managers or RPA admins select code quality check rules from a pre-defined set of rules in the RPA Hub instance.
Then, the RPA Desktop Design Studio performs an in-built code quality check before publishing a package. RPA developers can also perform pro-active code quality check on a package in the RPA Desktop Design Studio by inspecting an activity or a complete automation project for any issues, using the Code Quality Check feature.
The issues and their details are displayed in the Code Quality Check Results window. Double-click an individual entry to view the component that has displayed an error or a warning. Troubleshoot the issues before you publish the automation project to RPA Hub. For more information on how to perform Code Quality Check in RPA Desktop Design Studio, see Code quality check in RPA Desktop Design Studio.
If an error or a warning occurs in the automation, a decision is derived if the package can be published successfully or not, based on the system property [sn_rpa_fdn.restrict_package_by_severity] configuration (error, warning, or no restrictions). For more information about compliance rules for RPA Desktop Design Studio, see Code quality check compliance for RPA Desktop Design Studio.
If a package version is marked with code quality result as error or warning, a decision is derived if the bot process can be published successfully or not, based on the system property [sn_rpa_fdn.restrict_package_by_severity] configuration (error, warning, or no restrictions). For more information about compliance rules for RPA Hub, see Code quality check compliance for RPA Hub.
View a list of the pre-defined code quality rules in the RPA Hub instance. For more information, see Code quality rules list in RPA Hub.
View a code quality rule form along with the type and description. For more information, see Code quality rule form in RPA Hub.
In the code quality rule form, RPA release managers and admins can edit the Severity, Regular Expression, Active, and Value fields.
View the result of the code quality check, in the Code Quality Result field of an associated package version in RPA Hub. For more information, see Package Version form in RPA Hub.
Configuration
To enable the code quality check at the instance level, ensure that you mark the new system property sn_rpa_fdn.enable_code_quality_check as true.
- sn_rpa_fdn.restrict_package_by_severity - To set a restriction on publishing a package from RPA Desktop Design Studio and publishing a bot process in RPA Hub.
- sn_rpa_fdn.code_quality_check_timeout - To enter a maximum duration, in minutes, for the completion of the code quality check.