A Detail node is a multipurpose node kind that, as its name suggests, is used to store additional details of other nodes. Typically it would be used when there is a need to add something more than some basic attributes to augment existing nodes in the model. If you are extending database Software Instance nodes then you should use a Database Detail node.
Detail nodes have two default relationships defined that allow for multiple levels of modeling. For tree like structures use the containment relationship
Detail:Contained:Containment:Container:Detail. For record/table like structures use the list relationship
Detail node lifecycle
The following section describes the scenarios in which a Detail node is created, updated or removed.
This is under the full control of patterns and as a result there is no default Detail node behavior.
Setting the key for a Detail node
The key for a Detail node is entirely dependent on the pattern that creates the Detail node. It is advised therefore that you take extra care when constructing the key attribute, as it will need to be unique amongst all Detail nodes. Achieving this uniqueness would typically be done by including the following information in the key:
- The type attribute
- The parent node's key attribute
- Manual removal: find the necessary Detail node, select it in the list and pick Destroy from the Actions list.
- Authoritative removal by the pattern that creates/updates the Detail node should be considered. The pattern not only needs to create the correct Detail structure, it also needs to maintain it as the configuration changes
- Built in removal rules will remove all the contained Detail nodes if an SI/BAI/Host is removed.
- Built in removal rules will remove all the child Detail nodes (over both Containment and List) to allow simple deletion of part structures.
The attributes on a Detail node as described in the following table:
Name of the detail.
Short name of the detail.
Globally unique key.
Type of detail.
The relationships on a Detail node are as described in the following table:
Software Instance with this detail.
Runtime Environment with this detail.
Business Application Instance
Business Application Instance with this detail.
Host with this detail.
MFPart with this detail.
Element with this detail.
Detail list this Detail is part of.
List members of this Detail.
Detail this Detail is contained within.
Details contained within this Detail.
Depends On Software Instance
Software Instances that depend upon this Detail.
Depended Upon By Software Instance
Software Instances that this Detail depends on.
Depends On Software Component
Software Components that depend upon this Detail.
Depended Upon By Software Component
Software Components that this Detail depends on.
Depends On Files
File depended upon by this Detail.
Functional Components that contain this Detail.
Pattern that is maintaining this detail.
Software Cluster with this detail.
Depends On Software Clusters
Software Clusters that this Detail depends on.
Dependant Software Clusters
Software Clusters that depend upon this Detail.