SuiteCRM

Об интеграции ONLYOFFICE и SuiteCRM

SuiteCRM — это система управления взаимоотношениями с клиентами. ONLYOFFICE предлагает официальный модуль для интеграции ONLYOFFICE Docs с SuiteCRM, который позволяет редактировать офисные документы в вашем пространстве SuiteCRM. Модуль интеграции ONLYOFFICE можно получить на странице GitHub. Модуль распространяется по лицензии AGPL-3.

примечание

Чтобы узнать больше о том, как работает коннектор ONLYOFFICE для SuiteCRM, посетите страницу нашей документации по API.

Основные возможности

• Редактирование и просмотр текстовых документов, электронных таблиц и презентаций.

• Совместное редактирование документов в реальном времени: два режима совместного редактирования (Быстрый и Строгий), режим Отслеживание изменений, комментарии и встроенный чат.

• Создание и редактирование шаблонов форм.

  примечание

  Чтобы узнать больше о формах, прочитайте соответствующие статьи о создании и заполнении форм.

• Поддержка JWT для защиты передаваемых данных: доступ к документам есть только у пользователей с соответствующими правами.

Поддерживаемые форматы

• Для просмотра и редактирования: DOCX, XLSX, PPTX.
• Только для просмотра: PDF, ODT, ODS, ODP, DOC, XLS, PPT, PPS, EPUB, RTF, HTML, HTM, TXT, CSV.

Подключение ONLYOFFICE Docs к SuiteCRM

Требования

• ONLYOFFICE Document Server v7.1 (серверная версия) или более поздней версии

  Вам нужен экземпляр ONLYOFFICE Docs, который доступен для разрешения имени и подключения как из SuiteCRM, так и с любых клиентских устройств. Он должен иметь возможность отправлять POST-запросы напрямую в SuiteCRM.

  примечание

  Подробнее об установке ONLYOFFICE Docs читайте на официальной странице документации.

• SuiteCRM 7 (все выпуски 7.x)

• Коннектор ONLYOFFICE v1.0.0 и более поздних версий для SuiteCRM

Установка модуля интеграции ONLYOFFICE для SuiteCRM

Чтобы установить приложение ONLYOFFICE:

1. Получите последние скомпилированные файлы пакета плагина интеграции ONLYOFFICE на странице GitHub.

2. Запустите SuiteCRM и перейдите в раздел Admin > Admin Tools > Module Loader.

   

3. Загрузите архив плагина ONLYOFFICE.

4. Установите загруженный модуль, нажав кнопку Install.

5. Перейдите в раздел Admin > Admin Tools > Repair.

6. Запустите Quick Repair and Rebuild.

   

Как это работает

Взаимодействие пользователя с документом происходит как на стороне клиента, так и на стороне сервера.

Ниже объясняются основные термины, используемые в этой документации.

Клиентская часть включает:

• Менеджер документов — список документов, отображаемый в браузере пользователя. В нем пользователь может выбрать нужный документ и выполнить с ним некоторые действия (в зависимости от предоставленных прав пользователь может открыть документ для просмотра или редактирования, предоставить доступ к документу другим пользователям).
• Редактор документов — интерфейс просмотра и редактирования документов со всеми наиболее известными функциями редактирования, который служит посредником между пользователем и службой редактирования документов.

Серверная часть включает:

• Служба хранения документов — серверная служба, которая хранит все документы, доступные пользователям с соответствующими правами доступа. Она передает менеджеру документов, который пользователь видит в браузере, идентификаторы документов и ссылки на них.
• Служба редактирования документов — серверная служба, которая позволяет просматривать и редактировать документы (если у пользователя есть соответствующие права). Для доступа ко всем функциям службы редактирования документов используется интерфейс редактора документов.
• Служба команд документов — серверная служба, которая позволяет выполнять дополнительные команды со службой редактирования документов.
• Служба конвертации документов — серверная служба, которая позволяет конвертировать файл документа в соответствующий формат Office Open XML (docx для текстовых документов, xlsx для электронных таблиц и pptx для презентаций) для редактирования или скачивания.
• Служба сборки документов — серверная служба, которая позволяет легко собирать документ без необходимости запускать редактор для обработки документов.

Обратите внимание, что ONLYOFFICE Document Server включает редактор документов, службу редактирования документов, службу команд документов, службу конвертации документов и службу сборки документов. Менеджер документов и служба хранения документов либо входят в состав Community Server, либо должны быть реализованы разработчиками, которые используют ONLYOFFICE Document Server на собственном сервере.

Настройка JWT для интеграции ONLYOFFICE и SuiteCRM

JWT, или JSON Web Token, — это строка, которую клиент отправляет серверу в HTTP-запросе для проверки подлинности клиента. JWT сохраняется только на стороне клиента, поэтому передача данных между сторонами защищена и цифрово подписана.

Токен создается по стандарту JWT (JSON Web Tokens). Токены подписываются ключом сервера, поэтому клиент может убедиться, что токен подлинный.

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

В ONLYOFFICE Docs JWT включен по умолчанию начиная с версии 7.2.

Чтобы при необходимости настроить его вручную, выполните следующие действия:

1. Перейдите в раздел Admin > ONLYOFFICE > ONLYOFFICE Settings.

   

2. Введите значения в следующие поля:

   • Document Editing Service Address: укажите URL-адрес, по которому установлен ONLYOFFICE Docs (например, https://documentserver).
   • Secret key (оставьте пустым, чтобы отключить): секретный ключ генерируется автоматически, чтобы ограничить доступ к ONLYOFFICE Docs. Если вы хотите указать в этом поле собственный секретный ключ, укажите тот же ключ и в файле конфигурации ONLYOFFICE Docs, чтобы включить проверку.
   • Authorization header (оставьте пустым, чтобы использовать заголовок по умолчанию): стандартный заголовок JWT, используемый в ONLYOFFICE, — Authorization. Если он конфликтует с вашей конфигурацией, можно заменить его на пользовательский.

   

Начало работы с ONLYOFFICE Docs в SuiteCRM

Чтобы редактировать офисные файлы и совместно работать над ними:

• Перейдите в модуль Documents.
• Откройте страницу Detail View, нажав на имя файла.
• На странице Detail View выберите Open in ONLYOFFICE в раскрывающемся меню ACTIONS — файл откроется на той же вкладке.

примечание

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