Merge pull request #8437 from mandy-chessell/oak2024

Add descriptions to governance action processes
odpi · Oct 9, 2024 · decee6e · decee6e
2 parents ee77b0b + 3d31a0d
commit decee6e
Show file tree

Hide file tree

Showing 14 changed files with 36 additions and 15 deletions.
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/CoreContentPack.omarchive b/content-packs/CoreContentPack.omarchive
diff --git a/content-packs/ObservabilityContentPack.omarchive b/content-packs/ObservabilityContentPack.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/...ata/adapters/connectors/unitycatalog/controls/UnityCatalogDeployedImplementationType.java b/...ata/adapters/connectors/unitycatalog/controls/UnityCatalogDeployedImplementationType.java
@@ -28,7 +28,7 @@ public enum UnityCatalogDeployedImplementationType implements DeployedImplementa
 
 
     /**
-     * A function found in Unity Catalog (UC) that is working with data..
+     * A function found in Unity Catalog (UC) that is working with data.
      */
     OSS_UC_FUNCTION("Unity Catalog Function",
                   null,

diff --git a/...adata/adapters/connectors/governanceactions/ffdc/GovernanceActionConnectorsAuditCode.java b/...adata/adapters/connectors/governanceactions/ffdc/GovernanceActionConnectorsAuditCode.java
@@ -381,6 +381,16 @@ public enum GovernanceActionConnectorsAuditCode implements AuditLogMessageSet
                           "The governance action service returns an ACTIONED completion status.",
                           "Ensure follow-on uses of the asset are successful."),
 
+
+    /**
+     * GOVERNANCE-ACTION-CONNECTORS-0035 - The {0} governance action service has determined that today is {1}
+     */
+    DAY_OF_THE_WEEK("GOVERNANCE-ACTION-CONNECTORS-0035",
+                      AuditLogRecordSeverityLevel.INFO,
+                      "The {0} governance action service has determined that today is {1}",
+                      "The governance action service has completed successfully.",
+                      "Ensure follow-on uses of the day of the week are successful."),
+
     ;
 
     private final String                      logMessageId;

diff --git a/...dapters/connectors/governanceactions/stewardship/DaysOfWeekGovernanceActionConnector.java b/...dapters/connectors/governanceactions/stewardship/DaysOfWeekGovernanceActionConnector.java
@@ -3,6 +3,7 @@
 
 package org.odpi.openmetadata.adapters.connectors.governanceactions.stewardship;
 
+import org.odpi.openmetadata.adapters.connectors.governanceactions.ffdc.GovernanceActionConnectorsAuditCode;
 import org.odpi.openmetadata.adapters.connectors.governanceactions.ffdc.GovernanceActionConnectorsErrorCode;
 import org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException;
 import org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService;
@@ -57,7 +58,11 @@ public void start() throws ConnectorCheckedException
 
             outputGuards.add(output.toLowerCase(Locale.ROOT));
 
-            governanceContext.recordCompletionStatus(completionStatus, outputGuards);
+            governanceContext.recordCompletionStatus(completionStatus,
+                                                     outputGuards,
+                                                     null,
+                                                     null,
+                                                     GovernanceActionConnectorsAuditCode.DAY_OF_THE_WEEK.getMessageDefinition(governanceServiceName, output));
         }
         catch (Exception error)
         {

diff --git a/...nnectors/governanceactions/stewardship/WriteAuditLogMessageGovernanceActionConnector.java b/...nnectors/governanceactions/stewardship/WriteAuditLogMessageGovernanceActionConnector.java
@@ -5,6 +5,7 @@
 
 import org.odpi.openmetadata.adapters.connectors.governanceactions.ffdc.GovernanceActionConnectorsAuditCode;
 import org.odpi.openmetadata.adapters.connectors.governanceactions.ffdc.GovernanceActionConnectorsErrorCode;
+import org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition;
 import org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException;
 import org.odpi.openmetadata.frameworks.governanceaction.GeneralGovernanceActionService;
 import org.odpi.openmetadata.frameworks.governanceaction.properties.CompletionStatus;
@@ -45,10 +46,16 @@ public void start() throws ConnectorCheckedException
         {
             List<String> outputGuards = new ArrayList<>();
 
-            auditLog.logMessage(methodName, GovernanceActionConnectorsAuditCode.BLANK_INFO_LOG_MESSAGE.getMessageDefinition(messageText));
+            AuditLogMessageDefinition auditLogMessageDefinition = GovernanceActionConnectorsAuditCode.BLANK_INFO_LOG_MESSAGE.getMessageDefinition(messageText);
+
+            auditLog.logMessage(methodName, auditLogMessageDefinition);
 
             outputGuards.add(WriteAuditLogGuard.MESSAGE_WRITTEN.getName());
-            governanceContext.recordCompletionStatus(WriteAuditLogGuard.MESSAGE_WRITTEN.getCompletionStatus(), outputGuards);
+            governanceContext.recordCompletionStatus(WriteAuditLogGuard.MESSAGE_WRITTEN.getCompletionStatus(),
+                                                     outputGuards,
+                                                     null,
+                                                     null,
+                                                     auditLogMessageDefinition);
         }
         catch (Exception error)
         {

diff --git a/...n/java/org/odpi/openmetadata/frameworkservices/gaf/server/OpenGovernanceRESTServices.java b/...n/java/org/odpi/openmetadata/frameworkservices/gaf/server/OpenGovernanceRESTServices.java
@@ -16,7 +16,6 @@
 import org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException;
 import org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus;
 import org.odpi.openmetadata.frameworks.openmetadata.enums.ProcessStatus;
-import org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MetadataElement;
 import org.odpi.openmetadata.frameworks.openmetadata.types.OpenMetadataProperty;
 import org.odpi.openmetadata.frameworks.openmetadata.types.OpenMetadataType;
 import org.odpi.openmetadata.frameworks.governanceaction.properties.*;

diff --git a/.../odpi/openmetadata/archiveutilities/openconnectors/base/ContentPackBaseArchiveWriter.java b/.../odpi/openmetadata/archiveutilities/openconnectors/base/ContentPackBaseArchiveWriter.java
@@ -1493,7 +1493,7 @@ protected void createAndSurveyServerGovernanceActionProcess(String
                                                                       serverType + ":CreateAndSurveyGovernanceActionProcess",
                                                                       serverType + ":CreateAndSurvey",
                                                                       null,
-                                                                      null,
+                                                                      "Create a " + technologyType + ", run a survey against it, and print out the resulting report.",
                                                                       null,
                                                                       0,
                                                                       null,
@@ -1608,7 +1608,7 @@ protected void createAndCatalogServerGovernanceActionProcess(String
                                                                       serverType + ":CreateAndCatalogGovernanceActionProcess",
                                                                       serverType + ":CreateAndCatalog",
                                                                       null,
-                                                                      null,
+                                                                      "Create a " + technologyType + " and configure an integration connector to catalog its contents.",
                                                                       null,
                                                                       0,
                                                                       null,

diff --git a/...ava/org/odpi/openmetadata/archiveutilities/openconnectors/core/CorePackArchiveWriter.java b/...ava/org/odpi/openmetadata/archiveutilities/openconnectors/core/CorePackArchiveWriter.java
@@ -1730,7 +1730,7 @@ private void createDailyGovernanceActionProcess()
                                                                       "Egeria:DailyGovernanceActionProcess",
                                                                       "DailyGovernanceActionProcess",
                                                                       null,
-                                                                      null,
+                                                                      "Determines which day of the week it is today, and puts out a message on the audit log matching the assigned task for the day of the week.",
                                                                       null,
                                                                       0,
                                                                       null,
-Original file line number
+Diff line change
@@ Expand Up @@
         /**
-         * A function found in Unity Catalog (UC) that is working with data..
+         * A function found in Unity Catalog (UC) that is working with data.
          */
         OSS_UC_FUNCTION("Unity Catalog Function",
                       null,
@@ Expand Down @@