Documentation

doc/1.Setup/Debug information.md

@@ -0,0 +1,16 @@
+### Режим отладки
+
+Служит для включения расширенного логирования, предназначен для разработчиков. Для просмотра логов необходимо перейти *WooCommerce -> Статус -> Журналы* и там смотреть на файлы **retailcrm_debug**.
+
+### Отладочная информация
+
+Вывод основной информации о работе модуля. На данный момент выводит время последнего запуска крон-задач:
+<br/><br/>**History** - показывает время и дату запуска обновления по истории *(данные будут отображены, если активна опция “Загрузка данных из CRM”)*.
+
+**Icml** - показывает время и дату, когда последний раз срабатывала команда генерации каталога по WP-CRON *(информация будет отображена, если активна опция “Генерация ICML каталога товаров с помощью wp-cron”)*.
+
+**Inventories** - показывает время и дату запуска получения остатков по товарам из CRM в WooCommerce *(данные будут отображены, если активна опция “Настройка управления остатками”)*.
+
+Добавлено в версии 4.3.3.
+
+![](https://lh4.googleusercontent.com/_tdjxonwGp40uafwaEK__QenxJurbNPsvlMu8Pw3eZk_vN6-KzKB8RWeYXwJqYPRfjzTZnvT0TGYVBry-4JWXTzQuDt9zDIBWQO0lnrUSHP84PxoomFiDPIVHsRIZ7gHzKdgmDUc=s0)

doc/1.Setup/Main Settings.md

@@ -0,0 +1,15 @@
+### API URL
+
+Требуется ввести полный адрес системы (https://test.retailcrm.ru). Для ввода в поле можно использовать как адрес RetailCRM, так и Simla.com.
+
+  ### API ключ
+
+Ключ должен иметь доступ только к одному магазину (**1 магазин = 1 ключ**). Также для ключа должны быть разрешены все методы API *(рекомендуется)* в настройках системы.
+
+![](https://lh3.googleusercontent.com/GQlvq7WurtSreRy05xxkNw-yEPaIyISWgYrDUSDurxr4wFx_EMocT8MjRa4HktFyXnBiwsVL2a_wQFtXSCNEjJvhryUpvcNeR8xKpQBOpKGxtm3zFrJxnud8-ahwhIOcpmAZS_Be=s0)
+
+  
+
+![](https://lh5.googleusercontent.com/j27aD9LvAlFsfV0S2f_nCkRQL4iQR40dpw35K6yyb7latJScYFwP3GQceaLx5NfFYSBhhKHmrm8XH3v2KA57hujoJ_o99l104y_hEE6P08kV6Hi-ocWx28YAFN1Jrt7zZIk23bTf=s0)
+
+***При первичной настройке модуля, дальнейшие опции отображаются после корректного ввода API URL и API ключа!***

doc/1.Setup/Settings order number.md

@@ -0,0 +1,7 @@
+### Передача номера заказа
+
+Функционал позволяет в номер заказа CRM передавать номер заказа WooCommerce.
+
+Если опция не активна, то номер, с которым выгрузится заказ из WooCommerce в CRM, будет сгенерирован с использованием “Шаблона генерации номера заказа из API” *(в CRM Настройки - Системные - Заказы)*.
+
+![](https://lh4.googleusercontent.com/SeL8ZOuBRSOqpMeuORL8WBEOgFc4iGijFK6SgKRnyYShVYtTueUtJEJrFE0_o1tJgZFU7-sTOvtN5XeulqeCGpORNIsBLiq9N50qoxZgC4V0W-7Y0anVuK83nZTnpRZdynI4Ue9c=s0)

doc/1.Setup/Updating data in CRM.md

@@ -0,0 +1,3 @@
+### Обновление данных в Simla.com
+
+Если активировать данную опцию, **любые изменения заказов из Woocommerce не будут  передаваться в CRM**. Изменения заказа из CRM в Woocomerce передаются.

doc/FAQ/FAQ.md

@@ -0,0 +1,85 @@
+## FAQ
+
+**Ребрендинг модуля с RetailCRM на Simla.com**
+
+Ребрендинг модуля WooCommerce связан с тем, что данные он востребован на зарубежном направлении и название нашей системы в Испании и ЛатАм - Simla.com. Для клиентов, которые работают с данным модулем CMS в РФ, ничего не меняется, модули будут также поддерживаться и развиваться.
+
+Прошу обратить внимание, что в связи с ребрендингом изменилось название ICML-файла названия каталога - simla.xml *(ранее было retailcrm.xml)*.
+
+Ребрендинг произошел в версии 4.3.0.
+
+**Работа с более чем одним магазином в Woo**
+
+В данный момент в модуле не предусмотрена работа с более чем 1 магазином в Woo. <br>
+ 
+**Работа с одинаковыми позициями в заказе**
+    
+Модуль поддерживает работу с одинаковыми товарными позициями в заказе начиная с версии 3.5.4 <br>
+
+**Изменения генерации ICML-файла**
+В модуле возможно сделать необходимые кастомизация для генерации ICML-файла в желаемом формате <br>
+
+**Выгрузка архивных данных** <br>
+Ранее модуль *(до версии 4.3.3)* мог выгружать не более 700-800 архивных заказов *(т.к. выгрузка происходила по web-хиту, работа скрипта была ограничена и не все данные успевали прогрузится в CRM)*, этот момент был доработан *(#70113)* и сейчас модуль загружает из Woo в CRM все присутствующие заказы пачками по 50 шт *(сделано для того, чтобы у слабых серверов не возникало проблем с загрузкой)*.
+Также заказы архивные данные можно выгрузить с использованием консольного скрипта: нужно скачать этот скрипт, загрузить его в корень сайта на сервере
+**upload_to_crm.php**  *(название файла)*
+
+    <?php
+    ​/** Load WordPress Bootstrap **/
+    require_once dirname( __FILE__ ) . '/wp-load.php';
+    do_action("wp_ajax_do_upload");
+После чего в командной строке ввести команду 
+
+> php upload_to_crm.php
+
+ тем самым запустить выполнение скрипта. Для последнего действия нужно использовать ssh.
+После выполнения данных действий дожидаемся завершение работы. При этом информация об ошибках при выгрузке заказов будет фиксироваться в разделе WooCommerce "Статус", "Журналы".
+Как скрипт завершит работу в командной строке появляется возможность ввести новую команду.
+
+**Работа с зонами доставки**  *(WooCommerce - Настройки - Доставка - Зоны доставки)*
+    
+С зонами доставки модуль не работает
+
+[https://github.com/retailcrm/woocommerce-module/blob/master/src/include/abstracts/class-wc-retailcrm-abstracts-settings.php#L256](https://github.com/retailcrm/woocommerce-module/blob/master/src/include/abstracts/class-wc-retailcrm-abstracts-settings.php#L256)
+
+Как только появляются новые методы доставки они автоматически добавляются в настройки CRM. <br>
+
+**Выгрузка вариативных товаров**
+    
+В модуле добавлен обработка всех типов товаров в WooCommerce. Раньше обрабатывались только variable/simple, теперь, если тип товара не является variation/variable + кастомные типы плагинов содержащие торговые предложения *(variable-subscription и т.п.)*, то обрабатываются как simple. Стандартные типы товаров обрабатываются корректно, но любые кастомные типы с плагинов все равно необходимо исследовать.
+
+## Причины возникновения ошибок
+
+**Не пришел заказ из Woo в CRM** <br>
+Причина может быть в Методе оплаты. Если в настройках CRM *(Настройки - Справочники - Типы оплат)* в конкретном типе оплаты не выбран статус оплаты, с которым пришел заказ из CMS, то заказ не будет выгружен в CRM. Данная проблема должна решиться после реализации задачи [#73631](https://redmine.retailcrm.tech/issues/73631).
+
+![](https://lh3.googleusercontent.com/v3W9GDMvBy9ASK6t27utB4PtsH0EkO7cxfG_317D4FWw3y5sWe9GaNeuJj_NmAR0pMLsJnAnBpCZtK3_yA2kAg50iwO2yV2m1zDfKdSYYSw-2PIXRv3j2r3d3BpaogvTS44OV1U0=s0)
+
+ **Не выгрузились корп клиенты при архивной выгрузке** <br>
+ Необходимо проверить включение данной опции в настройках модуля в WooCommerce.
+
+**В CRM не отображаются остатки по товару** / **При создании заказа в CRM, товар не списывается со склада в Woocomerce** <br>
+    
+Необходимо выключить редактирование остатков в настройках CRM *(Настройки - Системные - Склад - Разрешить редактирование остатков)*. При включенной опции количество товаров из ICML-файла будет игнорироваться при загрузке. Также для магазина, привязанного к сайту Woo, должны быть разрешены все склады.
+
+По решению проблемы должны немного помочь задачи [#54708](https://redmine.retailcrm.tech/issues/54708) и [#74803](https://redmine.retailcrm.tech/issues/74803).
+
+  
+**В CRM приходит оплаченный заказ, хотя в Woo оплаты не было** <br>
+    
+Требуется проверить активность опции “Оплата произведена” *(Настройки - Справочники - Статусы оплат)* в статусе оплаты, с которым приходит заказ в CRM.
+
+**Когда заказ создается через Woocommerce, то ему на почту приходит вся информация по заказу, а если создается через CRM, то на почту приходит чаще всего приходит пустая карточка, но не всегда, от чего это может зависеть?**  <br>
+
+Это не проблема, а логика работы нашего модуля. Модуль не отправляет письма, то есть в Woo сохраняется заказ без суммы (она проставляется чуть позже), но как только заказ появляется в Woo, срабатывает хук и отправляется письмо на email, как раз без суммы.
+
+**Работоспособность модуля** <br>
+На работоспособность модуля влияют: <br>
+**1**) Оплата модуля Онлайн-консультанта. <br>
+**2**) Для работы модуля требуются файлы generate_icml.php и retailcrm_history.php *(не удалять их)*.
+
+**Ранее заказы могли не выгружаться из WooCommerce в CRM по причинам** *(сейчас заказы выгружаются, т.к. была убрана валидация)*: <br>
+
+- **Отсутствовала страна в настройках**.  <br> Если в настройках CRM в списке доступных стран (Настройки - Системные - Общие - Список доступных стран) не была выбрана страна, указанная в выгружаемом заказе, то заказ не появлялся в CRM. После внедрения задачи [#74148](https://redmine.retailcrm.tech/issues/74148), заказы с неразрешенной страной приходят в CRM. При открытии карточки заказа, появляется pop-up с информацией о том, что указанную в заказе страну нужно добавить в настройках.
+
+- **Неразрешенный способ оплаты в доставке**.  <br> Если в настройках CRM в справочниках Типов доставок (Настройки - Справочники - Типы доставок - перейти в конкретный справочник - вкладка Способы оплаты) не был разрешен способ оплаты для доставки, указанной в выгружаемом заказе, то заказ не приходил в CRM. После внедрения задачи [#71543](https://redmine.retailcrm.tech/issues/71543), заказы с неразрешенной оплатой для доставки, выгружаются в CRM. При заходе в карточку данного заказа, появляется pop-up с информацией о том, что для доставки требуется разрешить указанный метод оплаты.