UiPath Robot

The UiPath Robot Guide

Showing 194 results for search ''

UiPath Activities

  Documentation  Clear Range


  Documentation  v20.3 Process Document -Preview


  Documentation  V20.3 RegEx Based Extractor -Preview


  Documentation  Set Blob Tier


  Documentation  Set Security Alert State


  Documentation  For Each Security Alert


  Documentation  Get Security Alert


  Documentation  Delete Security Rule


  Documentation  Get Security Rule List


  Documentation  Get Security Rule


  Documentation  Create Security Rule


  Documentation  Get VM NSG List


  Documentation  For Each NSG


  Documentation  Delete NSG


  Documentation  Get NSG


  Documentation  Create NSG


  Documentation  Delete IP Configuration


  Documentation  Create IP Configuration


  Documentation  For Each Network Interface


  Documentation  Get NSG Network Interface List


UiPath Integrations

  Documentation  Release Notes


  Documentation  Get Analyze Layout Result

The Get Analyze Layout Result activity uses the Form Recognizer Get Analyze Layout Result API to asynchronously retrieve the results of previously run layout analysis operation (Result Location).

  Documentation  Get Analyze Receipt Result

The Get Analyze Receipt Result activity uses the Form Recognizer Get Analyze Receipt Result API to asynchronously retrieve the results of previously run receipt analysis operation (Result Location).

  Documentation  Get Analyze Form Result

The Get Analyze Form Result activity uses the Form Recognizer Get Analyze Form Result API to asynchronously retrieve the results of previously run form analysis operation (Result Location and Model Id).

  Documentation  Analyze Layout Async

The Analyze Layout Async activity uses the Form Recognizer Analyze Layout API to asynchronously extract layout information from a specified document (File Path or File URL). After completing the operation, the activity outputs the location of the results in a String (Result Location).

  Documentation  Analyze Layout

The Analyze Layout activity uses the Form Recognizer Analyze Layout API to extract layout information from a specified document (File Path or File URL).

  Documentation  Analyze Receipt Async

The Analyze Receipt Async activity uses the Form Recognizer Analyze Receipt API to asynchronously extract field text and semantic values from a specified receipt document (File Path or File URL). After completing the operation, the activity outputs the location of the results in a String (Result Location).

  Documentation  Analyze Form Async

The Analyze Form Async activity uses the Form Recognizer Analyze Form API to asynchronously extract key-value pairs and table data from a specified document (File Path or File URL) using a specified training model (Model Id). After completing the operation, the activity outputs the location of the results in a String (Result Location).

  Documentation  Building Activity Packages

Knowing Your Project TypeRight-click any of your projects and observe the context menu.

  Documentation  Icon

Activity Creator

  Documentation  Required

Activity Creator

  Documentation  Type

Activity Creator

  Documentation  Direction

There are four directions in which a property can point:

  Documentation  Description

Activity Creator

  Documentation  Category

Activity Creator

  Documentation  Name

Activity Creator

  Documentation  Timeout

The Timeout toggle adds a Timeout property to the activity. If the activity does not finish executing within the amount of time specified in this property, an error will be thrown. The default timeout is automatically set to 60000 ms (1 minute).

  Documentation  Type: Simple

Activity Creator

  Documentation  Description

Activity Creator

  Documentation  Customizing Properties

Now that you have gone through the Activity Creation tutorial and have a working activity package, it's time to understand what all the constituent files do and how they interweave to form a UiPath activity.

UiPath Task Capture

  Documentation  Creating your own Word template

Besides managing existent templates in Task Capture, you can create your own template and use it for exporting process maps.

  Documentation  Understanding the Process Definition Document

The document you export to Word will have the following elements:

  Documentation  Managing Word Templates

The below optionas are available for managing Word templates:

  Documentation  Installation and Licensing

Double click the .exe file and wait until the installation is completed.

  Documentation  Hardware Requirements


  Documentation  Software Requirements

Operating system

  Documentation  Help

Please use the Help button in the top menu in case you have questions or need assistance.

  Documentation  UiPath Studio

Export your guide as a robot prototype in .xaml format to UiPath Studio by following the below steps: You can continue implementing and debugging directly in UiPath Studio.

  Documentation  Word Document

To create a Process Definition Document by exporting your guide to Word complete the below steps:

  Documentation  Export & Publish

You can choose between 2 different output formats.

  Documentation  File

The file menu contains the following options:

  Documentation  The User Interface

Task Capture contains the following panels:

  Documentation  Main Workflow

To start capturing your processes and document your automation ideas, select one of the three available options:

  Documentation  Introduction

UiPath Task Capture is a process discovery tool that helps you get detailed insights about automation candidates directly from your employees.

UiPath Automation Hub

  Documentation  Dashboards

Within this module, System Admins and Program Managers will have access to two types of dashboards representations regarding the submitted automations in terms of number, performance benefits, and costs.

  Documentation  Components

Upload a Reusable Component

  Documentation  Automations

Explore the Automation Profile

  Documentation  Platform Setup

Manage the Automation Hierarchy

  Documentation  Manage Users

Understanding the Permission Levels

  Documentation  Submit an Idea

Submit an Employee-driven Idea

  Documentation  Explore

The Explore section includes video tutorials that explain the structure and the details that can be added to each automation profile and component profile.

  Documentation  Pricing Plan

Request a Standard Plan

  Documentation  Admin Console

The Admin Console section includes video tutorials that explain how to manage the users from your tenant and how to set up the platform.

  Documentation  Getting Started

Create a Trial Instance

  Documentation  Standard

Note:As of 16th of March Automation Hub is rolling out new pricing and a new licensing model. Per-user pricing model is replaced with a flat fee that enables customers to invite unlimited users in their instance, therefore the licenses will no longer be split between Paid and Non-paid. The changes will be reflected in the product's interface by mid-April.

  Documentation  Trial

To define the needs your company has when it comes to RPA implementation start with the Trial plan.

  Documentation  My Components

When accessing this page you have two lists containing the:

  Documentation  Starting as a Standard User

After successfully logging in, you, as a Standard User, will view the list of Automations submitted for your tenant.You are encouraged to Submit Ideas and Components that will boost the company’s RPA assimilation. By accessing the Workspace module, you can have a detailed view over:

  Documentation  The User Interface

Before Accessing Your Account

  Documentation  Pricing Plans Details

Note:As of 16th of March Automation Hub is rolling out new pricing and a new licensing model. Per-user pricing model is replaced with a flat fee that enables customers to invite unlimited users in their instance. The changes will be reflected in the product's interface by mid-April.

  Documentation  Additional Resources

This section’s icon is marked with a question mark and is available next to the Submit Idea option on the upper right-hand side of the screen.

  Documentation  My Profile

To log out or view your account details access the Profile information.The icon for this option is the last one displayed on the upper right-hand corner of the page.Note: This will be customized with each user’s First and Last name initials.

  Documentation  Notifications

Whenever something concerning your activity occurs, the system will send announcement messages. To find and manage them access the Notifications option.To do this, click the bell-shaped icon displayed on the right-hand side of the screen next to the Tasks icon.

  Documentation  Complete

In the Complete Task list, you have a clear display of the assigned tasks that are now finished and you can:

UiPath Studio

  Documentation  Tutorials

The following tutorials and examples are found in dedicated chapters throughout this guide. This page serves as a central point for accessing these examples.

  Documentation  ST-SEC-007 - SecureString Argument

Rule ID: ST-SEC-007

  Documentation  ST-DBP-023 - Empty Workflow

Rule ID: ST-DBP-023

  Documentation  ST-NMG-016 - Argument Length Exceeded

Rule ID: ST-NMG-016

  Documentation  About Backward and Forward Compatibility


  Documentation  Creating Custom Wizards

Using the UiPath.Activities.API package from the Official feed (https://www.myget.org/F/workflow], you can add your own custom wizard to Studio's ribbon.

  Documentation  Building Activities Project Settings

Using the UiPath.Activities.API package from the Official feed (https://www.myget.org/F/workflow), you can create and add your own custom activity project settings in Studio.

  Documentation  About the Activities SDK

The UiPath.Activities.API SDK package hosted on the Official activities feed (https://www.myget.org/F/workflow) is used for:

  Documentation  ST-SEC-009 - SecureString Misusage

Rule ID: ST-SEC-009

  Documentation  Trigger Based Attended Automation

Trigger Based Attended Automation is a project template based on a Sequence, that is tailored to monitor a certain trigger such as a mouse or keyboard event and deploy an automation. This sequence contains a Monitor Events activity that contains triggers for clicks, keystrokes, and hotkeys, a Get Source Element activity to retrieve UiElement objects and containers for Screen Scraping and Data Entry.

  Documentation  Transactional Process

The Transactional Process is a project template based on a Flowchart, optimized for basic automation processes.

  Documentation  Robotic Enterprise Framework

Robotic Enterprise Framework is a project template based on State Machines. It is created to fit all of the best practices regarding logging, exception handling, application initialization, and others, being ready to tackle a complex business scenario.

  Documentation  Background Process

The Background Process is a template for creating processes that can run in parallel on the same Robot, together with one foreground process. For this reason, background processes must not contain activities that require user interaction.

  Documentation  The Immediate Panel

The Immediate panel is only visible during debugging, and it can be used for inspecting data available at a certain point during debugging. It can evaluate variables, arguments, or statements. To do so, simply type the variable or argument name in the Immediate window and press Enter.

  Documentation  The Watch Panel

Similar to the Call Stack panel, the Watch panel is only visible during debugging. It can be set to display the values of variables or arguments, and values of user-defined expressions that are in scope. It also supports complex object variables like lists of string or dictionary variables. These values are updated after each activity execution while debugging.

  Documentation  The Breakpoints Panel


  Documentation  The Call Stack Panel

The Call Stack panel displays the next activity to be executed and its parent containers when the project is paused in debugging.

  Documentation  The Locals Panel

The Locals panel displays properties or activities and user-defined variables and arguments. The panel shows:

  Documentation  Debugging Actions

Debugging of a single file or the whole project can be performed both from the Design or Debug ribbon tabs. However, the debugging process is not available if project files have validation errors.

  Documentation  Test Activities

Test Activity

UiPath Cloud Platform

  Documentation  On-Premises vs Cloud Platform Orchestrator Features

On-Premises and Cloud Platform Orchestrator come with the same capabilities, with few notable exceptions that make the subject of this page.

  Documentation  Security

The security of your data is very important for UiPath Cloud Platform. We spare no resources to ensure that your information is stored securely at all times and accessible only to you. Cloud Platform includes the security and audit capabilities you need to simplify compliance with the regulations that matter to you.

  Documentation  About Licensing

There are 3 different licensing plans available for Cloud Platform from which you can choose according to your needs and budget: Community, Enterprise Trial or Enterprise. Each plan has its specific licensing offer and gives access to various services.

  Documentation  Migrating Data from On-Premises to Cloud Orchestrator

This page describes a method to perform data migration between your on-premises Orchestrator tenants and Cloud Orchestrator services. This method involves manual re-creation of the on-premises configuration and entities in your Cloud Platform account.

  Documentation  Regions and Instances

We're hosting Cloud Platform in multiple regions to ensure the best performance and data locality for our customers. Our current regions are Europe with servers located in Ireland, and North America with servers located in Virginia.

  Documentation  About API Access

The Services page enables you to access API specific information for each of your existing Orchestrator services, allowing you to easily find the information required for authenticating to your Cloud Platform-based Orchestrator services via API calls. You can also invalidate the already issued access keys in case you ever need to do so.

  Documentation  Managing Services

The Services page displays basic information about your Orchestrator services: name, status, number of licenses, and action buttons for each service.

  Documentation  Managing Organization Settings

The Organization Settings displays basic information about your organization, such as its owner and the creation date, and enables you to change its name, site URL, and language.

  Documentation  About Organizations

Organizations are the highest level of structuring available in UiPath Cloud Platform. Every new signup for Cloud Platform creates an organization. You can sign up as an individual willing to try out our products or a company willing to leverage UiPath capabilities for their needs.

  Documentation  Roles

Organization Level Roles

  Documentation  About Services

Services are instances of an application. Currently, Cloud Platform supports only instances of Orchestrator. In this context, a service is an Orchestrator tenant linked to your Cloud Platform organization in the cloud.

  Documentation  About Resource Center

The Resource Center page, accessible through the menu item with the same name, is built to be your one-stop place for all automation related download and documentation needs. It provides you with links for the newest UiPath Studio/StudioX install packages, documentation guides, Robot provisioning solution, and complementary UiPath apps.

  Documentation  Software Requirements

Our offering of UiPath Cloud Platform requires no installation from your part. In order to access it, you only need an internet connection and a compatible browser.

  Documentation  Homepage

Homepage, displayed by default after logging in to Cloud Portal, enables you quickly access your already created Orchestrator services, view organization telemetry data, and learn information about the components you need in order to start your automation journey. Accessible through the Home menu item, the page displays information about the usage trend of your existing licenses, and how they are distributed across services.

  Documentation  The User Interface


  Documentation  Notifications

You are notified of all changes within your Cloud Platform organization through pop-up notifications, quick messages displayed in the top right corner of your screen. These messages signal the successful or failed outcome of operations of the following categories:

  Documentation  Audit Logs

The Audit Logs page, accessible through the Audit Logs menu item, displays the audit trail for actions performed by all users in your UiPath Cloud Platform organization.

  Documentation  Checking for Changes

You can keep track of what’s happening on your UiPath Cloud Platform organization, having a complete record of all organization and membership changes.

  Documentation  Distributing Your Licenses

When you decide to increase your automation power and add one or more Orchestrator services to the organization, you need to allocate licenses to the new service(s). Since all your available licenses are already allocated to your first Orchestrator service - the one created automatically when signing up for your organization, you can either contact us to request additional licenses, or you can distribute your existing licenses between your existing services.

  Documentation  Managing Service Level Permissions

Note:Managing Orchestrator service level roles requires you to have the Organization Owner or Organization Admin role.

UiPath Release Notes

UiPath Robot

  Documentation  AWS Deployment


  Documentation  Field Descriptions

Agent Desktop

  Documentation  About Agent Desktop

Agent Desktop is the center of all your attended automation needs. It is an application which allows you to view, manage, and schedule jobs. As a client of the Robot Service, it can request to start or stop jobs and change settings, based on user input.

  Documentation  Windows Sessions

About Windows Sessions

  Documentation  Unresponsive Robot Over RDP

Observed Behavior

  Documentation  Robot API

The Robot is able to tackle various automation needs. These capabilities are greatly increased when you make use of the Robot API, offering a tailored experience to create domain-specific interfaces.

  Documentation  LicenseTool Command Descriptions

The UiPath.LicenseTool.exe is a command line utility which enables you to activate your machine online or offline, and update your license information. The utility can be found in the C:\Program Files (x86)\UiPath\Studio folder by default.

  Documentation  Duplicate Execution Logs

Observed Behavior

  Documentation  Parallel Attended Execution

An Attended Robot operates on the same machine as a human. It is usually triggered by user events and should only run under human supervision. Read more about the Robot's automation capabilities according to license.

  Documentation  Package Signature Verification

Observed Behavior

  Documentation  Increased Process Execution Duration

Observed Behavior

  Documentation  Command Line Interface

The Robot Command Line Interface (UiRobot.exe) is a console application which can request to start jobs, and waits for their output. It is a direct client of the Robot service, and communication is done through an IPC protocol.

  Documentation  Tray

The Robot Agent (UiPath.Agent.exe, Robot Tray) is the actual user interface of the Robot. It is a WPF application which displays the available jobs in a system tray window. As a client of the Robot service, it can request to start or stop jobs, and change settings through an IPC protocol, based on user input.

  Documentation  Executor

The Robot Executor (UiPath.Executor.exe) is the component which is directly responsible for the execution of a process. Every time a job is started, either from Orchestrator, Agent Desktop, the Robot Tray, or Studio, the Robot Service spawns a Robot Executor instance, and communicates all the necessary instructions through an IPC protocol.

  Documentation  Service

The Robot service is the brain of all operations. It communicates through an IPC protocol with Studio, Agent Desktop or the Robot Tray, and Robot Command Line Interface to receive and process information, and then to provide the necessary instructions to the Robot Executor.

  Documentation  High-Density Robots

High-Density Robots is a feature that ensures a full utilization of each machine at your disposal at its maximum potential. As a result, regardless of the Windows version a machine is running on, if you have multiple users on it, you can register a Robot on each of the users.

  Documentation  According to Deployment


  Documentation  According to License

The license that was chosen dictates a Robot's capabilities, as follows:

  Documentation  Frequently Encountered Robot Errors

Project Dependencies for EXE Installations

  Documentation  Executing Processes From a Shared Folder

Sharing folders across your network provides faster access to files of interest to all machines connected to that network, or a particular selection of users. However, if you try to execute a process located in a shared folder, an exception is thrown.

UiPath StudioX Preview

  Documentation  Tutorial: Extracting Data from Automated Emails and Moving It to a Desktop Application

  Documentation  Tutorial: Extracting Table Data from a Web Page and Editing It in Excel

In this tutorial, we will create an automation that extracts a table with today's exchange rates for the Euro against other currencies from the European Central Bank website. We keep historical exchange rate data in an Excel workbook and we want to add this data to it daily. Because the format of the data extracted from the website is different from the one in our Excel workbook, we must also edit the extracted data in Excel to apply the right format to it.

  Documentation  Reply to Outlook Email


  Documentation  Insert Rows


  Documentation  Execute Macro


  Documentation  Append Range


  Documentation  Tutorial: Extracting Data from Automated Emails and Moving It to a Desktop Application

In this tutorial, we will create an automation that makes it easy to extract specific data from blocks of text that follow a certain format. Let's imagine that you work in a bank and receive many email notifications related to new deposit transactions. You must open each email, manually copy the amounts and paste them into a teller application, and then move each processed email to an Outlook folder. The emails are automated, they all follow a template and the same text always appears next to the amounts you need in the email body. For example:

  Documentation  Forward Outlook Email


  Documentation  Fill Range


  Documentation  Insert Column


  Documentation  Sort Range


  Documentation  Delete Rows


  Documentation  Format Range


  Documentation  Extract Data


  Documentation  Tutorial: Formatting Cells

In this tutorial, we will create a simple automation that applies one format to the cells in the header row of a spreadsheet and another format to the cells in the first column of the same spreadsheet. We will apply each format to a cell in the project's Excel Workspace, and then use two Copy Paste Range activities to copy the format of each cell to the intended row and column in our spreadsheet.

  Documentation  Exit Loop


  Documentation  Skip Current


  Documentation  Get Folder Info


  Documentation  Save Outlook Email


  Documentation  Delete Outlook Email


UiPath Orchestrator

  Documentation  Backup and Restore

This page provides an overview, with links to detailed instruction, of the process and procedure for backing-up and restoring your Orchestrator deployment and all its settings and features.

  Documentation  Creating AWS Access Keys

Prior to proceeding with your AWS deployment, you must create the required AWS Access Key and SSH Key. Note that a separate SSH key is needed for each region where resources are provisioned.

  Documentation  Installing Terraform

This page provides instructions for the installation of Terraform v0.12.3. You may choose to download the most recent, or another, version of Terraform but you must then also upgrade the scripts according to the Terraform Upgrade Guide.

  Documentation  AWS Deployment

Important!This deployment plan is intended as a guiding example, to be used and customized according to the specific needs and practices of your company (i.e. removing public IPs, changing security groups, etc.).Previous knowledge and experience working with AWS is highly recommended before undertaking this deployment.

  Documentation  Default Dashboards

Processes Dashboard

  Documentation  Insights Data Model

This page details the Jobs, Queue Item, and Robot Logs data that is ingested into Insights to create its data cube.

  Documentation  Enabling Table Grouping

For large deployments where the number of processes and queues in production approaches the per tenant limit, the number of tables created in the Insights data cube can impact performance. This occurs because Insights creates a custom table for each process or queue which has a custom field added (i.e. the Log Message activity or Custom Schemas for queue items).

  Documentation  Multi-Node Deployment

If your deployment has grown and you need to increase capacity, expanding your Orchestrator to a multi-node installation is the next logical step. It offers both better performance and failure resistance as multiple Orchestrator nodes are available - when one fails, the other(s) can pick up the load. Horizontal scalability is also available, as it is possible to add additional nodes as your Robot needs grow further. This deployment model should not, however, be confused with High Availability, as the lone HAA node remains as a potential single point of failure.

  Documentation  Backup Web.config and NuGet Packages

Backing up your Orchestrator configuration and NuGet packages requires copying the relevant files and folders to your designated backup location. This page provides the details needed to identify and locate those files and folders you must copy.

  Documentation  Insights Backup and Restore

For Orchestrator deployments with the Insights feature enabled, regular backups of your Insights database should be performed inline with the backups of your Orchestrator database.

  Documentation  Orchestrator Backup and Restore

This page provides a sample solution for creating scheduled backups of your Orchestrator SQL database. See here how to back up the related web.config file and NuGet packages, and here details on backing up your Insights database, if applicable.

  Documentation  High Availability

High availability provides redundancy and stability for your multi-node Orchestrator deployment through failure resistance as multiple Orchestrator and High Availability Add-on (HAA) nodes are available - when one fails, the others pick up the load. Horizontal scalability is also available as you can add another node whenever your Robot needs grow.

  Documentation  Insights Troubleshooting

Dashboard Downtime

  Documentation  Dashboard Ownership and Sharing

Dashboards can viewed by all users with access to Insights on a respective Orchestrator tenant, however, they are owned by the user that creates them. A dashboard owner may then share their dashboard(s) with any or all users on that same tenant.

  Documentation  Additional Configurations

Updating Insights v2019.10.3

  Documentation  Managing Alerts

The Pulse tab of the Insights Portal provides an overview of all existing alerts.

  Documentation  Field Descriptions for the Filters Pane


  Documentation  About Filters

Filters are used to define the data that is displayed on your dashboard. There are two scopes by which you can define a filter:

UiPath Orchestrator