Add AnalysisNotScheduledSESTM codeunit and SentinelSetup page

This commit adds the AnalysisNotScheduledSESTM codeunit and the SentinelSetup page to the BusinessCentral.Sentinel project. The AnalysisNotScheduledSESTM codeunit is included in the SentinelAdminSESTM permission set, and the SentinelSetup page allows users to configure the Telemetry Logging setting for Sentinel. These changes enhance the functionality and customization options of the application.
StefanMaron · Jan 31, 2025 · d22f536 · d22f536
1 parent 41f6f64
commit d22f536
Show file tree

Hide file tree

Showing 10 changed files with 87 additions and 9 deletions.
diff --git a/BusinessCentral.Sentinel/SentinelAdmin.PermissionSet.al b/BusinessCentral.Sentinel/SentinelAdmin.PermissionSet.al
@@ -18,6 +18,7 @@ permissionset 71180275 SentinelAdminSESTM
         codeunit AlertDevScopeExtSESTM = X,
         codeunit AlertPteDownloadCodeSESTM = X,
         codeunit AlertSESTM = X,
+        codeunit AnalysisNotScheduledSESTM = X,
         codeunit DemoDataExtInProdSESTM = X,
         codeunit EvaluationCompanyInProdSESTM = X,
         codeunit NonPostNoSeriesGapsSESTM = X,
@@ -28,5 +29,5 @@ permissionset 71180275 SentinelAdminSESTM
         codeunit UserWithSuperSESTM = X,
         page AlertListSESTM = X,
         page SentinelRuleSetSESTM = X,
-        codeunit AnalysisNotScheduledSESTM = X;
+        page SentinelSetup = X;
 }
diff --git a/BusinessCentral.Sentinel/src/Alert.Table.al b/BusinessCentral.Sentinel/src/Alert.Table.al
@@ -104,10 +104,7 @@ table 71180275 AlertSESTM
 
         Rec.Id := NumberSequence.Next('BCSentinelSESTMAlertId');
 
-        Setup.SetLoadFields(Setup.TelemetryLogging);
-        Setup.ReadIsolation(IsolationLevel::ReadUncommitted);
-        Setup.SaveGet();
-        if Setup.TelemetryLogging = Setup.TelemetryLogging::OnRuleLogging then
+        if Setup.GetTelemetryLoggingSetting(Rec.AlertCode) = Setup.TelemetryLogging::OnRuleLogging then
             this.LogUsage();
     end;
 
@@ -189,7 +186,8 @@ table 71180275 AlertSESTM
         CurrSeverity: Enum SeveritySESTM;
     begin
         SentinelRuleSet.ReadIsolation(IsolationLevel::ReadUncommitted);
-        if SentinelRuleSet.Get(AlertCodeIn) then
+
+        if SentinelRuleSet.Get(AlertCodeIn) and (SentinelRuleSet.Severity <> SentinelRuleSet.Severity::" ") then
             CurrSeverity := SentinelRuleSet.Severity
         else
             CurrSeverity := SeverityIn;

diff --git a/BusinessCentral.Sentinel/src/SentinelRuleSet.Page.al b/BusinessCentral.Sentinel/src/SentinelRuleSet.Page.al
@@ -17,8 +17,8 @@ page 71180277 SentinelRuleSetSESTM
             {
                 field(AlertCode; Rec.AlertCode) { }
                 field(Severity; Rec.Severity) { }
+                field(TelemetryLogging; Rec.TelemetryLogging) { }
             }
-
         }
     }
 }
diff --git a/BusinessCentral.Sentinel/src/SentinelRuleSet.Table.al b/BusinessCentral.Sentinel/src/SentinelRuleSet.Table.al
@@ -21,6 +21,11 @@ table 71180277 SentinelRuleSetSESTM
             Caption = 'Severity';
             ToolTip = 'The severity level of the alert.';
         }
+        field(4; TelemetryLogging; Enum TelemetryLogging)
+        {
+            Caption = 'Telemetry Logging';
+            ToolTip = 'Specifies how sentinel emits telemetry data.';
+        }
     }
 
     keys

diff --git a/BusinessCentral.Sentinel/src/Setup/SentinelSetup.Page.al b/BusinessCentral.Sentinel/src/Setup/SentinelSetup.Page.al
@@ -0,0 +1,25 @@
+namespace STM.BusinessCentral.Sentinel;
+
+page 71180278 SentinelSetup
+{
+    ApplicationArea = All;
+    Caption = 'Sentinel Setup';
+    DeleteAllowed = false;
+    Extensible = false;
+    PageType = Card;
+    SourceTable = SentinelSetup;
+    UsageCategory = Administration;
+
+    layout
+    {
+        area(Content)
+        {
+            group(General)
+            {
+                Caption = 'General';
+
+                field(TelemetryLogging; Rec.TelemetryLogging) { }
+            }
+        }
+    }
+}
diff --git a/BusinessCentral.Sentinel/src/Setup/SentinelSetup.Table.al b/BusinessCentral.Sentinel/src/Setup/SentinelSetup.Table.al
@@ -6,7 +6,9 @@ table 71180278 SentinelSetup
     Caption = 'Sentinel Setup';
     DataClassification = SystemMetadata;
     InherentPermissions = R;
-    Permissions = tabledata SentinelSetup = RI;
+    Permissions =
+        tabledata SentinelRuleSetSESTM = R,
+        tabledata SentinelSetup = RI;
 
     fields
     {
@@ -18,6 +20,9 @@ table 71180278 SentinelSetup
         field(2; TelemetryLogging; Enum TelemetryLogging)
         {
             Caption = 'Telemetry Logging';
+            InitValue = Daily;
+            ToolTip = 'Specifies how sentinel emits telemetry data.';
+            ValuesAllowed = Daily, OnRuleLogging, Off;
         }
     }
 
@@ -37,4 +42,19 @@ table 71180278 SentinelSetup
         end;
     end;
 
+    internal procedure GetTelemetryLoggingSetting(AlertCode: Enum AlertCodeSESTM): Enum TelemetryLogging
+    var
+        SentinelRuleSet: Record SentinelRuleSetSESTM;
+    begin
+        SentinelRuleSet.ReadIsolation(IsolationLevel::ReadCommitted);
+        SentinelRuleSet.SetLoadFields(TelemetryLogging);
+        if SentinelRuleSet.Get(AlertCode) and (SentinelRuleSet.TelemetryLogging <> SentinelRuleSet.TelemetryLogging::" ") then
+            exit(SentinelRuleSet.TelemetryLogging);
+
+        Rec.SetLoadFields(TelemetryLogging);
+        Rec.ReadIsolation(IsolationLevel::ReadCommitted);
+        Rec.SaveGet();
+        exit(Rec.TelemetryLogging);
+    end;
+
 }
diff --git a/BusinessCentral.Sentinel/src/Setup/TelemetryLogging.Enum.al b/BusinessCentral.Sentinel/src/Setup/TelemetryLogging.Enum.al
@@ -5,7 +5,10 @@ enum 71180279 TelemetryLogging
     Access = Internal;
     Extensible = true;
 
-
+    value(0; " ")
+    {
+        Caption = ' ', Locked = true;
+    }
     value(1; Daily)
     {
         Caption = 'Daily';
@@ -14,4 +17,8 @@ enum 71180279 TelemetryLogging
     {
         Caption = 'On Rule Logging';
     }
+    value(3; Off)
+    {
+        Caption = 'Off';
+    }
 }
diff --git a/BusinessCentral.Sentinel/src/Severity.Enum.al b/BusinessCentral.Sentinel/src/Severity.Enum.al
@@ -5,6 +5,10 @@ enum 71180276 SeveritySESTM
     Access = Internal;
     Extensible = false;
 
+    value(0; " ")
+    {
+        Caption = ' ', Locked = true;
+    }
     value(1; Info)
     {
         Caption = 'Info';

diff --git a/BusinessCentral.Sentinel/src/Telemetry/SentinelTelemetryLogger.Codeunit.al b/BusinessCentral.Sentinel/src/Telemetry/SentinelTelemetryLogger.Codeunit.al
@@ -1,10 +1,13 @@
 namespace STM.BusinessCentral.Sentinel;
 
+using STM.BusinessCentral.Sentinel;
 using System.Telemetry;
 
 codeunit 71180285 "SentinelTelemetryLoggerSESTM" implements "Telemetry Logger"
 {
     Access = Internal;
+    Permissions =
+        tabledata AlertSESTM = R;
 
     procedure LogMessage(EventId: Text; Message: Text; Verbosity: Verbosity; DataClassification: DataClassification; TelemetryScope: TelemetryScope; CustomDimensions: Dictionary of [Text, Text])
     begin
@@ -19,4 +22,17 @@ codeunit 71180285 "SentinelTelemetryLoggerSESTM" implements "Telemetry Logger"
     begin
         Sender.Register(SentinelTelemetryLogger);
     end;
+
+    [EventSubscriber(ObjectType::Codeunit, Codeunit::"Telemetry Management", OnSendDailyTelemetry, '', false, false)]
+    local procedure LogSentinelTelemetry_OnSendDailyTelemetry()
+    var
+        Alert: Record AlertSESTM;
+        Setup: Record SentinelSetup;
+    begin
+        if Alert.FindSet() then
+            repeat
+                if Setup.GetTelemetryLoggingSetting(Alert.AlertCode) = Setup.TelemetryLogging::Daily then
+                    Alert.LogUsage();
+            until Alert.Next() = 0;
+    end;
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@
 [Full Changelog](https://github.com/StefanMaron/BusinessCentral.Sentinel/compare/1.6.26...HEAD)
 
 - Improve telemetry logging for rules, change logging to daily, give option to disable logging, log to "All" instead of "ExtensionPublisher"
+- Ability to completely turn off telemetry
+- Ability to control telemetry via ruleset per Alert individually
 - Improve Interface documentation
 
 ## [1.6.26](https://github.com/StefanMaron/BusinessCentral.Sentinel/tree/1.6.26)