Merge pull request #8608 from mandy-chessell/oak2025

Add mermaid graphs for information supply chain, soluton blueprints and solution roles
odpi · Jan 30, 2025 · b59a1e1 · b59a1e1
2 parents 9886f7f + ab9a54e
commit b59a1e1
Show file tree

Hide file tree

Showing 57 changed files with 3,865 additions and 251 deletions.
diff --git a/EgeriaContentPacksGUIDMap.json b/EgeriaContentPacksGUIDMap.json
diff --git a/content-packs/APIsContentPack.omarchive b/content-packs/APIsContentPack.omarchive
diff --git a/content-packs/ApacheAtlasContentPack.omarchive b/content-packs/ApacheAtlasContentPack.omarchive
diff --git a/content-packs/ApacheKafkaContentPack.omarchive b/content-packs/ApacheKafkaContentPack.omarchive
diff --git a/content-packs/CocoBusinessSystemsArchive.omarchive b/content-packs/CocoBusinessSystemsArchive.omarchive
diff --git a/content-packs/CocoClinicalTrialsTemplatesArchive.omarchive b/content-packs/CocoClinicalTrialsTemplatesArchive.omarchive
diff --git a/content-packs/CocoComboArchive.omarchive b/content-packs/CocoComboArchive.omarchive
diff --git a/content-packs/CocoGovernanceEngineDefinitionsArchive.omarchive b/content-packs/CocoGovernanceEngineDefinitionsArchive.omarchive
diff --git a/content-packs/CocoGovernanceProgramArchive.omarchive b/content-packs/CocoGovernanceProgramArchive.omarchive
diff --git a/content-packs/CocoOrganizationArchive.omarchive b/content-packs/CocoOrganizationArchive.omarchive
diff --git a/content-packs/CocoSustainabilityArchive.omarchive b/content-packs/CocoSustainabilityArchive.omarchive
diff --git a/content-packs/CocoTypesArchive.omarchive b/content-packs/CocoTypesArchive.omarchive
diff --git a/content-packs/CoreContentPack.omarchive b/content-packs/CoreContentPack.omarchive
diff --git a/content-packs/ObservabilityContentPack.omarchive b/content-packs/ObservabilityContentPack.omarchive
diff --git a/content-packs/OpenMetadataTypes.omarchive b/content-packs/OpenMetadataTypes.omarchive
diff --git a/content-packs/PostgresContentPack.omarchive b/content-packs/PostgresContentPack.omarchive
diff --git a/content-packs/UnityCatalogContentPack.omarchive b/content-packs/UnityCatalogContentPack.omarchive
diff --git a/open-metadata-distribution/omag-server-platform/build.gradle b/open-metadata-distribution/omag-server-platform/build.gradle
@@ -381,7 +381,7 @@ distributions {
                         { include 'Egeria*.http' }
                 from { "$rootProject.projectDir/open-metadata-implementation/view-services/reference-data" }
                         { include 'Egeria*.http' }
-                from { "$rootProject.projectDir/open-metadata-implementation/view-services/solutin-architect" }
+                from { "$rootProject.projectDir/open-metadata-implementation/view-services/solution-architect" }
                         { include 'Egeria*.http' }
                 from { "$rootProject.projectDir/open-metadata-implementation/view-services/runtime-manager" }
                         { include 'Egeria*.http' }

diff --git a/...pi/openmetadata/accessservices/digitalarchitecture/ffdc/DigitalArchitectureAuditCode.java b/...pi/openmetadata/accessservices/digitalarchitecture/ffdc/DigitalArchitectureAuditCode.java
@@ -117,6 +117,15 @@ public enum DigitalArchitectureAuditCode implements AuditLogMessageSet
                             "Event {0} could not be published due to {1} exception with message: {2}",
                             "The system is unable to publish the event to the Digital Architecture OMAS's OutTopic.",
                             "Verify the topic configuration and that the event broker is running."),
+
+    /**
+     * OMAS-DIGITAL-ARCHITECTURE-0015 - The Digital Architecture OMAS has received an unexpected {0} exception while formatting a response during method {1}.  The message was: {2}
+     */
+    UNEXPECTED_CONVERTER_EXCEPTION("OMAS-DIGITAL-ARCHITECTURE-0015",
+                         AuditLogRecordSeverityLevel.EXCEPTION,
+                         "The Digital Architecture OMAS has received an unexpected {0} exception while formatting a response during method {1}.  The message was: {2}",
+                         "The request returns all of the information that it was able to receive.",
+                         "Review the stack trace to identify where the error occurred and work to resolve the cause."),
     ;
 
     private final String                      logMessageId;

diff --git a/...lementation/access-services/digital-architecture/digital-architecture-client/build.gradle b/...lementation/access-services/digital-architecture/digital-architecture-client/build.gradle
@@ -21,6 +21,7 @@ dependencies {
     implementation project(':open-metadata-implementation:frameworks:open-integration-framework')
     implementation project(':open-metadata-implementation:frameworks:governance-action-framework')
     implementation project(':open-metadata-implementation:common-services:ffdc-services')
+    implementation project(':open-metadata-implementation:common-services:mermaid-services')
     implementation 'org.springframework:spring-core'
     compileOnly 'com.fasterxml.jackson.core:jackson-annotations'
 

diff --git a/...openmetadata/accessservices/digitalarchitecture/client/DigitalArchitectureClientBase.java b/...openmetadata/accessservices/digitalarchitecture/client/DigitalArchitectureClientBase.java
@@ -4,6 +4,7 @@
 package org.odpi.openmetadata.accessservices.digitalarchitecture.client;
 
 import org.odpi.openmetadata.accessservices.digitalarchitecture.client.rest.DigitalArchitectureRESTClient;
+import org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription;
 import org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler;
 import org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody;
 import org.odpi.openmetadata.frameworks.auditlog.AuditLog;
@@ -18,6 +19,8 @@
  */
 abstract class DigitalArchitectureClientBase
 {
+    final protected String serviceName = AccessServiceDescription.DIGITAL_ARCHITECTURE_OMAS.getAccessServiceFullName();
+
     DigitalArchitectureRESTClient restClient;    /* Initialized in constructor */
 
     String   serverName;               /* Initialized in constructor */

diff --git a/...java/org/odpi/openmetadata/accessservices/digitalarchitecture/client/SolutionManager.java b/...java/org/odpi/openmetadata/accessservices/digitalarchitecture/client/SolutionManager.java
diff --git a/...pi/openmetadata/adapters/connectors/egeriainfrastructure/ffdc/OMAGConnectorAuditCode.java b/...pi/openmetadata/adapters/connectors/egeriainfrastructure/ffdc/OMAGConnectorAuditCode.java
@@ -25,7 +25,7 @@ public enum OMAGConnectorAuditCode implements AuditLogMessageSet
      * EGERIA-CONNECTOR-0001 - The {0} Egeria Connector received an unexpected exception {1} during method {2}; the error message was: {3}
      */
     UNEXPECTED_EXCEPTION("OMAG-CONNECTORS-0001",
-                         AuditLogRecordSeverityLevel.EXCEPTION,
+                         AuditLogRecordSeverityLevel.ERROR,
                          "The {0} Egeria Connector received an unexpected exception {1} during method {2}; the error message was: {3}",
                          "The connector is unable to connector the the OMAG Infrastructure.",
                          "Use the details from the error message to determine the cause of the error and retry the request once it is resolved."),

diff --git a/...tadata/adapters/connectors/egeriainfrastructure/platform/OMAGServerPlatformConnector.java b/...tadata/adapters/connectors/egeriainfrastructure/platform/OMAGServerPlatformConnector.java
@@ -156,10 +156,10 @@ public void start() throws ConnectorCheckedException
         {
             if (auditLog != null)
             {
-                auditLog.logException(methodName, OMAGConnectorAuditCode.UNEXPECTED_EXCEPTION.getMessageDefinition(connectorName,
-                                                                                                                   error.getClass().getName(),
-                                                                                                                   methodName,
-                                                                                                                   error.getMessage()), error);
+                auditLog.logMessage(methodName, OMAGConnectorAuditCode.UNEXPECTED_EXCEPTION.getMessageDefinition(connectorName,
+                                                                                                                 error.getClass().getName(),
+                                                                                                                 methodName,
+                                                                                                                 error.getMessage()));
             }
             throw new ConnectorCheckedException(OMAGConnectorErrorCode.UNEXPECTED_EXCEPTION.getMessageDefinition(connectorName,
                                                                                                                  error.getClass().getName(),

diff --git a/...s/mermaid-services/src/main/java/org/odpi/openmetadata/commonservices/mermaid/Colour.java b/...s/mermaid-services/src/main/java/org/odpi/openmetadata/commonservices/mermaid/Colour.java
@@ -0,0 +1,70 @@
+/* SPDX-License-Identifier: Apache-2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+package org.odpi.openmetadata.commonservices.mermaid;
+
+/**
+ * Colour helps to capture the colours we are using in the mermaid graphs.
+ */
+public enum Colour
+{
+    BLACK       ("#000000"),
+    WHITE       ("#FFFFFF"),
+    CERISE      ("#AA00FF"),
+    EGERIA_BLUE ("#39add1"),
+    DARK_BLUE   ("#3079ab"),
+    BLUE_SKY    ("#A8C2FF"),
+    PINKY       ("#E1D5E7"),
+    MAUVE       ("#EFEFFF"),
+    RED         ("#e15258"),
+    ORANGE      ("#f9845b"),
+    LAVENDER    ("#838cc7"),
+    PURPLE      ("#7d669e"),
+    TEAL        ("#53bbb4"),
+    GREEN       ("#51b46d"),
+    MUSTARD     ("#e0ab18"),
+    PINK        ("#f092b0"),
+    LIGHT_GRAY  ("#b7c0c7"),
+    DARK_GRAY   ("#637a91"),
+    SLATE       ("#004563"),
+    SAND        ("#F9F7ED")
+    ;
+
+    private final String colourNumber;
+
+
+    /**
+     * Construct each of the colours.
+     *
+     * @param colourNumber string
+     */
+    Colour(String colourNumber)
+    {
+        this.colourNumber = colourNumber;
+    }
+
+
+    /**
+     * Return the colour number.
+     *
+     * @return string
+     */
+    public String getColourNumber()
+    {
+        return colourNumber;
+    }
+
+
+    /**
+     * JSON-style toString
+     *
+     * @return return string containing the property names and values
+     */
+    @Override
+    public String toString()
+    {
+        return "Colour{" +
+                "colourNumber='" + colourNumber + '\'' +
+                "} ";
+    }
+}
diff --git a/...g/odpi/openmetadata/commonservices/mermaid/InformationSupplyChainMermaidGraphBuilder.java b/...g/odpi/openmetadata/commonservices/mermaid/InformationSupplyChainMermaidGraphBuilder.java
@@ -0,0 +1,131 @@
+/* SPDX-License-Identifier: Apache-2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+package org.odpi.openmetadata.commonservices.mermaid;
+
+import org.odpi.openmetadata.frameworks.openmetadata.metadataelements.*;
+import org.odpi.openmetadata.frameworks.openmetadata.types.OpenMetadataType;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+
+/**
+ * Creates a mermaid graph rendering of the Open Metadata Framework's information supply chain graph.
+ */
+public class InformationSupplyChainMermaidGraphBuilder extends MermaidGraphBuilderBase
+{
+    /**
+     * Construct a mermaid markdown graph.
+     *
+     * @param informationSupplyChainElement content
+     */
+    public InformationSupplyChainMermaidGraphBuilder(InformationSupplyChainElement informationSupplyChainElement)
+    {
+        mermaidGraph.append("---\n");
+        mermaidGraph.append("title: Information Supply Chain - ");
+        mermaidGraph.append(informationSupplyChainElement.getProperties().getDisplayName());
+        mermaidGraph.append(" [");
+        mermaidGraph.append(informationSupplyChainElement.getElementHeader().getGUID());
+        mermaidGraph.append("]\n---\nflowchart TD\n%%{init: {\"flowchart\": {\"htmlLabels\": false}} }%%\n\n");
+
+        String currentNodeName    = informationSupplyChainElement.getElementHeader().getGUID();
+        String currentDisplayName = informationSupplyChainElement.getProperties().getDisplayName();
+
+        appendNewMermaidNode(currentNodeName,
+                             currentDisplayName,
+                             informationSupplyChainElement.getElementHeader().getType().getTypeName(),
+                             VisualStyle.INFORMATION_SUPPLY_CHAIN);
+
+        if (informationSupplyChainElement.getSegments() != null)
+        {
+            for (InformationSupplyChainSegmentElement node : informationSupplyChainElement.getSegments())
+            {
+                if (node != null)
+                {
+                    currentNodeName    = node.getElementHeader().getGUID();
+                    currentDisplayName = node.getProperties().getDisplayName();
+                    if (currentDisplayName == null)
+                    {
+                        currentDisplayName = node.getProperties().getQualifiedName();
+                    }
+
+                    appendNewMermaidNode(currentNodeName,
+                                         currentDisplayName,
+                                         node.getElementHeader().getType().getTypeName(),
+                                         VisualStyle.INFORMATION_SUPPLY_CHAIN_SEG);
+
+                    if (node.getLinks() != null)
+                    {
+                        for (InformationSupplyChainLink link : node.getLinks())
+                        {
+                            if (link != null)
+                            {
+                                super.appendMermaidLine(link.getEnd1Element().getGUID(),
+                                                        this.getListLabel(Collections.singletonList(super.addSpacesToTypeName(link.getElementHeader().getType().getTypeName()))),
+                                                        link.getEnd2Element().getGUID());
+                            }
+                        }
+                    }
+                }
+            }
+
+            List<String> solutionLinkingWireGUIDs = new ArrayList<>();
+
+            for (InformationSupplyChainSegmentElement node : informationSupplyChainElement.getSegments())
+            {
+                if (node != null)
+                {
+                    if (node.getImplementedByList() != null)
+                    {
+                        for (ImplementedByRelationship implementedByRelationship : node.getImplementedByList())
+                        {
+                            if (implementedByRelationship != null)
+                            {
+                                appendNewMermaidNode(implementedByRelationship.getEnd1Element().getGUID(),
+                                                     implementedByRelationship.getEnd1Element().getUniqueName(),
+                                                     implementedByRelationship.getEnd1Element().getType().getTypeName(),
+                                                     VisualStyle.SOLUTION_COMPONENT);
+
+                                appendNewMermaidNode(implementedByRelationship.getEnd2Element().getGUID(),
+                                                     implementedByRelationship.getEnd2Element().getUniqueName(),
+                                                     implementedByRelationship.getEnd2Element().getType().getTypeName(),
+                                                     VisualStyle.SOLUTION_COMPONENT);
+                            }
+                        }
+                    }
+
+                    if (node.getSolutionLinkingWires() != null)
+                    {
+                        for (SolutionLinkingWireRelationship relationship : node.getSolutionLinkingWires())
+                        {
+                            if (relationship != null)
+                            {
+                                appendNewMermaidNode(relationship.getEnd1Element().getGUID(),
+                                                     relationship.getEnd1Element().getUniqueName(),
+                                                     relationship.getEnd1Element().getType().getTypeName(),
+                                                     VisualStyle.SOLUTION_COMPONENT);
+
+                                appendNewMermaidNode(relationship.getEnd2Element().getGUID(),
+                                                     relationship.getEnd2Element().getUniqueName(),
+                                                     relationship.getEnd2Element().getType().getTypeName(),
+                                                     VisualStyle.SOLUTION_COMPONENT);
+
+                                if (! solutionLinkingWireGUIDs.contains(relationship.getElementHeader().getGUID()))
+                                {
+                                    super.appendMermaidLine(relationship.getEnd1Element().getGUID(),
+                                                            this.getListLabel(Collections.singletonList(super.addSpacesToTypeName(relationship.getElementHeader().getType().getTypeName()))),
+                                                            relationship.getEnd2Element().getGUID());
+
+                                    solutionLinkingWireGUIDs.add(relationship.getElementHeader().getGUID());
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}