Параметры `template`

Свойство	Описание	Примечания
object	Тип объекта, для которого выполняется примечание: 0 – открытый документ, 1 – выбранная товарная позиция.	Значение по умолчанию `0`
onAction	Настройка отображения примечания при срабатывании заданного действия
onPositionAdd	Настройка отображения примечания при добавлении позиции с заданным штрих-кодом
onPositionFromCatalog	Настройка отображения примечания при добавлении позиции из каталога с заданным кодом
dialogParams	Параметры диалогов	В зависимоси от значения `dialogType` объект `dialogParams` может содержать различные параметры

Значения объекта `onAction`

Свойство	Тип данных	Возможные значения	Описание	Примечания
context	целочисленный	4 – главное меню, 6 – открытый документ, 7 – подытог, 8 – сдача, 9 – закрытый документ, 14 – закрытие смены, 18 – возврат по чеку продажи, 25 – покупюрная ведомость, 32 – поставновка кега на кран/снятие кега с крана, 255 – любой контекст.	Код контекста, в котором вызывается действие	По умолчанию `255`
trigger	строковый	before – до, after – после	Выполнять примечание до или после выполнения действия, указанного в поле `actionType`	По умолчанию `before`
actionType	строковый		Тип выполняемого действия	По умолчанию `UNDEFINED` (не определено) Обязательно к заполнению
result	целочисленный	0 – вызывать примечание только если действие выполнилось успешно, 1 – вызывать примечание только если действие завершилось с ошибкой, 2 – вызывать примечание после любого результата.	Вызов примечания на основе результата выполнения действия `actionType`	По умолчанию `0` Используется при значении `trigger=after`

Значения объекта `onPositionAdd`

Свойство	Тип данных	Возможные значения	Описание	Примечания
positionCode	строковый		Код позиции
positionBcode	строковый		Штрих-код позиции	Обязательно к заполнению
docType	целочисленный	1 – чек продажи, 2 – чек возврата, 3 – акт внесения денег, 4 – акт выема денег, 16 – инвентаризация, 18 – возврат поставщику, 19 – заказ, 25 – чек возврата по чеку продажи, 26 – чек коррекции прихода, 27 – чек коррекции расхода, 29 – постановка на кран, 30 – отключение кега, 255 – все типы документов.	Тип открытого документа, в котором позиция была добавлена	По умолчанию `255`

Значения объекта `onPositionFromCatalog`

Свойство	Тип данных	Возможные значения	Описание	Примечания
catalogCode	строковый		Код каталога	Обязательно к заполнению
docType	целочисленный	1 – чек продажи, 2 – чек возврата, 3 – акт внесения денег, 4 – акт выема денег, 16 – инвентаризация, 18 – возврат поставщику, 19 – заказ, 25 – чек возврата по чеку продажи, 26 – чек коррекции прихода, 27 – чек коррекции расхода, 29 – постановка на кран, 30 – отключение кега, 255 – все типы документов.	Тип открытого документа, в котором позиция была добавлена	По умолчанию `255`

Значения объекта `dialogParams`

Свойство	Тип данных	Возможные значения	Описание	Примечания
dialogType	строковый	dialogChoice dialogSimpleChoice dialogMultiChoice dialogChoiceList dialogInputText dialogInputMultiText dialogMessage showTextInfo	Тип диалога, который будет отображен при срабатывании примечания	В зависимости от значения `dialogType` объект `dialogParams` может быть расширен дополнительными параметрами Параметр `dialogInputMultiText` не поддержан в Artix:SCO.

Значения параметра `dialogType`

`dialogChoice` – Диалог с выбором Да/Нет

Параметр	Тип данных	Возможные значения	Описание	Примечания
title	строковый		Заголовок диалога
message	строковый		Текст сообщения
okBtnText	строковый		Текст на кнопке подтверждения	По умолчанию `ОК`
cancelBtnText	строковый		Текст на кнопке отмены	По умолчанию `Отмена`
turnRed	логический	true false	Окрашивать фон диалога в красный	По умолчанию `false`
btnOkDelay	целочисленный		Настройка определяет, через какое время кнопка ОК станет доступной для нажатия	По умолчанию `0`
enableHotKeys	логический	true false	Включить горячие клавиши для ОК/Отмена	По умолчанию `true`

`dialogSimpleChoice` – Диалог выбора между несколькими вариантами

Параметр	Тип данных	Описание	Примечания
title	строковый	Заголовок диалога
message	строковый	Текст сообщения
choices	массив строк	Список возможных вариантов для выбора	Пример настройки { "choices": ["...", "...", "..."] }
choicesInfo	массив строк	Пояснения к возможным вариантам	Задается аналогично параметру `choices`. Размер массива параметра `choicesInfo` должен быть равен размеру массива параметра `choices`
choicesHeader	строковый	Заголовок для списка возможных вариантов
infoHeader	строковый	Заголовок для списка пояснений к возможным вариантам

`dialogMultiChoice` – Диалог множественного выбора

Параметр	Тип данных	Описание	Примечания
title	строковый	Заголовок диалога
choices	массив строк	Список возможных вариантов для выбора	Пример настройки { "choices": ["...", "...", "..."] }

`dialogChoiceList` – Диалог выбора из списка

Параметр	Тип данных	Возможные значения	Описание	Примечания
title	строковый		Заголовок диалога
headers	массив строк		Список заголовков	Пример настройки { "headers": ["цвет", "размер"] }
data	массив строк		Список данных	Пример настройки { "data": [["Черный", "52"], ["Черный", "50"], ["Белый", "52"], ["Белый", "50"]] }
allowDevices	целочисленный	1 – вручную, 2 – сканер штрих-кода, 4 – ридер магнитных карт, 8 – банковский терминал, 16 – получение данных с удалённого сервера, 32 – получение данных от процессинга, 255 – любой источник.	Разрешенные устройства для ввода	Устройства ввода задаются при помощи битовой маски. Существует возможность задать несколько разрешенных устройств ввода. Например, чтобы задать два способа ввода: вручную и через сканер штрих-кода, необходимо установить значение битовой маски равное 3 (1+2). По умолчанию `1`

`dialogInputText` – диалог ввода данных

Параметр	Тип данных	Возможные значения	Описание	Примечания
title	строковый		Заголовок диалога
message	строковый		Текст сообщения
okBtnText	строковый		Текст на кнопке подтверждения	По умолчанию `ОК`
cancelBtnText	строковый		Текст на кнопке отмены	По умолчанию `Отмена`
inputMask	строковый		Маска ввода данных	Пример маски для номера телефона "\\+7\\([0-9]{3}\\)-[0-9]{3}-[0-9]{2}-[0-9]{2}"
checkInputMaskOnEnter	логический	true false	Проверять маску ввода при нажатии Enter	По умолчанию `false`
checkInputMaskOnScan	логический	true false	Проверять маску при вводе данных со сканера	По умолчанию `false`
defaultValue	строковый		Значение поля для ввода по умолчанию	По умолчанию не задано
inputPattern	строковый		Шаблон ввода	Пример для номера телефона +7(999)-999-99-99
onlyNumber	логический	true – цифровая, false – полноразмерная.	Отображать цифровую или полноразмерную клавиатуру	По умолчанию `false`
allowDevices	целочисленный	1 – вручную, 2 – сканер штрих-кода, 4 – ридер магнитных карт, 8 – банковский терминал, 16 – получение данных с удалённого сервера, 32 – получение данных от процессинга, 255 – любой источник.	Разрешенные устройства для ввода	Устройства ввода задаются при помощи битовой маски. Существует возможность задать несколько разрешенных устройств ввода. Например, чтобы задать два способа ввода: вручную и через сканер штрих-кода, необходимо установить значение битовой маски равное 3 (1+2). По умолчанию `1`
allowScanCard	логический	true false	Разрешить сканирование карты в диалоге	По умолчанию `false`
disableEnter	логический	true false	Делать кнопку ввод недоступной, если в поле не было заполнено	По умолчанию `true`
moneyItem	логический	true false	Ввод денежной суммы	По умолчанию `false`
enableHotkeys	логический	true false	Включить горячие клавиши для Ок/Отмена	По умолчанию `true`
password	логический	true false	Ввод пароля??	По умолчанию `false`
hideCancel	логический	true false	Скрывать кнопку отмены	По умолчанию `false`

`dialogInputMultiText` – диалог многострочного ввода

Параметр	Тип данных	Возможные значения	Описание	Примечания
title	строковый		Заголовок диалога
description	строковый		Текст сообщения
hideCancelButton	логический	true false	Скрывать кнопку отмены	По умолчанию `false`
useDigitalKeyboard	логический	true false	Использование цифровой клавиатуры в Touch	По умолчанию `true`
allowDevices	целочисленный	1 – вручную, 2 – сканер штрих-кода, 4 – ридер магнитных карт, 8 – банковский терминал, 16 – получение данных с удалённого сервера, 32 – получение данных от процессинга, 255 – любой источник.	Разрешенные устройства для ввода	Устройства ввода задаются при помощи битовой маски. Существует возможность задать несколько разрешенных устройств ввода. Например, чтобы задать два способа ввода: вручную и через сканер штрих-кода, необходимо установить значение битовой маски равное 3 (1+2). По умолчанию `1`
fields	массив объектов		Поля многострочного диалога ввода	Пример настройки { "fields": [ {...}, {...}] }

Значения параметра `fields`

Название	Тип данных	Возможные значения	Описание	Примечания
fieldId	строковый		Идентификатор поля, используется при сохранении ввода	Обязательно к заполнению
description	строковый		Описание поля
type	строковый	2 – тип для выбора Radiobutton, 10 – строка, 14 – дата, 16 – дата и время.	Тип поля	По умолчанию `10`
regexp	строковый		Регулярное выражение для валидации
inputMask	строковый		Маска ввода
labels			Радиокнопки	Используется если `type=2`. Пример настройки { "labels":["Сырой","Белый","Черный"] }
defaultValue	строковый		Значение поля для ввода по умолчанию	По умолчанию не задано
dateFormat	строковый		Формат ввода даты
required	логический	true false	Поле должно быть обязательно заполнено	По умолчанию `true`
editable	логический	true false	Поле может быть отредактировано	По умолчанию `true`

`dialogMessage` – диалог-сообщение

Параметр	Тип данных	Возможные значения	Описание	Примечания
message	строковый		Текст сообщения
type	строковый	warning – предупреждение, error – ошибка, dialogMessage – сообщение.	Тип сообщения	По умолчанию `dialogMessage`

`showTextInfo` – форма с выводом кастомного текста

Параметр	Тип данных	Описание
title	строковый	Заголовок диалога
text	строковый	Текст, отображаемый на форме

Page tree

Параметры примечаний

Параметры template

Значения объекта onAction

Значения объекта onPositionAdd

Значения объекта onPositionFromCatalog

Значения объекта dialogParams

Значения параметра dialogType

dialogChoice – Диалог с выбором Да/Нет

dialogSimpleChoice – Диалог выбора между несколькими вариантами

dialogMultiChoice – Диалог множественного выбора

dialogChoiceList – Диалог выбора из списка

dialogInputText – диалог ввода данных

dialogInputMultiText – диалог многострочного ввода

Значения параметра fields

dialogMessage – диалог-сообщение

showTextInfo – форма с выводом кастомного текста

Параметры `template`

Значения объекта `onAction`

Значения объекта `onPositionAdd`

Значения объекта `onPositionFromCatalog`

Значения объекта `dialogParams`

Значения параметра `dialogType`

`dialogChoice` – Диалог с выбором Да/Нет

`dialogSimpleChoice` – Диалог выбора между несколькими вариантами

`dialogMultiChoice` – Диалог множественного выбора

`dialogChoiceList` – Диалог выбора из списка

`dialogInputText` – диалог ввода данных

`dialogInputMultiText` – диалог многострочного ввода

Значения параметра `fields`

`dialogMessage` – диалог-сообщение

`showTextInfo` – форма с выводом кастомного текста