Общие настройки ProCart [База знаний ГК Карбис]

Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Общие настройки ProCart ======

ProCart.yaml - файл конфигурации модуля, он содержит все необходимые настройки для работы модуля. 
Данный файл создается автоматически при первом запуске модуля.
После изменения параметров в данном файле, для вступлениях их в силу необходимо перезапустить модуль ProCart. 

Настройки разбиты на 5 групп:
  * r_keeper_midserver - параметры подключения к кассовому серверу
  * r_keeper_references - данные справочников r_keeper
  * local_server - параметры локального сервера модуля 
  * pro_cart_setting - параметры работы шлюза доставки
  * log - параметры логирования 

===== r_keeper_midserver =====
<code>
# Параметры подключения к кассовому серверу r_keeper 
r_keeper_midserver:
  # Адрес кассового сервера (str)
  host: 127.0.0.1
  # Порт для подключения к xml-интерфейсу кассового сервера (int)
  port: 3357
  # Логин пользователя (str)
  user: http
  # Пароль пользователя (str)
  password: http
  # Использовать SaaS XML для подключения к rk7 (bool)
  use_saas: false
</code>

  * **host** - ip адрес компьютера на котором работает кассовый сервер
  * **port** - http data port из конфигурации r_keeper [[https://wiki.carbis.ru/external/zz_дополнительные_материалы/02_xml_interfaсe_rkeeper#настройка_http_xml_интерфейса_кассового_сервера_или_кассы|Где найти]]
  * **user** - логин пользователя для доступа к xml-интерфейсу (цифры и латиница, регистр важен)
  * **password** - пароль пользователя для доступа к xml-интерфейсу (цифры и латиница, регистр важен)
  * **use_saas** - Значение зависит от того, какая лицензия на XML будет использоваться для работы. Если SaaS (подписка), то **true**, если lifetime (XML WriteOrder) - **false** \\ Если "use_saas=true", то необходимо произвести дополнительные настройки, необходимые для работы с XML SaaS, запустив файл "saas_settings.bat".

Если настройка saas-xml лицензии произведена успешно, в корневой папке с файлами ProCart появится файл с расширением .saasdata

Его примерное содержание должно быть:
<code>
{
  "seq_number": -1,
  "produrct_guid": "655cee55-7bcd-4826-b6e0-a8ccf2017ef3",
  "usr": "YWxrLW922HlhLnJ1OzQ0MWZmY2UzMjk0OWZkZTg2NGUxNDk0M2FkNWNmYzI1Ozc0NWZkYTk4MDA0ZjEzM2QyZWRlMjRkNTI4ODQ2N2Nl"
}
</code>

Если файл не появился вообще или в нём нет параметров "produrct_guid", "usr" - настройка неудачна, см. лог.


В случае появления в логе ошибки ErrorText="Инстанс лицензии не найден", следует запустить файл change_license_instance.bat.

Подробная статья про лицензирования XML-Save Order: [[external:zz_дополнительные_материалы:xml_save_order|почитать]]

===== r_keeper_references =====
<code>
# Данные справочников r_keeper 
r_keeper_references:
  # Код кассовой станции (int)
  cash_station: 1
  # Код стола для создания закаов (int)
r_keeper_references:
  # Код кассовой станции (int)
  cash_station: 1
  # Код стола для создания заказов (int)
  table: 1
  # Код категории заказа Если не передан в запросе будет использоваться по стандарту который указан в файле конфигурации, используется для подсчёта стоимости блюд (int)
  order_category: 1
  # Код классификации блюд для выгрузки меню (int)
  menu_classification: 1
   # Код суммовой скидки Скидка 'на заказ' c изменяемым значением (int)
  sum_discount: 1
  # Код суммовой наценки Наценка 'на заказ' c изменяемым значением (int)
  sum_markup: 1
  # Код интерфейса для применения карты (int)
  interface: 1
  # Закрывать сбалансированный заказ (bool)
  close_paid_order: false
  # Код кассира от которого будет происходить оплата заказа (int)
  cashier_code: 1
  # Код учётной записи менеджера для удаления заказ (int)
  manager_code: 1
  # Код причины удаления заказа (int)
  delete_reason: 1
  # Код свободного модификатора для добавления комментария к блюду (int)
  open_modifier_code: 1
  # GUID расширенного свойства в заказе для комментария Необязательный параметр. GUID указывать без фигурных скобок (str)
  guid_commment: ''
</code>

**cash_station** - КОД кассовой станции от имени которой будут производиться все операции. Как правило, это код главной кассы на кассовом сервере.
**table** - КОД стола, на котором по умолчанию будут создаваться заказы. [[https://wiki.carbis.ru/external/procart/02_procart_api#работа_со_столами|Подробнее тут]].
**order_category** - КОД категории заказа используемой по умолчанию. [[https://wiki.carbis.ru/external/procart/02_procart_api#категория_заказа|Подробнее тут]].
**menu_classification** - КОД классификации по которой ведется выборка блюд из r_keeper. [[https://wiki.carbis.ru/external/procart/02_procart_api#классификации_блюд|Подробнее тут]].
**payment_reason** - Код причины внесения предоплаты.**Параметр убран из настроек от версии ProCart v1.5.7.38**.
**sum_discount** - КОД суммовой скидки. Используется для передачи в систему произвольной скидки, сумма которой рассчитывается на стороне внешней системы. 
[[https://wiki.carbis.ru/external/procart/02_procart_api#скидки_суммовая_и_словарная|Подробнее тут]].
**sum_maprkup** - КОД суммовой наценки. Используется для передачи в систему произвольной наценки, сумма которой рассчитывается на стороне внешней системы. 
[[https://wiki.carbis.ru/external/procart/02_procart_api#наценка_суммовая|Подробнее тут]].

**open_modifier_code** - КОД свободного модификатора. Используется для добавления комментария к блюду [[https://wiki.carbis.ru/external/procart/02_procart_api#комментарии_к_блюду_в_заказе_открытый_модификатор|Подробнее тут]]
**guid_commment** - GUID расширенного свойства, для комментария. Из поля comment текст будет попадать в указанное свойство. Настройка расширенного свойства описана [[external:procart:01_setup:01_rkeeper_settings#настройка_длинного_комментария|тут]].  
===== local_server =====
<code>
# Параметры локального сервера 
local_server:
  # Адрес сервера (str)
  host: 0.0.0.0
  # Порт сервера (int)
  port: 11111
  # Количество потоков сервера (int)
  threads: 4
</code>

  * **host** - Подсеть, в рамках которой сервер ProCart принимает и обрабатывает запросы. Значение по умолчанию "0.0.0.0" (обрабатывать запросы из любой подсети). \\ Важно! Если вы не знаете зачем нужен этот параметр - не меняйте его значение. \\ Важно! Не устанавливать "127.0.0.1".
  * **port** - Порт на котором работает (принимает запросы) сервер ProCart. Значение по умолчанию - 11111
  * **threads** - количество потоков обработки. Изменять не рекомендуется!

===== pro_cart_setting =====
<code>
# Параметры настройки шлюза доставки 
pro_cart_settings:
  # Список токенов подключения (str)
  token_list:
  - ccccbf02-776c-49a7-8d04-57ee6047e31f
  - bab937cc-2241-48da-910c-9856aff13e2e
  # Задержка опроса r_keeper на предмет изменений в заказах (секунд) (int)
  timeout_statepolling: 10
  # Включить проверку кодов блюд при создании заказа По умолчанию True (включено). Если выключить, то модуль неизвестные коды блюд будет интерпретировать как обычное блюдо. (bool)
  enable_items_verification: true
  # Заполнять теги для интернет платежей (bool)
  use_internet_pay_tags: true
  # Адрес сайта (Место расчетов) (str)
  def_site_url_1187: ''
  # Контактные данные покупателя (str)
  def_contact_1008: ''
</code>

  * **token_list** - Список разрешенных токенов для подключения. \\ По умолчанию первый токен генерируется автоматически (при первом запуске модуля). Если с модулем ProCart будет работать несколько разных внешних систем, то рекомендуется для подключения каждой из них использовать отдельный токен. Новые токены записываются в файл с новой строки, строка начинается с символа "-". Значение токена должно соответствовать формату GUID. Для генерации значений новых токенов можно воспользоваться [[http://foxtools.ru/Guid|внешним сервисом]].
  * **timeout_statepolling** - Периодичность опроса кассовой системы r_keeper на предмет изменений в заказах. Значение в секундах. Значение по умолчанию: 10. Рекомендуемые значения: 10-60
  * **enable_items_verification** - Данное значение стоит менять, только при понимании для чего это делается. Флаг для включения или отключения проверки блюд самим модулем в заказе при его создании или валидации. Если отключить, то неизвестные софту блюда будут интерпретироваться как обычное блюдо. При этом сам r_keeper вернет ошибку, если такого блюда действительно не существует. Значение по умолчанию: true. Допустимые значения: **true**, **false**.
  * **use_internet_pay_tags** - Тег-признак расчета для интернет платежей.\\ По умолчанию "false", при указании "flase" игнорирует теги "def_site_url_1187", "def_contact_1008". При указании значения "true" берёт данные из полей запроса "site_url_1187", "contact_1008", если значение в запросе не указано берёт из конфига.[[https://wiki.carbis.ru/external/procart/02_procart_api#работа_с_тегами_интернет_продаж|подробнее тут]].
  * **def_site_url_1187** - Адрес сайта (место расчётов). \\ По умолчанию пустая строка (""). Задаёт дефолтное значение, если в запросе значение тега не передано, иначе берётся из запроса. Незаполненное поле требуется указать, если должен быть определенные данные  сайта
  * **def_contact_1008''**  - Контактные данные покупателя, \\ По умолчанию пустая строка (""). Задаёт дефолтное значение, если в запросе значение тега не передано, иначе берётся из запроса. Незаполненное поле требуется указать, если должен быть определенные данные покупателя 

===== log =====
<code>
log:
  # Уровень логирования (int)
  level: 3
  # Срок хранения .log файлов (дней) (int)
  retention_days: 7
</code>

  * **level** - Уровень логирования. Чем выше - тем подробнее. По умолчанию - 3. Возможные значения 1-10. 
  * **retention_days** - Срок хранения *.log файлов (дней). По умолчанию - 7.  Возможные значения 1-30.