The Code Quality Check (CQC) feature extends beyond RPA Desktop Design Studio <refer to the blog of CQC in RPA desktop design studio> to RPA Hub, ensuring end-to-end quality management for automation projects. This blog will discuss how RPA Hub complements Desktop Design Studio to enforce coding standards, maintain project integrity, and streamline publishing workflows.
Centralized Rule Management
In RPA Hub, release managers and administrators define and manage a pre-configured set of code quality rules. These rules are essential for:
- Evaluating automation files or scripts.
- Maintaining coding standards and best practices.
RPA admins can:
- Activate or deactivate rules.
- Adjust severity levels for each rule.
- Customize evaluation criteria using regular expressions.
View a list of pre-defined rules that RPA admins can set for the RPA developers to follow as a code quality standard.
Publishing with Quality Checks
When a project is published from RPA Desktop Design Studio to RPA Hub, the system performs an automatic code quality check. If issues are detected, the following occurs:
- The Code Quality Check Results window displays errors and warnings.
- A message such as "Automation contains one or more errors or warnings" highlights the detected issues.
- The ability to proceed depends on the property sn_rpa_fdn.restrict_package_by_severity, which can be configured to enforce stricter compliance or allow exceptions.
Real-Time Insights
In RPA Hub, you can:
- View detailed results for each package version in the Code Quality Result field. This indicates if the Code Quality Check feature in RPA Desktop Design Studio has detected any errors, warnings, or information in the package.
- Error –
- If a package that is published from RPA Desktop Design Studio with the code quality check as error.
- If a package has both error and warning, then the code quality check result is error.
- If a package has both error and info, then the code quality check result is error.
- Warning –
- If a package that is published from RPA Desktop Design Studio with the code quality check as warning.
- If a package has both warning and info, then the code quality check result is warning.
- Pass –
- If a package that is published from RPA Desktop Design Studio without any code quality check error or warning or info.
If the Code Quality Check feature is not enabled, then the value in this field is Not Applicable. Code quality status of package versions are set with highest severity.
To review the error or warning, open the package version file in RPA Desktop Design Studio.
- Access a list of predefined rules in the Code Quality Rules section.
- Review and adjust compliance settings to align with your organization’s standards.
Configuration Essentials
To enable the Code Quality Check feature in RPA Hub, ensure the following system properties are configured:
- sn_rpa_fdn.enable_code_quality_check: Enables the feature.
- sn_rpa_fdn.restrict_package_by_severity: Determines whether projects with errors or warnings can be published.
- sn_rpa_fdn.code_quality_check_timeout: Specifies the maximum duration (in minutes) for completing the quality check.
These settings provide flexibility while maintaining control over project quality.
Seamless Collaboration
The integration between RPA Desktop Design Studio and RPA Hub ensures a seamless workflow:
- Developers use Desktop Design Studio to address issues proactively.
- Release managers leverage RPA Hub to enforce organizational standards and compliance.
Conclusion
Code Quality Check bridges the gap between development and deployment, ensuring high-quality automations that align with organizational goals. By leveraging CQC capability, teams can reduce errors, enhance maintainability, and achieve greater success in their automation initiatives.
For more information on Code Quality Check, refer to the respective documentation for RPA Desktop Design Studio and RPA Hub.
