RG-DBP-003 Advanced Usage Activity
Description
RG-DBP-003 inspects workflows for activities defined as “Advanced Usage” cases. These activities contain complex syntax or require programmer centric knowledge to be correctly configured to perform their desired actions. This rule ensures these activities have been annotated to explain their purpose and configuration for non-developers.
This rule is configurable defining “Advanced Usage” activity types in a semi-colon; separated list.
Default Value:
UiPath.Core.Activities.InvokeCode;System.Activities.Statements.InvokeMethod;UiPath.Core.Activities.IsMatch;UiPath.Core.Activities.Match;
Impact
Workflow Readability.
Non-Developer understanding of complex syntax.
Mitigation
Advanced Usage Activities contain complex logic, configuration or syntax. These activities must be annotated to explain their complexity for non-developers.
- Annotate advanced usage activities to facilitate faster understanding of the activity’s usage, configuration and/or complexity.
- Ensure documentation is clear and concise.
- Consider utilizing simple markdown syntax to structure or format comments.
For example:
## WARNING - COMPLEX REGULAR EXPRESSION SYNTAX!
This activity utilizes the Regular Expression
^\w+([-+.']\w+)_@\w+([-.]\w+)_\.\w+([-.]\w+)\*$
to determine if the passed string is a pattern match
to an email address syntax.
Refer to https://regex101.com/ for regular expression
syntax guidance and online testing tools.