Введение

r_keeper CRM — система лояльности и учета клиентов. В этой статье описывается установка и настройка. Информация об использовании программы можно найти в  руководстве пользователя. 

Сокращения

  • CRM  — r_keeper CRM
  • Брандмауэр  — фаерволл, firewall — сетевой экран
  • Конфигуратор  — приложение RKeeper_CRM_Config.exe
  • FC  —  Farcards

Состав системы

CRM состоит из нескольких модулей:

  • Основные модули
    • RKeeper_CRM_Server  — сервер карт. Основной сервер, работает с базой данных
    • RU_Server  — сервер приложений. Работает с пользователями и отчетами
    • RKeeper_CRM_Config  — приложение для настройки карточной системы, пользователей и отчетов
    • RKeeper_CRM_Manager  — приложение редактора карт
    • RKeeper_CRM_Monitor  — сервер автоматических процессов
    • User_Manager  — приложение для управления пользователями
  • Дополнительные модули
    • PluginLoader  — приложение для просмотра отчетов
    • IRFeatureServer  — Feature Server для интерактивных отчетов
    • CommonServer
    • Farcards  — сервер ретранслятора запросов. Передает информацию из CRM в r_keeper_7.

CRM хранит данные в базе MS SQL. 

Системные требования

Минимальные системные требования ниже:

  • Оперативная память — 512 МБ
  • Процессор: x86/x64 1.4 ГГц
  • Место на жестком диске — 8 Гб
  • MS SQL server 2012

Если на компьютере установлен брандмауэр, его предварительно надо настроить. Настройка описана в статье  настройка брандмауэра для работы MS SQL

Установка CRM

Скачайте установщик CRM с FTP-сервера:  ftp://ftp.ucs.ru/R-Keeper.CRM/versions/
Запустите установщик от администратора. Выберите язык, согласитесь с лицензионным соглашением и укажите путь установки. Следуйте указаниям инсталлятора.


Выберите устанавливаемые компоненты.
IR plugin,  IR Feature server,  Common server  — необязательные компоненты.


Укажите порты для Feature Server


Укажите порты для  UCS Common Server


По желанию, выберите свои SSL-сертификаты для Common Server


Укажите настройки подключения к серверу MS SQL 


Укажите имя базы данных CRM и путь к базе данных card system


Укажите IP-адрес и порт сервера приложений


Выберите, какие приложения установить как службы. Выберите, каким приложениям сделать ярлык на рабочий стол.

Первоначальная настройка

Подключение к базе данных

Настройки подключения к базе данных SQL указываются во время установки. Проверить и поменять их можно в конфигураторе.
Откройте конфигуратор. Настройки подключения к SQL указаны в разделе  Сервер карт:

Формат строки подключения в поле База данных:

IP,port:имя_базы_данных
CODE

Указанная база данных должна существовать в MS SQL. Нажмите кнопку  Проверка подключения. Если ошибок не появилось — подключение прошло успешно. 

Настройка пользователей и отчетов

Теперь необходимо настроить подключение к базе данных приложение управления пользователями. Для этого:

  1. В разделе  Приложение выберите  Управление пользователями и отчеты.
  2. В поле  Строка подключения укажите строку подключения к базе данных MS SQL.
  3. Нажмите кнопку  в поле Строка подключения и настройте подключения к базе данных.
  4. Выберите  Microsoft OLE DB Provider for SQL Server  и нажмите  Далее >>
  5. Укажите IP-адрес сервера базы данных. По желанию, через запятую можно указать порт
  6. Укажите имя пользователя и пароль с правами на базу данных CRM
  7. Нажмите кнопку  Проверить соединение
  8. После успешной проверки, выберите базу данных:
  9. Нажмите  ОК
  10. Нажмите кнопку  Зарегистрировать сервер приложений. После удачного завершения кнопка  Отменить регистрацию сервера приложений станет активной.
  11. Нажмите кнопку и закройте конфигуратор.

Лицензирование

  1. CRM требует лицензирования. Получите мастер-лицензию на подходящее количество карт на сервере лицензирования. Процесс подробно в статье о системе лицензирования.
  2. После получения мастер-лицензии, сгенерируйте код лицензии без кода запроса. Для этого в меню Редактирования объекта нажмите кнопку Новая лицензия > Далее, не вводя код запроса.
    1. В поле программа введите CRM и выберите вашу мастер-лицензию
    2. Укажите требуемую дату или нажмите кнопку max date
    3. Укажите требуемое количество лицензий в поле Кол-во*
    4. Нажмите Далее.
  3. В сервере карт перейдите на вкладку Лицензии
  4. Введите свои данные дилера в полях Пользователь и Пароль. Нажмите кнопку Авторизоваться под дилером:
  5. Пользователь и пароль в системе не сохраняются. Выберите из выпадающего списка объект и нажмите кнопку Запросить лицензию для объекта.
    1. Если объектов много и требуется найти свой, Нажмите кнопку  над кнопкой Запросить лицензию для объекта
    2. Подведите мышку к столбцу Код
    3. Нажмите появившуюся кнопку со значком фильтра
    4. Выберите (Custom...)
    5. Введите код объекта напротив поля Like:
    6. Нажмите ОК. Система найдет указанный объект.
  6. В поле Дата окончания справа появится информация о лицензии.
  7. Если объектов много и требуется найти свой, воспользуйтесь мини-инструкцией ниже:
    1. Нажмите кнопку  над кнопкой Запросить лицензию для объекта
    2. Подведите мышку к столбцу Код
    3. Нажмите появившуюся кнопку со значком фильтра
    4. Выберите (Custom...)
    5. Введите код объекта напротив поля Like:
    6. Нажмите ОК. Система найдет указанный объект.
  8. Как объект найден, нажмите кнопку Запросить лицензию для объекта

Проверка связи и запуск

Запустите сервер карт — RKeeper_CRM_Server.exe.  В трее должен появиться значок . Нажмите правой кнопкой мыши на значке сервера и выберите Восстановить.
Перейдите в раздел Общее. Убедитесь, что сервер CRM подключился к базе данных. Если подключился, информация о подключении появится в правом поле:

Если путь к базе отсутствует или версия базы данных не указана, то CRM не будет работать. Попробуйте посмотреть статью по решению проблем.

Серверы CRM можно запускать как приложения или как службы. Для запуска приложениями запустите ярлыки на рабочем столе. ​

  • Запустите сервер карт — RKeeper_CRM_Server
  • Запустите сервер приложений   — RU_Server
  • Запустите сервер автоматических процессов —  RKeeper_CRM_Monitor

Значки всех серверов должны появиться в трее.  Для установки служб запустите серверы с ключом /install.

Запустите приложение  User_Manager.exe  и авторизуйтесь под пользователем Администратор, пароль —  1.

Измените пароль администратора. Нажмите правой кнопкой мыши на пользователя Администратор > Задать пароль

Нажмите Ctrl+S или значок дискаты  для сохранения.
По желанию, создайте пользователя с меньшим количеством прав. 

Запустите редактор карт —  RKeeper_CRM_Manager.exe  и авторизуйтесь. CRM готова к использованию. 

Настройка связи с r keeper 7

Для проверки интеграции  обязательно  наличие владельца карт и выпущенных карт. Создание владельцев и карт описано в  статье о выпуске карт, рекомендуем ознакомиться.

Схема работы

Интеграция систем CRM и r_keeper работает через ретранслятор карт  Farcards. Схема взаимодействия приложений изображена ниже.

После установки запустите службу Borland Socket Server. 

Настройка в менеджерской станции

Создайте на кассовом сервере PDS интерфейс

  1. Перейдите в  Сервис > Станции и устройства > Кассовый сервер
  2. Нажмите правой кнопкой мыши в разделе устройства и добавьте на кассовый сервере драйвер PDS interface
  3. В настройках интерфейса укажите имя в поле  PDS Server Name. Остальные настройки оставьте по умолчанию
  4. Привяжите драйвер к логическому интерфейсу:
    1. Перейдите в  Сервис > Интерфейсы
    2. Создайте новый интерфейс
    3. В разделе  Файлы библиотек (DLL)  выберите нужный ресторан
    4. В поле  Кассовый сервер выберите ранее созданный драйвер
    5. Сохранитесь и сделайте интерфейс активным.
    6. Перезапустите кассовый сервер.

Перейдите в меню  Сервис > Обработка сигналов устройств > MCR алгоритмы   и создайте алгоритм для CRM.

  1. Нажмите правой кнопкой мыши в левом поле и создайте новый алгоритм
  2. Укажите  название  созданному алгоритму
  3. В свойствах алгоритма укажите:
    1. Тип алгоритма —  обработка по маске
    2. Типы устройств —  все
    3. Область —  интерфейс
    4. Объект — выберите ранее созданный  PDS-интерфейс. В нашем случае это  PDS for CRM
    5. Маска обработки — укажите требуемую маску. Почитать подробнее о деталях настройке можно в  статье об MCR-алгоритмах. В нашем примере укажем маску  ii, т.е. 2 любых цифры
      Учтите, что после указания маски, на кассе  вы должны указывать именно такое количество символов, что и в маске. В нашем случае маска содержит 2 символа, а карта — №1. Соответственно, будем вводить  01.
  4. Активируйте алгоритм и сохраните изменения.

Настройка в CRM

Ниже описаны минимально необходимые настройки для интеграции с r_keeper_7.

Классификатор ПО

Настройте классификатор ПО для связи с r_keeper.

  1. Запустите сервер RKeeper_CRM_Server и приложение RKeeper_CRM_Manager.
  2. Перейдите в меню Файл > Классификаторы ПО
  3. Нажмите кнопку
  4.  или Insert на клавиатуре 
  5. Укажите название созданному классификатору в поле Название. В нашем случае, это классификатор для связи с r_keeper_7, поэтому назовем его  RK7.
  6. Укажите код для связи с r_keeper_7 в поле код. Воспользуйтесь кнопкой для генерации кода. Существует 3 вида кодов:
    1. Цифровой код dec, например 13864531741260458068
    2. Цифровой код hex, например 4BAA2CD24FF1E4E14B9E
    3. Буквенно-цифровой код, например iWjseh69x1b7lWuH9UG5
  7. Перейдите на вкладку  Права API  и поставьте галочку  Разрешить отображение в API CRM
  8. Нажмите внизу кнопку чтобы сохранить изменения
  9. Укажите сгенерированный код в файле FARCARDS.INI, настройка Qualifier

Счета

Мы будем настраивать связь с r_keeper_7 со скидками и бонусами.

Перейдите в меню Справочники > Типы счетов. 

  1. Создайте типы счетов. Нажмите кнопку или Insert на клавиатуре:
    1. Потраченные средства. Это единственный обязательный тип счета
    2. Дебетовый
    3. Дисконтный
    4. Бонусный
  2. Укажите названия в поле Название
  3. Выберите класс для созданных счетов:
    1. Потраченные средства  для потраченных средств
    2. Дебетовый  для дебетового
    3. Дисконтный  для скидочного
    4. Бонусный  для бонусного
  4. В правой части окна перейдите на вкладку Классификаторы ПО. Нажмите правой кнопкой мыши на пустом поле и выберите Настройка работы с классификаторами
  5. Выберите классификатор в левом поле — поставьте галочку у RK7
  6. Выберите тип счета в правом поле — поставьте галочку у одного типа счета.
  7. В нижнем выпадающем меню выберите Разрешить и поставьте обе галочки — Списание и Начисление
  8. Нажмите кнопку Применить
  9. Повторите действия  5 пункта  для всех типов счетов по очереди
  10. Для  бонусного счета  во время настройки укажите  приоритет 101
  11. В результате, к каждому типу счета будет привязан классификатор  RK7 и разрешено списание и начисление:
    • Бонусный
    • Дисконтный
    • Дебетовый
    • Потраченные средства
    • Обязательно нажмите галочку  Списание  и убедитесь, что там тоже классификатор появляется
  12. Настройка завершена, нажмите Закрыть.

Настройка схем

Если вы планируете работать с бонусами, создайте схемы. Подробное описание есть в статье о работе с бонусами

Важно!

Не указывайте временные периоды и базовую ставку у схем.

Настройка Farcards

Установка Farcards

Скачайте Farcards c FTP-сервера по адресу ftp://ftp.ucs.ru/R-Keeper.CRM/versions/FС_604.zip и распакуйте в папку.
Откройте файл FARCARDS.INI. В параметре NetServerName укажите имя созданного PDS-интерфейса:

[pds_netk]
NetServerName=
    FARCARDS
  
ininame=netk.ini
DebugMessages=1

В поле Address укажите настройки подключения к серверу CRM — IP-адрес:порт. Порт по умолчанию — 9192.
В поле Qualifier укажите код ранее созданного классификатора ПО.

[Card System 5]
Address=http://
    localhost
  :
    9192
  
Log_Level = 10
Log_Count = 5
Qualifier = 
    12695640651268910253

Сохраните изменения.

Копирование библиотеки

Farcards и CRM — разные продукты, хотя и используют одинаковые библиотеки. В связи с этим и недальновидностью разработчиков, необходимо каждый раз проверять версию библиотеки RKeeper_CRM.dll в папке Farcards и bin у CRM.

Для правильной работы Farcards, скопируйте с заменой файл RKeeper_CRM.dll из папки установки CRM: \CRM\bin в папку установки Farcards.

После замены файла, запустите Farcards и кассовый сервер.

Обратите внимание

Обновлять файл RKeeper_CRM.dll в папке Farcards необходимо каждый раз при обновлении CRM.

Активация карты на кассе

Запустите кассовый сервер, farcards и кассовую станцию.

  1. Создайте заказ на кассе.
  2. Если используете быстрый чек, нажмите в правом нижнем углу кнопку  Код с клавиатуры
  3. Если используете Создание заказа, нажмите кнопку Доп > Код с клавиатуры
  4. Укажите  код карты  в CRM. Указывать требуется  именно то количество символов, что и в маске MCR-алгоритма. В нашем случае, это 2 символа.
  5. Нажмите кнопку для продолжения
  6. Если интеграция работает и карта с указанным номером существует, на кассе отобразится карточка клиента. В карточке клиента отображается информация о владельце:
  7. Для применения карты на кассе  нажмите на картинку. 
  8. В нашем примере мы проверяли работу интеграции. Подробнее о скидках и бонусах читайте в руководстве пользователя.