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 us the containment relationship Detail:Contained:Containment:Container:Detail. For record/table like structures use the list relationship Detail:List:List:Member:Detail
By default SoftwareInstance, BusinessApplicationInstance and Host nodes all have relationships to Detail nodes. This does not prevent you relating Detail nodes to other node kinds.
Detail Node Lifecycle
The following section describes the scenarios in which a Detail Node is created, updated or removed.
Creation/Update
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
|
Removal
- 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.
Detail Attributes
The attributes and relationships on a Detail Node are described in the tables below.
UI Name
Attribute Name and Type |
Description |
Name
name string |
Name of the detail. |
Type
type string |
Type of detail. |
Trigger Count
count string |
Trigger count. |
Detail Relationships
The relationships on a Detail Node are described in the table below.
| Destination |
Relationship |
Description |
| BusinessApplicationInstance |
Detail
Detail
Detail
ElementWithDetail
BusinessApplicationInstance |
Business Application Instance with this detail. |
| Detail |
Detail
Contained
Containment
Container
Detail |
Detail this Detail is contained within. |
| Detail |
Detail
Container
Containment
Contained
Detail |
Details contained within this Detail. |
| Detail |
Detail
List
List
Member
Detail |
List members of this Detail. |
| Detail |
Detail
Member
List
List
Detail |
Detail list this Detail is part of. |
| File |
Detail
Dependant
Dependency
DependedUpon
File |
File depended upon by this Detail. |
| GenericElement |
Detail
Detail
Detail
ElementWithDetail
GenericElement |
Element with this detail. |
| Host |
Detail
Detail
Detail
ElementWithDetail
Host |
Host with this detail. |
| Pattern |
Detail
Element
Maintainer
Pattern
Pattern |
Pattern that is maintaining this detail. |
| SoftwareInstance |
Detail
Dependant
Dependency
DependedUpon
SoftwareInstance |
Software Instance depended upon by this Detail. |
| SoftwareInstance |
Detail
Detail
Detail
ElementWithDetail
SoftwareInstance |
Software Instance with this detail. |
Tideway Blog