Модуль для предпросмотра и редактирования документов онлайн с использованием сервера OnlyOffice позволяет работать с документами в интерфейсе ELMA365 как в облачной поставке, так и в ELMA365 On-Premises версии 0.9.0 и выше.
Особенности установки сервера OnlyOffice
Для работы требуется установленный сервер OnlyOffice Docs, который можно загрузить с официального сайта. Вы можете использовать бесплатную OpenSource версию, но она имеет ограничение на 20 одновременно открытых сеансов редактирования (просмотр без редактирования не ограничен).
Загрузите бесплатную версию и ознакомьтесь с инструкциями по установке OnlyOffice на официальном сайте. Обратите внимание, инструкции по установке отличаются в зависимости от варианта поставки.
начало внимание
Для корректной работы модуля интеграции рекомендуем устанавливать OnlyOffice ниже версии 7.2.
конец внимание
Важно: в ELMA365 не поддерживается работа с JWT-токенами, которые могут быть включены в OnlyOffice согласно инструкциям на официальном сайте. Для работы модуля интеграции рекомендуем отключить валидацию JWT-токенов.
Отключение валидации JWT-токенов на стороне OnlyOffice
supervisorctl restart all |
начало внимание
При установке OnlyOffice на один физический сервер с ELMA365, у сервера OnlyOffice нужно обязательно сменить порт по умолчанию на другой, например, 8080.
конец внимание
Чтобы сменить порт, выполните установку сервера OnlyOffice с параметром /DS_PORT командой:
onlyoffice-documentserver-ee.exe /DS_PORT=<PORT_NUMBER>
Где onlyoffice-documentserver-ee.exe — имя исполняемого файла дистрибутива сервера OnlyOfficeDocs, а <PORT_NUMBER> — номер порта, который вы хотите использовать для OnlyOffice.
Чтобы проверить готовность сервера работать с документами, перейдите по ссылке https://<ваш_адрес_сервера_onlyoffice>/web-apps/apps/api/documents/api.js. Откроется страница с кодом javascript.
Обратите внимание, сервер OnlyOffice должен быть настроен на работу по https и доступен в сети как пользователям, так и серверу ELMA365. Также для корректной работы модуля на сервере OnlyOffice необходимо использовать SSL сертификат, выданный доверенным удостоверяющим центром. При использовании самоподписанного SSL сертификата в работе модуля могут возникать ошибки. Например, без дополнительных настроек на стороне браузера или приложения просмотр документов будет недоступен.
Установка модуля в системе ELMA365
Модуль можно загрузить из каталога ELMA365 Store или в виде файла формата .e365.
Для установки модуля выполните следующие действия:
- В ELMA365 перейдите в раздел Администрирование > Модули и нажмите кнопку +Модуль в правом верхнем углу.
- В открывшемся окне перейдите в каталог ELMA365 Store или выберите ссылку Загрузить файл и добавьте файл формата .e365.
- Дождитесь окончания проверки и установки. Затем нажмите кнопку Перейти в модуль.
Настройка модуля
На странице настроек модуля заполните поля:
- Адрес сервера 365* — текущий фактический адрес в формате
https://name.domain.ru/; - Адрес сервера OnlyOffice* — адрес до OnlyOffice в формате
https://name.domain.ru/; - Поддерживаемые форматы* — отметьте форматы файлов, с которыми вы хотите работать в OnlyOffice. Можно отметить сразу все опции;
- Язык интерфейса* — укажите нужный язык интерфейса OnlyOffice. По умолчанию используется русская локализация;
- Режим совместимости* — отметьте Да. Эта опция позволяет открывать редактирование документов (приложение типа Документ) на версиях от 0.9.х до 2021.6 включительно;
- Чат* — отключает возможности внутреннего чата OnlyOffice в режиме редактирования. Установите Нет. Это настройка относится именно к внутренней функции OnlyOffice;
- Комментарии* — опция включает и отключает возможности внутренних комментариев OnlyOffice в режиме редактирования. Установите Нет. Это настройка относится именно к внутренней функции OnlyOffice.
- Запуск макросов* — установите Да, чтобы включить выполнение макросов в документе;
- Плагины* — установите Да, чтобы включить поддержку плагинов OnlyOffice;
- Отображение изменений — определите, как пользователи смогут работать с файлами в режиме редактирования по умолчанию:
- Исправления и выноски — разрешено вносить изменения в документ и просматривать выноски;
- Исходный документ — разрешено редактировать документ, отображение выносок отключено;
- Измененный документ — все изменения приняты, документ разрешено только просматривать;
- Только исправления — все изменения отклонены, документ доступен только для просмотра.
Сохраните настройки.
Использование
После установки модуля и настройки интеграции с помощью OnlyOffice вы сможете просматривать и редактировать файлы, добавленные в приложения типа Документ, а также в раздел Файлы.
Приложение типа «Документ»
Чтобы добавлять файл при создании элемента приложения и просматривать его в карточке элемента, создайте приложение и укажите в его настройках тип Документ.
Подробнее о работе с приложениями этого типа читайте в статье «Приложение типа "Документ"».
Создание документа
На форме создания элемента приложения типа Документ по умолчанию размещён виджет Загрузка файла с предпросмотром. Нажмите кнопку в центре формы и загрузите файл с компьютера.
После загрузки документ отобразится на форме с помощью OnlyOffice.
Просмотр документа
На форме просмотра приложений типа Документ по умолчанию размещен виджёт Просмотр файла, который используется для работы OnlyOffice.
Редактирование документа
Внести правки в документ можно несколькими способами:
- перейдите на форму редактирования элемента приложения, нажав Редактировать в левом нижнем углу формы просмотра;
- откройте полноэкранный режим редактирования, нажав Редактировать на верхней панели формы просмотра.
По умолчанию в OnlyOffice включён режим быстрого редактирования. При необходимости вы можете выбрать другой режим в настройках сервера OnlyOffice или переключать режим для конкретного документа вручную.
В режиме быстрого редактирования сервер OnlyOffice сохраняет изменения каждые несколько секунд, а если кто-то редактирует этот же документ одновременно с вами, то вы увидите его изменения в моменте.
После того как все пользователи прекратили редактировать документ, новая версия появится в системе ELMA365 в течение 5-10 секунд.
Задержка сохранения на 5-10 секунд не влияет на просмотр документа. То есть сразу после редактирования все пользователи уже увидят изменения, даже если кто-то продолжает редактировать документ (в этом случае новая версия ещё не появилась), или прошло менее 5-10 секунд.
Произвольная форма
Если вы используете приложение другого типа (стандартное или событие) или форма настроена в Low-сode дизайнере, то вы можете разместить виджет Просмотр файла на форме просмотра или редактирования. Для этого в настройках виджета в поле Файл выберите свойство типа Файлы из контекста приложения.
Если требуется на какой-либо форме, например, форме задачи, принудительно открыть файл на редактирование, то воспользуйтесь виджетом Просмотр и редактирование файла в OnlyOffice. В настройках виджета заполните поля:
- File — нажмите на значок
и выберите свойство типа Файлы из контекста приложения или бизнес-процесса; - Action — напишите «edit».
На одной форме нельзя одновременно просматривать и редактировать файл в OnlyOffice, даже на разных вкладках.
При отключении расширения виджет Просмотр и редактирование файла в OnlyOffice будет сообщать об ошибке, в отличие от системных виджетов.
Раздел Файлы
В разделе Файлы при открытии файла, предпросмотр будет происходить в OnlyOffice.
Чтобы перейти в режим редактирования и внести правки в документ, нажмите кнопку Редактировать в правом верхнем углу страницы с превью. После внесения изменений нажмите на крестик в правом верхнем углу окна редактирования. В систему будет добавлена новая версия файла, которая станет текущей.
Часто задаваемые вопросы
- У меня была предварительная версия и теперь я поставил новую. Как понять, где старая, а где новая?
URL до актуальной версии: /admin/extensions/ext_265d7b04-b8c1-45d3-8d28-4dcccf25672c.
- В браузере я вижу, что OnlyOffice работает по https, но в ELMA365 появляется ошибка Download failed.
Если ваш путь сертификации DST Root CA x3 / R3 / Ваш_сервер, то вероятно причина в устаревании сертификата R3. Данная ошибка сертификата игнорируется в браузерах.
Убедиться в этом можно, воспользовавшись сервисом проверки SSL, например, https://www.ssllabs.com/ssltest/analyze.html.
Для решения проблемы вам нужно использовать сертификат, где указан не только Ваш_сервер, но и путь сертификации. Обычно такой сертификат выдаётся сразу и в его названии написано +chain.