Detail node

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:List:List:Member:Detail.

By default Software Instance, Business Application Instance 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

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.

Detail attributes

The attributes on a Detail node as described in the following table:The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Detail relationships

The relationships on a Detail node are as described in the following table:The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.