Rules Category

Estimated reading: 2 minutes 126 views

The table below provides a detailed description of each predefined rule in the Workflow Analyzer.

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.

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.

Maintainability Rule

DE-MNR-001

Unreachable Activities

Identifies activities in the workflow that does not have connecting nodes in the flowchart or has been commented out in the flow.

Usage

DE-USG-002

Unused Variables

Highlights variables that are declared but never used within the workflow.

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.

Share this Doc

Rules Category

Or copy link

CONTENTS