Перейти к содержимому
Last updated

Общие поля и структура сценария

Выполните поиск через GET /node-types?q=keyword&page=1&pageSize=20, затем передайте полученный ID типа в GET /node-types/{nodeType}. Нумерация страниц начинается с 1, размер страницы составляет 1–100 (по умолчанию 20). Тип, например browser_gotoUrl, отличается от ID узла в сценарии, например visit.

Поле контрактаЧто проверить
authorable, runtimeSupported, externalRunnable, documentationCompleteВозможность использования в шаблонах, поддержка во время выполнения, внешний запуск и полнота документации.
inputSchemaТипы, перечисления, форматы и структура. Разрешайте $ref по URL схемы текущего экземпляра.
conditionalRules, referenceRulesПоля, обязательные или запрещённые в каждом режиме, вычисленные значения и допустимая область ссылок.
defaults, outputVariants, fieldPoliciesЗначения по умолчанию при выполнении, выходные данные по режимам и политики полей. x-editor-default описывает начальное значение в редакторе.

Структура сценария

Указывайте editorVersion: 2 и editorParametersVersion: 1. Корневые nodes выполняются по порядку: первым идёт один start, последним идёт один end. Вложенные узлы используют blocks, заданные контрактом каждого узла. ID узлов должны быть уникальными во всём дереве и не меняться при правках. Дайте каждому узлу и ветви содержательный data.title. Группа не может содержать другую группу.

Узел действия использует type: browser_<action>, соответствующий data.browserAction и входные данные в data.browserUi.inputs. Входные данные действий задаются строками вида ${targetUrl} и ${visit.data.finalUrl}. Выходные данные узла «Конец» и операнды условий могут использовать {"type":"ref","content":["visit","data","finalUrl"]} с массивом сегментов пути. Ссылайтесь только на видимые переменные и предыдущие узлы. Объявляйте пользовательские переменные в start.data.customVariables, обновляйте их с помощью browser_updateCustomVariable и читайте как ${custom.<id>}. После сохранения работайте с нормализованным деревом, которое вернул сервер.

Ссылки на переменные

Если поле поддерживает ссылки на переменные, используйте ${…} и замените многоточие фактическим именем переменной или путём ссылки. Сценарий разрешает эту ссылку во время выполнения и проверяет полученное значение по правилам поля.

Например, "selectorRadio": "${locatorType}" читает начальный параметр locatorType. Значение "XPath" выбирает режим XPath. Вычисленное значение должно быть "CSS" или "XPath", поэтому "TEXT" не проходит проверку.

Примеры полей и ограничений

ПолеПравило
gotoUrl.urlОбязательная строка; поддерживает ссылки. Для переносимых шаблонов используйте абсолютный URL HTTP(S). Для других схем выполните предварительную проверку на своём клиенте и проверьте, как браузер их обрабатывает.
gotoUrl.postWaitMsЧисло или поддерживаемое числовое выражение; задокументированный диапазон после вычисления составляет 0–2147483647 миллисекунд. По умолчанию 1000; чтобы не ждать, укажите 0. Не выходите за пределы этого диапазона.
getUrl.type / keyhref (по умолчанию), origin или search. Для search нужен ключ, значение которого вычисляется в непустую строку. В режиме href data.value содержит полный текущий URL. Как обрабатываются отсутствующие значения search, уточняйте в актуальном контракте.
browserUi.exception.timeoutЦелое число, 0–2147483647 миллисекунд. Ноль отключает тайм-аут узла, но бюджет времени запуска продолжает действовать. По умолчанию: 30000 для действий и 0 для управляющих узлов. Явно заданный тайм-аут управляющего узла распространяется на весь его дочерний граф.
browserUi.exception.policyЯвно укажите interrupt, skip или handle. Если узел с ошибкой пропущен, ссылки на его данные вычисляются в null; проверяйте hasNodeErrors запуска.
retryTimes / retryIntervalЕсли для атомарного действия включён повтор, допускается 1–10 дополнительных попыток. Интервал составляет 0–2147483 секунд. Повтор может заново выполнить действие, которое уже сработало.

Шаблону нужны title (1–100 символов после удаления пробелов по краям), description (до 1000 символов, может быть пустым), workflow и dependencies (если дочерних шаблонов нет, укажите []). Ограничения на размер запроса и сценария, число узлов, глубину вложенности и число правок в одном запросе смотрите в capabilities.data.limits. Полные модели описаны на страницах Сценарий, переменные и структурные узлы и Модели данных.

Далее: проверьте и сохраните пример.