UiPath Studio Guide

Managing Variables

In Studio, variables are used to store multiple types of data. Another key aspect of variables is that their value can change so that you can, for example, control how many times the body of a loop is executed.

Note:

Variables need to be created with different names, even if used in different Scopes. You can check out our Workflow Design Naming Conventions recommendations.

The data stored within a variable is called a value, and it can be of multiple types. In UiPath, we support a large amount of types, ranging from generic value, text, number, data table, time and date, UiElements to any .Net variable type.

Creating Variables

Note:

Variables cannot be created if the Designer panel does not contain at least one activity.

From the Body of an Activity

  1. From the Activities panel, drag an activity to the Designer panel. Right-click a field and select Create Variable from the context menu, or press Ctrl+K. The Set Var field is displayed.
  2. Fill in the name and press Enter. The variable is created and visible in the field. Check its scope and type in the Variables panel.

Variables created in this way automatically receive the type according to the activity. For example, if you create a variable in the Data Table field of a Write Range activity, the variable's type is set to DataTable. If you create a variable in the Text field of a Write Line activity, the variable's type is set to String.

The scope of variables created in this way is the smallest container it is part of. The type is automatically generated depending on the selected property.

From the Properties Panel

  1. In the Properties panel of any activity, right-click a field that can be edited, and select Create Variable from the context menu, or press Ctrl+K. The Set Var field is displayed.
  2. Fill in the name and press Enter. The variable is created and visible in the field. Check its scope and type in the Variables panel.

The scope of variables created in this way is the smallest container it is part of. The type is automatically generated depending on the selected property.

From the Variables Panel

  1. In the Designer panel, click Variables. The Variables panel is displayed.
  2. Click the Create Variable line, and fill in the name. A new variable is created.

The default type of variables created this way is String.

Removing Variables

  • In the Variables panel, right-click a variable and select the Delete option.
  • In the Variables panel, select a variable and press the Delete key.

You can also remove all the variables that are defined in the Variables panel, but not used in your currently opened project.

To do so, on the Design ribbon tab, in the Variables group, click Remove Unused Variables. This also removes variables that are unused but mentioned in annotations.

Note:

If you remove or upgrade a package that may lead to a variable or argument being undefined, an Unknown Type is added in its place so that the file can be opened and edited in Studio.

Browsing for .Net Variable Types

To search for types of variables that are not displayed by default in the Variable Type list, do the following:

  1. In the Variables panel, from the Variable Type drop-down list, select Browse for Types. The Browse and Select a .Net Type window is displayed.
  2. In the Type Name field, type a keyword for the variable you are looking for, such as excel. Note that the result section is updated, displaying all the .Net variable types that contain your keyword.
  3. Select one and click OK. A new variable is created with the selected type and is displayed in the Variables panel.

Note:

After first using a type of variable from the Browse and Select a .Net Type window, it is displayed in the Variable Type drop-down list, in the Variables panel.

Variable and argument types part of assemblies proprietary to Studio or Robot are hidden. Workflows that reference types from such assemblies should not be affected at runtime. To use a type from a non-.Net framework assembly, add it as a dependency to your project with the help of the Manage Packages window.



Managing Variables


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.