SMP-2097 ID 2464 Интеграция СуперМаг Плюс и DS_РитейлСофт

ID: 2464
SALE: 3226

Бизнес процесс.

Описание: клиенты, использующие СуперМаг Плюс заинтересованы в интеграции с СуперМаг DS для использования прайс-дисплеев и esl-ценников.
Для интеграции СуперМаг Плюс и DS - используется расширенный XML-протокол, с помощью которого сейчас интегрируются УКМ5 и ДС 

Интерфейс и реализация.

В настоящее время УКМ5 интегрируется с СуперМаг DS по следующей схеме (рис.1.):
Рис.1.

 
Схема интеграции через СуперМаг Плюс претерпит следующие изменения (Рис.2.):
Рис.2.

Подготовкой данных занимается служба Кассовый сервер СуперМаг Плюс. 

• Рабочее название.
  Логика работы с ПО Kafka заключается в следующем:
• Кассовый модуль СуперМаг Плюс подготавливает данные в специализированном формате XML (описан ниже).
• Полученные данные, модуль «Кассовый модуль СуперМаг Плюс» должен преобразовать и отправить в топик Kafka.

Справка: Apache Kafka — распределённая система обмена сообщениями между серверными приложениями в режиме реального времени. 

Описание форматов обмена.

Формат данных для публикации.

СуперМаг Плюс должен публиковать в Kafka файлы в следующем виде:

{
        "content_base64": "здесь содержимое в base64",
        "event_type": "F",
        "number": "1",
        "original_filename": "storePrices_[262]_[1]_[F].xml",
        "store_id": "262",
        "part": "1",      
        "part_status": "process"        
}

Формат данных для обмена.

За основу формата обмена данными взят конвертер СуперМаг XML, с некоторыми изменениями, в частности:

• Имена файлов должны быть строго такими, как они отражены в описании, иначе конвертер DS их проигнорирует.
• Структура файлов расширена новыми данными.

Файлы обмена (общий список).

Ниже представлен общий список файлов, которые требуется формировать. Часть файлов (их структура) не претерпела изменений по отношению к конвертеру СуперМаг XML, и не описывается в данном ТЗ.

Общее описание.

Ниже описывается расширение существующего протокола обмена данными (СуперМаг XML) для создания готового "коробочного" решения, которое позволит клиентам, использующим СуперМаг Плюс, избежать отдельной интеграции с «СуперМаг DS» для использования электронных ценников (ESL) и Прайс-дисплеев.
Ранее данные из Торговой системы выгружались данные исключительно для кассовых систем и систем контроля цен. Теперь этот процесс дополняется: фактически те же самые данные будут параллельно передаваться и в DS. Это позволит системе «СуперМаг DS» получать актуальную информацию о товаре и их ценах.

Описание расширения.

• Наименование файла строго как в описание. (операционная система LINUX регистрозависима)
• Формат представления информации – XML. 
• Кодировка – UTF-8.
• Десятичный разделитель – точка
• Каждый тип информации передаётся с помощью отдельного файла, который имеет название, соответствующее типу передаваемой информации. В одном файле может содержаться только один тип информации 

Расширение существующих файлов в протоколе: 

Добавление новых файлов в протокол:

Файл store (магазины).

Наименование файла: store (например, store_[1234]_[I].xml).

Описание изменений: Файл расширяется двумя новыми полями:

• director — ФИО директора магазина.
• description — Произвольное текстовое описание или комментарий к магазину.

Описание файла "store":

Файл updateItems (товары).

Наименование файла: updateItems (например: updateItems_[1234]_[F].xml).

Описание изменений: Файл расширяется тремя новыми полями, которые являются необязательными для передачи:

• producer - Страна производства 
• description - Описание товара 
• customType - Атрибут товара

Описание файла "updateItems":

Реализация заполнения значения <customType>:

Категория и дизайн ценников для системы управления медиаконтентом Супермаг DS.

В справочнике «Категория ценников» поле «Только для мобильного принтера» заменено полем «Применение» с возможностью выбора области применения ценника:

- для стандартного принтера,

- для мобильного принтера,

- для DS

Примечание: опция «Обязательна для печати» действует только при выборе применения «для стандартного принтера».

Выбор применения «для DS» означает, что ценники этой категории предполагается использовать в системе управления медиаконтентом Супермаг DS, и они будут воспроизводиться только в этой системе.

В справочнике «Дизайн ценников» поле «Файл ценника» получило название «Файл или код DS ценника». Для ценников с применением «для стандартного принтера» или «для мобильного принтера» в это поле по-прежнему надо заносить название файла ценника, для ценников «для DS» в это поле надо заносить код ценника*, известный системе Супермаг DS:

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

Код ценника* - Целое число — э, которое не имеет дробной части и включает в себя:

Натуральные числа — положительные числа, используемые для счёта (1, 2, 3 и т. д.).

Файл priceTagInfo (акционные цены).

Источником данных для акционных ценников будут выступать документы «Маркетинговая акция».

С помощью данного файла в DS возможно отразить следующие акционные кампании:

Секция campaign:

Пример:
<priceTagInfo fullness="I" storeId="2">
<version>1.0</version>
<item article="000177">
<description>Покупайте наших слонов</description>
<dateFrom>01.01.2025</dateFrom>
<dateTo>31.12.2025</dateTo>
<campaigntype>discountbypercent</campaigntype><campaign>
<price>45</price>
<oldPrice>50</oldPrice>
<discount>10</discount></campaign>
</item>
</priceTagInfo>

Файл itemInfo (QR-коды и PLU).

Наименование файла: itemInfo (например: itemInfo_[Store]_[Number]_[P].xml)

Правила наполнения данными для файла priceTagInfo.

Источником данных для акционных ценников будут выступать документы «Маркетинговая акция».
Следует учитывать, что у данного документа имеются следующие атрибуты, значение которых напрямую может оказывать влияние на цену товара, и как следствие цену на ценнике СуперМаг DS. К атрибутам относится:

• Планируемая дата начала акции.
• Планируемая дата окончания акции.
• Статус «Исполняется». (Статус указывает, что акция стартовала).
• Фактическая дата окончания акции.

Так же не исключены ситуации, при которых возможно пересечение артикулов в созданных маркетинговых акциях, а также досрочное завершение акции (вручную сотрудником).
Так как стоит задача, получить в DS акционные цены в строгом в соответствии в ценами в кассовой системе, то логика выгрузки определена следующая:
Маркетинговая акция запустилась (однократная выгрузка).
Задача: проинформировать DS о значении и начале действия аукционной цены.

1. 1. При формировании выгрузки storePrices (цены) - для товара участвующего в Маркетинговой акции, в качестве регулярной цены будет выгружаться текущая цена из карточки, она же на этот момент будет являться аукционной.
   2. При формировании выгрузки priceTagInfo (акционные цены) - для товара участвующего в действующей Маркетинговой акции, в качестве:

• «Цены» - должна выгружаться текущая цена из карточки, она же на этот момент будет являться акционной.
• «Старой цены» - должна быть выгружена цена, которая была зафиксирована как «цена до акции».
• «Название акции» - название акции, которая породила акционную цену.
• «Дата и время начала акции» - Планируемая Дата и время старта акции
• «Дата и время окончания акции» - Планируемая Дата и время окончания акции

Маркетинговая акция завершена (однократная выгрузка).
Задача: проинформировать DS о завершения действия аукционной цены.

1. 1. При формировании выгрузки storePrices (цены) - для товара участвующего в Маркетинговой акции, в качестве регулярной цены будет выгружаться текущая цена из карточки, она же на этот момент будет являться аукционной.
   2. При формировании выгрузки priceTagInfo (акционные цены) - для товара участвующего в действующей Маркетинговой акции, в качестве:

• «Цены» - должна выгружаться текущая цена из карточки, она же на этот момент будет являться регулярной ценой.
• «Старой цены» - должна быть выгружена цена из карточки, она же на этот момент будет являться регулярной ценой.
• «Название акции» - название акции, которая породила акционную цену.
• «Дата и время начала акции» - Планируемая Дата и время старта акции
• «Дата и время окончания акции» - Фактическая Дата и время окончания акции

Маркетинговая акция завершена, но артикул продолжает участвовать в другой акции (однократная выгрузка).
Задача: проинформировать DS о новом значении и начале действия новой аукционной цены.

1. 1. При формировании выгрузки storePrices (цены) - для товара участвующего в Маркетинговой акции, в качестве регулярной цены будет выгружаться текущая цена из карточки, она же на этот момент будет являться акционной.
   2. При формировании выгрузки priceTagInfo (акционные цены) - для товара участвующего в действующей Маркетинговой акции, в качестве:

• «Цены» - должна выгружаться текущая цена из карточки, она же на этот момент будет являться акционной.
• «Старой цены» - должна быть выгружена цена, которая была зафиксирована как «цена до акции».
• «Название акции» - название акции, которая породила акционную цену.
• «Дата и время начала акции» - Планируемая Дата и время старта акции
• «Дата и время окончания акции» - Планируемая Дата и время окончания акции

Публикация файлов в kafka (топики).

Каждый клиент идентифицируется уникальным ID (partner_id). Для каждого клиента создается отдельная группа топиков в формате: partner_id.doc_type
partner_id - id партнера на сервере DS 
doc_type - тип передаваемой информации

СуперМаг Плюс - 1.059 сп2 - https://manual.retail-soft.pro/x/GgQ7Cg