Rules Category

Estimated reading: 5 minutes 2733 views

The table below provides a detailed description of each predefined rule in the Workflow Analyzer. Click here to learn more about managing and customizing the rules.

Category	Code	Rule Name	Description
Naming Convention	DE-NMG-001	Variables Naming Convention	Ensures that variable names follow defined naming standards for readability and maintainability (e.g., camelCase, descriptive names). Helps in consistent identification and avoids confusion in complex workflows.
	DE-NMG-002	Arguments Naming Convention	Validates that input/output arguments adhere to standardized naming conventions (e.g., prefix with in_, out_, or io_) to clearly indicate direction and improve workflow clarity.
	DE-NMG-003	Display Name Duplication	Checks if multiple activities within the workflow share the same display name, which can make debugging difficult and reduce clarity during review or execution.
	DE-NMG-004	Variable Length Exceeded	Flags variables with names that exceed the provided character limit. By default, the limit is 30 which can be extended as per user preference in the settings page.
	DE-NMG-005	Argument Length Exceeded	Flags arguments with names that exceed the provided character limit. By default, the limit is 30 which can be extended as per user preference in the settings page.
	DE-NMG-006	Variables Overrides Argument	Flags if the variable name and argument name is same. Each variable and argument name should be unique to avoid confusion while debugging the workflow.
	DE-NMG-007	Arguments Default Values	Checks whether default values are defined for arguments in the workflow. Defining default values helps in testing individual workflows and provides a standard configuration for reusable components to ensure flexibility and consistency when invoking workflows.
Design Best Practices	DE-DBP-001	High Arguments Count	Warns when the number of arguments in a workflow exceeds a recommended threshold, indicating potential design issues. The threshold limit can be modified in the settings page.
	DE-DBP-002	Empty Catch Block	Detects Try-Catch blocks where the Catch section caught with empty blocks and make debugging difficult.
	DE-DBP-003	Empty Workflow	Identifies the workflow that contains empty workflow files, including empty sequences, flowcharts, or state machines.
	DE-DBP-004	Hardcoded Timeouts & Delays	Flags if the hardcoded timeout values exceed the default values specified in the Workflow Analyzer settings. This may apply to properties such as 'Wait Time' or 'Timeout' in the activity.
	DE-DBP-005	Undefined Output Properties	Flags if the output of an activity is not assigned to a declared variable.
	DE-DBP-006	Multiple Flowchart layers	Identifies when the number of flowcharts used in a workflow exceeds the recommended threshold to improve readability and maintainability.
Solution Anatomy Rules	DE-ANA-001	Solution Workflow Count	Identifies and reports the total number of workflows available in the current solution, including any invoked workflows.
	DE-ANA-002	File Activities Stats	Provides the number of activities used within a workflow. The statistics are provided at the individual workflow level and not for the entire solution.
	DE-ANA-003	SkipOnError True	Identifies activities in the workflow where the “Skip On Error” property is set to True, highlighting potential areas where errors may be ignored, which could affect workflow reliability and maintainability.
	DE-ANA-004	List OCR/Image Activities	Identifies and lists any activities related to OCR, Image Automation, or other image recognition processes found in the workflow. It helps to make it easier to review, optimize, and maintain workflows that involve visual automation.
Maintainability Rule	DE-MNR-001	Unreachable Activities	Identifies activities in the workflow that do not have connecting nodes in the flowchart or have been commented out in the flow.
	DE-MNR-002	Redundant Sequences	Detects and flags unnecessary sequences within a workflow. For example, if a sequence is placed inside another sequence, it can be avoided to reduce the overall number of activities.
	DE-MNR-003	Empty Sequence	Detects and flags empty sequences present in workflows.
	DE-MNR-004	Write Line Usage	Identifies any Write Line activities used in the workflow and flags them for removal before publishing.
	DE-MNR-005	Incomplete IF	Flags any “IF” activity in the workflow that is empty or lacks proper conditions, helping to prevent incomplete logic that could lead to unexpected workflow behavior.
	DE-MNR-006	Activity Name default	Detects activities that still use their default names instead of custom, descriptive names. Using meaningful names improves workflow readability and makes it easier to understand the purpose of each activity.
	DE-MNR-007	Deeply Nested Activities	It helps to set a threshold limit for the number of activities to be used in the workflow and flags if the workflow exceeds the limit.
	DE-MNR-008	Repeated Log Messages	Identifies duplicate log messages used within a workflow. Eliminating repeated log messages helps maintain consistency, improves readability, and ensures that logs are clear and meaningful for monitoring and debugging.
	DE-MNR-009	Nested If Clauses	Checks for workflows that contain more than threshold limit for nested If clauses. Limiting nested If clauses improve workflow readability, simplifies maintenance, and reduces complexity, making the logic easier to follow.
Usage	DE-USG-001	Hardcoded Activity Properties	Detects values hardcoded into activity properties that should ideally be passed as variables or configuration inputs.
	DE-USG-002	Unused Variables	Highlights variables that are declared but never used within the workflow.
	DE-USG-003	Unused Dependencies	Detects and flags any unused packages that are installed but not utilized in the workflow or solution.
	DE-USG-004	Minimum Log Messages	Verifies that at least one Write Log activity is present in the workflow. Including logging activities is recommended to ensure better monitoring, troubleshooting, and auditability of workflows.
	DE-USG-006	Check Stop Activity	Identifies whether the “GetStopStatus” activity is used in the workflow or main solution to ensure proper termination of the process when required.
Security	DE-SEC-001	Secure String Argument Usage	Flags arguments of type SecureString used in the workflow. This type of string should be used for storing potentially sensitive strings only.
Reliability	DE-REL-001	Infinite Loop	Identifies potential infinite loops in the workflow. Checks for self-connecting nodes without termination conditions or connections that loop back, which can create an infinite loop.

Rules Category

Recently Viewed articles

Rules Category

CONTENTS