IKuznetsov: /* ОбъектScriptConfig */

2025-03-23T13:54:49Z

ОбъектScriptConfig

← Предыдущая		Версия 13:54, 23 марта 2025
Строка 413:		Строка 413:
	\|}		\|}

	==== Объект<code>ScriptConfig</code> ====		==== Объект <code>ScriptConfig</code> ====
	Содержит настройку монитора.		Содержит настройку монитора.
	{\| class="wikitable"		{\| class="wikitable"

IKuznetsov: Новая страница: «В дополнение к обычной конфигурации в пользовательском интерфейсе вы можете использова...»

2025-03-13T19:32:59Z

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

Новая страница

В дополнение к обычной конфигурации в пользовательском интерфейсе вы можете использовать '''режим скрипта''' для настройки вашего '''clickpath''' или мониторов '''с одним URL'''. В этом режиме вы можете получить доступ к базовому скрипту '''JSON''' вашего монитора. Если вы синтетически продвинутый пользователь, это значительно облегчит вам жизнь и позволит вам ускорить создание и управление '''clickpath'''. Используйте '''редактор скриптов''' для быстрого поиска определенных событий (шагов), адаптации локаторов по всему скрипту или редактирования частей '''clickpath''' без повторной записи.

Вы не ограничены только одним режимом — вы можете переключаться между режимами пользовательского интерфейса и сценария, нажимая переключатель '''Clickpath / Script''' .

== Доступ к скрипту clickpath ==
Чтобы отредактировать '''Clickpath''' монитора браузера в режиме скрипта:

# Перейдите в раздел '''Синтетика'''.
# Выберите монитор '''clickpath''', который вы хотите отредактировать.
# Нажмите кнопку '''Обзор''' ( ⮟ ) и выберите '''Правка''' .
# Нажмите вкладку '''Записанный clickpath''' в меню настроек монитора слева.
# Нажмите '''script''' вверху.

== Доступ к скрипту с одним URL-адресом ==
Чтобы отредактировать монитор браузера с одним URL-адресом в режиме скрипта:

# Перейдите в раздел '''Синтетика'''.
# Выберите монитор '''с одним URL-адресом''', который вы хотите редактировать.
# Нажмите кнопку '''Обзор''' ( ⮟ ) и выберите '''Правка''' .
# Нажмите вкладку '''script''' монитора в меню настроек монитора слева.

== Редактировать сценарий ==
Вы можете загрузить скрипт ('''Загрузить скрипт как .json''') или просто скопировать его из редактора и редактировать в текстовом редакторе по вашему выбору. Однако вы также можете редактировать скрипт непосредственно в браузере. Это дает следующие преимущества:

* '''Автозаполнение''' — просто нажмите Ctrl+Пробел, чтобы увидеть список предложений.
* '''Подсветка синтаксиса''' упрощает написание кода скрипта.
* '''Мгновенная проверка ошибок''' — редактор мгновенно показывает предупреждение о любой ошибке в скрипте. Наведите курсор на ошибку, чтобы увидеть, что не так, и получить предложение по ее исправлению. Вы не сможете сохранить изменения, пока код не будет свободен от ошибок.

Обратите внимание, что вам необходимо экранировать все специальные символы и переносить строки с помощью обратной косой черты (например, новая строка — <code>\n</code>, двойные кавычки — <code>\"</code>, а табуляция — <code>\t</code>).

Вы можете воспроизвести изменения в скриптах '''clickpath''', не сохраняя их — просто нажмите '''Воспроизвести clickpath.'''

== Структура скрипта ==

=== Модель скрипта ===
{| class="wikitable"
|{
"configuration": {

"userAgent": "string",

"device": {

"mobile": true,

"touchEnabled": true,

"width": 375,

"height": 667,

"scaleFactor": 2,

"deviceName": "string",

"orientation": "portrait"

},

"bandwidth": {

"latency": 1,

"download": 1,

"upload": 1,

"networkType": "WiFi"

},

"requestHeaders": {

"addHeaders": [

{

"name": "string",

"value": "string"

}

],

"toRequests": ["string"]

},

"cookies": [

{

"name": "string",

"value": "string",

"domain": "string",

"path": "string"

}

]

},

"version": "1.0",

"type": "clickpath",

"events": [

{

"type": "navigate",

"url": "string",

"description": "string",

"wait": {

"waitFor": "page_complete"

},

"authentication": {

"type": "basic",

"masked": true,

"username": "string",

"password": "string"

},

"validate": [

{

"type": "content_match",

"failIfFound": true,

"isRegex": false,

"match": "string"

}

],

"target": {

"window": "string"

}

},

{

"type": "click",

"description": "string",

"button": 0,

"wait": {

"waitFor": "network"

},

"target": {

"locators": [

{

"type": "css",

"value": "string"

},

{

"type": "dom",

"value": "string"

}

]

},

"validate": [

{

"type": "element_match",

"failIfFound": false,

"target": {

"locators": [

{

"type": "css",

"value": "string"

}

]

}

}

]

},

{

"type": "javascript",

"description": "string",

"javaScript": "string",

"wait": {

"waitFor": "time",

"milliseconds": 2000

},

"target": {

"window": "string"

}

},

{

"type": "selectOption",

"description": "string",

"selections": [

{

"index": 1,

"value": "string"

}

],

"wait": {

"waitFor": "validation",

"validation": {

"type": "element_match",

"failIfFound": false,

"match": "string",

"target": {

"locators": [

{

"type": "dom",

"value": "string"

}

]

}

},

"timeoutInMilliseconds": 60000

}

},

{

"type": "cookie",

"description": "string",

"cookies": [

{

"name": "string",

"value": "string",

"domain": "string",

"path": "string"

}

]

},

{

"type": "keystrokes",

"description": "string",

"textValue": "string",

"masked": false,

"simulateBlurEvent": true,

"wait": {

"waitFor": "next_action"

}

}

]

}
|}

=== Параметры скрипта ===

==== Основной объект скрипта ====
Содержит скрипт монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|configuration
|ScriptConfig
|Настройка монитора
|необязательный
|-
|type
|string
|Тип монитора
Возможные значения:

* <code>clickpath</code> для мониторов '''Clickpath'''
* <code>availability</code> для мониторов браузера '''с одним URL''' Этим мониторам разрешено иметь только одно событие типа <code>navigate</code>.
|необходимый
|-
|version
|string
|Версия скрипта — используйте значение <code>1.0</code>.
|необходимый
|-
|events
|Массив из:
navigateEvent

interactionEvent

javaScriptEvent

selectOptionEvent

cookieEvent

keystrokesEvent
|Шаги '''Clickpath''' — первый шаг всегда должен быть типа <code>navigate</code>.
Обратите внимание, что событие — это не то же самое, что действие — только события, которые запускают веб-запросы, называются действиями, поэтому ваш скрипт может не иметь столько действий, сколько событий. Синтетические действия (похожие на действия пользователя для мониторинга реального пользователя) содержат данные о производительности, собранные во время воспроизведения событий '''clickpath'''.

Фактический '''JSON-объект''' события зависит от его типа:

* <code>navigateEvent</code>— содержит событие '''Navigate''' .
* <code>interactionEvent</code>— содержит событие '''Click''' или '''Tap''' .
* <code>javaScriptEvent</code>— содержит событие '''JavaScript''' .
* <code>selectOptionEvent</code>— содержит событие '''Выбор опции'''.
* <code>cookieEvent</code>— содержит событие '''Cookie''' .
* <code>keystrokesEvent</code>— содержит событие '''Нажатие клавиши'''.
|необходимый
|}

==== Объект<code>ScriptConfig</code> ====
Содержит настройку монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|userAgent
|string
|'''<u>''[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent Пользовательский агент]''</u>''' запроса
|необязательный
|-
|device
|customDevice
or

predefinedDevice
|Эмулируемое устройство монитора — содержит либо параметры пользовательского устройства, либо имя и ориентацию предварительно настроенного устройства.
Если не установлено, то <code>Desktop</code> используется в качестве предварительного настроенного устройства.
|необязательный
|-
|bandwidth
|bandwidthOptions
or

predefinedBandwidth
|Эмулированные сетевые условия монитора
Если не установлено, то используется вся доступная пропускания способность.
|необязательный
|-
|requestHeaders
|requestHeader[]
|Список HTTP-заголовков, отправляемых с запросами монитора
|необязательный
|-
|cookies
|requestCookie[]
|Список файлов cookie, которые будут созданы для монитора
Эти файлы cookie добавляются перед выполнением первого шага.
|необязательный
|}

==== Объект <code>customDevice</code> ====
Содержит эмулируемое устройство монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|mobile
|boolean
|Флаг мобильного устройства
Установите значение <code>true</code> для мобильных устройств или <code>false</code> для настольного компьютера или ноутбука.
|необходимый
|-
|touchEnabled
|boolean
|Флаг сенсорного экрана
Установите <code>true</code>, если устройство использует сенсорный экран. В этом случае можно установить событие взаимодействия как <code>tap</code>.
|необходимый
|-
|width
|integer
|Ширина экрана в пикселях
Максимально допустимая ширина составляет <code>1920</code>.
|необходимый
|-
|height
|integer
|Высота экрана в пикселях
Максимально допустимая высота составляет <code>1080</code>.
|необходимый
|-
|scaleFactor
|integer
|Соотношение пикселей устройства
|необязательный
|}

==== Объект <code>predefinedDevice</code> ====
Содержит одну из предварительно настроенных эмуляций устройств.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|deviceName
|string
|Имя предварительно настроенного устройства — при редактировании в браузере нажмите <code>Crtl</code>+<code>Spacebar</code>, чтобы увидеть список доступных устройств.
|необходимый
|-
|orientation
|string
|Ориентация устройства — <code>portrait</code> или <code>landscape</code>
Настольные устройства и ноутбуки не могут использовать данную ориентацию <code>portrait</code>.
|необходимый
|}

==== Объект <code>bandwidthOptions</code> ====
Содержит эмулированные сетевые условия монитора.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|latency
|integer
|Задержка сети в миллисекундах
|необходимый
|-
|download
|integer
|Скорость загрузки сети, в байтах в секунду
|необходимый
|-
|upload
|integer
|Скорость отдачи сети, в байтах в секунду
|необходимый
|}

==== Объект <code>predefinedBandwidth</code> ====
Содержит предварительно настроенные сетевые эмуляции.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|networkType
|string
|Тип преднастроенной сети — при редактировании в браузере нажмите <code>Crtl</code>+<code>Spacebar</code>, чтобы увидеть список доступных сетей.
|необходимый
|}

==== Объект <code>requestHeader</code> ====
Содержит список '''HTTP-заголовков''', отправляемых с запросами монитора.

Следующие заголовки не допускаются:

* user-agent
* cookie

{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|name
|string
|Имя HTTP-заголовка
|необходимый
|-
|value
|string
|Значение заголовка HTTP
|необходимый
|}

==== Объект <code>requestCookie</code> ====
Содержит список файлов '''cookie''', которые будут созданы для монитора.

Каждый файл '''cookie''' должен быть уникальным в списке. Однако вы можете использовать тот же файл '''cookie''' снова в другом случае.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|name
|string
|Имя файла '''cookie'''
Следующие имена файлов '''cookie''' не допускаются:

* <code>dtCookie</code>
* <code>dtLatC</code>
* <code>dtPC</code>
* <code>rxVisitor</code>
* <code>rxlatency</code>
* <code>rxpc</code>
* <code>rxsession</code>
* <code>rxvt</code>
|необходимый
|-
|value
|string
|Значение '''cookie''' — следующие символы не допускаются: <code>;,\"</code>.
|необходимый
|-
|domain
|string
|Домен '''cookie'''
|необходимый
|-
|path
|string
|Путь к файлу cookie
|необязательный
|}

==== Объект <code>navigateEvent</code> ====
Содержит событие '''Navigate'''.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Тип синтетического события
В данном случае тип события — <code>navigate</code>.
|необходимый
|-
|url
|string
|URL-адрес для перехода
|необходимый
|-
|description
|string
|Краткое описание события, которое будет отображаться в пользовательском интерфейсе.
|необходимый
|-
|wait
|waitCondition
|Условие ожидания события — определяет, как долго Ключ-АСТРОМ должен ждать перед выполнением следующего действия.
|необязательный
|-
|validate
|validationType[]
|Правило проверки для события — помогает вам убедиться, что монитор вашего браузера загружает ожидаемое содержимое страницы или элемент страницы.
|необязательный
|-
|target
|targetType
|Вкладка, на которой должна открываться страница
|необязательный
|-
|authentication
|plainAuthenticationType или secureAuthenticationType
|Учетные данные для обхода маски входа в браузер
|необязательный
|}

==== Объект <code>interactionEvent</code> ====
Содержит событие '''Click''' или '''Tap'''.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Тип синтетического события
В этом случае, <code>click</code> или <code>tap</code>
|необходимый
|-
|description
|string
|Краткое описание события, которое будет отображаться в пользовательском интерфейсе.
|необходимый
|-
|button
|integer
|Кнопка мыши, которая будет использоваться для щелчка
|необходимый
|-
|wait
|waitCondition
|Условие ожидания события — определяет, как долго Ключ-АСТРОМ должен ждать перед выполнением следующего действия.
|необязательный
|-
|validate
|validationType[]
|Правило проверки для события — помогает вам убедиться, что монитор вашего браузера загружает ожидаемое содержимое страницы или элемент страницы.
|необязательный
|-
|target
|targetType
|Элемент, на который нужно нажать/коснуться
|необязательный
|}

==== Объект <code>javaScriptEvent</code> ====
Содержит событие '''JavaScript'''.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Тип синтетического события
В этом случае, <code>javascript</code>
|необходимый
|-
|description
|string
|Краткое описание события, которое будет отображаться в пользовательском интерфейсе.
|необходимый
|-
|javaScript
|string
|Код '''JavaScript''', который будет выполнен в этом событии
|необходимый
|-
|wait
|waitCondition
|Условие ожидания события — определяет, как долго Ключ-АСТРОМ должен ждать перед выполнением следующего действия.
|необязательный
|-
|target
|targetType
|Вкладка, на которой выполняется код '''JavaScript'''
|необязательный
|}

==== Объект <code>selectOptionEvent</code> ====
Содержит событие '''выбора опции'''.
{| class="wikitable"
!Элемент
!Тип
!Описание
!Необходимость
|-
|type
|string
|Тип синтетического события
В этом случае, <code>selectOption</code>
|необходимый
|-
|description
|string
|Краткое описание события, которое будет отображаться в пользовательском интерфейсе.
|необходимый
|-
|selections
|listOptions[]
|Варианты выбора
|необходимый
|-
|wait
|waitCondition
|Условие ожидания события — определяет, как долго Ключ-АСТРОМ должен ждать перед выполнением следующего действия.
|необязательный
|-
|validate
|validationType[]
|Правило проверки для события — помогает вам убедиться, что монитор вашего браузера загружает ожидаемое содержимое страницы или элемент страницы.
|необязательный
|-
|target
|targetType
|Тег выбора выпадающего списка
|необязательный
|}

Режим скрипта - История изменений

IKuznetsov: /* ОбъектScriptConfig */

IKuznetsov в 13:54, 23 марта 2025

IKuznetsov: Новая страница: «В дополнение к обычной конфигурации в пользовательском интерфейсе вы можете использова...»