Пример разработки решения

В данном практическом примере содержится типовой сценарий разработки решения.

Ссылка на пример на GitHub: NetStatSolution.

Пример рассчитан на версию Web-клиента dv6 или выше.

Перечень необходимых инструментов:
  • NodeJS v22.14.0 и выше

  • Visual Studio 2022 и выше.

  • WiX Toolset — для сборки пакетов установки. Последняя версия доступна на странице проекта.

  • Установленные клиентские компоненты базовых модулей Docsvision (обязательно Платформа, Windows-клиент), совместимые с платформой Docsvision версии 6.1 и выше.

Основные сведения

Пример, приведенный в данном разделе, содержит полный сценарий создания собственного решения (на платформе Docsvision) для учёта сетевого оборудования организации и сбора статистики его отказов, а также исходные коды всего проекта.

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

Для данного решения будут созданы:
  • Библиотека карточек и её компонент.

  • Карточка учёта сетевого оборудования и её компонент.

  • Два пакета установки: клиентская и серверная части.

  • Объектная модель карточки учёта сетевого оборудования.

  • Расширение Web-клиента для добавления кнопки создания карточки учёта сетевого оборудования в диалог создания карточек.

  • Web-расширение для оформления кнопки создания карточки.

  • Решение с разметками создания, просмотра и редактирования карточки учёта сетевого оборудования.

Также введём дополнительное требование на совместимость карточки с конструкторами Docsvision, чтобы иметь возможность настраивать разметку карточки при помощи конструктора разметок.

Чтобы решение было законченным, также потребуются:
  • Бизнес-процесс Проверка доступности сетевых узлов, который должен фиксировать факт изменения доступности сетевого устройства.
    Непосредственная реализация логики проверки не предусмотрена.

  • Выгруженные настройки справочника видов карточек, конструктора разметок, конструктора состояний и другие.

  • В качестве примера, экземпляр карточки учёта сетевого оборудования, который предполагается загружаться в Docsvision при установке решения. В собственном решении подобным образом может быть загружен шаблон карточки.

Данное руководство сопровождается исходными кодами всего решения, в том числе пакетов установки, а также схемами библиотеки карточек и карточки.

Описание файлов проекта

  • Binaries — каталог для размещения готовых сборок.

  • CardDefs — каталог со схемами карточки учёта сетевого оборудования и библиотеки модуля учёта сетевых устройств, а также их ресурсами.

  • CardLib — каталог с проектом (C#) компонента библиотеки карточек.

  • CardPackage — каталог с данными справочников и конструкторов, выгруженных из базы данных Docsvision. Используются на этапе формирования CardPackage и SqlPackage.

  • Database — каталог с файлом, определяющим путь к файлу с метаданными библиотеки карточек. Используются на этапе формирования CardPackage и SqlPackage.

  • Installers — каталог сборки пакетов установки.

  • NetstatSolution.Cards — каталог с проектом компонента карточки.

  • NetStatSolution.ObjectModel — каталог с объектной моделью карточки.

  • NetstatSolutionClientInstaller — каталог с проектом пакета установки клиентской части решения.

  • NetstatSolutionInstaller — каталог с проектом пакета установки серверной части решения.

  • NetStatSolutionServerExtension — расширение Web-клиента для добавления кнопки создания карточки учёта сетевого оборудования в диалог создания карточек.

  • NetStatSolutionWebExtension — web-расширение для оформления кнопки создания карточки.

  • Solution — каталог решения с разметками создания, просмотра и редактирования карточки учёта сетевого оборудования.