Функциональная архитектура решения

История изменений

Версия	Дата	Автор	Описание
01	16.10.2018	Кукушкин Д.В.	Исходная версия.

 

 

 

Оглавление

История изменений. 2

Оглавление. 3

1. Глоссарий. 4

2. Общие сведения. 5

2.1. Назначение документа. 5

3. Описание системы.. 5

4. Функциональная архитектура решения. 6

5. Файловый сервер. 8

5.1. Прием файлов из социальной сети. 9

5.2. Передача файлов от оператора в социальную сеть. 9

5.3. Особености работы файлового сервера с ВК. 10

6. Отказоустойчивость. 10

7. Установка приложения. 10

7.1. Требования к рабочей среде. 10

7.2. Состав ПО.. 10

7.3. Инициализация БД.. 11

7.4. Настройка конфигурационного файла. 11

7.4.1. Настройки подключения к zookeeper. 12

7.4.2. Настройки подключения к БД.. 12

7.4.3. Настройки файл-сервера. 12

7.4.4. Настройка аккаунта. 12

7.5. Настройка подключения к чат-серверу Eralink. 13

7.6. Настройка аккаунта в социальной сети ВК. 13

7.6.1. Зарегистрировать приложение. 13

7.6.2. Получение токена. 14

i. Получение токена для пользователя. 14

ii.          Получение токена для группы: 14

7.6.3. Включение бота в ВК. 15

7.7. Запуск приложения. 16

 

Глоссарий

Термин	Определение
ПО	Программное обеспечение.
Базовое ПО	Программы для ЭВМ и другие результаты интеллектуальной деятельности, неисключительные права использования которых, получены или должны быть получены Заказчиком от Производителя ПО.
Genesys	Производитель ПО, реализующий средства для организации контактных центров.
Проект	Комплекс взаимосвязанных мероприятий, направленный на выполнение работ или оказание услуг, в том числе, но не ограничиваясь созданием Системы или ее части, в условиях временных и ресурсных ограничений.
Система	Взаимосвязанная совокупность информационных, технических, программных, математических, организационных, лингвистических, технологических и других средств, предназначенная для автоматизации бизнес-процессов Заказчика, в том числе, но не ограничиваясь сбором, обработкой, хранением и выдачей информации, и принятием управленческих решений.
Документация	Набор инструкций для различных типов пользователей, который будет разработан Исполнителем в ходе оказания услуг или выполнения работ, согласно Договору, и который не заменяет Документацию Производителя ПО.
Вендор	Производитель программ для ЭВМ Genesys (Правообладатель), обладающий необходимым объемом полномочий по предоставлению неисключительных прав использования Базового ПО Заказчику.
КЦ	Контактный центр.
АРМ	Автоматизированное рабочее место.
Клиент	Потребитель услуг Заказчика.
Обращение	Единичный контакт Клиента в КЦ Заказчика по любому из цифровых каналов.
Интеракция	Синоним Обращения в терминологии Genesys. Отдельный диалог с Клиентом, имеющий свой идентификатор.
API	Программный интерфейс приложения - набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) или операционной системой для использования во внешних программных продуктах.
WDE	Genesys Workspace Desktop Edition – десктопное приложение, обеспечивающее функциональность АРМ агента КЦ.
WWE	Genesys Workspace Web Edition – веб приложение, обеспечивающее функциональность АРМ агента КЦ.
ВК	Социальная сеть “ВКонтакте”(https://vk.com)
Коннектор	Коннектор Eralink к ВК

 

 

Общие сведения

Назначение документа

Документ описывает коннектор Eralinkдля социальной сети “ВК” в части личных сообщений, включая:

• Описание функциональной архитектуры решения;

• Описание установки и настройки коннектора

Описание системы

Коннектор позволяетреализовать:

· Прием личных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от клиента группе ВК

· Отправкаличных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от группы ВК клиенту

· Прием личных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от клиента пользователю ВК

· Прием личных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от пользователя клиенту ВК

· Отправку кастомной клавиатуры в личном сообщенииклиенту

При работе коннектора с социальной сетью «ВКонтакте» существует ряд ограничений, которые являются особенностями социальной сети. Перечень ограничений:

· Ограничение на количество запросов к ВК 3 для пользователя, 20 для группы

· Максимальная длина сообщения — 4096 символов;

· Максимальное количество вложений — 10 штук;

· Максимальный размер фотографии — 50 мегабайт;

· Максимальный размер произвольного файла— 200 мегабайт;

· Нельзя отправить исходящее сообщение пользователю, если:

o У пользователя в настройках приватности выставлены ограничения по приему сообщений;

o Пользователь добавил вас в черный список.

· Пользователь не может инициировать исходящее сообщение в адрес сообщества, в случае если его добавили в черный список сообщества;

· В случае выполнения большого количества операций за короткое время, может возникнуть необходимость по вводу «капчи»;

· Количество минут, которые пользователь будет иметь статус «онлайн» после бездействия в социальной сети «ВКонтакте» равно 15 минутам;

· Ответ от имени сообщества в адрес пользователя может быть выполнен не позднее 10 дней;

· Отмена ограничения, связанного с необходимостью ввода «капчи» должно быть оговорено между Заказчиком и представителями сети «ВКонтакте»;

· Нет возможности сформировать ссылку на конкретное сообщение пользователя, при этом есть возможность сформировать ссылку на диалог с пользователем;

· Получение аудиозаписей невозможно

· Кроме того, социальная сеть «ВКонтакте» может иметь прочие ограничения, влияющие тем или иным способом на обработку взаимодействий (Отсутствия API, логические ограничения и так далее).

 

Файловый сервер

Файловый сервер является состовной частью любого коннектора Eralink. Файловый сервер отвечает за получение, хранение, передачу файлов из социальный сети на АРМ и обратно.

Отказоустойчивость

Коннекторы могут работать в двух режимах: Primaryи Backup. Режим работы коннектора задается для каждого аккаунта индивидуально. То есть коннектор может по одному аккаунту быть Primary, а по другому Backup,это сделано чтобы ошибка обработки одного аккаунта не влияла на другой. При этом по каждому аккаунту только один коннектор работает в режиме Primary. Изначально коннектор стартует в режиме Backup, и в этом режиме он не принимет и не отправляет сообщения. При переходе в Primaryстартует монитор забирающий сообщения из ВК. При переходе в режим Backup монитор останавливается.

Установка приложения

Требования к рабочей среде

На сервере должна быть установлены:

· Javaверсии 8 или выше.

· Dwebp для конвертации файлов

В рабочей среде должны буть установлены и настроены:

· Zookeeper

· БД(Oracleверсии 12 или выше, MSSQL 2008 или выше), для которой должен быть предостален пользователь с правами на сохранение и чтение данных, вызов процедур.

· Настроеный чат-сервер Eralink

Коннектор и операторы должны иметь доступ к следующим хостам:

· pp.userapi.com

· api.vk.com

· *.vk.com

Состав ПО

В состав стандартной поставки ПО входят:

· vk.jar – основной файл коннектора

· vk-deps.jar – файл со сторонними библиотеками

· application.conf – файл конфигурации коннектора

· logback.xml – конфигурационный файл логгирования

· start.batилиstart.sh – файл для запуска коннектора

Инициализация БД

Для работы коннектора ВК должны существовать следующие таблицы (скрипты приведены для Oracle, для других БД создаются по аналогии):

CREATE TABLE "VK_MESSAGE_MONITOR" (

 ownerId number NOT NULL,

 lastMessageId number NULL,

 ADD_DATE TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL,

 UPDATE_DATE TIMESTAMP NULL

);

CREATE TABLE LONG_POLL_UPDATES (

update_id NUMBER NOT NULL,

status NUMBER(1) NOT NULL,

account VARCHAR2(50) NOT NULL

);

CREATE TABLE LONG_POLL_STATE (

account VARCHAR2(50) NOT NULL,

offset NUMBER NOT NULL

);

Такжееслиещенебылисозданыследуетдобавитдветаблицыдляработыфайловогосервера
CREATE TABLE "FILES"(ID number GENERATED ALWAYS AS IDENTITY NOT NULL,

FILENAME varchar2(512),

FILE_SIZE number,

SECURE_KEY varchar2(64),

CONTENT blob,

ADD_DATE timestamp DEFAULT CURRENT_TIMESTAMP,

constraint FILES_INDEX_PK primary key (ID)

);

CREATE TABLE "CHANNEL_FILES"(ID number GENERATED ALWAYS AS IDENTITY NOT NULL,

FILE_ID number NOT NULL,

SPECIAL_ID varchar2(4000) NOT NULL,

CHANNEL_NAME varchar2(128) NOT NULL,

constraint CHANNEL_FILES_INDEX_PK primary key (ID)

);

ALTER TABLE "CHANNEL_FILES" ADD CONSTRAINT CHANNEL_FILES_FILE_ID_FK

FOREIGN KEY (FILE_ID) REFERENCES "FILES"(ID);

Запуск приложения

Скопируйте все файлы поставки в рабочую директорию и запустите start.batили start.sh.

 

[ДК1]https://altcrm.altuera.com:18011/plantuml/uml/bLF1IiD04BttAuQUxG-8yGiy25wz50rIY4a8HV3M1aIaGb4yzI3qv3KjniRMR7zXvezyixQ5cZMjB2pPsNbltiwyU1wFs729bVDSKZRI8-dZ8-C5nKddkftS7gmYqfEKU2azBdW1r0Sm9HSozBn6t4wwdOjEt0wxnCyysWvKQcnVF_7BLg39RwYMjgJFEQfDTMys74fRnnPCXyGpA5Pf1g12Kdc4KdjO8F_Ted8w3n4mzZL6XYeUGPx_vkNCLUoejIbMPQxoDhGD5bIbSkezYSAhqoW8plpanaz-uFf05zoL-uzIctaELjAn9lAmdcTzxLrWp-EnDL29xbZJS8dSJuA47AOf-4i_Cvw0C9K1mJv15CK04hyYUsblfvXBLk473RQPzPW2QvNYQC1Z73frFau_ERsdN6Q7CXaIJqdkA-WTnXqZS6TvozLqzdVfFXrJNKP_N0FRggXi3RVzS_hypoRKDxJMXRLGFxmazS0t

[ДК2]https://altcrm.altuera.com:18011/plantuml/uml/rLBBIiDG5DpdAoxPvmUA-2-5PY4KD_e1QUe3iQ22A-b2GN2RHgEfCRU_CEUFdEGsQHfZSuihAGHwphbpvioCYoTekK2A29dCa2EI6oKJ91BAp5NUeS83DEiv4dnAoEb03Oe9pTz2hbZE-JmnfJS-3F1EbAB1uXc1byYS3XHYktWsVJPZkSRIh0uG5rzte8YS4uFZ-28eYP8UT8sBnEd1A4-umxtXBETiH2KDm_hd0gIj1HtK3xn-waUZ3KZa3CUdzLz5RGEYBMHQwDn1h3WoBcdplDqEsL311_ih5hHCjdrAURN6Q_FWg7UbZN6ryN-pfy7AFnufglXhabx8ClJQDBfoshAcysd9wnQFcDk1c5cxJA_OoMGgbpIQWcwqsWv9Iuz68YmLtTlstRXCsjgfYgy_Fl7_VK2hNDd8MWLY_VOR

[ДК3]https://altcrm.altuera.com:18011/plantuml/uml/dPDD2e9G58NdhkBXt0r4j8Qs83Ln4X4kGEsFAAYWKJGe29fQ85YIRU7S7NLVbfMzr49GzDtptNFFnRhPiQs6rJPRjj2nGKm3XF0HqGHd-3GLv28WZoQwLd-fnH8n5vmHu4GUovotOnrRXXmHSTM1nZWc60S7US-WvbXan3lkxEL9PbXZfIKFOTIA-bNaQqnz_k2pvr3E8wYNIBG2iUHBZnb88448KWpyXv-gKUp7QYg4jq4KioUT-ThJwDdNpK2KqflvZrrLH2dYfx1KrhZmIKHT6lwTzFy83l--h5-QAX9AzTzIoFrPb2j3c5Al

История изменений

Версия	Дата	Автор	Описание
01	16.10.2018	Кукушкин Д.В.	Исходная версия.

 

 

 

Оглавление

История изменений. 2

Оглавление. 3

1. Глоссарий. 4

2. Общие сведения. 5

2.1. Назначение документа. 5

3. Описание системы.. 5

4. Функциональная архитектура решения. 6

5. Файловый сервер. 8

5.1. Прием файлов из социальной сети. 9

5.2. Передача файлов от оператора в социальную сеть. 9

5.3. Особености работы файлового сервера с ВК. 10

6. Отказоустойчивость. 10

7. Установка приложения. 10

7.1. Требования к рабочей среде. 10

7.2. Состав ПО.. 10

7.3. Инициализация БД.. 11

7.4. Настройка конфигурационного файла. 11

7.4.1. Настройки подключения к zookeeper. 12

7.4.2. Настройки подключения к БД.. 12

7.4.3. Настройки файл-сервера. 12

7.4.4. Настройка аккаунта. 12

7.5. Настройка подключения к чат-серверу Eralink. 13

7.6. Настройка аккаунта в социальной сети ВК. 13

7.6.1. Зарегистрировать приложение. 13

7.6.2. Получение токена. 14

i. Получение токена для пользователя. 14

ii.          Получение токена для группы: 14

7.6.3. Включение бота в ВК. 15

7.7. Запуск приложения. 16

 

Глоссарий

Термин	Определение
ПО	Программное обеспечение.
Базовое ПО	Программы для ЭВМ и другие результаты интеллектуальной деятельности, неисключительные права использования которых, получены или должны быть получены Заказчиком от Производителя ПО.
Genesys	Производитель ПО, реализующий средства для организации контактных центров.
Проект	Комплекс взаимосвязанных мероприятий, направленный на выполнение работ или оказание услуг, в том числе, но не ограничиваясь созданием Системы или ее части, в условиях временных и ресурсных ограничений.
Система	Взаимосвязанная совокупность информационных, технических, программных, математических, организационных, лингвистических, технологических и других средств, предназначенная для автоматизации бизнес-процессов Заказчика, в том числе, но не ограничиваясь сбором, обработкой, хранением и выдачей информации, и принятием управленческих решений.
Документация	Набор инструкций для различных типов пользователей, который будет разработан Исполнителем в ходе оказания услуг или выполнения работ, согласно Договору, и который не заменяет Документацию Производителя ПО.
Вендор	Производитель программ для ЭВМ Genesys (Правообладатель), обладающий необходимым объемом полномочий по предоставлению неисключительных прав использования Базового ПО Заказчику.
КЦ	Контактный центр.
АРМ	Автоматизированное рабочее место.
Клиент	Потребитель услуг Заказчика.
Обращение	Единичный контакт Клиента в КЦ Заказчика по любому из цифровых каналов.
Интеракция	Синоним Обращения в терминологии Genesys. Отдельный диалог с Клиентом, имеющий свой идентификатор.
API	Программный интерфейс приложения - набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) или операционной системой для использования во внешних программных продуктах.
WDE	Genesys Workspace Desktop Edition – десктопное приложение, обеспечивающее функциональность АРМ агента КЦ.
WWE	Genesys Workspace Web Edition – веб приложение, обеспечивающее функциональность АРМ агента КЦ.
ВК	Социальная сеть “ВКонтакте”(https://vk.com)
Коннектор	Коннектор Eralink к ВК

 

 

Общие сведения

Назначение документа

Документ описывает коннектор Eralinkдля социальной сети “ВК” в части личных сообщений, включая:

• Описание функциональной архитектуры решения;

• Описание установки и настройки коннектора

Описание системы

Коннектор позволяетреализовать:

· Прием личных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от клиента группе ВК

· Отправкаличных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от группы ВК клиенту

· Прием личных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от клиента пользователю ВК

· Прием личных сообщений, содержащих текст (файлы,изображения, видео, аудио, стикеры), от пользователя клиенту ВК

· Отправку кастомной клавиатуры в личном сообщенииклиенту

При работе коннектора с социальной сетью «ВКонтакте» существует ряд ограничений, которые являются особенностями социальной сети. Перечень ограничений:

· Ограничение на количество запросов к ВК 3 для пользователя, 20 для группы

· Максимальная длина сообщения — 4096 символов;

· Максимальное количество вложений — 10 штук;

· Максимальный размер фотографии — 50 мегабайт;

· Максимальный размер произвольного файла— 200 мегабайт;

· Нельзя отправить исходящее сообщение пользователю, если:

o У пользователя в настройках приватности выставлены ограничения по приему сообщений;

o Пользователь добавил вас в черный список.

· Пользователь не может инициировать исходящее сообщение в адрес сообщества, в случае если его добавили в черный список сообщества;

· В случае выполнения большого количества операций за короткое время, может возникнуть необходимость по вводу «капчи»;

· Количество минут, которые пользователь будет иметь статус «онлайн» после бездействия в социальной сети «ВКонтакте» равно 15 минутам;

· Ответ от имени сообщества в адрес пользователя может быть выполнен не позднее 10 дней;

· Отмена ограничения, связанного с необходимостью ввода «капчи» должно быть оговорено между Заказчиком и представителями сети «ВКонтакте»;

· Нет возможности сформировать ссылку на конкретное сообщение пользователя, при этом есть возможность сформировать ссылку на диалог с пользователем;

· Получение аудиозаписей невозможно

· Кроме того, социальная сеть «ВКонтакте» может иметь прочие ограничения, влияющие тем или иным способом на обработку взаимодействий (Отсутствия API, логические ограничения и так далее).

 

Функциональная архитектура решения

Ниже представлена общая схема взаимодействия с другими частями системы

 

Коннектор отвечает за прием и отправку сообщений в ВК. Коннектор инициирует все запросы, входящих запросов от ВК нет. Структурно коннектор состоит из следующих функциональных частей:

· Коннектор к Eralink. Входная точка приложения. Отвечает за подключение к системе Eralink.

· Коннектор к ВК. Отвечает за подключение к ВК

· Монитор. Отвечает за вычитывание сообщений из ВК. Монитор запускается для каждого аккаунта указанного в конфигурации.

При старте приложения запускаются коннекторы к Eralink и ВК. Если приложение переходит в режим Primary(подробнее в разделе Отказоустойчивость) то запускаются мониторы. При старте мониторы запрашивают в ВК данные оLongPollServer, с помощью которого в дальнейшем будут получены сообщения из ВК. После получения LongPollServer из ВК запрашиваются старые необработанные сообщения.Вычитанные старые сообщения и сообщения полученные через LongPollServer собираются в одну группу, из которой удаляются дубликаты, а оставшиеся сообщения сортируются по идентификатору сообщения из ВК. Далее сообщения передаются в коннектор к Eralink, который отправляет их в чат-сервер Eralink. После выхода на стационарный режим работы все сообщения приходящие через LongPollServer сразу передаются на коннектор к Eralink, для отправки на чат-сервер Eralink.
[ДК1]

Файловый сервер

Файловый сервер является состовной частью любого коннектора Eralink. Файловый сервер отвечает за получение, хранение, передачу файлов из социальный сети на АРМ и обратно.