Lexema-RPA_Studio_Docs/docs/HelloStudio.md

Знакомство со студией

Интерфейс главного окна

Пользовательский интерфейс студии Lexema-RPA Studio характеризуется областью для работы с проектами (рабочей областью), расположенной в центре главного окна программы. Прямо над рабочей областью располагается полоса с кнопками управления проектом. Слева от рабочей области находится меню, в котором собраны модули для создания роботов, справа – обозреватель решений, прямо под рабочей областью – отладочный вывод.

### Главное окно

Главное окно студии имеет несколько разделов и основные кнопки управления проектом/


Все панели (меню, обозреватель решений и отладочный вывод) могут быть закреплены или открываться при наведении на них.

Чтобы открепить или закрепить панель необходимо нажать на иконку с изображением канцелярской кнопки  в правом верхнем углу панели.


Студия имеет две цветовые схемы – светлая тема, та, которая идет по умолчанию, и темная. Для перехода на темную тему необходимо нажать на слайдер «Темная тема», находящийся между кнопками управления и информацией о текущем пользователе.

Функционал разделов главного окна студии будет описан ниже. ### Кнопки управления

Кнопки управления проектом находятся на верхней панели главного окна студии и предназначены для осуществления основных манипуляций с проектом: создания  , сохранения  , открытия  , выполнения описанных в проекте действий  и выхода из программы  .

Также поддерживаются различные комбинации горячих клавиш. Например, для создания проекта можно использовать комбинацию Ctrl+N.

Более подробно поддерживаемые комбинации горячих клавиш описаны в разделе «Горячие клавиши». #### Создать

Нажатие на кнопку «Создать» вызывает окно создания нового проекта.


В открывшемся окне необходимо ввести имя нового проекта, дополнительно можно указать его описание. Нажатие на кнопку «Создать» в указанном окне завершит процесс создания проекта. Новый проект будет открыт в главном окне студии. Ключ проекта – уникальный идентификатор проекта, который необходим для загрузки проекта в оркестратор. По этому ключу происходит обновление проекта, который уже загружен в оркестратор, при его повторной загрузке. Если необходимо загрузить в оркестратор проект, основанный на проекте с ключом, который уже загружен в оркестратор, необходимо изменить его ключ.


#### Сохранить

Кнопка «Сохранить» вызывает стандартный диалог сохранения файла.

Для нового проекта в диалоговом окне необходимо выбрать папку назначения и название файла, в котором будет сохранен проект (по умолчанию, предлагается название проекта, которое вы задали при его создании). Файлы проектов Lexema-RPA Studio имеют расширение «.rpa». После выбора папки для сохранения, необходимо нажать на кнопку «Сохранить». По завершении операции, файл проекта будет сохранен по указанному расположению. Существующий проект будет сохранен в его текущем расположении. #### Сохранить как

Кнопка «Сохранить как» вызывает стандартный диалог сохранения файла, аналогичный окну сохранения нового проекта.

В диалоговом окне предоставляется возможность для изменения наименования или расположения файла проекта. #### Открыть

Кнопка «Открыть» вызывает стандартный диалог выбора файла.

Выбранный файл проекта будет загружен в главное окно студии.


#### Проиграть

Кнопка «Проиграть» запускает выполнение всех описанных в проекте действий.

Попытка запуска будет осуществляться только в случае, если в проекте имеется хотя бы одно действие. Действия выполняются в порядке, описанном в структуре проекта.

В случае возникновения ошибок или исключительных ситуаций, они будут выведены в область «Отладочный вывод» (далее будет дано подробное описание области отладочного вывода). #### Опубликовать

Кнопка «Опубликовать»  вызывает диалог публикации текущего проекта в оркестратор роботов . #### Форум

Кнопка «Форум»  позволяет перейти на веб-сайт форума технической поддержки приложения. #### О программе

Кнопка «О программе»  выводит диалоговое окно, содержащее информацию о текущей версии студии.


#### Выйти Кнопка «Выйти»  закрывает студию. ### Меню

В разделе «Меню» выводится список доступных для добавления в проект модулей. Каждый модуль отвечает за выполнение конкретного действия или за взаимодействие с определенной программой. #### Список доступных модулей

В программе Lexema-RPA Studio имеются следующие модули: Excel, Кликер, Поиск изображения (2 варианта), Запустить/Завершить процесс, Условие, Цикл, Вычисления, Работа с файлами, Код С#, Распознавание текста (обычное и ABBYY), SQL, Отправить/Считать письмо, HTTP GET/POST запросы, Break, JSON, Интерфейс, Закрыть Excel-файл, While.

В списке доступных модулей выводятся все имеющиеся модули. #### Поиск модуля

Поиск модуля можно выполнить с помощью текстового поля, расположенного над списком доступных модулей. Список будет фильтроваться по мере ввода поисковой фразы. #### Добавление модуля в проект

Для добавления выбранного модуля в проект необходимо перетащить его в рабочую область с помощью указателя мыши. Новый модуль можно расположить в нужной позиции в общей последовательности действий. Для этого необходимо навести курсор на соседний с нужной позицией модуль. При этом соседний модуль будет подсвечен красным выделением и положение нового модуля будет отображаться в виде яркого выделения сверху или снизу: сверху – если новый модуль будет добавлен перед соседним, снизу – если после него.






### Обозреватель решений

Раздел «Обозреватель решений» находится в правой части главного окна. В верхней части раздела расположена панель управления переменными и функциями, прямо под панелью - область текущих проектов. Активный проект (окно которого сейчас открыто) выделен зеленым цветом и помечен маркером зеленая точка. Панель управления переменными и функциями содержит следующие кнопки (перечисление слева направо): «Переменные», «Создать новую переменную», «Узнать значение переменной», «Локальное хранилище», «Создать локальную переменную», «Функции». При нажатии на одну из этих кнопок будут открыты или созданы те переменные или функции, которые относятся к активному проекту. Подробное описание кнопок будет приведено далее.


### Обзор переменных

В рабочей области студии можно вывести информацию о доступных в активном проекте переменных.

Окно обзора переменных отображается во вкладке «Переменные» при нажатии на кнопку «Переменные»  в обозревателе решений.


Окно содержит строку для поиска переменной по её названию и таблицу со списком всех доступных проекту переменных. Таблица имеет три столбца:

• Название переменной

• Константа — флаг, показывающий можно ли изменять значение данной переменной

• Значение переменной

По умолчанию, переменные автоматически создаются при указании их в том или ином модуле. При создании проекта автоматически создаются системные переменные:

• @CurrentDirectory – директория, в которой установлена студия;

• @UserNameWindows – название пользователя ОС;

• @MachineName – имя компьютера.

При двойном щелчке по строке с переменной открывается диалоговое окно редактирования свойств переменной. В диалоговом окне предоставляется возможность изменять свойства переменной или удалять переменную из проекта. Подробное описание работы с переменными будет рассмотрено ниже.


Обзор функций

Доступные в проекте функции выводятся в рабочей области студии во вкладке «Функции» по нажатию на кнопку  в обозревателе решений. В окне имеется строка для поиска функции по её названию или описанию.

Список доступных функций представлен в виде таблицы со следующими столбцами:

• Название функции — название функции и пример аргументов, которые она принимает;

• Пример использования — пример результата выполнения функции первого столбца;

• Описание — общее описание функции.


#### Обзор локальных переменных

Lexema-RPA Studio позволяет хранить конфиденциальную информацию, например, пароли, логины или почтовые адреса, в переменных, которые будут зашифрованы и сохранены на вашем компьютере. Обзор ваших локальных переменных доступен по кнопке «Локальное хранилище»  в панели управления переменными и функциями. Окно состоит из трех столбцов:

• Имя – название переменной;

• Значение;

• Описание – ваш комментарий относительно переменной.


При двойном нажатии по переменной откроется окно её редактирования, аналогичное окну создания локальной переменной.


### Отладочный вывод

В раздел «Отладочный вывод» главного окна студии выводятся все сообщения, возникающие в ходе выполнения настроенных действий проекта после нажатия на кнопку «Проиграть». Сообщения выводятся для всех действий по порядку их выполнения в проекте.


В отладочном выводе выводится информация о времени начала робота, общее время работы. Для каждого модуля выводится информация о начале времени его выполнения и затраченное время.

В случае возникновения исключения в работе модуля, робот приостановит выполнение, и в отладочном выводе, в последней строке, будет содержаться информация об ошибке. Текст первой и последней строки отладочного вывода будет написан красным цветом.


## Основы работы ### Переменные

Переменные предназначены для хранения данных, которые должны быть доступны для всех действий проекта. Большинство модулей поддерживает чтение и запись данных в переменные.

К наименованию переменных предъявляется следующее требование: название переменной должно всегда начинаться с символов ‘v.’.

Обращаться к переменным можно в полях окон настройки модулей приложения. При обращении необходимо указывать полное название переменной согласно описанному выше требованию.

В проекте можно создавать переменные четырех типов:

• Элемент – переменная, имеющая одно значение. Это может быть строка или число;

• Список – переменная, состоящая из нескольких элементов;

• Таблица – переменная в виде таблицы, в ячейках которой содержатся элементы.

• Объект – переменная, имеющая именованные поля - ключи и их значения-элементы.

Для создания переменной нажмите на кнопку «Создать переменную» в обозревателе решений, предварительно выбрав нужный проект (сделав его активным). Для создания локально хранимой и зашифрованной переменной необходимо нажать кнопку «Создать локальную переменную». После выполнения действия откроется окно создания переменной, это окно аналогично окну редактирования свойств переменной. Локальные переменные могут создаваться только с типом «Элемент», поэтому окно их настройки немного отличается от настройки обычных переменных.





В окне создания переменной укажите название переменной согласно требованиям приложения (в начале наименования обязательно должны быть символы v.) и выберите тип переменной из списка. При изменении типа переменной изменяются доступные настройки.

Для переменных с типом «Элемент» доступны следующие настройки:

• поле для ввода значения;


Переменные с типом «Список» хранят набор (массив) переменных. Обращение к каждому элементу списка осуществляется по его индексу, индекс начинается с 0. Индекс указывается в квадратных скобках, следующих сразу за названием переменной. Например, для обращения ко второму элементу – v.array[1].

Заполнение переменных-списков производится посредством ввода значения в поле «Значение», затем нажатием кнопки «Добавить», после чего введенный элемент добавится в список элементов в нижней части окна.


Переменные с типом «Таблица» представляют собой таблицу (двумерный массив), т.е. это список, элементами которого являются списки. Другими словами, это набор простых элементов, доступ к которым осуществляется по двум индексам. Наглядно двумерный массив удобно представлять в виде таблицы, в которой n строк и m столбцов, а под ячейкой таблицы, стоящей в i-й строке и j-м столбце, понимают некоторый элемент массива a[i-1,j-1] (так как индекс начинается с нуля). Это означает, что для обращения к элементу в 3 строке и 5 столбце, отвечающему за ячейку таблицы, необходимо указывать два индекса: v.table[2, 4].


Для заполнения значений переменных с типом «Таблица» становится доступной таблица, набор столбцов которой можно расширять с помощью кнопки «Добавить столбец». Добавление новых строк производится по нажатию клавиши «Enter». Вводить значения можно для каждой ячейки. Незаполненные столбцы не будут использоваться при создании переменной.

И последний возможный тип переменных в программе – переменные-объекты. Для создания переменной необходимо заполнять поля «Ключ» и «Значение» указанного ключа. В примере показана переменная v.person, которая состоит из двух полей – name и age, значения которых John и 18 соответственно. Для обращения к полям такой переменной в программе необходимо указать название переменной с символов «v.» и через точку поле, к которому хотите обратиться: v.person.name (результатом будет строка John).


При нажатии в обозревателе решений на кнопку «Узнать значение переменной» открывается окно, с помощью которого можно проверить значение переменной активного проекта. Для проверки значения необходимо ввести полное наименование переменной (включая символы v.).



### Функции

Предустановленный набор вспомогательных функций позволяет выполнять различные вычисления в действиях проекта.

Для вызова встроенной функции необходимо перед её названием ввести знак #, например, #OperationPlus(1, 1). Аргументы функции, над которыми должна производится операция, перечисляются в круглых скобках через запятую (если функция работает с несколькими аргументами). Между наименованием вызываемой функции и скобками с её аргументами не должно быть пробела. ### Рабочая область

Это основной раздел главного окна студии. Здесь осуществляется настройка структуры проекта и выполняемых в нём действий. #### Структура проекта

Действия добавляются с помощью меню доступных модулей. После добавления модуля в структуру проекта он отображается в виде элемента, обозначающего выполняемое действие.


Элемент действия имеет несколько составляющих:

• порядковый номер действия;

• название действия;

• настраиваемое пользователем примечание;

• кнопку удаления действия.

В структуре проекта по нажатию правой кнопкой мыши на добавленное действие доступно контекстное меню со следующими пунктами:

• отключить/включить;

• снять/поставить точку остановки;

• копировать;

• вставить.


Пункт «Отключить/Включить» позволяет переключать активность выбранного действия. Выключенное действие будет пропущено при запуске проекта.

Пункт «Снять/поставить точку остановки» создаёт или отключает точку остановки выполнения проекта. Точки остановки упрощают процесс наладки последовательности действий.

Пункт «Копировать» копирует в буфер обмена выбранное действие для последующей вставки.

Пункт «Вставить» вставляет скопированное действие после выделенного действия. Данный пункт доступен также при вызове контекстного меню в рабочей области главного окна студии.

Пункт «Удалить» удаляет данный модуль из списка модулей (аналогичен нажатию крестика в правой части модуля).


#### Точка остановки

Точка остановки – это инструмент, который помогает отлаживаться при написании робота. Такой инструмент позволяет остановить работу робота перед выполнением выбранного модуля, при этом в панели отладочного вывода отображаются текущие переменные и их значения, модуль, который должен будет выполняться после продолжения подсвечивается красной рамкой, а в панели инструментов появляются две новые кнопки, позволяющие управлять пошаговой отладкой.


Пошаговая отладка позволяет выполнять каждый модуль робота друг за другом, при этом можно следить за значениями всех переменных. Для выполнения подсвечиваемого модуля и остановки робота после его выполнения, то есть, для перехода к следующему модулю (шагу), необходимо нажать кнопку «Следующий шаг отладки» . Для прекращения выполнения работы робота необходимо нажать кнопку «Остановить» . Если требуется остановить робота в другом месте, через несколько модулей, то во время отладки можно поставить новую точку остановки на модуле, перед выполнением которого необходимо остановить работу робота, и нажать «Продолжить выполнение» . Изменения, внесенные в модули во время отладки, в текущем выполнении применены не будут. #### Настройка добавленных действий

Окно настройки свойств действия, добавленного в структуру проекта, открывается с помощью двойного щелчка левой кнопкой мыши по указанному действию. Набор свойств, доступных в этом окне, зависит от выбранного действия. Подробнее о доступных свойствах каждого действия будет описано далее в руководстве.