.. _gsauto_specs:

Спецификация
============


Назначение
----------

Библиотека включает набор классов, представляющих элементы пользовательского 
интерфейса, и обеспечивает взаимодействие с ними. 
Используется библиотека `Selenium <https://www.selenium.dev/>`__
и её реализация протокола удалённого управления браузерами `WebDriver API <https://www.w3.org/TR/webdriver2/>`__.

.. note::
   - Список поддерживаемых браузеров и их версий определяется библиотекой Selenium.
   - Библиотека Selenium требует Java 11 или новее.

Библиотека может использоваться:

- В составе самостоятельных приложений
- В составе UI-тестов

Возможности
-----------

- Выполнение аутентификации
   Вход и выход пользователя из системы.

   .. warning::
      Реализована только передача учётных данных (логин и пароль) через URL.

- Выбор приложения
   Запуск выбранного прикладного решения.

   .. warning::
      Реализован только выбор приложения через сегмент URL-адреса.

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

   .. warning::
      Иногда клик по кнопке панели инструментов не обрабатывается с 
      первого раза после ввода значения в карточку.

- Взаимодействие с вкладками выборки и MDI-формами
   Переключение между вкладками выборки. Переключение между открытыми MDI-формами.

- Ожидание форм
   Ожидание открытия на интерфейсе форм или диалогов.

- Поиск выборок
   Поиск или ожидание появления одной или нескольких выборок в интерфейсе.

- Ввод данных.
   Ввод значений в поля карточек и редактируемых таблиц.

- Взаимодействие с кнопками редакторов
   Открытие выпадающих диалогов и форм редакторов.

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

- Взаимодействие с табличными представлениями
   Эмуляция кликов кнопками мыши в элементы табличного представления. Выделение/выбор строки таблицы.
   Выбор ячейки таблицы по порядковому номеру строки и порядковому номеру столбца либо названию атрибута столбца.

- Эмуляция клавиатуры
   Эмуляция нажатий клавиш клавиатуры (включая комбинации клавиш).

- Выполнение Jexl
   Выполнение Jexl-скриптов в контексте выборки с возможностью возврата строкового
   результата. 

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

- Управление пользовательским сессиями.
   Принудительное завершение пользовательских сессий.

Примеры использования
---------------------

.. versionadded:: 1.1.1
   Демонстрационные проекты доступны в виде архива в репозитории `https://repo.global-system.ru <https://repo.global-system.ru/ui/repos/tree/General/common/ru/bitec/gs-automation/gs-automation-examples>`__

.. toctree::
   :maxdepth: 1
   :includehidden:
   :titlesonly:
   :hidden:

   repository.rst
   versions.rst
   server.rst
   envprops.rst
   nameconvention.rst
   api.rst