Merge pull request #828 from mandy-chessell/dev-dojo

Update servers and assets
odpi · Jul 31, 2023 · 519feda · 519feda
2 parents 8f98265 + c57d7d2
commit 519feda
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 20 deletions.
diff --git a/site/docs/types/0/0042-Software-Capabilities.md b/site/docs/types/0/0042-Software-Capabilities.md
@@ -3,9 +3,11 @@
 
 # 0042 Software Capabilities
 
+Software capabilities are the capabilities implemented in software and supported by [ITInfrastructure](/types/0/0030-Hosts-and-Platforms) such as hosts, software server platforms and software servers.  They are composed of, support and/or consume various [digital resources](/concepts/resources) represented as [Asset entities](/types/0/0010-Base-Model).  They are linked together using the [ServerAssetUse relationship](/types/0045-Servers-and-Assets). 
+
 ![UML](0042-Software-Capabilities.svg)
 
-## SoftwareCapability
+## SoftwareCapability entity
 
 [*IT Infrastructure*](/types/0/0030-Hosts-and-Platforms) contains many capabilities.  Each capability can be catalogued using the *SoftwareCapability* entity and linked to the hosting *ITInfrastructure* entity using the *SupportedSoftwareCapability* relationship. 
 
@@ -49,20 +51,15 @@ In addition, it is possible to augment software capabilities with the following
 - [*FileManager*](/types/0/0056-Resource-Managers/#filemanager) - A manager of a collection of files and folders.
 - [*NotificationManager*](/types/0/0056-Resource-Managers/#notificationmanager) - A software capability that is distributing events from a topic to its subscriber list.
 
-## SupportedSoftwareCapability
-
-Defines the relationship between a *SoftwareCapability* and the *ITInfrastructure* asset that hosts it.
-
-## ProcessingState
-
-Defines a classification for a *SoftwareCapability*. The *ProcessingState* can be used to describe additional runtime processing information used by various SoftwareCapabilities.
+## SupportedSoftwareCapability relationship
 
+Defines the relationship between a *SoftwareCapability* and the *ITInfrastructure* entity that hosts it.  This relationship, plus the attached *SoftwareCapability* entity, help to build out a picture of the capabilities of a particular deployed host, software server platform or software server.  Together they help to describe where and how various IT capabilities are delivered to the owning organization.  This model can form the basis of traceability from business function to IT Infrastructure, particularly when combined with [location information](/types/0/0025-Locations) and [links to the data assets and APIs](/types/0/0045-Servers-and-Assets). 
 
-## ProcessingState
+## ProcessingState classification
 
-Defines a classification for a `SoftwareCapability`. It stores the last sync timestamp for critical elements. 
+Defines a classification for a *SoftwareCapability*. The *ProcessingState* can be used to describe additional runtime processing information used by the component represented by the *SoftwareCapability* entity.
 
 ??? deprecated "Deprecated types"
-    - *SoftwareServerSupportedCapability* is deprecated in favor of *SupportedSoftwareCapability*.
+    - *SoftwareServerSupportedCapability* is deprecated in favour of the *SupportedSoftwareCapability* relationship.
 
 --8<-- "snippets/abbr.md"
diff --git a/site/docs/types/0/0045-Servers-and-Assets.md b/site/docs/types/0/0045-Servers-and-Assets.md
@@ -3,10 +3,27 @@
 
 # 0045 Servers and Assets
 
+Many data catalogs capture information about data stores, data sets, APIs and topics.  These [digital resources](/concepts/resource) provide access to data and reusable function which is why they are of interest.  These resources run on IT infrastructure.
+
 ![UML](0045-Servers-and-Assets.svg)
 
-## ServerAssetUse
+## ServerAssetUseType enumeration
+
+The *ServerAssetUseType* describes the different types of dependencies that a software capability has on an asset.
+
+* *OWNS* means that the asset is hosted and controlled by the software capability.  For example, a database server OWNS the databases deployed to it.
+* *GOVERNS* means the the asset is monitored and action is taken if the asset moves out of certain boundaries or thresholds.  For example, an archiving service GOVERNS a database by removing records that are past a certain date.
+* *MAINTAINS* means that although the software capability does not host the asset, it is responsible for maintaining its contents.  For example, an application may store its data in a database running on a remote database server.  The application MAINTAINS the database.
+* *USES* means that the software capability is a consumer of the asset.  For example, an analytical service may read the data in a database to feed an algorithm.  The analytical service USES the database.
+* *OTHER* means there is another type of dependency between the software capability and the asset.
+
+## ServerAssetUse relationship
+
+[Assets](/types/0/0010-Base-Model/#asset) are managed or consumed by [SoftwareCapabilities](/types/0/0042-Software-Capabilities/#softwarecapability), which is captured by the *ServerAssetUse* relationship.  The properties characterize the relationship:
 
-[`Asset`s](/types/0/0010-Base-Model/#asset) are managed or consumed by [`SoftwareCapabilities`](/types/0/0042-Software-Capabilities/#softwarecapability), which is captured by the *`ServerAssetUse`* relationship.
+* *useType* defines how the software capability depends on the asset as defined by the *SoftwareAssetUseType* enumeration.
+* *description* provides a description of the use of the asset by the software capability.
+* *minimumInstances* defines the minimum number of instances of the asset connected to the software capability.
+* *maximumInstances* defines the maximum number of instances of the asset connected to the software capability.
 
 --8<-- "snippets/abbr.md"
diff --git a/site/docs/types/2/area-2-assets.drawio b/site/docs/types/2/area-2-assets.drawio
@@ -1,4 +1,4 @@
-<mxfile modified="2023-07-27T10:55:30.914Z" host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.5.0 Chrome/112.0.5615.204 Electron/24.5.1 Safari/537.36" etag="_tkyzCCuOKih3DDJ16jC" version="21.5.0" type="device" pages="23">
+<mxfile modified="2023-07-28T10:24:43.019Z" host="Electron" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.5.0 Chrome/112.0.5615.204 Electron/24.5.1 Safari/537.36" etag="Qu93YjPntos6X-KlGMfZ" version="21.5.0" type="device" pages="23">
   <diagram id="ErCcJrGKzW-L592V1ftQ" name="overview">
     <mxGraphModel dx="1194" dy="775" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
       <root>
@@ -1016,7 +1016,7 @@
     </mxGraphModel>
   </diagram>
   <diagram name="0220-Files-and-Folders" id="D2cg2sYWF97WglRkFQJs">
-    <mxGraphModel dx="1186" dy="773" grid="1" gridSize="10" guides="0" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
+    <mxGraphModel dx="1194" dy="775" grid="1" gridSize="10" guides="0" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
       <root>
         <mxCell id="ZrNOeMicPIiF9nXJ6mgr-0" />
         <mxCell id="ZrNOeMicPIiF9nXJ6mgr-1" parent="ZrNOeMicPIiF9nXJ6mgr-0" />
@@ -1137,7 +1137,7 @@
         <mxCell id="VsX3TWaoQLOxbVQCu9RD-18" value="*&amp;nbsp; linkedFiles" style="text;html=1;resizable=0;points=[];autosize=1;align=left;verticalAlign=top;spacingTop=-4;" parent="ZrNOeMicPIiF9nXJ6mgr-1" vertex="1">
           <mxGeometry x="386.5" y="340" width="80" height="20" as="geometry" />
         </mxCell>
-        <mxCell id="aCFCdC7cdcEgBlMMroLI-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=1;endArrow=block;endFill=0;endSize=18;" edge="1" parent="ZrNOeMicPIiF9nXJ6mgr-1" source="fRcZvzqJL7tkSI1bYRcw-0" target="fRcZvzqJL7tkSI1bYRcw-2">
+        <mxCell id="aCFCdC7cdcEgBlMMroLI-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=1;endArrow=block;endFill=0;endSize=18;" parent="ZrNOeMicPIiF9nXJ6mgr-1" source="fRcZvzqJL7tkSI1bYRcw-0" target="fRcZvzqJL7tkSI1bYRcw-2" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
         <mxCell id="fRcZvzqJL7tkSI1bYRcw-0" value="«entity»&lt;br&gt;&lt;b&gt;DataFileCollection&lt;/b&gt;" style="html=1;strokeColor=#6c8ebf;align=center;fillColor=#dae8fc;gradientColor=#7ea6e0;" parent="ZrNOeMicPIiF9nXJ6mgr-1" vertex="1">
@@ -1181,16 +1181,16 @@
         <mxCell id="ROwfh0Mwp-DavKNeRNNh-10" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;gradientColor=#ffffff;align=left;" parent="ZrNOeMicPIiF9nXJ6mgr-1" vertex="1">
           <mxGeometry x="41" y="666" width="210" height="27" as="geometry" />
         </mxCell>
-        <mxCell id="aCFCdC7cdcEgBlMMroLI-5" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=1;endArrow=block;endFill=0;endSize=18;" edge="1" parent="ZrNOeMicPIiF9nXJ6mgr-1" source="aCFCdC7cdcEgBlMMroLI-1" target="aCFCdC7cdcEgBlMMroLI-3">
+        <mxCell id="aCFCdC7cdcEgBlMMroLI-5" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=1;endArrow=block;endFill=0;endSize=18;" parent="ZrNOeMicPIiF9nXJ6mgr-1" source="aCFCdC7cdcEgBlMMroLI-1" target="aCFCdC7cdcEgBlMMroLI-3" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
-        <mxCell id="aCFCdC7cdcEgBlMMroLI-1" value="«entity»&lt;br&gt;&lt;b&gt;DataFolder&lt;/b&gt;" style="html=1;strokeColor=#6c8ebf;align=center;fillColor=#dae8fc;gradientColor=#7ea6e0;" vertex="1" parent="ZrNOeMicPIiF9nXJ6mgr-1">
+        <mxCell id="aCFCdC7cdcEgBlMMroLI-1" value="«entity»&lt;br&gt;&lt;b&gt;DataFolder&lt;/b&gt;" style="html=1;strokeColor=#6c8ebf;align=center;fillColor=#dae8fc;gradientColor=#7ea6e0;" parent="ZrNOeMicPIiF9nXJ6mgr-1" vertex="1">
           <mxGeometry x="500" y="680" width="211" height="50" as="geometry" />
         </mxCell>
-        <mxCell id="aCFCdC7cdcEgBlMMroLI-2" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;gradientColor=#ffffff;align=left;" vertex="1" parent="ZrNOeMicPIiF9nXJ6mgr-1">
+        <mxCell id="aCFCdC7cdcEgBlMMroLI-2" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#000000;gradientColor=#ffffff;align=left;" parent="ZrNOeMicPIiF9nXJ6mgr-1" vertex="1">
           <mxGeometry x="500" y="730" width="210" height="30" as="geometry" />
         </mxCell>
-        <mxCell id="aCFCdC7cdcEgBlMMroLI-3" value="«entity»&lt;br&gt;&lt;b&gt;FileFolder&lt;/b&gt;" style="html=1;strokeColor=#6c8ebf;align=center;fillColor=#dae8fc;gradientColor=#7ea6e0;" vertex="1" parent="ZrNOeMicPIiF9nXJ6mgr-1">
+        <mxCell id="aCFCdC7cdcEgBlMMroLI-3" value="«entity»&lt;br&gt;&lt;b&gt;FileFolder&lt;/b&gt;" style="html=1;strokeColor=#6c8ebf;align=center;fillColor=#dae8fc;gradientColor=#7ea6e0;" parent="ZrNOeMicPIiF9nXJ6mgr-1" vertex="1">
           <mxGeometry x="500" y="580" width="211" height="50" as="geometry" />
         </mxCell>
       </root>