Параметры 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строковыйТекст, отображаемый на форме