Построение документационного отчета

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

Получить доступ к редактору отчетов можно через систему меню "Tools / Report Designer". Выбор этого пункта меню переводит разработчика в режим настройки отчетов с использованием шаблонов, которые формируются на основании сформированных отчетов. Добавление нового отчета переводит разработчика в режим настройки элементов отчета, где определяются основные объекты и их свойства. При этом изначально разработчик должен определиться с наименованием отчета и его типом: Logical (логическая модель), Physical (физическая модель), Logical/ Physical (логико-физическая модель).

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

Тип отчета (Report Туре) используется для идентификации множества объектов и их свойств, доступных разработчику для формирования отчета. В случае использования третьего типа отчета (логико-физическая модель) для его построения будут использоваться все имеющиеся в инструментальном средстве объекты логического и физического уровней моделирования со всеми свойствами, которыми они обладают. При использовании первых двух вариантов типов отчета разработчику будут предложены только те объекты, которые соответствуют выбранному уровню моделирования: логическому или физическому.

Ниже области определения имени и типа отчета разработчику предлагается, используя закладку "Report Design", выбрать объекты (левая область) и их свойства (правая область), а в закладке "Definition" разработчик может дать содержательное описание формируемого отчета, обеспечивая полное понимание сути формируемого отчета, поскольку настройки отчета, по сути, являются шаблонами отчетов для использования во множестве моделей базы данных и правильное понимание особенностей формируемого отчета позволяет правильно его использовать (рис. 3.33).

Рис. 3.33. Диалоговое окно настройки элементов отчета

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

Например, при необходимости публикации в отчете диаграммы модели разработчику необходимо выбрать в левой области объект "Subject Area" (рабочая область) и в правой области указать характеристику "Graphical Members", ниже уровня которой специфицировать, какие объекты диаграммы нужно отобразить в картинке модели, включая указание сущностей, атрибутов, ключей, связей и множества других элементов.

Аналогичным образом разработчик указывает необходимость использования в отчете сведений о сущностях, умолчаниях, связях и прочих объектах. Описание всех выделенных элементов модели базы данных будет представлено в табличном виде, разделенном по типам объектов на отдельные мини-отчеты.

Формируя отчет, разработчик определяет в рамках одного мини-отчета не более одного объекта модели базы данных, но набор характеристик объекта позволяет создать достаточно большое количество сведений, выводимых в отчет. Основное окно отчетов разделено на две части (рис. 3.34), где в левой области показывается список отчетов, настроенных для экспорта (выгрузки), а в правой области — результат выполнения отчета, включающего в себя определение элементов модели, по которым строится отчет.

Рис. 334. Подготовленный набор отчетов для формирования и экспорта

По окончании выполнения отчета, вызываемого из диалогового окна настройки отчета с помощью кнопки "Run Report" (запустить отчет) или через контекстное меню отчета "Run" (запустить), разработчик может его экспортировать в текстовые данные для использования в офисном средстве MS Excel или в формат HTML для открытия в браузере (рис. 3.35).

Рис. 335. Пример отчета но сущностям модели

В случае формирования отчета по диаграмме модели базы данных генератором отчетов формируются непосредственно картинка модели и в отдельных элементах "Tabular" (списочно) и "Hierarchical" (иерархически) — описание используемых в диаграммах объектах: сущности, связи, умолчания и т.д., — в зависимости от того, какие элементы были выбраны разработчиком при настройке отчета по диаграмме (рис. 3.36).

Рис. 336. Пример отчета по диаграмме модели базы данных

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