Приложение Меню документов

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

«Меню документов»

Введение

Документ описывает функциональные характеристики программы «Меню документов» (далее— «Система»), а также содержит информацию, необходимую для ее установки и эксплуатации.

Документ с общим описанием Системы состоит из трех разделов:
1. Назначение Системы и Ф ункциональные возможности.
2. Интерфейс системы.
3. Руководство по эксплуатации.
4. Настройка структуры интерфейса.
5. Стоимость.

В разделе «Назначение Системы» приводятся сведения о целях использования и основных функциях, которые реализует Система. В разделе «Интерфейс Системы» описан порядок взаимодействия пользователя с элементами интерфейса. Раздел «Руководство по эксплуатации» содержит информацию о минимальных требованиях к программному обеспечению для корректной работы Системы, а также о последовательности действий, обеспечивающих запуск, выполнение и завершение работы Системы. Раздел «Настройка структуры интерфейса» содержит подробную инструкцию по работе с редактором интерфейса Системы. В «Стоимость» указана модель размещения Системы и сумма подписки.

Назначение Системы

Система «Меню документов» предназначена для структурирования и централизованного управления доступом к шаблонам документов и бизнес-процессам внутри портала Битрикс24.

Функциональные возможности
Система представляет собой пользовательский интерфейс, встроенный в CRM Битрикс24, с помощью которого можно:

Создавать произвольную структуру разделов и подразделов с настраиваемыми названиями;
Назначать каждой кнопке определённое действие — генерацию документа или запуск бизнес-процесса;
Управлять структурой интерфейса с помощью встроенного редактора;
Оперативно запускать шаблонные документы или бизнес-процессы из карточки сделки;
Конфигурировать визуальные параметры (цвета, порядок, заголовки) элементов интерфейса.

Эксплуатационное назначение Системы
Система предназначена для следующих категорий пользователей:

Администратор — доступ к настройке структуры, правам и редактированию конфигурации.
Операционный пользователь (менеджер по продажам, сотрудник CRM) — доступ к созданию документов из интерфейса сделки.
Наблюдатель — доступ только к просмотру структуры и документов, без возможности изменения и запуска.

Права доступа к Системе определяются на стороне Битрикс24 и зависят от ролей пользователя в CRM. Только пользователи с административными правами имеют доступ к редактору структуры и настройкам интерфейса. Обычные пользователи могут инициировать создание документов и бизнес-процессов, если соответствующие кнопки настроены и доступны.
В зависимости от назначенной роли пользователю может быть доступен различный набор функций:

Просмотр структуры документов;
Запуск генерации документа или бизнес-процесса;
Редактирование структуры и параметров кнопок (только для администраторов).

Интерфейс Системы

Интерфейс Системы доступен через веб-браузер в составе портала Битрикс24. Поддерживается работа во всех современных браузерах. Интерфейс полностью интегрирован в Битрикс24 и адаптирован под различные разрешения экранов, что позволяет использовать Систему как на компьютерах, так и на мобильных устройствах. Язык интерфейса — русский.
Сотрудник с административными правами на портале Битрикс24 получает доступ к расширенному функционалу Системы, включая:

Настройку структуры разделов и документов;
Добавление, удаление и переименование элементов;
Назначение типа действия каждой кнопки (создание документа или запуск бизнес-процесса);
Указание параметров визуального отображения (заголовки, цвет, порядок).

Для выполнения операций по настройке структуры необходимо перейти в приложение «Меню документов» из главного меню CRM или из карточки сделки. При наличии административных прав становится доступна кнопка «Настройки», открывающая редактор структуры.
Редактирование структуры осуществляется через визуальный интерфейс, основанный на древовидном представлении JSON-структуры. Добавление, изменение или удаление элементов производится через контекстное меню и управляющие элементы интерфейса.

Руководство по эксплуатации

Требования к программному обеспечению
Для корректной работы Системы «Меню документов» необходимо наличие действующего аккаунта в Битрикс24 с правами администратора для настройки структуры документов, а также стандартного доступа к CRM для пользователей. Система функционирует в среде веб-браузера без необходимости установки дополнительного ПО. Поддерживаются все актуальные версии браузеров (Google Chrome, Mozilla Firefox, Microsoft Edge, Safari).

Доступ и запуск
После установки приложения из Маркета Битрикс24, доступ к нему появляется:

В левом меню CRM;
В карточке сделки (основной способ для создания документов).

Для запуска Системы:

Откройте приложение «Меню документов» из CRM или карточки сделки;
При первом входе предоставьте все запрашиваемые разрешения;
Настройте интерфейс под ваши нужды;
Для работы с документами перейдите в нужный раздел и выберите требуемый подраздел.

Навигация и взаимодействие

Для создания документа необходимо открыть сделку, перейти в подраздел и нажать на кнопку с названием документа.
Кнопки запускают либо шаблон документа, либо бизнес-процесс, в зависимости от типа (doc или bp).
Время создания документа зависит от сложности шаблона: от 1 секунды до 1–2 минут для бизнес-процессов.

Режим редактирования (только для администраторов)

Войти в приложение с правами администратора.
Нажать на кнопку «Настройки» в верхней части интерфейса.
Нажать «Обновить» — загрузятся текущие данные.
Добавлять, удалять и изменять элементы структуры можно через контекстное меню объектов.
После внесения изменений необходимо нажать «Сохранить», затем перезагрузить страницу.

Ограничения и особенности

Пользователи без административных прав не имеют доступа к редактированию структуры.
Для корректной генерации документов требуется наличие актуальных шаблонов и корректно настроенных бизнес-процессов на стороне Битрикс24.
Время выполнения операций по созданию документов через БП зависит от количества полей и логики внутри шаблона.
Битрикс24 ограничивает длительность выполнения бизнес-процесса по генерации документа (до 1 минуты).
Соблюдение указанных требований и порядка действий обеспечивает стабильную и предсказуемую работу Системы.

Настройка структуры интерфейса

Общие сведения
Настройка структуры интерфейса Системы «Меню документов» доступна пользователям с административными правами на портале Битрикс24. Интерфейс представляет собой визуальный редактор, работающий с древовидной структурой, описывающей разделы, подразделы и кнопки-документы. Изменения в структуре позволяют настраивать доступные пользователям действия — генерацию документов или запуск бизнес-процессов.

Редактор интерфейса доступен после нажатия на кнопку «Настройки» в верхней части окна приложения (доступна только администраторам).

Этапы настройки

Открытие редактора

Перейдите в приложение «Меню документов» через главное меню CRM или из карточки сделки.
При наличии административных прав появится красная кнопка «Настройки» — нажмите на неё.

Загрузка текущей структуры

Нажмите кнопку «Обновить» в нижней части редактора.
Если структура загружена корректно, параметр object примет ненулевое значение.

Добавление нового раздела (пункта меню)

Нажмите кнопку «Добавить» — появится новый объект.
В контекстном меню слева выберите тип Object.
Разверните объект sections, затем перетащите добавленный объект в массив sections, зажав кнопку с шестью квадратиками.
Переименуйте объект:
id — уникальный идентификатор (следующий по порядку номер).
title — отображаемое название раздела.
color — цвет фона (например, primary, success, warning text-dark, и др.).

Создание подразделов и документов

Внутри раздела создайте параметр items типа array.
В массив items добавляйте объекты с параметрами:
title — название подраздела;
docs — массив типа array, содержащий документы.

Добавление документа

В массив docs добавьте объект с параметрами:
title — название кнопки документа;
doctype — тип действия:
doc — генерация документа по шаблону;
bp — запуск бизнес-процесса.
numtype — ID шаблона документа или бизнес-процесса (определяется в адресной строке или в списке шаблонов в Битрикс24).

Сохранение и применение изменений

После внесения всех изменений нажмите кнопку «Сохранить».
Обновите страницу для применения новой структуры.

Пример: Добавление раздела с двумя кнопками

{
  "sections": [
    {
      "id": "1",
      "title": "Документы сделки",
      "color": "primary",
      "items": [
        {
          "title": "Коммерческое предложение",
          "docs": [
            {
              "title": "Создать КП",
              "doctype": "doc",
              "numtype": "101"
            }
          ]
        },
        {
          "title": "Финансовые документы",
          "docs": [
            {
              "title": "Счёт на оплату",
              "doctype": "bp",
              "numtype": "204"
            }
          ]
        }
      ]
    }
  ]
}

Варианты цветов (color)

primary — синий
success — зелёный
danger — красный
warning text-dark — жёлтый
info text-dark — голубой
light text-dark — белый
dark — чёрный

Для обеспечения читаемости рекомендуется добавлять text-dark при использовании светлого фона.

Особенности и рекомендации

Названия id должны быть уникальными внутри структуры.
При добавлении новых объектов рекомендуется ориентироваться на структуру уже существующих элементов.
Для сложных документов через БП учитывайте лимит времени выполнения в Битрикс24 (до 1 минуты).
Все данные редактируются вручную через визуальный JSON-интерфейс — изменение должно быть точным и последовательным.

Эта структура позволяет гибко настраивать меню документов под конкретные бизнес-процессы компании без необходимости изменения кода или повторной установки приложения.

Видео-инструкция

Демонстрация работы приложения и настройка интерфейса Системы.

Стоимость

Приложение «Меню документов» распространяется по подписочной модели через официальный Маркет Битрикс24.

Для использования приложения необходимо оформить подписку на Маркет Битрикс24. Стоимость подписки устанавливается и взимается напрямую Битриксом, узнать подробнее подробнее. Приложение входит в состав подписки и не требует отдельной оплаты.

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