ВНИМАНИЕ!
Данная статья содержит информацию по настройкам, релевантным только для обмена с кассами или модулем интеграции. Настройки экспорта XML для обмена через сервер доступны по обращению к команде техподдержки УКМ 5.
В данной статье приведены только некоторые настройки, необходимые для корректной работы конвертера Экспорт XML. Ознакомиться с подробным описанием структуры файлов экспорта можно ЗДЕСЬ.
Особенности
Особенностью конвертера Экспорт XML для УКМ 5 является возможность выгружать все документы, относящиеся к смене (включая отмененные чеки). В оперативной выгрузке выгружаются только успешно завершенные чеки. При закрытии смены могут выгружаться как завершенные, так и аннулированные (отменённые) чеки.
Все чеки выгружаются в составе документа о закрытии смены.
Отменённые позиции чеков выгружаются и в оперативной выгрузке, и в составе закрытой смены.
Выгрузка отменённых позиций и отменённых чеков регулируется наличием параметра isExportCancelledReceipts = true в настройках конвертера.
Ручная выгрузка
При ручной выгрузке указываются следующие параметры:
- каталог, в который выгружается информация (по умолчанию подставляется тот же, что указан в настройках автоматической выгрузки);
- информация, которая должна выгружаться:
- открытие смен;
- операции с денежным ящиком;
- соответствие кодов магазинов и средств оплаты (используется из настроек автоматической выгрузки и при ручной выгрузке не отображается);
- магазин, для которого делается выгрузка (по умолчанию подставляется текущий магазин);
- касса, для которой делается выгрузка;
- номер смены, которую необходимо выгрузить: выбор смены должен происходить путем указания даты; если в выбранную дату было закрыто более одной смены, то пользователю необходимо выбрать только одну.
Правила выгрузки смен:
- если выгружаемая смена закрыта, то выгружается информация о закрытии смены (в её состав входят чеки этой смены);
- если выгружаемая смена не закрыта, то выгружаются чеки, которые к ней относятся (в формате «оперативной» выгрузки).
В обоих случаях выгружаются все документы, относящиеся к указанным сменам, если установлены соответствующие параметры.
Порядок выгрузки информации
Если в момент начала работы конвертера на сервере есть документы, относящиеся к нескольким сменам, или делается ручная выгрузка нескольких смен, то для каждой кассы выгружается блок, состоящий из следующих пакетов:
- все операции с денежным ящиком;
- все открытия смен;
- все чеки;
- все закрытия смен.
В каждом пакете информация упорядочена по возрастанию номеров смен.
Блоки с информацией по разным кассам никак не упорядочены.
Настройки
Настройки выполняются в конфигурационном файле xml5_exporter.conf (services\converters\doc_exporter\xml5_exporter.conf), расположенном на кассовом сервере по адресу: Магазин – Типы касс, где нужно выбрать тип кассы и нажать кнопку Настройки:
"doc_exporter.xml5": {
params : {
enabled = true (конвертер включен)
isExportReceipts = true (разрешена выгрузка оперативных чеков)
isExportMoneyOperations = true (разрешена выгрузка операций внесения/изъятия)
isExportShiftOpens = false (разрешена выгрузка документов открытия смен)
isExportCancelledReceipts = true (включение выгрузки отменённых позиций и чеков)
converterId = XML5 (формат выгрузки)
retryPeriod = 5 minutes (интервал)
outputFolder = "/home/ukm5/mint/exchange/converters/out"
tempFolder = "/home/ukm5/mint/exchange/converters/tmp"
storeIdMap: [ (мапирование идентификаторов магазинов во внешней системе)
{externalId = 11, internalId = 456001},
{externalId = 22, internalId = 456002},
{externalId = 33, internalId = 456003},
{externalId = 44, internalId = 456004}
]
Если для магазина мапирование не указано, то файлы будут выгружаться с идентификатором, указанным в настройках магазина на сервере по адресу Магазин – Описание – Интеграция – Id во внешней системе. Другими словами, отсутствие записи для магазина в данном параметре эквивалентно следующей записи:
{externalId = 1144, internalId = 39}
Здесь значения взяты из cправочника магазина:
paymentIdMap: [ (мапирование идентификаторов магазинов во внешней системе)
{externalId = 1, internalId = 1},
{externalId = 101, internalId = 2},
{externalId = 101, internalId = 3},
{externalId = 101, internalId = 4}
]
Если для средства оплаты мапирование не указано, то см. описание структуры чека выше (параметр paymentId).