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

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

Архив с исходным кодом решения доступен по ссылке.

Для работы с проектом "Решения" необходимы:

  1. Visual Studio 2013 или выше. Для сборки проекта библиотеки карточек требуется Visual Studio 2013.

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

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

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

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

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

Для данного решения будут созданы:

  • Библиотека карточек и её компонент.

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

  • Модуль расширения Консоли настройки (далее — SnapIn).

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

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

Чтобы решение было законченным, также потребуются:

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

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

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

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

Архив решения имеет следующую структуру:

  • bin — каталог с основными сборками Docsvision, использованными в проекте компонента карточки.

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

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

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

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

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

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

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

  • NetstatSolution.Snapin — каталог с проектом модуля расширения Консоли настройки Docsvision.

  • NetstatSolutionCard — каталог с проектом компонента карточки, а также его объектной моделью.

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

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

Идентификаторы некоторых сущностей (к примеру, идентификатор библиотеки карточек) используются в нескольких компонентах, что будет обозначено дополнительно в тексте. Таким идентификаторам будет присвоено уникальное название.