SellOut+ Connector

SellOut+ Connector — программный комплекс, позволяющий получать и синхронизировать данные из сервиса SellOut+ и записывать их в базу данных на стороне клиента.

Дистрибутив

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

Компоненты. Для организации процесса синхронизации данных используются:

  • База данных – Для хранения синхронизируемых данных и информации о процессе синхронизации.

  • Приложение Connector — Консольное приложение синхронизации данных.

  • SellOut+ API – Интерфейс обмена передачи данных из базы данных SellOut+.

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

  • SQL Server 2014

  • Windows Server 2008

  • .NET Framework 4.8

  • 40Gb свободного места на диске

  • 1Gb свободного места ОЗУ

Принцип работы

  • SellOut+ Connector обращается к SellOut+ API по протоколу HTTPS с токеном для авторизации. Токен предоставляется сотрудниками SellOut+ на запрос по почте.

  • Получает список изменений в данных с момента последней синхронизации.

  • На основе полученных данных добавляет, обновляет и удаляет данные в базе данных SellOut+ Connector.

  • Информация о сессиях синхронизации записывается в подпапку приложения Log\, а так же в таблицы:

    • api.Session - сессии синхронизации.

    • api.Request - запросы API.

Установка

Состав поставки

  • архив с утилитой коннектора

    • bin\ – Директория с компонентами приложения.

    • Log\ – Директория c логами коннектора, создается автоматически при первом запуске коннектора.

    • Connector.exe – Исполняемый файл коннектора.

    • Connector.exe.config – Файл конфигурации коннектора.

Параметры установки

В файле Connector.exe.config необходимо задать значения параметров синхронизации:

  • Token – Идентификатор для доступа к источнику данных. Обязательный параметр.

  • apiUrl – Ссылка на приложение (сайт). Например, "https://app.sellout.plus/demo".

  • Параметры подключения к БД назначения:

    • connectionString — Строка подключения к БД.

      • data source — Имя SQL-сервера. Для указания локального сервера нужно указать 'localhost'.

      • catalog — Имя БД. Если Базы с таким названием нет, то приложение создаст её.

      • user id — Имя пользователя с типом аутентификации SQL Server Authentication.

      • password — Пароль пользователя.

Параметры в файле connector.exe.config, требующие редактирования

Порядок установки

  • Распаковать приложение коннектора из архива.

  • Задать параметры подключения к БД и токен для синхронизации в файле Connector.exe.config.

  • Настроить расписание запусков коннектора SOP_ConnectorUpdate в планировщике Windows. При каждом запуске данные в базе коннектора будут синхронизироваться с данными из SellOut+. Типовая настройка – ежедневный ночной запуск.

    Настройка расписания запусков коннектора
    Настройка расписания запусков коннектора

Проверка установки и работоспособности

Для проверки того, что в БД (параметр catalog) появились таблицы, необходимо выполнить скрипт ниже. Им же можно проверить наполнение таблиц после синхронизации.

declare @S varchar(max) = ''

select @S += 'select ''' + TableCode + ''' as [Table], count(*) as [Count] from ' + TableCode + ' (nolock) union all' + char(13) + char(10)
from etl.Object

set @S = left(@S, len(@S) - 12) + char(13) + char(10) + 'order by [Table] desc'

exec (@S)

Обслуживание БД коннектора

Со временем может расти лог файл БД коннектора. Это может привести к расходу места на диске, на котором развернута БД коннектора. Рекомедуется:

  • Настроить модель восстановления БД в SQL Server Management Studio:

    • Развернуть список БД на сервере

    • Кликнуть ПКМ на БД коннектора, в контекстном меню выбрать Properties

    • В открывшемся окне переместиться в раздел Options

    • Установить для опции Recovery Model значение Simple

  • Периодически сбрасывать лог файл БД коннектора. Для этого нужно:

    • Кликнуть ПКМ на БД коннектора, в контекстном меню выбрать Tasks -> Shrink -> Files

    • В опции File type выбираем Log. Жмем на OK

    • После завершения проверяем размер Log файла на диске

Удаление коннектора

Для полного удаления SellOut+ Connector необходимо выполнить следующие шаги:

  1. Остановить работу коннектора

    • Если в Планировщике задач Windows настроено задание SOP_ConnectorUpdate, удалить его или отключить.

      Удаления из планировщика задач

    • В Диспетчере задач Windows проверить, запущен ли процесс Connector.exe. Если он выполняется, завершить его.

  2. Удалить базу данных коннектора

    • Подключиться к серверу SQL Server.

    • Найти базу данных, имя которой указано в параметре catalog файла Connector.exe.config.

    • Кликнуть ПКМ по базе данных и выбрать Delete.

    • Подтвердить удаление.

  3. Удалить файлы приложения

    • Удалить директорию, в которую был распакован архив коннектора.

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