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
Studio User Guide
Last updated Nov 18, 2024
Attended Automation Framework
The Attended Automation Framework is a comprehensive template tailored to attended scenarios, which aims to provide a seamless and user-friendly experience by offering a set of intuitive forms and corresponding trigger workflows.
The template consists of six distinct folders, each serving a particular purpose:
- Framework_Workflows—Stores supporting workflows necessary for the template to execute correctly. This folder does not require modification.
- Form_Inputs—Enables users to input information and interact with the automation through intuitive forms, and triggers workflows based
on their actions (such as clicking Cancel, Continue, Select folder, or View user guide). The values are stored in the
ConfigUtility.jsonfile, which is used to pre-populate the forms in subsequent runs. - Form_ConfigUtility—Provides the ability to add custom logic and configurations, invoked by the
ConfigUtility.xamlfile and includes trigger workflows for canceling configuration changes, resetting all configurations to default, or saving new configurations. Allows you to customize the automation settings, including default form values, customized exceptions, additional settings, constants, and orchestrator assets, to tailor the automation to your specific needs. To set the configurations run this workflow at design time. - Form_Success—Displays the form when the transaction is successful and includes trigger workflows for options such as closing, repeating the process, or viewing the output.
- Form_Error—Displays when an error or exception occurs during the automation process and includes trigger workflows for options such
as closing the automation, emailing the error to the default email address (saved in the
Form_ConfigUtilityform file), or repeating the process. - Form_StatusWindow—Displays the automation process status throughout the automation, providing real-time updates on its progress.
To configure the template for your specific use case, please follow these steps:
- Open the
Process.xamlfile and customize the following options:- Status messages - personalize the messages that appear to the user during the automation process (
resultFormMessage). - View Output button - choose whether the user can open the selected folder using the View Output button (
Config("showViewOutput")). -
Place the logic of your automation in this workflow.
- Status messages - personalize the messages that appear to the user during the automation process (
- Run only the
ConfigUtility.xamlfile and configure theForm_ConfigUtilityform file by following these steps:- Form Defaults - Set the default form values that appear during every run. The form fields will reset to these values during every run.
- Exceptions - Define custom business exceptions in the automation.
- Settings - Define parameters that must be unique for each automation but are not fields in the input form. This includes:
logF_BusinessProcessName—The name of your automation, which will be displayed at the top of your forms and in any error emails.userGuideUrl—The URL for the user guide or any other documentation you want to provide to the user as a reference.automationDescription—The text that appears at the top of the form below the automation name and before the user guide link.errorEmailRecipient—The recipient of the error email that is automatically generated in case of an error.
- Constants and Assets - Set constant values and Orchestrator assets used in the automation.
The default dependencies of this project template are UiPath.Form.Activities, UiPath.System.Activities, UiPath.UIAutomation.Activities, and UiPath.WebAPI.Activities.
