Команды представляют собой некоторые операции, выполняемые в кассовой программе. Большинство команд связаны с действиями. Подробнее о действиях и командах можно прочитать в статье "Настройка действий".

Команды, выполняемые при запуске макроса

Макрос представляет собой заданный набор действий, выполняемых в строго определенной последовательности. Подробнее о макросах можно прочитать в статье "События и макросы". 

Макросы хранятся в БД Dictionaries таблице Macro, действия – в БД Dictionaries таблице Cmaction, команды – в БД Dictionaries таблице Command. При запуске макроса вызываются команды, соответствующие действиям, выполняемым в макросе.

Если при запуске макроса осуществляется попытка выполнить действие, отсутствующее в БД, то:

  1. На экран будет выведено предупреждение: "Не обнаружено действие в макросе".
  2. В /linuxcash/logs/current/terminal.log будет выведено: "WARN actionfactory - Действие с id <id действия> не обнаружено в БД".
  3. Действие выполнено не будет.

После закрытия предупреждения выполнение макроса может быть продолжено.

Список доступных команд

Команда

Описание

Параметры командыРежимы (контексты)
COMMAND_ABOUTПросмотр информации о программе
главное меню
COMMAND_ACTION_PANEL_PAGEПереключение между страницами на панели клавиш в touch-интерфейсеПараметр page определяет номер страницыформирование документа
COMMAND_ACTION_PANEL_PAGE_EXITВозврат к предыдущей странице на панели клавиш в touch-интерфейсе
формирование документа
COMMAND_ADDPAYMENTPOSITION Добавление оплаты в чек
оплата документа (подытог)
COMMAND_ADD_ALLOWED_VALUTSДобавление списка разрешенных валют для оплатыПараметр allowedValuts определяет список кодов валют, которыми разрешено оплачивать документ.оплата документа (подытог)
COMMAND_APPLYПрименение модификаторов к текущей позиции в чеке
формирование документа, инвентаризация
COMMAND_BACKПереход в режим «Возврат»

Параметр authenticate определяет необходимость подтверждения перехода в режим возврата:

  • при значении true требуется подтверждение операции, необходимо ввести пароль пользователя,
  • при значении false подтверждение не требуется. Значение по умолчанию.

Параметром backReasons задается код причины возврата (можно указать через запятую)

главное меню, формирование документа, возврат

COMMAND_BACK_WITH_SUM 

 Возврат суммой в отдел

Параметр authenticate определяет необходимость подтверждения перехода в режим возврата:

  • при значении true требуется подтверждение операции, необходимо ввести пароль пользователя,
  • при значении false подтверждение не требуется. Значение по умолчанию.

Параметром backReasons задается код причины возврата (можно указать через запятую).

Параметр department указывает код отдела

формирование документа
COMMAND_BACKBYSALE Возврат по чеку продажи

Параметр choiceType задает способ выбора чека продажи для формирования чека возврата:

  • 0 – возврат с последовательным выбором из списка смены и документа в БД кассы,
  • 1 – возврат с выбором из списка по номеру документа в БД кассы,
  • 2 – возврат по идентификатору документа с поиском документа в БД кассового сервера,
  • 3 – возврат по фискальному идентификатору чека с поиском документа в БД кассы (используется только для ФР с ФН, требуется ввод номера фискального документа и номера фискального накопителя или считывание QR-кода),
  • 4 – возврат по фискальному идентификатору чека с поиском документа в БД кассового сервера (используется только для ФР с ФН),
  • 5 – возврат по номеру карты лояльности с поиском документа в БД кассового сервера,
  • 6 – возврат по номеру телефона с поиском документа в БД кассового сервера,
  • 7 – возврат по последним 4 цифрам банковской карты с поиском документа в БД кассового сервера.

Параметр url (со значением http://<хост>:<порт>/CSrest/rest/sales/document) используется для возврата по чеку продажи на другой кассе.

Параметр getBack определяет необходимость контролировать ранее возвращенные товары при возврате по чеку продажи на другой кассе:

  • при значении параметра true чек возврата формируется с учетом тех позиций, которые были возвращены ранее на текущей или других кассах,
  • при значении параметра false или его отсутствии ранее возвращенные позиции не учитываются при формировании чека возврата, в качестве исходных данных используется только чек продажи.

Параметр timeout – таймаут ожидания ответа от сервера в секундах. По умолчанию 10 секунд.

Параметр showReturned отвечает за отображение документов в списке выбора документов для возврата:

  • при значении true отображаются все документы (значение по умолчанию),
  • при значении false скрываются документы, которые были полностью возвращены.

Параметром backReasons задается код причины возврата (можно указать через запятую).

Параметр requireParams определяет необходимость ввода фискальных данных чека продажи при формировании чека возврата:

  • при значении true, если в БД для чека продажи отсутствуют фискальные данные (поле frdoccopy не заполнено), то при формировании чека возврата требуется ввод фискальных данных,
  • при значении false ввод фискальных данных чека продажи не требуется. Если в БД для чека продажи отсутствуют фискальные данные (поле frdoccopy не заполнено), чек возврата не будет сформирован.

Параметр requireParams используется только для сервиса fiscaldriveapi.

возврат, формирование документа, главное меню

COMMAND_BACKTOSUPPLIERВозврат поставщику
главное меню
COMMAND_BANK_CARD_BALANCEСостояние счета (используется в модуле Инпас)

Параметром valutcode задается код валюты.

Параметр showPrintSlipDialog позволяет задавать поведение программы при запросе баланса:

  • при значении true после получения баланса на экран будет выведен диалог с балансом карты и вопросом необходимо ли распечатать банковскую квитанцию,
  • при значении false банковская квитанция печатается автоматически, на экран сообщение о балансе не выводится. Значение по умолчанию.

главное меню, формирование документа, подытог

COMMAND_BCODEВвод по штрих-коду
формирование документа, инвентаризация
COMMAND_BCODETESTПереход в режим «Проверка»

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

  • при значении single после добавления товара в чек касса переходит в режим формирования чека,
  • при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

COMMAND_BCODETESTBYNAMEПросмотр информации о товаре с подбором по наименованию

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

  • при значении single после добавления товара в чек касса переходит в режим формирования чека,
  • при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

Параметр substring определяет правило поиска (по умолчанию true):

  • при значении true поиск осуществляется по вхождению,
  • при значении false поиск выполняется по началу слов.

формирование документа, инвентаризация

COMMAND_BUTTONСкидка по кнопкеПараметр button указывает значение кода объекта – кнопкиформирование документа
COMMAND_CALCКалькулятор
все режимы

COMMAND_CARD

Ввод карты

Параметр cardNumber –  номер карты.

Параметр phoneNumber – номер телефона.

Параметра paymentCode – платежный код.

Параметр cachePhoneNumber – кэширование номера телефона, при значении:

  • true – включено,
  • false – выключено, значение по умолчанию.

Параметр cardMode – тип карты.

Значения параметра cardMode:

  • 0 – Дисконтная,
  • 1 – Артикс Бонус,
  • 2 – Артикс:Дисконт,
  • 5 – Карта Террасофт,
  • 6 – Социальная карта,
  • 7 – RS.Loyalty,
  • 8 – CardLab,
  • 9 – Золотая корона,
  • 10 – EPS,
  • 11 – Loymax,
  • 12 – ABMLoyalty,
  • 17 – UDS,
  • 18 – Plazius,
  • 19 – Manzana2019,
  • 20 – KilBil,
  • 21 – Единая Карта Петербуржца,
  • 23 – Manzana Loyalty Online,
  • 24 – Mindbox,
  • 25 – Карта жителя Нижегородской области.
Если тип карты указан, то с помощью команды в чек нельзя добавить карту другого типа.

Параметр source – источник ввода.

Значения параметра source:

  • 0 – не определено,
  • 1 – вручную,
  • 2 – сканер штрих-кода,
  • 4 – ридер магнитных карт,
  • 8 – банковский терминал,
  • 16 – получение данных с удаленного сервера,
  • 32 – получение данных от процессинга.

Параметр cardNumberType – параметр для идентификации способа ввода информации о клиенте в системе лояльности.

Значения параметра cardNumberType. Идентифицировать по:

  • 0 – номеру карты лояльности,
  • 1 – номеру телефона клиента (11 цифр, номер начинается с 7),
  • 2 – номеру купона,
  • 4 – номеру карты, полученному через банковский терминал (используется при наличии параметра valutcode),
  • 5 – карте, добавленной через процессинг (используется при наличии параметра valutcode),
  • 6 – платежному коду,
  • 7 – номеру карты/номеру телефона/платежному коду.

Параметр valutcode – код валюты.

Параметр dialogtitle – заголовок диалога ввода номера карты.

Параметр dialogmessage – текст сообщения диалога ввода номера карты.

Параметр dialoginputmask – маска ввода номера карты.

Параметр dialoginputpattern – шаблон ввода.

Параметр dialogokbuttonmsgid – текст на кнопке подтверждения.

Параметр dialogcancelbuttonmsgid – текст на кнопке отмены.

Параметр forcedverifiedinput – принудительный ввод верифицированного значения (true/false).

Параметр fillCardOwnerInfo – определяет необходимость заполнения данных о владельце карты лояльности (true/false).

Параметр allowScanCard – включение сканера при отображении диалога ввода карты в подытоге при запрете сканирования данных в подытоге (forbidScanInSubtotal = true). Работает только со значением 1

формирование документа, сдача по документу, подытог, возврат поставщику

COMMAND_CARDCREATEСоздание карты системы лояльности Mindbox


формирование документа

COMMAND_CARDINFOВывод информации о текущей активной карте

Параметр display определяет способ вывода информации о балансе карты:

  • 1 – информация о балансе карты будет выведена на экран,
  • 2 – информация о балансе будет напечатана на квитанции,
  • 3 – информация о балансе будет выведена на экран и напечатана на квитанции,
  • другие значения – информация о балансе будет выведена на экран.

Параметры cardNumberType и cardMode используются для получения информации о клиенте онлайн.

Параметр cardNumberType – способ ввода карты:

  • 0 или не указано – по номеру карты лояльности,
  • 1 – по номеру телефона клиента (11 цифр, номер начинается с 7).

Параметр cardMode – тип карты:

  • 1 – Артикс Бонус.

формирование документа, сдача по документу, подытог, возврат поставщику

COMMAND_CARDISSUANCEВыдача карты

Параметр clientNotRequired определяет, требуется ли заполнение полей клиента (true/false).

Параметр phoneNumber – номер телефона клиента

формирование документа
COMMAND_CARDREPLACEЗамена карты

Параметр url (со значением http://<хост>:<порт>/v1/changecard/src_cardnumber) – адрес сервиса замены карт, является обязательным.

Параметр timeout – таймаут ожидания ответа от сервера в секундах. Значение по умолчанию 5 секунд

формирование документа

COMMAND_CASHADVANCEВыдача наличных покупателю
подытог
COMMAND_CASHDRAWERSUMПросмотр суммы в денежном ящике
главное меню
COMMAND_CDTESTТестирование табло покупателя
главное меню
COMMAND_CERTIFICATEДобавление сертификата в чек для продажи
формирование документа
COMMAND_CERTIFICATE_INFOВывод информации о сертификате

Параметр display определяет способ вывода информации о балансе сертификата:

  • 1 – информация о балансе сертификата будет выведена на экран,
  • 2 – информация о балансе будет напечатана на квитанции,
  • 3 – информация о балансе будет выведена на экран и напечатана на квитанции,
  • другие значения – информация о балансе будет выведена на экран.

формирование документа

COMMAND_CLEAR_MANUAL_DISCOUNTОтмена выбора скидки кассиром из списка
формирование документа
COMMAND_CODEВвод по коду

Параметр quantity позволяет задать модификатор количества для товара с произвольным кодом.

Параметр weight позволяет задать модификатор веса для товара с произвольным кодом.

Параметр data определяет, какой товар будет добавлен в чек по команде COMMAND_CODE.

Для корректной работы необходимо указать код товара в качестве значения параметра data.

формирование документа, инвентаризация
COMMAND_CONNECT_TAPПостановка кега на кран
главное меню
COMMAND_DISCONNECT_TAPОтключение кега от крана
главное меню
COMMAND_CONSULTANTВыбор консультанта из списка
формирование документа
COMMAND_CONSULTANT_FILLДобавить консультанта ко всем свободным позициям
формирование документа
COMMAND_CONSULTANT_DELETEУдалить консультанта у текущей позиции
формирование документа
COMMAND_COUPON_ADDДобавление купона
формирование документа
COMMAND_COUPON_DELETEУдаление купона

Параметр deleteAllCoupons – определяет возможность удаления всех купонов в чеке, которые были добавлены на гашение:

  • при значении параметра true удаляются все купоны в чеке. Значение по умолчанию,
  • при значении параметра false необходимо ввести штрих-код купона для удаления.

формирование документа

COMMAND_CUSTOMER_ADDRESS_ADDДобавить адрес покупателя
формирование документа
COMMAND_DELETECARDУдаление карты
формирование документа, возврат поставщику
COMMAND_DEPTВыбор отдела товара в чеке
формирование документа
COMMAND_DEPTNТовар по свободной ценеПараметром department задается номер отделаформирование документа
COMMAND_DOCCANCELАннулирование документа

Параметр mode со значением last аннулирует последний закрытый документ продажи в смене (если такой есть).

При других значениях (или если параметр mode не задан) – открывается список документов текущей смены для выбора документа для аннулирования

главное меню, формирование документа, работа с закрытым документом

COMMAND_DRAFTBEER_REMAINSПросмотр остатков разливного пива
главное меню
COMMAND_DRAWERTESTТестирование денежного ящикаПараметр device — имя денежного ящикаглавное меню
COMMAND_EDITDOCРедактирование чека
главное меню

COMMAND_EGAIS_TTN

Просмотр списка товарно-транспортных накладных

Параметр type – тип транспортного модуля.

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

  • excise – для приема ТТН акцизного алкоголя,
  • nonexcise – для приема ТТН неакцизного алкоголя.

Если работа с ТТН ведется через один транспортный модуль, то указывать параметр type не требуется

главное меню

COMMAND_EMPLOYEEMARK

Отметка сотрудника


режим авторизации, главное меню

COMMAND_EMV_PRINTREPORT

Печать отчета по безналуПараметр valutcode – код валюты, по которому будет проводиться печать отчетаглавное меню, формирование документа
COMMAND_EMV_PRINTSHORTREPORTПечать краткого отчета по безналуПараметр valutcode – код валюты, по которому будет проводиться печать краткого отчетаглавное меню
COMMAND_EMV_PRINTSLIPCOPYПечать копии слипаПараметр valutcode – код валюты, по которому будет проводиться печать копии слипаглавное меню
COMMAND_EMV_TESTCONNECTIONПроверка связи с хостомПараметр valutcode – код валюты, по которому будет проверяться связь с пин-падомглавное меню
COMMAND_ENTERКоманда "Ввод"
возврат, заказ
COMMAND_ENTER_TRAINING_MODE Вход в тренировочный режим
главное меню, формирование документа
COMMAND_ESCКоманда "Отмена"
главное меню, формирование документа, работа с закрытым документом, возврат, сдача по документу, подытог, инвентаризация, заказ, покупюрная ведомость, операции с деньгами
COMMAND_EXITВыход из терминала продаж
главное меню, формирование документа, подытог, инвентаризация, заказ, покупюрная ведомость, операции с деньгами 
COMMAND_EXIT_TRAINING_MODEВыход из тренировочного режима
главное меню, формирование документа
COMMAND_FILL_CARDOWNER_INFOРегистрация анкеты покупателя

Применяется для системы лояльности EPS.

Параметр cardmode = 10

главное меню

COMMAND_HOTKEYГорячая клавиша

Созданные действия назначаются на кнопки клавиатуры. Список горячих клавиш может быть загружен на кассу в формате Штрих и AIF.

Параметр hotKeyCode задается кодом горячей клавиши.

Параметр showEmptyLines отвечает за отображение товаров по горячей клавише, которые по какой-либо причине не могут быть найдены в справочниках:

  • при значении true на месте таких товаров будут проставлены прочерки. Значение по умолчанию,
  • при значении false такие товары будут скрыты.

Параметр filterMode со значением byBarcodeEnding определяет возможность поиска товара по последним символам штрих-кода в списке товаров, закрепленных за горячей клавишей.

формирование документа, инвентаризация

COMMAND_INVENTORYИнвентаризация
главное меню
COMMAND_JOURNALПросмотр журнала учета алкогольной продукцииПараметр journalDir – директория, в которой находятся журналыглавное меню
COMMAND_KBTESTТестирование клавиатуры
главное меню
COMMAND_KKMTESTТестирование ККМ
главное меню
COMMAND_LICENSEDOCПросмотр лицензионного соглашения кассовой программы
главное меню
COMMAND_LICENSEINFOПросмотр информации о лицензии
главное меню
COMMAND_LOGINРегистрация кассира
регистрация кассира, главное меню, формирование документа, покупюрная ведомость
COMMAND_LOTTERYРегистрация лотерейного билета
формирование документа
COMMAND_MANUAL_DISCOUNTВыбор скидки кассиром из списка

Параметр code — код скидки.

Параметр byDiscountCode отвечает за то, будет использован код акции или скидки для скидочных действий:

  • при значении true используется код скидки,
  • при значении false используется код акции.

Параметр message – выводимое сообщение при подтверждении скидки

формирование документа
COMMAND_MENUПереход в менюПараметр menu используется для задания кода менюглавное меню
COMMAND_MENUEXITВыход из меню
главное меню
COMMAND_MONEYINВнесение денег

Параметр kkm используется для указания ФР, в который будет сделано внесение:

  • single – использовать первый ФР,
  • конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

главное меню

COMMAND_MONEYIN_CORRECTIONКоррекционное внесение наличных

Параметр kkm используется для указания ФР, из которого будет сделан выем:

  • single – использовать первый ФР,
  • конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

главное меню
COMMAND_MONEYOUTВыем денег

Параметр kkm используется для указания ФР, из которого будет сделан выем:

  • single – использовать первый ФР,
  • конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ.

Параметр billsverify (не имеет значений) определяет возможность заполнения и печати покупюрной ведомости при выеме:

  • если параметр указан, то выем наличных осуществляется с заполнением и печатью покупюрной ведомости,
  • если параметр не указан, то заполнение покупюрной ведомости не требуется.

Параметр nobillsverifyprint (не имеет значений) позволяет запретить печать покупюрной ведомости при выеме:

  • если параметр указан, то выем наличных осуществляется без печати покупюрной ведомости,
  • если параметр не указан, то выем наличных осуществляется с печатью покупюрной ведомости.

Для выема денег с возможностью заполнения покупюрной ведомости, но без ее печати, необходимо указывать оба параметра billsverify и nobillsverifyprint.

Параметром moneyOutReasons задается код причины выема наличных из ДЯ (можно указать через запятую)

главное меню

COMMAND_MONEYOUTALLОбязательный выем денежных средств (Инкассация) 
закрытие смены
COMMAND_MONEYOUT_CORRECTIONКоррекционный выем наличных

Параметр kkm используется для указания ФР, из которого будет сделан выем:

  • single – использовать первый ФР,
  • конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

главное меню
COMMAND_MONEYOUT_WITHOUTCASHIERВыем без участия кассира

Параметр kkm используется для указания ФР, из которого будет сделан выем:

  • single – использовать первый ФР,
  • конкретный номер ФР.

При других значениях при наличии нескольких ФР на экран будет выведен диалог для выбора ККМ

главное меню

COMMAND_ONLINECHECKВосстановление онлайн-чека

Параметр dialogtitle – заголовок диалога ввода идентификатора онлайн-чека.

Параметр dialogmessage – текст сообщения диалога идентификатора онлайн-чека

формирование документа

COMMAND_ONLINECHECK_REVIEWСогласование онлайн-чека



формирование документа

COMMAND_OPENDRAWERОткрыть денежный ящик
операции с деньгами, сдача по документу, формирование документа, подытог, закрытие смены, покупюрная ведомость
COMMAND_OPERATIONКоманда "Выполнить операцию"

Параметр roles определяет список ролей, для которых доступно выполнение операции.

Параметр url определяет действие, задаваемое командой

Параметр showProgress отвечает за отображение прогресс-бара при выгрузке продаж при закрытии смены:

  • при значении true прогресс-бар отображается,
  • при значении false прогресс-бар не отображается.

сдача по документу, формирование документа, работа с закрытым документом, инвентаризация, главное меню, подытог, закрытие смены, покупюрная ведомость


COMMAND_ORDERMEDICINEЗаказать лекарства
диалог
COMMAND_PACKINGРасфасовка товара
формирование документа
COMMAND_PAPERCUTОтрезка бумаги
сдача по документу, формирование документа, работа с закрытым документом, главное меню
COMMAND_PAYWITHBONUSДиалог оплаты бонусами: сообщение о доступных бонусных баллах и возможные действия (оплатить/отменить)
оплата документа (подытог)

COMMAND_PLAY_SOUND

Воспроизведение аудио-файла

Параметр path позволяет задать путь к файлу для воспроизведения.

Параметр volume позволяет задать громкость воспроизведения

Используется только в Artix:SCO и Artix:Hybrid.

COMMAND_PRICEВвод цены товара

Параметр mode определяет возможность применения модификатора "Цена" автоматически:

  • при значении 1 – модификатор будет применен автоматически,
  • при других значениях (или если параметр mode не задан) – модификатор необходимо применить вручную.

Параметр discType определяет тип ставки при применении скидки в модификаторе цены товара:

  • при значении 1 (или если параметр не задан)– процентная,
  • при значении 2 – суммовая.

Параметр precision определяет точность округления цены после расчета скидки – число знаков после запятой. Принимает значения 0,1,2. Если параметр не задан, то будет использована точность округления со значением 2.

Параметр forbidDiscount позволяет запретить использование дисконтных скидок при применении модификатора "Цена":

  • при значении true скидки не применяются,
  • при значении false скидки применяются.

формирование документа

COMMAND_PRICELISTПоказать прайс-лист

Параметр catalogCode – код каталога, который содержит товары из прайс-листа

формирование документа

COMMAND_PRINTCOPY

Печать копии чека

Параметр canceled определяет вид последнего документа, копию которого необходимо распечатать:

  • при значении 1 или true при печати учитывается наличие сторнированных документов,
  • при значениях 0, false или отсутствии параметра печатаются только закрытые документы, сторнированные чеки не учитываются.

главное меню, формирование документа, работа с закрытым документом

COMMAND_PRINT_REPORTCOPYПечать копии отчета

Параметр reportName определяет тип отчета, копия которого будет распечатана:

  • при значении frzreport будет распечатана копия сохраненного фискального Z-отчета,
  • при значении frxreport будет распечатана копия сохраненного фискального X-отчета.
Информация о фискальных Z и X-отчетах у программных ФР сохраняется в БД Documents в таблицу Report.

главное меню

COMMAND_PRINTFNDOCUMENTCOPYПечать копии по номеру документа (для ФР с ФН)
главное меню
COMMAND_PRINTGOODSCHПечать товарного чека
главное меню, работа с закрытым документом
COMMAND_PRINTWAYBILL Печать УПД (счета-фактуры)

Параметр useLastDocument определяет, какой документ будет напечатан:

  • при значении true будет напечатан УПД для последнего закрытого чека,
  • при значении false / отсутствии параметра будет предложено выбрать смену и документ.

все режимы

COMMAND_PROCESS_ELECTRONIC_PRESCRIPTIONSОбработка электронных рецептов

Параметр status определяет, какие электронные рецепты будут отображены в окне просмотра:

  • при значении active будет сформирован список активных электронных рецептов,
  • при значении completed будет сформирован список электронных рецептов, по которым лекарственные препараты были отпущены полностью.

формирование документа

COMMAND_PROCESSING_REGSTATICQRРегистрация кассовой ссылки

Параметр valutcode определяет валюту, для которой будет использоваться процессинг.

На данный момент используется только для СБП Альфа-Банк и СБП ГазпромБанк.

главное меню

COMMAND_PUTOUTОтложить чек
формирование документа, подытог
COMMAND_QRDTESTТестирование QR-дисплея и табло покупателя

Параметр qr позволяет отобразить произвольный QR-код:

  • если параметр указан, будет отображен QR-код, соответствующий значению параметра,
  • если параметр не указан, будет отображен QR-код по умолчанию.

Для вывода QR-кода на табло покупателя необходимо включить настройку "Отображение QR-кода" в настройках оборудования.

главное меню
COMMAND_QUANTВвод количества товара

Параметр mode определяет возможность применения модификатора "Количество" автоматически:

  • при значении 1 – модификатор будет применен автоматически,
  • при других значениях (или если параметр mode не задан) – модификатор необходимо применить вручную.

Параметр decreaseControl определяет необходимость подтверждения операции уменьшения количества товара в позиции:

  • при значении true требуется подтверждение операции, необходимо ввести пароль привилегированного пользователя,
  • при значении false подтверждение не требуется. Значение по умолчанию.

Параметр decreaseControlRoles определяет список ролей, которым разрешено подтверждать операции уменьшения количества товара в позиции.

Для подтверждения операции уменьшения количества товара в позиции необходимо указывать оба параметра decreaseControl и decreaseControlRoles.
При указании только одного из параметров запрос подтверждения операции осуществляться не будет.

Параметр decreaseControlIgnoredRoles определяет список ролей из параметра decreaseControlRoles, для которых не требуется подтверждение операции уменьшения количества товара в позиции.

Используется совместно с параметрами decreaseControl и decreaseControlRoles.

формирование документа, возврат, инвентаризация

COMMAND_REBOOTПерезагрузить кассу
главное меню, закрытие смены
COMMAND_RESTARTПерезапустить программу
главное меню, закрытие смены
COMMAND_REPLACE_GOODS_ITEMЗамена товара в онлайн-чеке
формирование документа
COMMAND_REVEALВосстановить отложенный чек
формирование документа, подытог
COMMAND_SALEПереход в режим «Продажа»

Параметр authenticate определяет необходимость подтверждения перехода в режим возврата:

  • при значении true требуется подтверждение операции, необходимо ввести пароль пользователя,
  • при значении false подтверждение не требуется. Значение по умолчанию.
формирование документа
COMMAND_SCALESПолучить количество с весов

Параметр device — имя весов.

Параметр taracatalog – код каталога, который содержит товары, являющиеся упаковкой (Продажа товара с выбором упаковки).

Параметр addTaraPosition определяет возможность добавления в чек выбранной упаковки отдельной позицией:

  • при значении true упаковка будет добавлена отдельной позицией,
  • при значении false упаковка не будет добавлена отдельной позицией. Значение по умолчанию.

Параметр base – группа весового товара (передается в систему распознавания товаров только при отключенном асинхронном режиме, см. Системы распознавания товаров)

формирование документа, инвентаризация

COMMAND_SCALETESTТестирование весов
главное меню
COMMAND_SELECTBYARTICULПодбор товара по артикулу
формирование документа, инвентаризация
COMMAND_SELECTBYCODEПодбор товара по коду
формирование документа, инвентаризация
COMMAND_SELECTBYNAMEПодбор товара по наименованиюПараметр substring задает поиск по всем словам наименованияформирование документа, инвентаризация
COMMAND_SELECTDEFERREDПросмотр отложенных чеков
формирование документа
COMMAND_SELECTMULTIPLEПодбор товара по нескольким параметрам

Параметр substring определяет правило поиска:

  • при значении true поиск осуществляется по вхождению,
  • при значении false поиск выполняется по началу слов.

формирование документа

COMMAND_SELECTBYPRICEПодбор товара по цене

Параметр orderBy со значением name определяет сортировку списка товаров в алфавитном порядке.

Если параметр не указан, то сортировка осуществляется по штрих-коду

формирование документа, инвентаризация

COMMAND_SELECTMEDICINEПодбор лекарственных препаратов
формирование документа
COMMAND_SELECTTMCВыбор товара из справочника по штрих-коду

Параметр filterMode со значением byBarcodeEnding определяет возможность поиска товара из справочника по последним символам штрих-кода.

формирование документа, инвентаризация
COMMAND_SELECTFROMPICKLISTВыбор товаров из каталога

Параметр multilevel определяет уровень каталогов:

  • 0 – одноуровневые каталоги. Значение по умолчанию,

    Функционал использования одноуровневых каталогов является устаревшим.

  • любое значение отличное от 0 – многоуровневые каталоги.

формирование документа

COMMAND_SELECT_ONLINE_ORDERОтображение списка онлайн-заказов (tabletka.by)


формирование документа

COMMAND_SELECT_ORDER_FROM_RESERVEОтображение списка заказов из резерва (tabletka.by)

Параметр daysBefore определяет временной период для отображения заказов:

  • если параметр указан, то из резерва будут запрошены только те заказы, дата изменения которых удовлетворяет заданному временному периоду.

    Например, если daysBefore = 10, а текущая дата 15 ноября, то будет сформирован список заказов, дата изменения которых попадает в промежуток с 5 по 15 ноября.

  • если параметр не указан, то осуществляется запрос всех заказов в резерве.

формирование документа

COMMAND_SERVICE_MENUВызов меню "Сервис"
операции с деньгами, сдача по документу, формирование документа, подытог, работа с закрытым документом
COMMAND_SHIFTCLOSEЗакрытие сменыПараметр macrocode определяет код макросаглавное меню
COMMAND_SHIFTOPENОткрытие смены
главное меню
COMMAND_SHOW_EJПросмотр электронного журналаПараметр printej — печатать электронный журнал (true/false)главное меню
COMMAND_SHOW_REMAINSПросмотр остатков товара по магазинам

Параметр choiceType задает способ выбора товара:

  • byname – выбор товара по наименованию,
  • bybarcode – выбор товара по штрих-коду.

Параметр substring определяет правило поиска:

  • при значении true поиск осуществляется по вхождению,
  • при значении false поиск выполняется по началу слов.

все режимы

COMMAND_SHUTDOWNВыключить кассу
главное меню, закрытие смены
COMMAND_SOFTCHECKДобавление софт-чека
формирование документа
COMMAND_SOCIAL_AUTODISTRIBUTEАвторасчет социальных товаров
формирование документа
COMMAND_SOCIAL_MANUALSETОтметить позицию как социальный товар
формирование документа
COMMAND_SSCO_SALEРежим продажи на КСО
главное меню
COMMAND_STORNOALLСторно всех позиций в чеке

Параметр notAskConfirm — сторнировать все позиции без диалога-подтверждения (true/false).

Параметр roles определяет список ролей пользователей, для которых разрешено выполнение команды.

Параметр sumRestrictions определяет список ограничений для каждой из ролей по сумме позиции или чека. Используется формат "код роли:сумма"

возврат, операции с деньгами, формирование документа, подытог, инвентаризация, главное меню, заказ

COMMAND_STORNOSELECTСторно выделенной позиции в чеке

Параметр roles определяет список ролей пользователей, для которых разрешено выполнение команды.

Параметр sumRestrictions определяет список ограничений для каждой из ролей по сумме позиции или чека. Используется формат "код роли:сумма"

возврат, операции с деньгами, формирование документа, подытог, инвентаризация, главное меню, заказ, возврат поставщику

COMMAND_SUBTOTALПодытог
формирование документа
COMMAND_SUBTOTAL_BYCARDПодытог по безналуПараметр valut – код валютыформирование документа
COMMAND_SUSPEND_CFOОтключить контроль финансовых операций
главное меню
COMMAND_TAKE_SUMВыем суммы

Параметр kkm используется для указания ФР, из которого будет сделан выем:

  • single – использовать первый ФР,
  • конкретный номер ФР.
главное меню
COMMAND_TERMINALПереход в режим продаж
главное меню
COMMAND_TESTBYCODEПросмотр информации о товаре с подбором по коду

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

  • при значении single после добавления товара в чек касса переходит в режим формирования чека,
  • при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

COMMAND_TESTMULTIPLEПросмотр товара по нескольким параметрам

Параметр substring определяет правило поиска:

  • при значении true поиск осуществляется по вхождению,
  • при значении false поиск выполняется по началу слов.

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

  • при значении single после добавления товара в чек касса переходит в режим формирования чека,
  • при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа

COMMAND_TESTBYARTICULИнформация о товаре (по артикулу)

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

  • при значении single после добавления товара в чек касса переходит в режим формирования чека,
  • при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

COMMAND_TESTBYPRICEИнформация о товаре (по цене)

Параметр orderBy со значением name определяет сортировку списка товаров в алфавитном порядке.

Если параметр не указан, то сортировка осуществляется по штрих-коду.

Параметр canInput позволяет добавлять товар в чек из режима просмотра информации о товаре:

  • при значении single после добавления товара в чек касса переходит в режим формирования чека,
  • при отсутствии значения у параметра после добавления товара в чек касса возвращается в список товаров для просмотра информации.

формирование документа, инвентаризация

COMMAND_TOTALИтог

Параметр printCheck определяет, печатать ли чек при закрытии, если добавлен адрес покупателя.

  • при значении print чек печатается, отправляется на адрес покупателя,
  • при значении notprint чек не печатается, отправляется на адрес покупателя.
  • Для корректной работы необходимо включить плагин customerAddress.
  • Параметр printCheck имеет приоритет над настройкой printCheck плагина customerAddress.
операции с деньгами, сдача по документу, формирование документа, подытог, инвентаризация, покупюрная ведомость
COMMAND_VALUTОплата валютойПараметр valCode – код валюты для оплатыоплата документа (подытог)

COMMAND_VERIFYBILLS

Покупюрная ведомость

Параметр nofiscalreport (не имеет значений) позволяет запретить печать программного и фискального X-отчетов при закрытии покупюрной ведомости:

  • если параметр указан, то при закрытии покупюрной ведомости печать программного и фискального X-отчетов не осуществляется,
  • если параметр не указан, то при закрытии покупюрной ведомости осуществляется печать программного и фискального X-отчетов.
главное меню
COMMAND_VERIFYTOTALСверка итогов по безналу

Параметр valutcode – код валюты для выполнения сверки итогов.

Параметр ignoreErrors определяет игнорирование ошибок во время выполнения сверки итогов:

  • при значении true ошибки будут игнорироваться,
  • при значении false на экран будут выведены сообщения об ошибках. Значение по умолчанию.

Если параметры не указаны, то сверка итогов выполняется для всех настроенных процессингов до первой ошибки

главное меню, формирование документа, закрытие смены

COMMAND_VIEWПереход к просмотру выбранного документа
главное меню
COMMAND_WEB_BROWSERВстроенный браузер

Параметр url – ссылка на стартовую страницу.

Параметр showCursor определяет отображение курсора мыши:

  • при значении true курсор мыши отображается. Значение по умолчанию,
  • при значении false курсор мыши не отображается.

Параметр codePage – кодовая страница, используется для отображения локальных файлов. Значение по умолчанию "UTF-8".

Параметр printService используется для работы сервиса печати xml-документа в браузере. В качестве значения параметра указывается порт, на котором будет работать сервис.

Параметр showDigitalKeyboard позволяет использовать в touch-интерфейсе цифровую клавиатуру вместо полноразмерной:

  • при значении true используется цифровая клавиатура,
  • при значении false используется полноразмерная клавиатура. Значение по умолчанию.

Параметр showKeyboard позволяет использовать в touch-интерфейсе полноразмерную клавиатуру вместо цифровой:

Параметр showKeyboard используется только в случае, если параметр showDigitalKeyboard равен false или не указан.

  • при значении true используется полноразмерная клавиатура. Значение по умолчанию,
  • при значении false цифровая и полномразмерная клавиатуры не используются.

Параметр lockDelay позволяет не блокировать работу кассы в браузере:

  • при значении true не срабатывает автоматическая блокировка кассы,
  • при значении false срабатывает автоматическая блокировка кассы. Значение по умолчанию.

Параметр timeoutInactive позволяет задать время до автоматического закрытия браузера (в cекундах) при бездействии пользователя

Параметр timeoutInactive используется только в Artix:SCO и Artix:Hybrid.

Параметр cashMode позволяет отображать встроенный браузер в зависимости от типа кассы:

  • pos – отображать только на POS,

  • sco – отображать только на SCO,

  • all – отображать на кассах обоих типов. Значение по умолчанию

сдача по документу, формирование документа, подытог, главное меню





Команды для переназначения клавиш
KEY_0 ... KEY_9Ввод цифр от "0" до "9"





При использовании цифровой клавиатуры touch-интерфейса команды работать не будут.

KEY_00Ввод "00"
KEY_ARROW_DOWNИмитация нажатия клавиши "Стрелка вниз"
KEY_ARROW_LEFTИмитация нажатия клавиши "Стрелка влево"
KEY_ARROW_RIGHTИмитация нажатия клавиши "Стрелка вправо"
KEY_ARROW_UPИмитация нажатия клавиши "Стрелка вверх"
KEY_BACKSPACEИмитация нажатия клавиши "Backspace"
KEY_ENTERИмитация нажатия клавиши "Enter"
KEY_ESCИмитация нажатия клавиши "Esc"
KEY_PAGEDOWNИмитация нажатия клавиши "PgDn" («страница вниз»)
KEY_PAGEUPИмитация нажатия клавиши "PgUp" («страница вверх»)
KEY_PERIODВвод десятичного разделителя (" . ")
KEY_PLUSВвод знака сложения (" + ")
KEY_MINUSВвод знака вычитания (" – ")
KEY_ASTERISKВвод знака умножение (" * ")
KEY_SLASHВвод знака деления (" / ")
  • No labels