r_keeper

White Server Agent v2

1
Системные требования
2
Миграция с WSA v1 на WSA v2
3
Новая установка
4
Обновление агента
5
Конфигурирование агента
6
Настройка интеграции с r_keeper v7
7
Примеры конфигураций

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

Windows 7 Home (32/64)

Пакет обновления SP1 KB976932 https://www.microsoft.com/ru-ru/download/details.aspx?id=5842 (~540Мб)

Пакет обновления KB2999226 https://www.microsoft.com/ru-RU/download/details.aspx?id=49077 (<1Мб) или Visual Studio С++ 2015 Redistributable https://www.microsoft.com/ru-ru/download/details.aspx?id=48145 (~14Мб)

Пакет обновления KB2533623 https://www.microsoft.com/ru-ru/download/details.aspx?id=26767 (~1Мб)

Или подойдёт любая операционная система начиная от Windows 7 SP2 и выше.

Миграция с WSA v1 на WSA v2

Если требуется переход на новую версию агента, то обратитесь с запросом об обновлении в техническую поддержку с указанием кодов объектов, где провести обновление и желаемое время обновления.

Обратите внимание, что на второй версии агента не поддерживается первый протокол интеграции.

В случае, если по каким либо причинам новая версия агента не смогла запуститься, то произойдет автоматический откат на предыдущую версию агента. Переход на новую версию занимает 5-10 минут.

Новая установка

Первичная установка осуществляется с помощью инсталятора:

В начале установки необходимо будет выбрать (подтвердить) путь, по которому будут развёрнуты бинарные файлы:
Инсталятор сперва останавливает процессы (и удаляет службы, которые могли ссылаться на другую папку), затем распаковывает бинарные файлы в указанную папку.
.Net Core 3.0 включен в дистрибутив агента и его отдельная установка не требуется.
В конце установки необходимо будет ввести ключ лицензии WsClient:
Если Агент WhiteServer версии 2.0 и выше уже был сконфигурирован на этом компьютере ранее, то можно не вводить токен авторизации, а просто нажать "Закрыть" - хранящая на компьютере конфигурация не изменится.

Ключ лицензии можно скопировать с сайта l.ucs.ru:
По завершению установки будут созданы и запущены службы Windows для Агента и Монитора, а также будет открыта папка с данными:

Обновления агента

Обновлять агента возможно только удаленно через административную панель.

Монитор

Монитор выполняет команды с WS по каналу, отличному от WSA. Он понимает такие команды, как:
  • получение логов;
  • получение конфигурации;
  • перезапись конфигурации агента;
  • остановка/запуск агента;
  • обновление агента.
Монитор также следит за тем, чтобы Агент был виден в процессах. Если его нет, то запускает заново (если для агента разрешен запуск).

Агент следит за тем, чтобы Монитор был активен.

Конфигурирование агента

Конфигурирование агента будет производиться удалённо из административной панели.
На стороне Агента все изменения настроек будет принимать Монитор, как изменения конфигурационных файлов Агента.

Описание параметров конфигурации

Интеграция с кассовым сервером R-Keeper

Для подключения к кассовому серверу r_keeper в конфигурации Агента в административной панели WhiteServer необходимо указать IP компьютера, на котором развёрнут кассовый сервер, а также порт и ключ шифрования, которые можно узнать в станции менеджера r_keeper:
Если поле CryptKey пустое (как на картинке), можно не упоминать его в конфигурации агента.

Аналогично, если Агент развернут на том же компьютере, что и кассовый сервер, поле IP можно не указывать в конфигурации Агента. 
// Пример минимальной конфигурации подключения к r_keeper
{
    "RKeeper": {
        "TcpConnetion": {
            "Port": 2233
        }
    }
}

// Пример полной конфигурации подключения к r_keeper
{
    "RKeeper": {
        "TcpConnetion": {
            "IP": "127.0.0.1",
            "Port": 2233,
            "CryptKey": ""
        }
    }
}

Примеры конфигурации

Ниже представлены примеры конфигурации WSA v2
// Пример конфигурации Агента с настройками подключения к Web API StoreHouse 5
{
    "StoreHouse5Connection": {
        "IP": "127.0.0.1",
        "Port": "9797",
        "User": "Admin",
        "Password": "",
        "RequestTimeoutSec": 10
    }
}

// Пример минимальной конфигурации подключения к серверу справочников R-Keeper
{
    "RKeeper": {
        "RefServer": {
            "Port": 2222
        }
    }
}

// Пример полной конфигурации подключения к серверу справочников R-Keeper
{
    "RKeeper": {
        "RefServer": {
            "IP": "127.0.0.1",
            "Port": 2222,
            "CryptKey": ""
        }
    }
}

// Пример конфигурации
{
    "RKeeper": {
        "TcpConnetion": {
            "IP": "127.0.0.1",
            "Port": 2233,
            "CryptKey": ""
        },
        "OrderCreationPreferences": {
            "DefaultStationID": 15003,
            "DefaultCashierID": 1000003,
            "DefaultTableCode": 107,
            "CurrencyCode": 1,
            "PriceTypeID": 3,
            "OrderConfirmationHost": "127.0.0.1",
//далее - необязательные параметры:
            "CashierTimeoutSec": 20,
            "TradeGroupID": 3,
            "VoidingReasonCode": 1,
            "CustomExtSource": "42",
            "PickupPreferences": {
                "OrderTypeCodeForCustomerTaker": 42,
                "OrderCategoryCodeCustomerTaker": 42
            }
 
        }
    },
    "StoreHouse5Connection": {
        "IP": "172.18.2.26",
        "Port": "9797",
        "User": "Admin",
        "RequestTimeoutSec": 10
    }
}