Начиная с версии 4.6.226 информация о фискальных Z и X-отчетах у программных ФР сохраняется в БД Documents в таблицу Report.

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

Таймаут команды "Выполнить операцию" по умолчанию составляет 120 секунд.

С помощью данной команды возможно реализовать: 

  • печать документов ККМ, 

  • выполнение внешних программ, 

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

Действие, которое выполняется командой COMMAND_OPERATION, определяет ее параметр. Параметры задаются по правилам формирования url. 

Параметры команды:

НаименованиеТип данныхОписание

Примечания

rolesчисловойСлужит для определения ролей, которым доступно выполнение заданной операцииЗначением данного параметра является список кодов ролей, через запятую
urlстроковыйВ значении данного параметра указываются действия, которые выполняются заданной командой

Выполнение внешних программ 

Команда для выполнения внешних программ формируется в виде: shell:///<script>?<attributes>#<parameters>, где:

  • script – полный путь к программе, которую необходимо выполнить. Может содержать макросы,
  • attributes – атрибуты. Атрибуты формируются в виде пар <ключ>=<значение>, разделенных символом "&",
  • parameters – параметры выполнения внешних программ. Передаются в качестве параметров в командной строке. Могут содержать макросы.

Доступные объекты при использовании макросов: 

  • status – текущее состояние кассы,

  • registry – реестр,

  • shift – смена,

  • timeout – таймаут,

  • document – документ (доступен если он есть в контексте вызова),

  • position – текущая позиция (доступен если используется текущий документ).

При выборе текущего документа становится доступен объект position.

Если выбирается период смен и выбор документа с параметром selected, то документ не выбирается.

Атрибуты выполнения внешних программ:

Ключ

Значение

document 

Документ. Возможные значения:

  • selected – выбранный документ. Пользователю будет предложено выбрать документ для указанной смены из списка,
  • current – текущий документ,
  • last – выбор последнего документа в текущей смене,
  • none – документ не доступен. По умолчанию документ не доступен.
shift

Смена. Возможные значения:

  • selected – выбранная смена. Пользователю будет предложено выбрать смену из списка,
  • current – текущая смена. По умолчанию указана текущая смена,
  • period – диапазон смен (начальная и конечная смена отправляется в отчет объектами shift_beg и shift_end).
title

Заголовок, который отображается при выполнении операции. Может содержать символы '|', по которым выполняется перенос (многострочный текст)

При выполнении внешних скриптов вывод данных в поток вывода и поток ошибок подавляется.   
Пример команды
shell:////linuxcash/cash/sync/scripts/unloadSales.sh?shift=current&document=none&timeout=5#%20-s%20%(shift.num[d])@%(shift.num[d])%20-c%202

Для того чтобы запустить команду в фоновом режиме, необходимо в конце команды добавить %20&.

Генерация документов на основании данных о продажах

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

Значение параметра url для генерации документов на основании данных о продажах формируется в виде:

  • report://<name>?<attributes> для программных отчетов.
    • name – наименование шаблона,
    • attributes – атрибуты. Атрибуты формируются в виде пар <ключ>=<значение>, разделенных символом "&".

    В качестве значения name могут быть использованы:

    Тип отчетаОписаниеПримечания
    bonusreportОтчет по бонусам
    cashierОтчет по кассирам
    deptreportПрограммный отчет по отделам
    goodsreportОтчет по товарам
    streportПрограммный отчет по сторно
    xreportПрограммный X-отчет
    zreportПрограммный Z-отчет

      

  • frdoc://<name>?<attributes> для отчетов ФР, где:

    • name – наименование шаблона,
    • attributes – атрибуты. Атрибуты формируются в виде пар <ключ>=<значение>, разделенных символом "&".

    В качестве значения name могут быть использованы:

    Тип отчетаОписаниеПримечания
    frdeptreportОтчет по отделам для ФР
    frvatreportОтчет по налогамРеализовано только для ФР Штрих
    frxreportСуточный отчет без гашения (X-отчет для ФР)
    frzreportСуточный отчет с гашением (Z-отчет для ФР)
    frlastfndocumentПечать последнего документа из ФНПри печати на ФР Атол чек имеет вид фискального документа

Возможные атрибуты:

Ключ

Значение

Примечания
append

Способ открытия файла. Используется, если способ вывода – сохранение в файл. Возможные значения:

  • true – дописывать файл,
  • false – переписывать файл.

createifempty

Создание пустого файла. Используется, если способ вывода – сохранение в файл. Возможные значения:

  • true – создавать пустой файл,
  • false – не создавать пустой файл.

doctype

Тип документа. Возможные значения:

  • moneyin – акт внесения денег,
  • moneyout – акт выема денег:
    • moneyinout – акты внесения и выема денег,
    • sale – чек продажи,
    • back – чек возврата,
    • backbysale – чек возврата по чеку продажи,
    • sales – чеки продажи, возврата и возврата по чеку продажи.
По умолчанию все типы документов. В команду могут быть записаны несколько типов документов
document

Документ. Возможные значения:

  • selected – выбранный документ. Пользователю будет предложено выбрать документ для указанной смены из списка,
  • current – текущий документ,
  • last – выбор последнего документа в текущей смене,
  • bynumber – ввод номера документа,
  • none – документ недоступен. По умолчанию документ недоступен.

kkm

Выбор ККМ для печати отчета. Возможные значения:

  • single – использовать первый ФР,
  • all – печатать на всех ККМ,
  • selected – показать диалог выбора ККМ перед печатью,
  • N – печатать на ККМ с указанным номером N = 0, 1, 2, ...
По умолчанию selected
name

Имя выходного файла. Используется, если способ вывода – сохранение в файл. Может содержать макросы. Доступные объекты:

  • status – текущее состояние работы кассы,
  • registry – реестр,
  • shift – смена,
  • document – документ (доступен если он есть в контексте вызова).

out 

Способ вывода. Может принимать значения:

  • print – вывод на печать,
  • file – сохранение в файл,
  • display – отображение отчета на экране кассы.

title

Заголовок отчета. Поддерживает форматирование

Работает совместно с атрибутом out=display
font

Шрифт отображаемого текста отчета

Работает совместно с атрибутом out=display.

Значение по умолчанию: Courier New

fontSize

Размер шрифта отображаемого текста отчета

Работает совместно с атрибутом out=display.

Значение по умолчанию: 12

styleSheet

Стиль отображения виджета с текстом отчета.

Пример значения

styleSheet=font-size:%2012px;%20font-family:%20Courier%20New;%20background-color:%20red

Работает совместно с атрибутом out=display.

Задается только для интерфейсов keyboard, touch

pagination 

Разбиение файла по страницам. Используется, если способ вывода – сохранение в файл.
К имени файла добавляется суффикс "-<номер страницы>". Нумерация страниц начинается с 1. Возможные значения:

  • true – разрешить разбиение по страницам,
  • false – запретить разбиение по страницам.

producer
Наименование производителя ФР. Возможные значения:
  • shtrihm – Штрих-М,
  • serviceplus – Сервис Плюс,
  • pilot – Пилот,
  • atol – Атол,
  • crystal – Кристалл Сервис.
Является приоритетным атрибутом
model

Код модели ФР. Возможные значения:

  • Для Штрих-М: 1 – ШТРИХ-ФР-Ф, 4 – ШТРИХ-ФР-К, 6 – ЭЛВЕС-ФР-К, 7 – ШТРИХ-МИНИ-ФР-К, 8 – Штрих-ФР-К (Беларусь), 22 – ФР Retail-01K, 250 – ШТРИХ-М-ФР-К, 252 – ШТРИХ-LIGHT-ФР-К,
  • Для Сервис Плюс: 1 – СП101, 2 – СП402,
  • Для Пилот: 1 – FP410K,
  • Для Атол: 30 – FPrint-02K, 31 – FPrint-03K, 32 – FPrint-88K, 35 – FPrint-5200K, 47 – FPrint-55K, 51 – FPrint-11ПТК, 52 – FPrint-22K, 53 – FPrint-77ПТК, 57 – АТОЛ 25Ф, 61 – АТОЛ 30Ф, 62 – АТОЛ 55Ф, 63 – АТОЛ FPrint-22ПТК, 64 – АТОЛ 52Ф, 67 – АТОЛ 11Ф, 69 – АТОЛ 77Ф, 80 – АТОЛ 50Ф, 81 – АТОЛ 20Ф,
  • Для Кристалл Сервис: 1 – ПИРИТ-К, 2 – ПИРИТ-ЕНВД, 3 – ПИРИТ-01К, 4 – Вики Принт 57 Ф, 5 – Вики Принт 57 Плюс Ф, 6 – Вики Принт 80 Плюс Ф, 11 – Viki Print K, 12 – Viki Print 57 plus K.
Работает совместно с атрибутом producer
shift

Смена, возможные значения параметра:

  • selected – выбранная смена, пользователю будет предложено выбрать смену из списка,
  • current – текущая смена,
  • period – диапазон смен (начальная и конечная смена отправляется в отчет объектами shift_beg и shift_end).
По умолчанию задана текущая смена
tmclist

Выбор товаров из списка:

  • true – доступен выбор товаров из списка,
  • false – выбор товаров из списка недоступен.

Пример команды: Отчет по товарам
report://goodsreport?out=print&tmclist=true&shift=period
Пример команды: Отчет по кассирам
report://cashier?out=print&shift=selected&kkm=selected
Пример команды: Отображение Х-отчета на экране кассы с данными за текущую смену, заголовком, стандартными шрифтом и размером

report://xreport?out=display&title=X%20отчет%20за%20смену%20%(shift.num[d])&font=Courier%20New&fontSize=12

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

В кассовом ПО Artix реализована печать копий сохраненных фискальных отчетов. Для печати копии отчета необходимо в утилите администрирования Yuki на пункт меню "Отчеты" настроить действие "Печать копии отчета" с командой COMMAND_PRINT_REPORTCOPY и параметром reportName с необходимым значением:

  • frzreport – для печати копии сохраненного фискального Z-отчета,
  • frxreport – для печати копии сохраненного фискального X-отчета.

О настройке действий подробнее можно прочитать в разделе "Настройка действий". 

При вызове команды печати копии отчета на экран будет выведен список дат формирования отчетов.

Если в параметре reportName не задано значение, то при вызове команды печати копии отчета на экран будет выведена ошибка "Не указано наименование отчета для печати копии".

Порядок выбора ККМ для печати отчетов

Порядок выбора ККМ для печати отчетов осуществляется следующим образом:

Атрибут producer является приоритетным при выборе ККМ для печати отчета:

  • если в параметрах url указан атрибут producer, то осуществляется поиск всех ФР, соответствующих этому производителю,

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

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

  • если помимо атрибутов producer/model указан kkm=single, то будет выбран первый ФР из всех, удовлетворяющих критерию producer/model.

Если в параметрах url не указан producer, то выбор ФР осуществляется следующим образом:

  • если kkm=single, то используется первый найденный ФР, т.е. ФР с наименьшим логическим номером,
  • если kkm=all, то выбираются все найденные ФР,
  • если kkm=<число>, то осуществляется поиск ФР с заданным логическим номером,
  • во всех остальных случаях:
    • для программных отчетов используется первый найденный ФР, т.е. ФР с наименьшим логическим номером,
    • для отчетов ФР будет показан диалог выбора ККМ. При печати отчетов ФР во время закрытия смены выбираются все найденые ФР.

Выполнение команд ФР

Значение параметра url для выполнения команд ФР формируется в виде frcommand://<command>?<attributes>, где:

  • command – команда,
  • attributes – атрибуты. Атрибуты формируются в виде пар <ключ>=<значение>, разделенных символом "&".

В качестве значения command могут быть использованы:

КомандаОписаниеПримечания
beepПодача звукового сигнала
cutОтрезка чековой ленты
setparamПрограммирование параметров ФР

Атрибуты:

  • table – № таблицы,
  • row – № строки (ряда) в таблице,
  • field – № колонки (поля) в таблице,
  • value – программируемое значение.
maintenanceОбслуживание ФРОсуществляет перенос файл-логов для Атол 5.0
Пример команды: Подача звукового сигнала
frcommand://beep
Пример команды: Программирование параметра для ФР Штрих Retail 01K
frcommand://setparam?producer=shtrihm&model=22&table=17&row=1&field=2&value=3

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

Закрытие смены на ФР Штрих Retail 01K без печати Z-отчета ФР

В кассовом ПО Artix реализована возможность закрытия смены без печати Z-отчета ФР, но с печатью краткого Z-отчета ФН.

Закрытие смены без печати Z-отчета ФР осуществляется настройкой макроса "Закрытие смены" в утилите администрирования Yuki. В параметры макроса необходимо добавить команды:

  1. Перед действием "Z отчет(ФР)" добавить действие "Выключение печати" с командой COMMAND_OPERATION и параметром url:

    frcommand://setparam?producer=shtrihm&model=22&table=17&row=1&field=7&value=2

  2. После действия "Z отчет(ФР)" добавить действие "Включение печати" с командой COMMAND_OPERATION и параметром url:

    frcommand://setparam?producer=shtrihm&model=22&table=17&row=1&field=7&value=0

  3. После действия "Включение печати" добавить действие "Отрезка" с командой COMMAND_OPERATION и параметром url:

    frcommand://cut?producer=shtrihm&model=22

  4. После действия "Отрезка" добавить действие "Печать последнего документа из ФН" с командой командой COMMAND_OPERATION и параметром url:

    frdoc://frlastfndocument?producer=shtrihm&model=22
  • No labels