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:

UI Name
Attribute Name and Type

Description

Name
name string

Name of the detail.

Short Name
short_name string

Short name of the detail.

Key
key string

Globally unique key.

Type
type string

Type of detail.

Trigger Count
count string

Trigger count.

Detail relationships

The relationships on a Detail node are as described in the following table:

UI name

Relationship

Description

Software Instance

Detail:
Detail:
Detail:
ElementWithDetail:
SoftwareInstance

Software Instance with this detail.

Runtime Environment

Detail:
Detail:
Detail:
ElementWithDetail:
RuntimeEnvironment

Runtime Environment with this detail.

Business Application Instance

Detail:
Detail:
Detail:
ElementWithDetail:
BusinessApplicationInstance

Business Application Instance with this detail.

Host

Detail:
Detail:
Detail:
ElementWithDetail:
Host

Host with this detail.

MFPart

Detail:
Detail:
Detail:
ElementWithDetail:
MFPart

MFPart with this detail.

Element

Detail:
Detail:
Detail:
ElementWithDetail:
GenericElement

Element with this detail.

Detail List

Detail:
Member:
List:
List:
Detail

Detail list this Detail is part of.

Members

Detail:
List:
List:
Member:
Detail

List members of this Detail.

Containing Details

Detail:
Contained:
Containment:
Container:
Detail

Detail this Detail is contained within.

Contents

Detail:
Container:
Containment:
Contained:
Detail

Details contained within this Detail.

Depends On Software Instance

Detail:
Dependant:
Dependency:
DependedUpon:
SoftwareInstance

Software Instances that depend upon this Detail.

Depended Upon By Software Instance

Detail:
DependedUpon:
Dependency:
Dependant:
SoftwareInstance

Software Instances that this Detail depends on.

Depends On Software Component

Detail:
Dependant:
Dependency:
DependedUpon:
SoftwareComponent

Software Components that depend upon this Detail.

Depended Upon By Software Component

Detail:
DependedUpon:
Dependency:
Dependant:
SoftwareComponent

Software Components that this Detail depends on.

Depends On Files

Detail:
Dependant:
Dependency:
DependedUpon:
File

File depended upon by this Detail.

Functional Component

Detail:
ContainedFunctionality:
FunctionalContainment:
FunctionalContainer:
FunctionalComponent

Functional Components that contain this Detail.

Maintaining Pattern

Detail:
Element:
Maintainer:
Pattern:
Pattern

Pattern that is maintaining this detail.

Software Cluster

Detail:
Detail:
Detail:
ElementWithDetail:
SoftwareCluster

Software Cluster with this detail.

Depends On Software Clusters

Detail:
Dependant:
Dependency:
DependedUpon:
SoftwareCluster

Software Clusters that this Detail depends on.

Dependant Software Clusters

Detail:
DependedUpon:
Dependency:
Dependant:
SoftwareCluster

Software Clusters that depend upon this Detail.

Was this page helpful? Yes No Submitting... Thank you

Comments