Интеграция с OnlyOffice

Модуль для предпросмотра и редактирования документов онлайн с использованием сервера OnlyOffice позволяет работать с документами в интерфейсе ELMA365 как в облачной поставке, так и в ELMA365 On‑Premises версии 0.9.0 и выше.

Особенности установки сервера OnlyOffice

Для работы требуется установленный сервер ONLYOFFICE Docs, который можно загрузить с официального сайта. Вы можете использовать бесплатную OpenSource версию, но она имеет ограничение на 20 одновременно открытых сеансов редактирования (просмотр без редактирования не ограничен).

Загрузите бесплатную версию и ознакомьтесь с инструкциями по установке OnlyOffice на официальном сайте. Обратите внимание, инструкции по установке отличаются в зависимости от варианта поставки.

начало внимание 

Для корректной работы модуля интеграции рекомендуем устанавливать OnlyOffice версии 7.4.

конец внимание

Изменение порта по умолчанию

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

Чтобы сменить порт, выполните установку сервера OnlyOffice с параметром /DS_PORT командой:

onlyoffice-documentserver-ee.exe /DS_PORT=<PORT_NUMBER>

Где onlyoffice-documentserver-ee.exe — имя исполняемого файла дистрибутива сервера ONLYOFFICE Docs, а <PORT_NUMBER> — номер порта, который вы хотите использовать для OnlyOffice.

Чтобы проверить готовность сервера работать с документами, перейдите по ссылке https://<ваш_адрес_сервера_onlyoffice>/web-apps/apps/api/documents/api.js. Откроется страница с кодом javascript.

Обратите внимание, сервер OnlyOffice должен быть настроен на работу по HTTPS и доступен в сети как пользователям, так и серверу ELMA365.

Также для корректной работы модуля на сервере OnlyOffice необходимо использовать SSL‑сертификат, выданный доверенным удостоверяющим центром. При использовании самоподписанного SSL‑сертификата в работе модуля могут возникать ошибки. Например, без дополнительных настроек на стороне браузера или приложения просмотр документов будет недоступен.

Настройка поддержки JWT

В ELMA365 поддерживается работа с JWT‑токенами, которые используются для обеспечения дополнительного уровня безопасности при аутентификации. Начиная с версии ONLYOFFICE Docs 7.2 валидация JWT включена по умолчанию. Для более ранних версий её необходимо включить.

Включение валидации JWT-токенов на стороне OnlyOffice

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

Отключение валидации JWT-токенов на стороне OnlyOffice

Установка модуля OnlyOffice в системе ELMA365

Модуль можно загрузить из каталога ELMA365 Store или в виде файла формата .e365.

Для установки модуля выполните следующие действия:

  1. В ELMA365 перейдите в раздел Администрирование > Модули и нажмите кнопку + Модуль в правом верхнем углу.

only-1

  1. В открывшемся окне перейдите в каталог ELMA365 Store или выберите ссылку Загрузить файл и добавьте файл формата .e365.
  2. Дождитесь окончания проверки и установки. Затем нажмите кнопку Перейти в модуль.

only-2

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

На открывшейся странице заполните основные поля:

only-office-3

  • Адрес сервера 365* — текущий фактический адрес в формате https://name.domain.ru/;
  • Адрес сервера OnlyOffice* — адрес до OnlyOffice в формате https://name.domain.ru/;
  • Поддерживаемые форматы* — отметьте форматы файлов, с которыми вы хотите работать в OnlyOffice. Можно отметить сразу все опции.

Затем перейдите к дополнительным настройкам:

only-office-4

  • Язык интерфейса* — укажите нужный язык интерфейса OnlyOffice. По умолчанию используется русская локализация;
  • Секрет для формирования JWT — если на сервере ONLYOFFICE Docs включена поддержка JWT, укажите в этом поле секретный ключ. Его можно скопировать в конфигурационном файле local.json в поле secret;
  • Режим совместимости* — отметьте Да. Эта опция позволяет открывать редактирование документов (приложение типа Документ) на версиях от 0.9.х до 2021.6 включительно;
  • Чат* — отключает возможности внутреннего чата OnlyOffice в режиме редактирования. Установите Нет. Это настройка относится именно к внутренней функции OnlyOffice;
  • Комментарии* — опция включает и отключает возможности внутренних комментариев OnlyOffice в режиме редактирования. Установите Нет. Это настройка относится именно к внутренней функции OnlyOffice;
  • Запуск макросов* — установите Да, чтобы включить выполнение макросов в документе;
  • Плагины* — установите Да, чтобы включить поддержку плагинов OnlyOffice;
  • Рецензирование — установите Да, чтобы при редактировании файла автоматически включался режим отслеживания изменений. Все изменения, внесённые в этом режиме, фиксируются как правки и выделяются цветом. Их можно принять или отклонить. Пользователи могут индивидуально включать и отключать отслеживание изменений при редактировании определённого документа на вкладке Совместная работа;
  • Отображение изменений — выберите, как отображаются изменения, внесённые в документ в режиме рецензирования. Опция работает для ONLYOFFICE Docs версии 7.0 и выше:
    • Подсветка — опция используется по умолчанию. Во время просмотра документа правки, добавленные в режиме отслеживания изменений, выделены цветом. При нажатии на отредактированный текст можно посмотреть автора, дату и детали исправлений. Все вносимые изменения отображаются для пользователя в реальном времени.

В режиме редактирования можно принять или отклонить правки, нажав на выделенный цветом текст;

    • Не показывать — в режиме просмотра правки не видны, пока их не одобрят. Чтобы увидеть последние принятые правки, а также изменения, внесённые с отключённым рецензированием, нужно обновить страницу. Как только все пользователи заканчивают редактирование, и новая версия документа добавляется в систему, страница обновляется автоматически.

В режиме редактирования все ещё не принятые исправления выделены цветом. Их можно принять или отклонить, нажав на них;

    • Показывать с изменениями — исправления, внесённые в режиме рецензирования, при просмотре документа отображаются без выделения, как если бы они уже были приняты. Если рецензирование отключено, в режиме просмотра можно увидеть изменение текста в моменте.

При редактировании документа правки, которые ещё не приняты, выделены цветом. Их можно принять или отклонить, нажав на них;

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

Обратите внимание, при включении упрощённой подсветки нельзя принять правки, внесённые в режиме отслеживания изменений. Они остаются выделены цветом и учитываются в системе как исправления.

После заполнения полей сохраните настройки.

Использование

После установки модуля и настройки интеграции с помощью OnlyOffice вы сможете просматривать и редактировать файлы, добавленные в  приложения типа Документ, а также в раздел Файлы.

Приложение типа «Документ»

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

only-4

Подробнее о работе с приложениями этого типа читайте в статье «Приложение типа „Документ“».

Создание документа

На форме создания элемента приложения типа Документ по умолчанию размещён виджет Загрузка файла с предпросмотром. Нажмите кнопку в центре формы и загрузите файл с компьютера.

r7-office-4

После загрузки документ отобразится на форме с помощью OnlyOffice.

Просмотр документа

На форме просмотра приложений типа Документ по умолчанию размещён виджет Просмотр файла, который используется для работы OnlyOffice.

only-office-5

Редактирование документа

Внести правки в документ можно несколькими способами:

  • перейдите на форму редактирования элемента приложения, нажав Редактировать в левом нижнем углу формы просмотра;
  • откройте полноэкранный режим редактирования, нажав Редактировать на верхней панели формы просмотра.

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

only-office-6

В режиме быстрого редактирования сервер OnlyOffice сохраняет изменения каждые несколько секунд, а если кто-то редактирует этот же документ одновременно с вами, то вы увидите его изменения в моменте.

После того как все пользователи прекратили редактировать документ, новая версия появится в системе ELMA365 в течение 5–10 секунд.

Задержка сохранения на 5–10 секунд не влияет на просмотр документа. То есть сразу после редактирования все пользователи увидят изменения, даже если кто-то продолжает редактировать документ (в этом случае новая версия ещё не появилась), или прошло менее 5–10 секунд.

Произвольная форма

Если вы используете приложение другого типа (стандартное или событие) или форма настроена в Low‑сode дизайнере, то вы можете разместить виджет Просмотр файла на форме просмотра или редактирования. Для этого в настройках виджета в поле Файл выберите свойство типа Файлы из контекста приложения.

r7-office-5

Если требуется на какой-либо форме, например, форме задачи, принудительно открыть файл на редактирование, то воспользуйтесь виджетом Просмотр и редактирование файла в OnlyOffice. В настройках виджета заполните поля:

only-office-7

  • File — нажмите на значок chain_iconи выберите свойство типа Файлы из контекста приложения или бизнес‑процесса;
  • Action — напишите «edit»;
  • Отображать в режиме редактирования — выберите Да, чтобы после загрузки файл отображался в режиме редактирования.

Все остальные параметры являются сервисными и не требуют дополнительной настройки.

На одной форме нельзя одновременно просматривать и редактировать файл в OnlyOffice, даже на разных вкладках.

При отключении расширения виджет Просмотр и редактирование файла в OnlyOffice будет сообщать об ошибке, в отличие от системных виджетов.

Раздел «Файлы»

В разделе Файлы при открытии файла, предпросмотр будет происходить в OnlyOffice.

only-office-9

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

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

После внесения изменений можно:

  • вернуться в режим просмотра, нажав на значок onlyoffice-17 в правом верхнем углу окна;
  • закрыть файл, нажав на крестик.

В систему будет добавлена новая версия файла, которая станет текущей.

Часто задаваемые вопросы

  • У меня была предварительная версия и теперь я поставил новую. Как понять, где старая, а где новая?

URL до актуальной версии: /admin/extensions/ext_265d7b04-b8c1-45d3-8d28-4dcccf25672c.

  • В браузере я вижу, что OnlyOffice работает по https, но в ELMA365 появляется ошибка Download failed.

only-14

Если ваш путь сертификации DST Root CA x3 / R3 / Ваш_сервер, то вероятно причина в устаревании сертификата R3. Данная ошибка сертификата игнорируется в браузерах.

only-15

Убедиться в этом можно, воспользовавшись сервисом проверки SSL, например, www.ssllabs.com/ssltest/analyze.html.

only-16

Для решения проблемы вам нужно использовать сертификат, где указан не только Ваш_сервер, но и путь сертификации. Обычно такой сертификат выдаётся сразу и в его названии написано +chain.