Child Objects

An object in your model can have subordinate objects: for example, elements have child diagrams and other elements; packages contain other packages, elements and diagrams; and diagrams contain elements and connectors. When you set up your document report template to report on these subordinate objects, you can:

Generate just the information you specify in selected fields, such as the object name only; for example, details of elements could be extracted in a number of places - Package elements, Embedded elements, source and target elements on connectors, child elements - and you might not require full details in all sections in your report, so you would just set a field for the element name in some of the sections
Generate the same type of information as is provided for the parent-level objects of that type, by not defining any content (text or fields) between the section tags; for example, you could generate recursive documentation of child packages, getting the same level of detail as for the parent package

Access     Tools | Document Template Designer > Sections
                  Tools | Documentation | Document Template Designer > Content

Examples of reporting on child objects



See also

Specific object details

This template has valid content (text and the Element.Name field) between the child element tags. Therefore, in the generated report, the child element section will show only the element name and none of the detail shown for the parent element.





Default to parent-level detail

This template has no valid content between the child element tags. Therefore, in the generated report the child element section will default to the detail shown for the parent element.





Default parent detail for child objects

Child Object (Checkboxes)

Section Content Applied

Package > Child Package


Package > Element > Child Element

Package > Element

Package > Element > Diagram

Package > Diagram

Package > Diagram > Element

Package > Element

Package > Diagram > Connector

Package > Element  > Connector




In principle, it is better to leave Child sections blank to replicate their parent sections
Child sections do not contain the same sub-section detail as their parents; Element::Child Element does not contain sub-sections such as Scenario or Attribute, so where Child Element sections are populated, these sub-sections are not rendered
An exception to this is cases where sub-sections are not required, but different formatting of the section fields is preferred

Learn more