Вся документация

A4 для Битрикс24

В Диске коробочного Битрикс24 появляется пункт «A4». Сотрудник открывает книгу прямо из портала, правит её в браузере, а сохранение попадает в историю Диска новой версией. Администратор ставит один модуль; ядро портала не меняется, файлы остаются в Диске.

Запись с портала: книга из Диска открывается в редакторе таблиц, правка ячейки сохраняется, в истории Диска появляется новая версия.

Что умеет

  • в меню файла Диска есть пункт A4; книга .xlsm открывается в редакторе в браузере;
  • документы .docx открываются в редакторе A4, презентации .pptx — в редакторе P2; сохранение становится новой версией файла в Диске;
  • после правки ячейки и закрытия редактора в истории Диска появляется ровно одна новая версия;
  • книга с макросами сохраняется целиком: число частей файла не меняется, проект VBA остаётся байт в байт прежним;
  • сохранённую версию открывает Microsoft Excel без диалога восстановления;
  • замена предыдущего модуля переносит все настройки без повторного ввода: адрес редактора, публичный адрес портала, проверку подписи запросов и ключи организаций. Объекты Диска и их история версий остаются на месте.
Чего нет. Макросы сохраняются, но в браузере не запускаются.

Как работает

  • Где живут файлы. В Диске Битрикс24, как и раньше. История версий остаётся у того же объекта Диска.
  • Путь документа. Модуль регистрирует свой обработчик документов Диска и работает по протоколу WOPI. Сервер редакторов получает файл от портала внутри сети организации и возвращает сохранённую книгу; Диск записывает её новой версией.
  • Что не уходит из сети. Файл передаётся только между порталом, сервером редакторов в сети организации и браузером сотрудника. Ключи организаций хранятся в настройках портала и не попадают в архив модуля, журналы и документацию.
  • Чего модуль не делает. Не меняет файлы ядра портала, не назначает A4 редактором по умолчанию, не удаляет объекты Диска и их историю. Не использует и не обходит штатный платный коннектор сервера документов Битрикс24.

Требования

  • коробочный Битрикс24 с модулем «Диск»;
  • сервер редакторов A4 в сети организации и HTTPS-адрес его discovery. В комплект модуля сервер не входит;
  • публичный HTTPS-адрес портала, доступный серверу редакторов;
  • права на запись в local/modules/ и доступ к административной части портала;
  • резервная копия базы и каталога портала.

Не открывайте сервер редакторов в публичный Интернет без сетевых ограничений.

Установка

До установки

  • сделайте резервную копию базы и каталога портала;
  • закройте открытые редакторы документов;
  • сверьте SHA-256 архива модуля с SHA256SUMS.

Шаги

  1. Распакуйте ZIP модуля из комплекта в local/modules/. Итоговый каталог должен называться local/modules/a4.wopi.
  2. В административной части откройте Настройки → Настройки продукта → Модули и установите A4.
  3. В настройках модуля укажите адрес discovery сервера редакторов, публичный адрес портала и оставьте проверку подписи запросов (proof-key) включённой.
  4. Убедитесь, что открывается маршрут /a4/open.php, а в меню файла Диска появился пункт A4.

Первая проверка

  1. Загрузите в Диск отдельную контрольную копию книги .xlsm.
  2. Откройте её через A4, измените одну ячейку и дождитесь сохранения.
  3. Закройте редактор. В истории Диска должна появиться ровно одна новая версия.
  4. Скачайте новую версию и откройте её в настольном Excel. Для точной проверки сравните SHA-256 файла xl/vbaProject.bin до и после.

Обновление и откат

Замена предыдущего модуля

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

  1. Сделайте резервную копию базы и каталога портала.
  2. Закройте все редакторы и дождитесь, пока снимутся блокировки редактирования.
  3. Распакуйте ZIP модуля в local/modules/ и установите A4.
  4. Установщик сначала проверит, что прежние каталоги можно удалить. Если прав не хватает, он остановится с понятным сообщением и ничего не переключит.
  5. Установщик перенесёт адрес discovery, публичный адрес, настройку подписи запросов и ключи организаций, зарегистрирует маршруты /a4/, снимет прежний обработчик и удалит его файлы и настройки.
  6. Откройте настройки A4 — секреты вводить заново не нужно. Выполните первую проверку. История версий Диска остаётся у тех же объектов.

После замены: новый модуль зарегистрирован, прежний — нет; прежних каталогов и строк настроек не остаётся; /a4/open.php отвечает, прежний маршрут — нет; у контрольного файла сохраняются все версии.

Откат

  1. Остановите новые сеансы редактора.
  2. Восстановите базу и каталоги портала из резервной копии, сделанной до замены.
  3. Верните прежний образ сервера редакторов, если он менялся.
  4. Очистите управляемый кеш Битрикс24 и перезапустите PHP-FPM.
  5. Проверьте прежний обработчик и откройте контрольный файл без сохранения.

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

Безопасность

  • Файл хранится в Диске и передаётся редактору внутри сети организации.
  • Ключи организаций хранятся в настройках портала и не входят в ZIP, журналы, документацию и SHA256SUMS.
  • Проверка подписи запросов (proof-key) должна быть включена. Публичный адрес портала открывайте только в доверенной сети или через HTTPS-шлюз с ограничением доступа.
  • Перед заменой установщик требует закрыть активные сеансы редактирования и проверяет, что прежние каталоги можно удалить.

Типовые ошибки

Что видноЧто проверить
Пункта A4 нет в меню ДискаМодуль установлен, обработчик Диска зарегистрирован
Редактор не открылсяАдрес discovery открывается из браузера; тип файла есть в discovery
Редактор открылся, но файла нетПубличный адрес портала доступен из сети сервера редакторов
Ответ 401Срок и подпись ссылки, ключ организации
Ответ 409 при сохраненииФайл или его блокировку изменила другая сессия. Закройте старую сессию и откройте свежую версию
Новая версия не появиласьПраво пользователя на запись, активная блокировка, журнал редактора

Скачать

Комплект A4 для Битрикс24модуль 0.2.1 · идентификатор a4.wopi
Скачать комплект
ФайлРазмерНазначение
a4.wopi-0.2.1.zip171 336 байтмодуль для local/modules/
SHA256SUMS683 байтконтрольные суммы всех файлов
docs/7 файловREADME, установка, сервер редакторов (SERVER-REDAKTOROV.md), замена и откат, безопасность, история изменений, описание выпуска

Сведения о выпуске

ЧтоЗначение
Версия модуля0.2.1 (идентификатор a4.wopi)
Битрикс24коробочная версия, главный модуль 26.800.0, Диск 26.1175.0
Замена предыдущего модуляс версий 0.1.0 и 0.2.0, история версий Диска сохраняется

Контрольные суммы

99a69b3daccdb0fbdd647080279567d639236dbf618789f331b1cd0ce0528ee0  a4.wopi-0.2.1.zip
4fa63f8c8254d87b4be6f9799327ae767ec271545c9fe6deb8d9482a3de884d9  docs/BEZOPASNOST.md
929341635b929ed2bc6c7c7a9c57e2b340dd3a6c48de435e7aa9bea532b5d194  docs/CHANGELOG.md
9b37b0014dce2d8625be8f7a379081fc34404549bc5ac6f14609dc2ccc79a6d1  docs/OBNOVLENIE.md
ff6ae059ad66715bbc5dfd4a9d991545c62765a3a8210aa5097cb4cddd500b2a  docs/README.md
6aa788b0885c1f40e0301160b4aa3a86c22981548291d906e12e1b30490eab2a  docs/SERVER-REDAKTOROV.md
a301ee8019784aba080764662302a3dcbf3775732e7f3264b20bfc7b08f3be79  docs/USTANOVKA-ADMIN.md
3125c056a9a84ad36dfe76a4693237d229d549e06d4b1339dc03e576e7f72e6b  docs/VYPUSK.md

Проверка комплекта после скачивания:

shasum -a 256 -c SHA256SUMS