studio
2024.10
true
- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- Control Flow
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- Logging
- The Diagnostic Tool
- Workflow Analyzer
- About Workflow Analyzer
- ST-NMG-001 - Variables Naming Convention
- ST-NMG-002 - Arguments Naming Convention
- ST-NMG-004 - Display Name Duplication
- ST-NMG-005 - Variable Overrides Variable
- ST-NMG-006 - Variable Overrides Argument
- ST-NMG-008 - Variable Length Exceeded
- ST-NMG-009 - Prefix Datatable Variables
- ST-NMG-011 - Prefix Datatable Arguments
- ST-NMG-012 - Argument Default Values
- ST-NMG-016 - Argument Length Exceeded
- ST-NMG-017 - Class name matches default namespace
- ST-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DPB-010 - Multiple instances of [Workflow] or [Test Case]
- ST-DBP-020 - Undefined Output Properties
- ST-DBP-021 - Hardcoded Timeout
- ST-DBP-023 - Empty Workflow
- ST-DBP-024 - Persistence Activity Check
- ST-DBP-025 - Variables Serialization Prerequisite
- ST-DBP-026 - Delay Activity Usage
- ST-DBP-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- ST-USG-005 - Hardcoded Activity Arguments
- ST-USG-009 - Unused Variables
- ST-USG-010 - Unused Dependencies
- ST-USG-014 - Package Restrictions
- ST-USG-020 - Minimum Log Messages
- ST-USG-024 - Unused Saved for Later
- ST-USG-025 - Saved Value Misuse
- ST-USG-026 - Activity Restrictions
- ST-USG-027 - Required Packages
- ST-USG-028 - Restrict Invoke File Templates
- ST-USG-032 - Required Tags
- ST-USG-034 - Automation Hub URL
- Variables
- Arguments
- Imported Namespaces
- Coded automations
- Introduction
- Registering custom services
- Before and After contexts
- Generating code
- Generating coded test case from manual test cases
- Trigger-based Attended Automation
- Recording
- UI Elements
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Citrix Technologies Automation
- RDP Automation
- VMware Horizon Automation
- Salesforce Automation
- SAP Automation
- macOS UI Automation
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- Extensions
- About extensions
- SetupExtensions tool
- UiPathRemoteRuntime.exe is not running in the remote session
- UiPath Remote Runtime blocks Citrix session from being closed
- UiPath Remote Runtime causes memory leak
- UiPath.UIAutomation.Activities package and UiPath Remote Runtime versions mismatch
- The required UiPath extension is not installed on the remote machine
- Screen resolution settings
- Group Policies
- Cannot communicate with the browser
- Chrome extension is removed automatically
- The extension may have been corrupted
- Check if the extension for Chrome is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and Incognito mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Chrome
- Chrome Extension on Mac
- Group Policies
- Cannot communicate with the browser
- Edge extension is removed automatically
- The extension may have been corrupted
- Check if the Extension for Microsoft Edge is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and InPrivate mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Edge
- Extension for Safari
- Extension for VMware Horizon
- Extension for Amazon WorkSpaces
- SAP Solution Manager plugin
- Excel Add-in
- Test Suite - Studio
- Troubleshooting
ST-USG-027 - Required Packages
Studio User Guide
Last updated Nov 18, 2024
ST-USG-027 - Required Packages
Rule ID:
ST-USG-027
Scope: Project
The rule allows enforcing the use of activity packages and versions in a given project. After the list of required packages is defined, the rule checks the project to determine if any were not added as dependencies. By default, if any required package has not been installed in the project, the rule logs an error in the Error List panel.
Make sure all the packages required by your organization are installed in your project.
In the Project Settings window, select the Workflow Analyzer tab. Find the rule and select the rule, as in the image below:
By default, this rule does not require any activity packages. Add a package by writing its full name together with its version
separated by the equals sign (=), for example,
UiPath.Excel.Activities=2.5.3
.
Add the greater than (>) symbol to require any version higher than a specified version, for example,
UiPath.Excel.Activities>=2.5.3
would require a UiPath.Excel.Activities package with a version of 2.5.3 or higher. The greater than (>) symbol can only be
used together with the equals sign (=), inputs such as UiPath.Excel.Activities>2.5.3
are invalid.
The less than (<) and the less than or equals (<=) symbols are not supported, therefore inputs such as
UiPath.Excel.Activities<2.5.3
or UiPath.Excel.Activities<=2.5.3
are considered invalid.
Use a wildcard character
*
to require one of multiple versions of the same package. For example, the UiPath.Excel.Activities=2.7.2-beta*
value requires any 2.7.2-beta
version of the UiPath.Excel.Activities=2.7.2
package and the rule generates an error if other versions of the same package are installed, including:
UiPath.Excel.Activities=2.7.2
- Other prerelease versions of the
UiPath.Excel.Activities=2.7.2
package (like alpha versions) - Other stable and prerelease versions of the
UiPath.Excel.Activities
package
The wildcard character
*
can only be used at the end of the version. Furthermore, when using the greater than or equals (>=) symbol together with
a wildcard character *
, the greater than symbol (>=) is interpreted as the equals sign (=), for example, UiPath.Excel.Activities>=2.7.2-beta*
is a valid input, but is interpreted as UiPath.Excel.Activities=2.7.2-beta*
.
Examples:
UiPath.Excel.Activities=2.8.4-*
UiPath.Excel.Activities>=2.7.2
UiPath.Excel.Activities=2.7.2
To require multiple packages, simply separate them by a comma, for example,
UiPath.Excel.Activities, UiPath.UIAutomation.Activities
requires any version of UiPath.Excel.Activities and UiPath.UIAutomation.Activities to be added to the project.
Note: To check which package an activity belongs to, use the Group by Packages option in the Activities panel, as explained here. Another easy way to check is to hover over an activity in the panel and read the tooltip.
After adding packages to the rule, use the Analyze Project button to try out the rule.