OnBoard Help

Модуль BPM2B OnBoard Help добавляет в платформу BPM2B контекстную справку и интерактивные пошаговые экскурсии (guided tours). Бейдж в правом нижнем углу автоматически отслеживает текущий роут (controller + action + options) и подсказывает пользователю, что именно делать на этом экране.

Основные функциональные возможности:

• Контекстная справка по роуту: бейдж слушает событие routed, извлекает {controller, action, options}, фильтрует служебные ключи через app.onboardHelp.keysToExclude и запрашивает релевантные материалы у GET /OnBoarding.
• Сущности туров: GuidedTour привязывается к connector+action(+options); GuidedTourItem описывает один шаг с CSS-селектором, заголовком и описанием; туры и шаги связаны M:N через guidedTourGuidedTourItem с колонкой order.
• Запуск тура (Intro.js): при наличии тура в текущем контексте кнопка «Guided Tour» запускает Intro.js — подсветка DOM-элементов, шаги Next / Prev / Done, прогресс-бар, оверлей.
• WYSIWYG-редактор туров: прямо на странице админ выбирает элемент кликом — библиотека finder.js генерирует CSS-селектор; dom-to-image делает скриншот; шаги перетаскиваются drag & drop.
• Help Side Panel на карточке: сущность KnowledgeBaseArticle расширена полями helpParent, helpParentEntity, helpMode (detail&edit / detail / edit); side panel detail-help подтягивает статью для конкретной записи или для типа сущности.
• Strategy Pattern для разрешения статьи: HelpArticle ищет Espo\Custom\Classes\HelpArticle\{Scope}Type → Espo\Modules\{module}\Classes\HelpArticle\{Scope}Type → дефолтный HelpArticleType — расширяемое сопоставление сущности и статьи.
• Демо-импорт: в админ-панели есть кнопки «Импорт статей» и «Импорт туров» — модуль грузит предустановленные KB-статьи и туры из PHP-файлов через insertOnDuplicateUpdate().

Модуль предназначен для проектов с большим числом операторов и сложной системой: контекстная справка снимает нагрузку с поддержки и ускоряет онбординг. Зависит от bpm2bNavbarViews ≥ 2.0.0 (бейдж на навбаре) и bpm2bCore ≥ 2.1.0.