Workflow Analyzer

What are the four options unveiled by the "Analyze file" button?

- Analyze project. Analyze all files in the automation project against a set of rules configured in Workflow Analyzer - Validate file: check specific file only for validation errors - Validate project: check project only for validation errors. - Workflow Analyzer settings: configure and edit WA rules. See list of all available rules.

Which tools are used to enforce governance policies with Workflow Analyzer?

- UiPath Automation OPS: web-based application available in Automation Cloud, used to create and deploy governance policies - File-based governance: create JSON policy file and deploy the file locally, externally, or through Orchestrator.

True or false: Analyzer can't be configured to block publishing/running the process if there is an error level breach during analysis.

False, analyzer can be configured in such a way.

Rule default action

The action level defined for the rule: error/warning/info/verbose.

Rule Name

The actual name of the rule.

How does the "Analyze File" option work? How is it executed?

1. Analyzer runs workflow validation (check for compilation errors) 2. If passed, analyzer checks the workflow for breaches against the defined Workflow Analyzer rules.

Rule recommendation

A suggestion on how to improve the workflow and link to documentation page for the rule.

Describe project anatomy rules!

ANA code in ID. Ensure the project meets general anatomy requirements.

How can rules be enabled/disabled?

By checking/unchecking the box next to it in "Workflow Analyzer Settings".

Describe design best practices rules!

DBP in ID. Requirements for ensuring project meets a general set of best practices.

Some activity packages come with their own sets of rules. Give examples of such packages!

Excel, Mail, Testing, UiAutomation. The rules are added automatically when the workflow uses any of the activity packages.

If you change rule parameters and decide to revert back to the original state, how can you do that?

Any default parameters that were changed can be reverted by right-clicking the selected rule and selecting "Reset to Default.

Rule ID

Describes origin, category and number, e.g. ST-DBP-007

How do you access Workflow Analyzer options?

Design ribbon > Analyze File.

What are the abilities of Workflow Analyzer?

Edit/disable/enable rules, Run validation (+ analysis) at file/project level, Manage errors and warnings in Error List panel, Build custom rules with Uipath.Activities.Api, Integrate workflow analysis with prebuilt and/or custom rules in CI/CD pipeline configurations.

Which two ways can Workflow Analyzer be enforced in?

Enforce analyzer before run, enforce analyzer before publish. Both of these can be enabled/disabled via Home > Settings > Design.

Each rule defined for the analyzer has a default action level based on criticality - what are the levels?

Error, warning, information, verbose.

How is governance used when working with rules and workflow analyzer?

Governance makes sure users adhere to development standards and comply with certain rules by enforcing policies, e.g. determine which applications and URLs users are allowed to automate by configuring App/URL restrictions rule in WA. As a part of governance policies, organizations can enforce custom rules pertaining to their needs across all projects in a centralized manner.

What are the rule components?

ID, name, description, scope, default, action, editable properties

What is UiPath.Studio.CommandLine.exe?

It contains a set of parameters for checking files/projects against certain rules, even in CI/CD pipeline configurations. It is available in the installation folder for the Windows installer (.msi) version of Studio, and for Studio installed in user mode (.exe)

What is Workflow Analyzer?

It is a static code analyzer ensuring the project meets quality, readability and reliability standards. When triggered, it uses the configured rule set to check the project/workflow for inconsistencies without actually executing the project. Found errors are logged in Error List panel. Rules are based on Automation Best Practices.

What does Studio do before running the analysis?

It performs a project validation, and any validation errors found will be visible in the Error List panel.

Describe maintainability and readability rules!

MRD code in ID. Projects should be easy to understand so their maintainability is ensured.

Describe naming rules!

NMG code in ID. Checks the file/project for naming-related inconsistencies.

What are the eight rule categories?

Naming rules, design best practices, project anatomy rules, maintainability and readability, usage rules, performance and reusability rules, reliability rules, security rules.

Describe performance and reusability rules!

PRR code in ID. Checks file/project for inconsistencies related to performance and reusability.

Describe reliability rules!

REL code in ID. Check file/project for reliability inconsistencies.

What is the information about each rule contained in the file summarizing the analyzer results?

RuleId, RuleName, Parameters, Severity, ErrorsDescription

Describe security rules!

SEC code in ID. Check file/project for security inconsistencies.

Rule description.

Short description of the rule.

Rule editable properties:

Some rules can have properties that can be modified, e.g. layer count for multiple flowchart layers, Regex for naming conventions.

Where are results of each workflow saved, if "Export Analyzer Results" is enabled?

They are saved in JSON format in \.local\.analysis subfolder of project folder.

How do you sort the results in Error List?

This can be done by Code, Name, Description or File, by clicking on the respective headers. Filter entries by scope or Rule.

Rule Scope

This is the level for which the rule applies (Activity/Workflow/Project)

Describe usage rules!

USG code in ID. Requirements for ensuring elements defined in the project are actually used.

Workflow Analyzer allows for building custom rules, but this requires a certain package - which one?

UiPath.Activities.Api package from the Official feed. Custom rules are built in an IDE, and can be integrated in Studio at global or project level.

What happens if workflow analyzer is enforced before publish?

Workflow Analyzer is run before publishing a workflow file/project. Checks all enabled rules regardless of action and allows publishing only if there are no rule violations of type Error.

What happens if workflow analyzer is enforced before run?

Workflow Analyzer is run before running/debugging a workflow file, checks for all rules with Error action. Allows execution only if no errors are found.

If Studio finds any errors during the project validation, what happens?

Workflow analysis, debugging, running, and publishing are impossible until the issue is resolved.

Is it possible to configure studio to export results of each workflow analysis to the project folder?

Yes, - Studio Backstage View > Settings > Design > Enable "Export Analyzer Results".