Workflow Analyzer

Estimated reading: 4 minutes 163 views

The Workflow Analyzer is a static analysis tool designed to assist developers in adhering to best practices, such as consistent naming conventions, proper error handling, and efficient variable usage. By automating the detection of these areas, it helps ensure workflows maintain high-quality standards and best practices. Here’s how it works:

1. Naming Convention: The tool ensures variables and arguments follow consistent naming patterns and adhere to character limits, improving readability and maintainability.

2. Design Best Practices: It checks for design consistency by ensuring workflows are not empty, contain necessary try-catch blocks, and avoid excessive complexity from too many arguments, making workflows more resilient and manageable.

3.Maintainability: The analyzer identifies disconnected or commented-out activities and unused variables, helping clean up and optimize workflows, improving clarity, and boosting efficiency.

4. Security String Usage: It flags improper handling of sensitive data, ensuring SecureString arguments are used correctly and adhering to security best practices.

By guiding developers to follow these best practices, the Workflow Analyzer promotes proactive improvements, reduces errors, and enhances workflow efficiency.

How It Works

The Robility Workflow Analyzer helps you check your workflows during development without needing to run them. It scans your workflow to ensure it follows best practices and standards.

Key Areas Checked:

A. Naming conventions for variables and arguments. 
B. Error handling (e.g., empty catch blocks or incomplete workflows)
C. Unused resources (e.g., unnecessary variables or commented-out activities)
D. Security practices
E. Workflow maintainability and modularity

Features of the Robility Workflow Analyzer

The Robility Workflow Analyzer focuses on three main features:

1. Analyze Workflow – This option allows you to check the current workflow you’re working on. It scans the workflow and compares it against the selected rules in the Analyzer. A report will be generated, showing areas for improvement and suggestions for enhancement. This feature helps you refine your workflow, ensuring it’s clean and ready for the next step. 

2. Analyze Solution – This option allows you to analyze the entire solution and validate each process against the selected automation rules.

3. Workflow Analyzer Settings – The Workflow Analyzer Settings let you customize the validation process by choosing the automation rules you want to apply during workflow or solution analysis. These settings provide control over the level of validation and help tailor the analyzer to meet your project or organizational standards.

Analyzer Settings Wizard

Each rule in the wizard includes metadata to explain its purpose and impact. Here’s what each field means:

Code: A unique identifier that indicates the rule’s origin, category, and sequence.

Different rule categories serve specific purposes in the validation process.

  • Naming- NMG
  • Design Best Practices-DBP
  • Project Rule-PRR
  • Maintainability Rules-MNR
  • Usage-USG
  • Security- SEC

 Example: DE-NMG-001

1. DE – Indicates the rule originates from Designer.
2. NMG – Denotes the rule category, such as Naming Convention.
3. 001 – The sequential number of the rule. 

Name: The title of the rule, giving a quick summary of what it validates.

Scope: Specifies where the rule is applied. Currently, all rules apply at the workflow level, meaning they check elements within an individual workflow file.

Default Action: Defines the logging behavior when the rule is triggered during analysis. You can choose the logging level:

1. Error Marks the issue as critical and logs it as an error.
2. Warning Indicates a potential issue that may not break the workflow but should be addressed.
3. Info Logs informational notes for developer awareness without suggesting immediate action.

Recommendation: Provides guidance on how to fix or avoid violations if this rule is triggered during validation.

Regex / Length / Threshold:  Displays the default regex patterns, threshold limits, and parameter lengths, with the option to customize them based on your preferences.

Share this Doc

Workflow Analyzer

Or copy link

CONTENTS