Убедитесь, что у вас есть доступ администратора к вашему аккаунту Bitrix24, так как следующие действия требуют данных прав.

Требования к установке коннектора

Коннектор поддерживает работу коробочной версии Bitrix24 не ниже 20.300.

Для корректной работы коннектора необходим PHP версии не ниже 7.4., а также агенты, запущенные из cron с частотой 1 раз в минуту.

Получение токена авторизации в вашем рабочем пространстве

Для того, чтобы подключить Bitrix24 в качестве источника данных, в первую очередь потребуется получить токен доступа в вашем рабочем пространстве Yva.ai.

Чтобы получить токен, необходимо создать новый источник данных на странице «Администрирование - Управление источниками». Типом источника необходимо выбрать «API интеграции».

Назвать источник можно на ваше усмотрение. Рекомендуем использовать название, которое будет определять какой это конкретно источник. Например, «Bitrix24».

После нажатия на кнопку «Настроить» вы попадете на страницу, где сможете получить необходимые для подключения Bitrix24 данные.

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

done

Итого, в результате этого шага у вас должны остаться данные для подключения.

Для облачной установки:

Адрес установки: например, https://eeu.yva.app/api/integration/2.0/sources/settings
Токен доступа: <тот, который вы получили в результате создания источника>
CODE

Для on-premises установки:

Адрес установки: <адрес, который вы настроили для установки вашей Yva.ai>
Токен доступа: <тот, который вы получили в результате создания источника>
CODE

Установка модуля

Установка модуля осуществляется в разделе «Marketplace - Установленные решения».

Выберите «QSOFT Yva.ai коннектор» и нажмите «Установить».

На первом шаге установки потребуется указать путь к папке для размещения логов модуля. Путь указывается от корня сервера.

На следующем шаге установки необходимо указать конечную точку, к которой будет обращаться коннектор. Вы можете скопировать ее на странице «Администрирование - Управление источниками», выбрав подключенный источник Bitrix24.

Конечной точкой является ссылка на вашу развертку Yva.ai.

Пример: https://eeu.yva.app/

На следующем шаге установки необходимо указать токен авторизации, полученный на странице «Администрирование - Управление источниками».

На следующем шаге будет отображено сообщение об успешной установке модуля или список ошибок в случае их возникновения во время установки модуля. Также на экране будет показано требование о необходимости запуска агентов через cron для корректной работы модуля.

Настройка модуля

Доступ к настройкам осуществляется через «Настройки - Настройки продукта - Настройки модулей - QSOFT Yva.ai коннектор».

Вкладка «Настройки»

На вкладке «Настройки» располагаются основные настройки модуля.

Параметры по умолчанию расчитаны для наиболее оптимальной работы коннектора и его быстродействия нашими инженерами. Мы настоятельно не рекомендуем самостоятельно менять параметры по умолчанию без запроса со стороны технической поддержки Yva.ai, так как это может повлиять на быстродействие коннектора.

Параметры не предусматривают валидацию на текущем этапе реализации.

Параметр

Описание

Значение по умолчанию

Токен авторизации

Токен для доступа к платформе Yva.ai, указанный при установке.

-

Максимальный размер запроса (МБ)

Максимальный размер отправляемого пакета в платформу в Мб. В случае превышения размера пакета при формировании, та часть, на которую превышен размер, будет передана в следующем пакете.

8 Мб

Время задержки для повторения запроса к Yva.ai в случае ошибки (Минуты)

Время, на которое будет отложен текущий процесс обращения к Yva.ai в случае получения одной из перечисленных ошибок на запрос к Yva.ai - 408, 429, 503, 504, 524.

60 минут

Время задержки для повторения запроса к Yva.ai в случае постоянной ошибки (Минуты)

Время, на которое будет отложен текущий процесс обращения к Yva.ai в случае получения ошибок, не упомянутых в предыдущем пункте.

1440 минут

Начальная глубина краулинга

Дата в UTC, до которой передаются сообщения для пользователя. Неизменяемый параметр, получаемый запросом к Yva.ai. Информационное поле.

Endpoint

Адрес развертки Yva.ai, к которой обращается коннектор.

При изменении данного параметра необходимо будет заново запускать агенты.

Метод для получения настроек

Метод, которому обращается коннектор для получения начальной глубины краулинга.

При изменении данного параметра необходимо будет заново запускать агенты.

api/integration/2.0/sources/settings

Путь для сохранения логов

Полный физический путь к папке с логами, указанный при установке модуля.

-

Ночная синхронизация

Переключатель синхронизации на период с 22:00 до 8:00. Данная настройка сделана для того, чтобы иметь возможность не нагружать сервер днем, во время работы пользователей. При переключении данная настройка будет применена на следующий день.

Включено

Вкладка «Отправка пользователей»

На вкладке «Отправка пользователей» располагаются настройки, связанные с алгоритмом отправки пользователей в развертку Yva.ai и получения данных о пользователях, по которым осуществляется сбор данных.

Параметры по умолчанию расчитаны для наиболее оптимальной работы коннектора и его быстродействия нашими инженерами. Мы настоятельно не рекомендуем самостоятельно менять параметры по умолчанию без запроса со стороны технической поддержки Yva.ai, так как это может повлиять на быстродействие коннектора.

Параметр

Описание

Значение по умолчанию

Метод для отправки пользователей

Метод, к которому обращается коннектор для передачи информации о пользователях в платформу Yva.ai. При первой синхронизации передаются данные по всем пользователям, в дальнейшем передается разница между состоянием на момент начала последней отправки и на момент начала новой отправки. Коннектор забирает всех пользователей, у которых статус active, есть email и заполнен атрибут «департамент».

api/integration/2.0/sources/users

Метод для получения пользователей, по которым осуществляется сбор данных

Метод, к которому обращается коннектор для получения данных о пользователях, по которым необходимо получать сообщения (для которых включен сбор пассивных данных).

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

Такого пользователя необходимо отключить в Yva.ai.

api/integration/2.0/sources/users

Максимальное количество пользователей в запросе

Количество пользователей в одном отправляемом пакете к Yva.ai.

50

Периодичность полной синхронизации

Период, через который осуществляется проверка на существование изменений в данных о пользователях (добавление/изменение данных) для их передачи в Yva.ai.

30 минут

Периодичность получения из Yva.ai пользователей, у которых включен сбор пассивных данных

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

30 минут

Лимит выборки

Количество пользователей, передаваемых в рамках одной сессии синхронизации.

500

Дата последней отправки пользователей

Дата завершения последней сессии отправки пользователей. Информационное поле.

-

Дата последнего получения пользователей

Дата завершения последней сессии получения пользователей. Информационное поле.

-

Периодичность докраулинга пользователей

Период, через который осуществляется докраулинг данных

1440 минут

Вкладка «Отправка сообщений»

На вкладке «Отправка сообщений» располагаются настройки, связанные с алгоритмом отправки сообщений в развертку Yva.ai.

Параметры по умолчанию расчитаны для наиболее оптимальной работы коннектора и его быстродействия нашими инженерами. Мы настоятельно не рекомендуем самостоятельно менять параметры по умолчанию без запроса со стороны технической поддержки Yva.ai, так как это может повлиять на быстродействие коннектора.

Параметр

Описание

Значение по умолчанию

Метод для отправки сообщений

Метод, к которому коннектор обращается для отправки сообщения. Сообщения загружаются в платформу из публичных и приватных чатов. Наиболее важная информация, получаемая из сообщений - упоминания, в которые пишутся мейлы упоминаемых в сообщениях пользователей. Если в чате до 10 человек включительно, то упомянутыми считаются все юзеры в чате. Упоминания используются для построения кругов сотрудничества. В коннекторе также есть настройка не забирать текст сообщений.

api/integration/2.1/activity

Максимальное количество сообщений в одном запросе

Количество сообщений в рамках одного пакета к Yva.ai

100

Максимальное количество запросов в течении сессии

Количество пакетов, которые будут отправлены за одну сессию

10

Частота синхронизации Activity для каждого отдельного пользователя (в минутах)

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

Необходимо учитывать, что синхронизация может занимать длительное время, поэтому в начале синхронизации фиксируется время ее начала. Все данные, отправляемые в Yva.ai будут актуальны на это время. Все данные, добавленные после начала, будут переданы в рамках следующей синхронизации, вне зависимости от протяженности текущей.

30 минут

Дата последней отправки сообщений

Дата и время, когда сообщения были последний раз отправлены в Yva.ai. Информационное поле

-

Периодичность получения и сохранения/обновления актуальной глубины краулинга из Yva Integration API и запуска докраулинга, в случае ее изменения (в минутах)

Частота синхронизации глубины краулинга с целью досинхронизации сообщений за предыдущие периоды при изменении в платформе Yva.ai

30 минут

Частота докраулинга Activities.

Частота проверки и инициализации сессии докраулинга активностей.

Необходимо учитывать, что синхронизация может занимать длительное время, поэтому в начале синхронизации фиксируется время ее начала. Все данные, отправляемые в Yva.ai будут актуальны на это время. Все данные, добавленные после начала, будут переданы в рамках следующей синхронизации, вне зависимости от протяженности текущей.

Значение должно быть не менее 1 часа, в минутах

60 минут

Количество одновременно синхронизируемых пользователей в рамках докраулинга

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

10

Отправлять текст сообщений

При включении данной настройки текст сообщений будет отправляться в платформу Yva.ai.

Выключено