Документация с гиперссылками на диаграммы в Enterprise Architect?

Я изо всех сил пытаюсь включить всю необходимую (и только необходимую) информацию в документацию моего проекта Enterprise Architect. Точно: мы смоделировали различные требования и отобразили исходные «стандарты» для этих требований на наших диаграммах с помощью элемента «гиперссылка» из общего набора инструментов. (Это позволяет нам записать заголовок, веб-сайт, на котором находится документация, и описание этой документации).

Теперь этот элемент отображается на диаграмме, но не в представлении пакета нашей модели, и он не создается в нашей документации Word (docx).

Я вижу, что это должно быть возможно получить в документации, потому что «Отчет по модели», который в основном печатает все, печатает гиперссылки. Но я не могу найти то, что мне нужно выбрать в моем шаблоне (в представлении дерева пакетов, как поле пакета, поле элемента или поле диаграммы), чтобы это напечатать. Я не могу просто использовать отчет по модели, поскольку он в основном выводит всю базу данных в документ, и обратное проектирование этого отчета по модели оказалось для меня слишком сложным. На самом деле я ожидал, что это будет в какой-то документации для EA, но не смог найти такого с таким уровнем детализации ... есть ли воспроизводимый способ найти такие вещи в дальнейших случаях? (кстати, я использую EA 11.0)

[извините, здесь были иллюстрации, но мне не разрешено их загружать ...]


person Antony Robert    schedule 30.04.2015    source источник
comment
Если вы добавляете ссылку на иллюстрации, пользователь с большей репутацией часто включает их в свой вопрос. Если это поможет прояснить вопрос, вам обязательно стоит это сделать.   -  person Geert Bellekens    schedule 30.04.2015


Ответы (3)


Как уже отмечал Герт, существует разница между «правильными» элементами и элементами, представляющими только диаграммы. Это фактически отражено в редакторе шаблонов документов, где есть раздел «Элемент» внутри раздела «Диаграмма». Это даст результат для всех элементов диаграммы, независимо от того, находятся ли они также в браузере проекта или нет.

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

Диаграмма

... и шаблон, который выводит имя, псевдоним и гиперссылку для каждого элемента на диаграмме:

Шаблон

... EA сгенерирует документ следующего содержания:

Документ

Поэтому, если вы хотите, чтобы гиперссылка приводила к гиперссылке в документе, используйте поле HyperlinkAlias.

Что может немного сбить с толку, так это тот факт, что в дополнение к типу элемента Hyperlink в панели инструментов Common diagram, EA позволяет создавать гиперссылки в обычных элементах (в диалоговом окне Element Properties, на вкладке Related: Files, которые могут быть локальными файлами или веб-адреса).

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

Выбор подмножества элементов на диаграмме («только необходимая информация») немного сложнее и зависит от того, как структурирована ваша модель. Фрагменты шаблона выполнят свою работу, но вы можете достичь желаемого результата, просто используя фильтры в диалоговом окне создания документа.

person Uffe    schedule 30.04.2015
comment
Спасибо за хорошо задокументированный ответ. Это отвечает на мой вопрос, поскольку он дает мне отношение к этому элементу гиперссылки из диаграммы. Я действительно могу распечатать это с помощью шаблона отчета, который вы мне показали. К сожалению, я до сих пор не сгенерировал документ, как требуется, потому что это также приносит много других вещей, которые я не хочу в документе (я хотел отфильтровать это, но EA не позволяет мне помещать здесь селектор, хотя документация скажем, фрагменты можно поместить в раздел элементов. Я предполагаю, что они имели в виду элемент в пакете, но не в диаграмме?). - person Antony Robert; 02.05.2015
comment
Что касается прослеживаемости, мы использовали отношения заметок от требования к гиперссылке, и это делает гиперссылку частью связанной вкладки для требования, как вы предложили, так что это хорошо. - person Antony Robert; 02.05.2015

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

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

Поэтому, если вы распечатаете весь элемент пакета, содержащий диаграмму, вы также сможете распечатать гиперссылку.

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

person Geert Bellekens    schedule 30.04.2015
comment
Привет и спасибо, я проверил первые три пункта и создал базовый шаблон со всей иерархией и элементами пакетов, и хотя ни один из параметров скрытия документации или исключений не задан, эти гиперссылки не печатаются (также как и диаграмма границ или диаграммы Примечания). Так что, если я выберу этот путь, я останусь с SQL и пользовательскими запросами. (Я знаю, что у вас довольно много примеров на вашей домашней странице - спасибо за это, я довольно часто использовал информацию, пытаясь понять объектную модель EA). - person Antony Robert; 02.05.2015

[Отредактировано 04.05.15, чтобы отразить комментарий Уффе и предоставить окончательное решение]

Хорошо, на основе ответа Гертса, используя следующий фрагмент настраиваемого запроса в разделе диаграммы:

select 
    t_object.ea_guid as CLASSGUID, 
    t_object.Object_Type as CLASSTYPE, 
    t_object.Object_Id as OBJECTID, 
    t_object.name as HL_Name,
    t_object.Stereotype as HL_Stereotype,
    t_object.object_type as HL_Type,
    t_object.Alias as HL_Alias,
    Note as Notes
    --,t_object.*
from t_object
  left join t_diagramobjects on (t_object.Object_ID = t_diagramobjects.Object_ID)
  left join t_diagram on (t_diagram.Diagram_ID = t_diagramobjects.Diagram_ID)
where t_diagram.Diagram_ID = '#DIAGRAMID#'
  and t_object.Object_Type='Text'

Мне удалось получить список гиперссылок по схеме, это фрагмент:

custom >
{HL_Alias}: {HL_Name}
{Notes}
< custom

«Заметки» можно распечатать, получив атрибут прямо из таблицы t_object. Не запутайтесь, как я был сначала: автозаполнение для t_object и результаты (t_object. *) НЕ ПОКАЗЫВАЮТ атрибут примечания, но он существует, и когда вы записываете его в запрос, он генерируется в документ.

person Antony Robert    schedule 02.05.2015
comment
Примечания сами по себе являются элементами. Они живут в t_object, как гиперссылки. - person Geert Bellekens; 02.05.2015
comment
В EA примечание может означать две разные вещи: комментарии, которые вы можете написать в любом элементе, и тип элемента, который вы можете разместить на диаграмме (но который не отображается в браузере проекта). Каждый элемент, независимо от того, находится он в браузере проекта или нет, хранится в таблице t_object, которая содержит столбец примечания (без s), содержимое которого отображается в поле примечаний диалогового окна свойств элемента. Поэтому вам нужно включить t_object.Note в свой SQL-запрос. NB: этот столбец не отображается в результатах оперативных SQL-запросов в EA, но он будет работать во фрагменте шаблона. - person Uffe; 04.05.2015