Code quality is a cornerstone of reliable and efficient automation. In RPA Desktop Design Studio, the Code Quality Check feature enables you to proactively identify issues in an automation activity or an entire project before deployment. This blog will explore how this feature empowers developers to create robust automations by adhering to best practices and coding standards.
Proactive Code Quality Check
RPA Desktop Design Studio provides two methods for running code quality checks:
- Check Current Activity: This option evaluates the active automation activity, helping you identify and resolve localized issues quickly.
- Check Complete Project: This option performs a comprehensive evaluation of the entire automation project. It’s especially useful for projects with multiple activities.
Both options generate detailed results in the Code Quality Check Results window, where issues are categorized as errors, warnings, or informational messages based on severity. Developers can filter results by severity to focus on critical problems first.
Navigating and Fixing Issues
The Code Quality Check Results window is designed for easy issue resolution:
- Highlighting Components: Double-clicking an entry highlights the affected component, either in the current activity or another activity within the project.
- Active and Inactive Rules: Developers can view and filter the rules used in the evaluation via the View Rules window(as below). This transparency helps teams understand the standards they need to comply with.
Integration with Publishing
Code quality checks are automatically performed when you publish an automation project. If the system detects issues, the Code Quality Check Results window appears, allowing developers to address them before final deployment.
However, the ability to publish a package with errors or warnings depends on the system property sn_rpa_fdn.restrict_package_by_severity, which is configurable in RPA Hub. For details on configuring this property <refer to the RPA Hub – Code Quality Check Blog>.
View a list of compliance rules that the Code Quality Check feature follows if a package is published from RPA Desktop Design Studio.
Example Scenario
Imagine you’re working on a sales automation project. Upon running a code quality check, you notice a warning about a potential null value in a calculation. Double-clicking the result highlights the problematic component, enabling you to address it immediately. This proactive approach ensures that the project meets quality standards before publication.
Next Steps
After fixing the identified issues, your project is ready to be published. For more information, refer to the Publish an Automation Project in RPA Desktop Design Studio documentation.
The Code Quality Check feature in RPA Desktop Design Studio enables developers to build reliable automations by proactively identifying and resolving issues at both activity and project levels. It ensures adherence to best practices and coding standards. By leveraging these capabilities, teams can confidently deliver high-quality automation projects.
