Требования к разработке подсистем#

Подсистема — часть общей информационной системы, которая имеет набор объектов, обеспечивающих функциональность в рамках АРМ, модуля и взаимодействие между собой.

Этапы разработки подсистемы#

Совет

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

  1. Планирование и анализ требований

    Цель - сформулировать требования подсистемы и определить ее размещение: общая или проектная. Рекомендуется создавать подсистему как общую, а проектные особенности реализовывать в виде отдельных правок. Проектные подсистемы в основном связаны с уникальным функционалом, как правило, интеграционными решениями.

  2. Проектирование

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

  3. Реализация

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

Работа с метаданными#

Для ведения метаданных рекомендуется использовать репозиторий, в т.ч. для отслеживания версионности.

При реализации подсистемы важно определиться с ее уникальным префиксом, который будет использоваться при инициализации соответствующих объектов, относящихся к подсистеме. Это позволяет в дальнейшем легче конфигурировать Систему. Для разрабатываемой подсистемы создаются отдельные физические сущности, так как использовать созданные ранее не рекомендуется. Исключением является таблица для хранения документов D_DOCUMENT (DocumentTable).

Вспомогательные материалы для развертывания#

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

  • Скрипты pkg_add_data. Могут создавать новые роли, заполнять справочники, подготавливать шаблонные формы отчетов, добавлять новые каталоги (в т.ч. слои и карты).

  • Стили для слоев в формате .sld + иконки

  • Шаблоны для инструмента по публикации слоев и карт (подготавливаются в формате .csv)

Большинство материалов для развертывания должны находиться там же, где и сама подсистема, например, в папке «Для установки».

../../_images/for_installation.png

Пользовательская инструкция добавляется в справку пользователя , инструкция для администраторов - в справку администратора Описание разработанной подсистемы (назначение системы, основные функции) добавляется в справку интеграторов