Codeunit 6154 API Webhook Notification Send
src/Layers/W1/BaseApp/System/API/Webhooks/APIWebhookNotificationSend.Codeunit.al1,943 lines, Copyright (c) Microsoft Corporation. MIT
namespace Microsoft.API.Webhooks;using Microsoft.Integration.Dataverse;using Microsoft.Integration.Graph;using Microsoft.Utilities;using System;using System.Environment;using System.Environment.Configuration;using System.Integration;using System.Reflection;using System.Security.AccessControl;using System.Text;using System.Threading;using System.Utilities;codeunit 6154 "API Webhook Notification Send"{ // 1. Aggregates notifications // 2. Generates notifications payload per notification URL // 3. Sends notifications Permissions = TableData "API Webhook Subscription" = rimd, TableData "API Webhook Notification" = rimd, TableData "API Webhook Notification Aggr" = rimd; trigger OnRun() var [SecurityFiltering(SecurityFilter::Ignored)] APIWebhookSubscription: Record "API Webhook Subscription"; [SecurityFiltering(SecurityFilter::Ignored)] APIWebhookNotification: Record "API Webhook Notification"; [SecurityFiltering(SecurityFilter::Ignored)] APIWebhookNotificationAggr: Record "API Webhook Notification Aggr"; begin if not IsApiSubscriptionEnabled() then begin Session.LogMessage('000029V', DisabledSubscriptionMsg, Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; if (not APIWebhookSubscription.WritePermission()) or (not APIWebhookNotification.WritePermission()) or (not APIWebhookNotificationAggr.WritePermission()) then begin Session.LogMessage('0000DY0', NoPermissionsTxt, Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; if not APIWebhookNotificationMgt.CanScheduleJob() then begin Session.LogMessage('0000EWZ', NoPermissionsTxt, Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; Initialize(); DeleteExpiredSubscriptions(); DeleteObsoleteSubscriptions(); DeleteInactiveJobs(); if not GetActiveSubscriptions() then begin Session.LogMessage('000029W', NoActiveSubscriptionsMsg, Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; // Don't roll back the cleanup done // and release any potentional locks before starting of processing Commit(); ProcessNotifications(); // Don't roll back the cleanup done // and release any potentional locks before starting of processing Commit(); DeleteObsoleteNotifications(); end; var TempAPIWebhookNotificationAggr: Record "API Webhook Notification Aggr" temporary; TempAPIWebhookSubscription: Record "API Webhook Subscription" temporary; TempFirstModifiedDateTimeAPIWebhookNotification: Record "API Webhook Notification" temporary; TypeHelper: Codeunit "Type Helper"; APIWebhookNotificationMgt: Codeunit "API Webhook Notification Mgt."; SubscriptionIdList: List of [Text[150]]; KeyFieldTypeBySubscriptionId: Dictionary of [Text[150], Text]; SystemIdBySubscriptionIdDictionary: Dictionary of [Text[150], Guid]; TableIdBySubscriptionIdDictionary: Dictionary of [Text[150], Integer]; ResourceUrlBySubscriptionIdDictionary: Dictionary of [Text[150], Text]; NotificationUrlBySubscriptionIdDictionary: Dictionary of [Text[150], Text]; SubscriptionsPerNotificationUrlDictionary: Dictionary of [Text, List of [Text[150]]]; SubscriptionsTypeNotificationUrlDictionary: Dictionary of [Text, Integer]; ProcessingDateTime: DateTime; APIWebhookCategoryLbl: Label 'AL API Webhook', Locked = true; ActivityLogContextLbl: Label 'APIWEBHOOK', Locked = true; JobQueueCategoryCodeLbl: Label 'APIWEBHOOK', Locked = true; ChangeTypeCreatedTok: Label 'created', Locked = true; ChangeTypeUpdatedTok: Label 'updated', Locked = true; ChangeTypeDeletedTok: Label 'deleted', Locked = true; ChangeTypeCollectionTok: Label 'collection', Locked = true; SingleEntityUrlTemplateTxt: Label '%1(%2)', Locked = true; DataverseEntityUrlTemplateTxt: Label '%1companies(%2)/%3', Locked = true; ProcessNotificationsMsg: Label 'Process notifications. Processing time: %1.', Locked = true; DeleteProcessedNotificationsMsg: Label 'Delete processed notifications. Processing time: %1.', Locked = true; SavedFailedNotificationsMsg: Label 'Saved failed notifications. Earliest scheduled time: %1.', Locked = true; SaveFailedNotificationMsg: Label 'Save failed notification. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4. Attempt number: %5.', Locked = true; MissingEntityForNotificationTxt: Label 'Entity linked to notification is not found. Subscription: %1. Entity: %2. Last modification time: %3.', Locked = true; EntityUpdatedJustBeforeNotificationTxt: Label 'Entity update just before notification. Subscription: %1. Entity: %2. System modified at: %3. Last modification time: %4.', Locked = true; IgnoreNotificationOnNullUpdateTxt: Label 'Ignore notification on null update. Subscription: %1. Entity: %2. Entity system modified at: %3. Last modification time: %4.', Locked = true; GenerateAggregateNotificationMsg: Label 'Generate aggregate notification. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4.', Locked = true; MergeIntoExistingCollectionAggregateNotificationMsg: Label 'Merge into existing collection aggregate notification. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4.', Locked = true; MergeAllIntoNewCollectionAggregateNotificationMsg: Label 'Merge all notifications into new collection aggregate notification. Subscription: %1. Last modification time: %2.', Locked = true; GenerateSingleAggregateNotificationMsg: Label 'Generate single aggregate notification. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4.', Locked = true; SendNotificationsMsg: Label 'Send notifications. Unique notification URL count: %1.', Locked = true; SendNotificationMsg: Label 'Send notification. Notification URL number: %1.', Locked = true; AllPayloadsEmptyMsg: Label 'No one notification has been sent. All the payloads are empty.', Locked = true; SucceedNotificationMsg: Label 'Notification has been sent successfully. Notification URL number: %1.', Locked = true; FailedNotificationRescheduleMsg: Label 'Server was not able to process the notification at this point. Notification URL number: %1. Response code %2. Notification is rescheduled.', Locked = true; FailedNotificationRejectedMsg: Label 'Server has rejected the notification. Notification URL number: %1. Response code %2.', Locked = true; NoPendingNotificationsMsg: Label 'No pending notifications.', Locked = true; NoActiveSubscriptionsMsg: Label 'No active subscriptions.', Locked = true; DisabledSubscriptionMsg: Label 'API subscription disabled.', Locked = true; DeleteObsoleteSubscriptionMsg: Label 'Delete obsolete subscription. Subscription: %1. Expiration time: %2. Table: %3.', Locked = true; DeleteExpiredSubscriptionMsg: Label 'Delete expired subscription. Subscription: %1. Expiration time: %2. Table: %3.', Locked = true; DeleteInvalidSubscriptionsMsg: Label 'Delete invalid subscriptions. Subscription count: %1.', Locked = true; DeleteInvalidSubscriptionMsg: Label 'Delete invalid subscription. Subscription: %1.', Locked = true; DeleteSubscriptionWithTooManyFailuresMsg: Label 'Delete subscription with too many failures. Subscription: %1. Expiration time: %2. Table: %3. Attempt number: %4.', Locked = true; DeleteNotificationsForSubscriptionsMsg: Label 'Delete notifications for subscriptions. Subscription count: %1.', Locked = true; DeleteNotificationsForSubscriptionMsg: Label 'Delete notifications for subscription. Subscription: %1.', Locked = true; DeleteNotificationsForDeletedSubscriptionsMsg: Label 'Delete notifications for deleted subscriptions. Subscription count: %1.', Locked = true; DeleteNotificationsForDeletedSubscriptionMsg: Label 'Delete notifications for deleted subscription. Subscription: %1.', Locked = true; DeleteAggrNotificationsForDeletedSubscriptionsMsg: Label 'Delete aggregate notifications for deleted subscriptions. Subscription count: %1.', Locked = true; DeleteAggrNotificationsForDeletedSubscriptionMsg: Label 'Delete aggregate notifications for deleted subscription. Subscription: %1.', Locked = true; UnexpectedNotificationChangeTypeMsg: Label 'Unexpected notification change type. Subscription: %1. Expected change type: %2. Actual change type: %3.', Locked = true; ManyNotificationsOfTypeCollectionMsg: Label 'Many notifications of type collection. Subscription: %1. Expected count: %2. Actual count: %3.', Locked = true; FewNotificationsOfTypeCollectionMsg: Label 'Few notifications of type collection. Subscription: %1. Expected count: %2. Actual count: %3.', Locked = true; UpdateNotificationOfTypeCollectionMsg: Label 'Update notification of type collection. Subscription: %1. First modification time: %2. Last modification time: %3.', Locked = true; MergeNotificationsOfTypeUpdatedMsg: Label 'Merge notifications of type updated. Subscription: %1. Entity: %2. Last modification time: %3.', Locked = true; MergeNotificationsIntoOneOfTypeCollectionMsg: Label 'Merge notifications into one of type collection. Subscription: %1. Notification count: %2. First modification time: %3. Last modification time: %4.', Locked = true; EmptyLastModifiedDateTimeMsg: Label 'Empty last modified time. Subscription: %1. Entity: %2. Change type: %3. Attempt number: %4.', Locked = true; EmptyNotificationUrlErr: Label 'Empty notification URL. Notification URL number: %1.', Locked = true; EmptySubscriptionIdErr: Label 'Empty subscription ID.', Locked = true; EmptyPayloadPerSubscriptionErr: Label 'Empty payload for subscription. Subscription: %1.', Locked = true; EmptyPayloadPerNotificationUrlErr: Label 'Empty payload per notification URL. Notification URL number: %1.', Locked = true; CannotGetResponseErr: Label 'Cannot get response. Notification URL number: %1.', Locked = true; CannotFindCachedAggregateNotificationErr: Label 'Cannot find cached aggregate notification for subscription. Subscription: %1.', Locked = true; CannotFindCachedCollectionAggregateNotificationMsg: Label 'Cannot find cached collection aggregate notification for subscription. Subscription: %1.', Locked = true; CannotFindCachedEntityKeyFieldTypeForSubscriptionIdErr: Label 'Cannot find cached entity key field type for subscription. Subscription: %1.', Locked = true; CannotFindCachedFirstModifiedTimeForSubscriptionIdMsg: Label 'Cannot find cached first modified time for subscription. Subscription: %1.', Locked = true; CannotFindCachedResourceUrlForSubscriptionIdErr: Label 'Cannot find cached resource URL for subscription. Subscription: %1.', Locked = true; CannotFindCachedNotificationUrlForSubscriptionIdErr: Label 'Cannot find cached notification URL for subscription. Subscription: %1.', Locked = true; CannotFindCachedSubscriptionsForNotificationUrlNumberErr: Label 'Cannot find cached subscriptions for notification URL. URL number %1.', Locked = true; CannotFindCachedNotificationUrlForNotificationUrlNumberErr: Label 'Cannot find cached notification URL for notification URL. URL number %1.', Locked = true; CannotFindSystemIdForSubscriptionIdTxt: Label 'Cannot find system ID for subscription. Subscription: %1.', Locked = true; CannotFindTableIdForSubscriptionIdTxt: Label 'Cannot find table ID for subscription. Subscription: %1.', Locked = true; FoundCachedEntityKeyFieldTypeForSubscriptionIdMsg: Label 'Found cached entity key field type for subscription. Subscription: %1. Cached value: %2', Locked = true; FoundCachedFirstModifiedTimeForSubscriptionIdMsg: Label 'Found cached first modified time for subscription. Subscription: %1. Cached value: %2.', Locked = true; FoundCachedResourceUrlForSubscriptionIdMsg: Label 'Found cached resource URL for subscription. Subscription: %1.', Locked = true; FoundCachedNotificationUrlForSubscriptionIdMsg: Label 'Found cached notification URL for subscription. Subscription: %1.', Locked = true; FoundCachedSubscriptionsForNotificationUrlNumberMsg: Label 'Found cached subscriptions for notification URL. URL number %2. Subscription count: %1', Locked = true; CachedResourceUrlForSubscriptionIdMsg: Label 'Resource URL for subscription is cached already. Subscription: %1.', Locked = true; CachedNotificationUrlForSubscriptionIdMsg: Label 'Notification URL for subscription is cached already. Subscription: %1.', Locked = true; CachingEntityKeyFieldTypeForSubscriptionIdMsg: Label 'Caching entity key field type for subscription. Subscription %1.', Locked = true; CachingFirstModifiedTimeForSubscriptionIdMsg: Label 'Caching first modified time for subscription. Subscription: %1. Old value: %2. New value: %3.', Locked = true; NewFirstModifiedTimeLaterThanCachedMsg: Label 'New first modified time is later than cached time for subscription. Subscription: %1. Old value: %2. New value: %3.', Locked = true; CachingSystemIdForSubscriptionIdMsg: Label 'Caching system ID for subscription. Subscription: %1.', Locked = true; CachingTableIdForSubscriptionIdMsg: Label 'Caching table ID for subscription. Subscription: %1.', Locked = true; CachingResourceUrlForSubscriptionIdMsg: Label 'Caching resource URL for subscription. Subscription: %1', Locked = true; CachingNotificationUrlForSubscriptionIdMsg: Label 'Caching notification URL for subscription. Subscription: %1.', Locked = true; CachingSubscriptionsForNotificationUrlMsg: Label 'Adding subscription to the cached list of subscription system IDs by notification URL. Subscription: %1.', Locked = true; CachingSubscriptionTypesForNotificationUrlMsg: Label 'Adding subscription to the cached list of subscription types by notification URL. Subscription: %1.', Locked = true; CollectPayloadPerNotificationUrlMsg: Label 'Collect payload per notification URL. Notification URL number: %1. Subscription count: %2.', Locked = true; CollectPayloadPerSubscriptionMsg: Label 'Collect payload per subscription. Subscription: %1.', Locked = true; CollectNotificationPayloadMsg: Label 'Collect notification payload. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4.', Locked = true; CannotFindSubscriptionErr: Label 'Cannot find subscription. Subscription: %1.', Locked = true; NoNotificationsForSubscriptionMsg: Label 'No notifications for subscription. Subscription: %1.', Locked = true; RescheduleBeforeOrEqualToProcessingMsg: Label 'Reschedule time is before or equal to processing time. Reschedule time: %1. Processing time: %2.', Locked = true; IncreaseAttemptNumberForSubscriptionsMsg: Label 'Increase attempt number for notifications. Processing time: %1.', Locked = true; IncreaseAttemptNumberForSubscriptionMsg: Label 'Increase attempt number for notifications. Subscription: %1. Processing time: %2.', Locked = true; IncreaseAttemptNumberForNotificationMsg: Label 'Increase attempt number for notification. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4. Attempt number: %5. Scheduled time: %6. Processing time: %7.', Locked = true; DoNotIncreaseAttemptNumberForNotificationMsg: Label 'Do not increase attempt number for notification. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4. Attempt number: %5. Scheduled time: %6. Processing time: %7.', Locked = true; SendingNotificationFailedErr: Label 'Sending notification failed. Notification URL: %1. Response code: %2. Error message: %3. Error details: %4.', Locked = true; CannotInsertAggregateNotificationErr: Label 'Cannot insert aggregate notification. Subscription: %1. Entity: %2. Change type: %3. Last modification time: %4. Attempt number: %5. Sending scheduled time: %6.', Locked = true; SendingJobFailedMsg: Label 'Sending job failed. Earliest start time: %1.', Locked = true; FailedJobDetailsMsg: Label 'Sending job failed. %1', Locked = true; DeleteInactiveJobMsg: Label 'Delete inactive job. Status: %1. Earliest start time: %2.', Locked = true; DeleteReadyButNotScheduledJobMsg: Label 'Delete ready but not scheduled job. Earliest start time: %1.', Locked = true; DeleteJobWithWrongParametersMsg: Label 'Delete job with wrong parameters. Category: %1. Recurring: %2. Earliest start time: %3.', Locked = true; SubscriptionDetailsTxt: Label 'Subscription ID: %1. Resource URL: %2. Notification URL: %3.', Locked = true; FailedNotificationDetailsTxt: Label 'Notification URL: %1. Response code: %2. Error message: %3. Error details: %4.', Locked = true; DeleteInvalidSubscriptionTitleTxt: Label 'Delete invalid subscription.', Locked = true; DeleteObsoleteSubscriptionTitleTxt: Label 'Delete obsolete subscription.', Locked = true; DeleteExpiredSubscriptionTitleTxt: Label 'Delete expired subscription.', Locked = true; DeleteSubscriptionWithTooManyFailuresTitleTxt: Label 'Delete subscription with too many failures.', Locked = true; IncreaseAttemptNumberTitleTxt: Label 'Increase attempt number.', Locked = true; NotificationFailedTitleTxt: Label 'Notification failed.', Locked = true; JobFailedTitleTxt: Label 'Job failed.', Locked = true; NoPermissionsTxt: Label 'No permissions.', Locked = true; PostEmittedTxt: Label 'Notification POST emitted to URL %1.', Locked = true; PostFailedTxt: Label 'Notification POST failed. Notification URL: %1. Response code %2.', Locked = true; PostCorrelationGuidTxt: Label 'Correlation GUID for notification POST created: %1', Locked = true; SameNotificationUrlDifferentTypeErr: Label 'Same notification URL cannot have multiple subscrition types.', Locked = true; local procedure Initialize() begin TempAPIWebhookNotificationAggr.Reset(); TempAPIWebhookNotificationAggr.DeleteAll(); TempAPIWebhookNotificationAggr.SetCurrentKey("Subscription ID", "Last Modified Date Time", "Change Type"); TempAPIWebhookNotificationAggr.Ascending(true); TempAPIWebhookSubscription.Reset(); TempAPIWebhookSubscription.DeleteAll(); TempAPIWebhookSubscription.SetCurrentKey("Subscription Id"); TempAPIWebhookSubscription.Ascending(true); TempFirstModifiedDateTimeAPIWebhookNotification.Reset(); TempFirstModifiedDateTimeAPIWebhookNotification.DeleteAll(); TempFirstModifiedDateTimeAPIWebhookNotification.SetCurrentKey("Subscription ID"); TempFirstModifiedDateTimeAPIWebhookNotification.Ascending(true); Clear(SubscriptionIdList); Clear(SystemIdBySubscriptionIdDictionary); Clear(TableIdBySubscriptionIdDictionary); Clear(KeyFieldTypeBySubscriptionId); Clear(ResourceUrlBySubscriptionIdDictionary); Clear(NotificationUrlBySubscriptionIdDictionary); Clear(SubscriptionsPerNotificationUrlDictionary); ProcessingDateTime := CurrentDateTime(); end; local procedure ProcessNotifications() var RescheduleDateTime: DateTime; AggregateNotificationsExist: Boolean; begin Session.LogMessage('00006ZT', StrSubstNo(ProcessNotificationsMsg, DateTimeToString(ProcessingDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); OnBeforeProcessNotifications(); TransferAggregateNotificationsToBuffer(); AggregateNotificationsExist := GenerateAggregateNotifications(); if AggregateNotificationsExist then begin SendNotifications(); UpdateTablesFromBuffer(RescheduleDateTime); if RescheduleDateTime > ProcessingDateTime then APIWebhookNotificationMgt.ScheduleJob(RescheduleDateTime) else if RescheduleDateTime <> 0DT then Session.LogMessage('00006ZU', StrSubstNo(RescheduleBeforeOrEqualToProcessingMsg, DateTimeToString(RescheduleDateTime), DateTimeToString(ProcessingDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); end; OnAfterProcessNotifications(); end; local procedure SendNotifications() var SubscriptionIds: List of [Text[150]]; NotificationUrl: Text; PayloadPerNotificationUrl: Text; NotificationUrlCount: Integer; I: Integer; Reschedule: Boolean; HasPayload: Boolean; begin NotificationUrlCount := SubscriptionsPerNotificationUrlDictionary.Keys().Count(); Session.LogMessage('00006ZV', StrSubstNo(SendNotificationsMsg, NotificationUrlCount), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); for I := 1 to NotificationUrlCount do if GetSubscriptionsPerNotificationUrl(I, NotificationUrl, SubscriptionIds) then begin PayloadPerNotificationUrl := GetPayloadPerNotificationUrl(I, SubscriptionIds); if not HasPayload then HasPayload := PayloadPerNotificationUrl <> ''; if SendNotification(I, NotificationUrl, PayloadPerNotificationUrl, Reschedule) then DeleteNotifications(SubscriptionIds) else if Reschedule then IncreaseAttemptNumber(SubscriptionIds) else begin DeleteNotifications(SubscriptionIds); DeleteInvalidSubscriptions(SubscriptionIds); end; end; if not HasPayload then Session.LogMessage('0000735', AllPayloadsEmptyMsg, Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); end; local procedure GetPayloadPerNotificationUrl(NotificationUrlNumber: Integer; var SubscriptionIds: List of [Text[150]]): Text var JSONManagement: Codeunit "JSON Management"; JsonArray: DotNet JArray; SubscriptionId: Text[150]; PayloadPerNotificationUrl: Text; begin Session.LogMessage('00006ZX', StrSubstNo(CollectPayloadPerNotificationUrlMsg, NotificationUrlNumber, SubscriptionIds.Count()), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); JSONManagement.InitializeEmptyCollection(); JSONManagement.GetJsonArray(JsonArray); foreach SubscriptionId in SubscriptionIds do AddPayloadPerSubscription(JSONManagement, JsonArray, SubscriptionId); if JsonArray.Count() = 0 then begin Session.LogMessage('000029X', StrSubstNo(EmptyPayloadPerNotificationUrlErr, NotificationUrlNumber), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit('') end; PayloadPerNotificationUrl := JsonArray.ToString(); FormatPayloadPerNotificationUrl(PayloadPerNotificationUrl, SubscriptionsPerNotificationUrlDictionary.Keys().Get(NotificationUrlNumber)); exit(PayloadPerNotificationUrl); end; local procedure AddPayloadPerSubscription(var JSONManagement: Codeunit "JSON Management"; var JsonArray: DotNet JArray; SubscriptionId: Text[150]) var JsonObject: DotNet JObject; I: Integer; SubscriptionSystemId: Guid; begin SubscriptionSystemId := GetSystemIdBySubscriptionId(SubscriptionId); Session.LogMessage('00006ZY', StrSubstNo(CollectPayloadPerSubscriptionMsg, SubscriptionSystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if SubscriptionId = '' then begin Session.LogMessage('00006ZZ', EmptySubscriptionIdErr, Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", SubscriptionId); if not TempAPIWebhookNotificationAggr.Find('-') then begin Session.LogMessage('0000700', StrSubstNo(NoNotificationsForSubscriptionMsg, SubscriptionSystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; // We have two rows for a notification of change type Collection. We take the last one. if TempAPIWebhookNotificationAggr."Change Type" = TempAPIWebhookNotificationAggr."Change Type"::Collection then TempAPIWebhookNotificationAggr.FindLast(); repeat if GetEntityJObject(TempAPIWebhookNotificationAggr, JsonObject) then begin JSONManagement.AddJObjectToJArray(JsonArray, JsonObject); I += 1; Session.LogMessage('00006ZW', StrSubstNo(CollectNotificationPayloadMsg, SubscriptionSystemId, TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); end; until TempAPIWebhookNotificationAggr.Next() = 0; if I > 0 then exit; Session.LogMessage('000029Y', StrSubstNo(EmptyPayloadPerSubscriptionErr, SubscriptionSystemId), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); end; local procedure FormatPayloadPerNotificationUrl(var PayloadPerNotificationUrl: Text; NotificationUrl: Text) var APIWebhookSubscription: Record "API Webhook Subscription"; JSONManagement: Codeunit "JSON Management"; JsonObject: DotNet JObject; JsonArray: DotNet JArray; begin if PayloadPerNotificationUrl = '' then exit; if SubscriptionsTypeNotificationUrlDictionary.Get(NotificationUrl) = APIWebhookSubscription."Subscription Type"::Regular then begin JSONManagement.InitializeCollection(PayloadPerNotificationUrl); JSONManagement.GetJsonArray(JsonArray); JSONManagement.InitializeEmptyObject(); JSONManagement.GetJSONObject(JsonObject); JSONManagement.AddJArrayToJObject(JsonObject, 'value', JsonArray); PayloadPerNotificationUrl := JsonObject.ToString(); end else begin JSONManagement.InitializeEmptyObject(); JSONManagement.GetJSONObject(JsonObject); JSONManagement.AddJPropertyToJObject(JsonObject, 'ProviderName', 'dyn365bc'); JSONManagement.AddJPropertyToJObject(JsonObject, 'Request', PayloadPerNotificationUrl); PayloadPerNotificationUrl := JsonObject.ToString(); end; end; local procedure GetPendingNotifications(SubscriptionId: Text[150]; var APIWebhookNotification: Record "API Webhook Notification"; ProcessingDateTime: DateTime): Boolean begin APIWebhookNotification.SetCurrentKey("Subscription ID", "Last Modified Date Time", "Change Type"); APIWebhookNotification.Ascending(true); APIWebhookNotification.SetRange("Subscription ID", SubscriptionId); APIWebhookNotification.SetFilter("Last Modified Date Time", '<=%1', ProcessingDateTime); exit(APIWebhookNotification.FindSet()); end; local procedure TransferAggregateNotificationsToBuffer() var APIWebhookNotificationAggr: Record "API Webhook Notification Aggr"; EmptyGuid: Guid; SubscriptionId: Text[150]; begin foreach SubscriptionId in SubscriptionIdList do begin APIWebhookNotificationAggr.SetFilter(ID, '<>%1', EmptyGuid); APIWebhookNotificationAggr.SetRange("Subscription ID", SubscriptionId); if APIWebhookNotificationAggr.FindSet() then repeat TempAPIWebhookNotificationAggr.TransferFields(APIWebhookNotificationAggr, true); if not TempAPIWebhookNotificationAggr.Insert() then begin Session.LogMessage('0000736', StrSubstNo(CannotInsertAggregateNotificationErr, GetSystemIdBySubscriptionId(TempAPIWebhookNotificationAggr."Subscription ID"), TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time"), TempAPIWebhookNotificationAggr."Attempt No.", DateTimeToString(TempAPIWebhookNotificationAggr."Sending Scheduled Date Time")), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; until APIWebhookNotificationAggr.Next() = 0; end; end; local procedure GenerateAggregateNotifications(): Boolean var APIWebhookNotification: Record "API Webhook Notification"; PendingNotificationsExist: Boolean; NewNotificationsExist: Boolean; SubscriptionId: Text[150]; begin ClearFiltersFromNotificationsBuffer(); PendingNotificationsExist := TempAPIWebhookNotificationAggr.FindFirst(); if PendingNotificationsExist then CollectFirstModifiedTimeForPendingCollectionNotifications(); foreach SubscriptionId in SubscriptionIdList do if GetPendingNotifications(SubscriptionId, APIWebhookNotification, ProcessingDateTime) then repeat if not IsNullUpdate(APIWebhookNotification) then begin NewNotificationsExist := true; GenerateAggregateNotification(APIWebhookNotification); end; until APIWebhookNotification.Next() = 0; if (not PendingNotificationsExist) and (not NewNotificationsExist) then begin Session.LogMessage('0000298', NoPendingNotificationsMsg, Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; exit(true); end; local procedure GenerateAggregateNotification(var APIWebhookNotification: Record "API Webhook Notification") var TooManyNotifications: Boolean; begin Session.LogMessage('000073O', StrSubstNo(GenerateAggregateNotificationMsg, GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"), APIWebhookNotification."Entity ID", ChangeTypeToString(APIWebhookNotification."Change Type"), DateTimeToString(APIWebhookNotification."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", APIWebhookNotification."Subscription ID"); if TempAPIWebhookNotificationAggr.FindLast() then begin if TempAPIWebhookNotificationAggr."Change Type" = TempAPIWebhookNotificationAggr."Change Type"::Collection then begin MergeIntoExistingCollectionAggregateNotification(APIWebhookNotification); exit; end; if APIWebhookNotification."Change Type" = APIWebhookNotification."Change Type"::Updated then if MergeIntoExistingUpdatedAggregateNotification(APIWebhookNotification) then exit; end; GenerateSingleAggregateNotification(APIWebhookNotification, TooManyNotifications); if TooManyNotifications then MergeAllIntoNewCollectionAggregateNotification(APIWebhookNotification); end; local procedure CollectFirstModifiedTimeForPendingCollectionNotifications() var PrevSubscriptionId: Text[150]; begin ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Change Type", TempAPIWebhookNotificationAggr."Change Type"::Collection); if not TempAPIWebhookNotificationAggr.FindFirst() then exit; // We have two rows for a notification of change type Collection. We collect the date from the first one. repeat if TempAPIWebhookNotificationAggr."Subscription ID" <> PrevSubscriptionId then begin if TempAPIWebhookNotificationAggr."Subscription ID" <> '' then CollectFirstModifiedTimeBySubscriptionId( TempAPIWebhookNotificationAggr."Subscription ID", TempAPIWebhookNotificationAggr."Last Modified Date Time"); PrevSubscriptionId := TempAPIWebhookNotificationAggr."Subscription ID"; end; until TempAPIWebhookNotificationAggr.Next() = 0; end; local procedure MergeIntoExistingCollectionAggregateNotification(var APIWebhookNotification: Record "API Webhook Notification") var LastAPIWebhookNotification: Record "API Webhook Notification"; CountPerSubscription: Integer; FirstNotificationId: Guid; LastNotificationId: Guid; FirstModifiedDateTime: DateTime; LastModifiedDateTime: DateTime; SubscriptionSystemId: Guid; EmptyGuid: Guid; begin SubscriptionSystemId := GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"); Session.LogMessage('000073P', StrSubstNo(MergeIntoExistingCollectionAggregateNotificationMsg, SubscriptionSystemId, APIWebhookNotification."Entity ID", ChangeTypeToString(APIWebhookNotification."Change Type"), DateTimeToString(APIWebhookNotification."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", APIWebhookNotification."Subscription ID"); if not TempAPIWebhookNotificationAggr.FindLast() then begin Session.LogMessage('000073Q', StrSubstNo(CannotFindCachedCollectionAggregateNotificationMsg, SubscriptionSystemId), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; if TempAPIWebhookNotificationAggr."Change Type" <> TempAPIWebhookNotificationAggr."Change Type"::Collection then begin Session.LogMessage('000073R', StrSubstNo(CannotFindCachedCollectionAggregateNotificationMsg, SubscriptionSystemId), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; LastNotificationId := TempAPIWebhookNotificationAggr.ID; CountPerSubscription := TempAPIWebhookNotificationAggr.Count(); GetLastNotification(LastAPIWebhookNotification, APIWebhookNotification."Subscription ID"); LastModifiedDateTime := LastAPIWebhookNotification."Last Modified Date Time"; TempAPIWebhookNotificationAggr."Last Modified Date Time" := LastModifiedDateTime; TempAPIWebhookNotificationAggr.Modify(true); TempAPIWebhookNotificationAggr.FindFirst(); if TempAPIWebhookNotificationAggr."Change Type" <> TempAPIWebhookNotificationAggr."Change Type"::Collection then begin Session.LogMessage('000073S', StrSubstNo(UnexpectedNotificationChangeTypeMsg, SubscriptionSystemId, ChangeTypeCollectionTok, ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type")), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); TempAPIWebhookNotificationAggr."Change Type" := TempAPIWebhookNotificationAggr."Change Type"::Collection; TempAPIWebhookNotificationAggr.Modify(true); end; FirstNotificationId := TempAPIWebhookNotificationAggr.ID; if TempAPIWebhookNotificationAggr."Last Modified Date Time" <> 0DT then if LastAPIWebhookNotification."Change Type" <> LastAPIWebhookNotification."Change Type"::Deleted then if not HasNotificationOnDelete(APIWebhookNotification."Subscription ID") then FirstModifiedDateTime := TempAPIWebhookNotificationAggr."Last Modified Date Time"; if TempAPIWebhookNotificationAggr."Last Modified Date Time" <> FirstModifiedDateTime then begin TempAPIWebhookNotificationAggr."Last Modified Date Time" := FirstModifiedDateTime; TempAPIWebhookNotificationAggr.Modify(true); end; // We should have two rows for a notification of change type Collection. if CountPerSubscription <> 2 then if CountPerSubscription = 1 then begin Session.LogMessage('000072W', StrSubstNo(FewNotificationsOfTypeCollectionMsg, SubscriptionSystemId, 2, CountPerSubscription), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); FirstModifiedDateTime := 0DT; TempAPIWebhookNotificationAggr.ID := CreateGuid(); TempAPIWebhookNotificationAggr."Entity ID" := EmptyGuid; TempAPIWebhookNotificationAggr."Last Modified Date Time" := FirstModifiedDateTime; if not TempAPIWebhookNotificationAggr.Insert() then begin Session.LogMessage('0000737', StrSubstNo(CannotInsertAggregateNotificationErr, SubscriptionSystemId, TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time"), TempAPIWebhookNotificationAggr."Attempt No.", DateTimeToString(TempAPIWebhookNotificationAggr."Sending Scheduled Date Time")), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; end else begin Session.LogMessage('00006P2', StrSubstNo(ManyNotificationsOfTypeCollectionMsg, SubscriptionSystemId, 2, CountPerSubscription), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); TempAPIWebhookNotificationAggr.SetFilter(ID, '<>%1&<>%2', FirstNotificationId, LastNotificationId); TempAPIWebhookNotificationAggr.DeleteAll(); end; Session.LogMessage('0000712', StrSubstNo(UpdateNotificationOfTypeCollectionMsg, SubscriptionSystemId, DateTimeToString(FirstModifiedDateTime), DateTimeToString(LastModifiedDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); CollectFirstModifiedTimeBySubscriptionId(APIWebhookNotification."Subscription ID", FirstModifiedDateTime); APIWebhookNotification := LastAPIWebhookNotification; end; local procedure MergeIntoExistingUpdatedAggregateNotification(var APIWebhookNotification: Record "API Webhook Notification"): Boolean begin ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", APIWebhookNotification."Subscription ID"); TempAPIWebhookNotificationAggr.SetRange("Entity Key Value", APIWebhookNotification."Entity Key Value"); if TempAPIWebhookNotificationAggr.FindLast() then if TempAPIWebhookNotificationAggr."Change Type" = TempAPIWebhookNotificationAggr."Change Type"::Updated then begin Session.LogMessage('0000713', StrSubstNo(MergeNotificationsOfTypeUpdatedMsg, GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"), APIWebhookNotification."Entity ID", DateTimeToString(APIWebhookNotification."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); TempAPIWebhookNotificationAggr."Last Modified Date Time" := APIWebhookNotification."Last Modified Date Time"; TempAPIWebhookNotificationAggr."Created By User SID" := APIWebhookNotification."Created By User SID"; TempAPIWebhookNotificationAggr.Modify(true); exit(true); end; exit(false); end; local procedure GenerateSingleAggregateNotification(var APIWebhookNotification: Record "API Webhook Notification"; var TooManyNotifications: Boolean) var CountPerSubscription: Integer; SubscriptionSystemId: Guid; begin ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", APIWebhookNotification."Subscription ID"); CountPerSubscription := TempAPIWebhookNotificationAggr.Count(); TooManyNotifications := CountPerSubscription > GetMaxNumberOfNotifications() - 1; if TooManyNotifications then exit; SubscriptionSystemId := GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"); Session.LogMessage('000073T', StrSubstNo(GenerateSingleAggregateNotificationMsg, SubscriptionSystemId, APIWebhookNotification."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); TempAPIWebhookNotificationAggr.TransferFields(APIWebhookNotification, true); if not TempAPIWebhookNotificationAggr.Insert() then begin Session.LogMessage('0000738', StrSubstNo(CannotInsertAggregateNotificationErr, SubscriptionSystemId, TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time"), TempAPIWebhookNotificationAggr."Attempt No.", DateTimeToString(TempAPIWebhookNotificationAggr."Sending Scheduled Date Time")), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; end; local procedure MergeAllIntoNewCollectionAggregateNotification(var APIWebhookNotification: Record "API Webhook Notification") var FirstNotificationId: Guid; FirstModifiedDateTime: DateTime; LastModifiedDateTime: DateTime; CountPerSubscription: Integer; SubscriptionSystemId: Guid; begin SubscriptionSystemId := GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"); Session.LogMessage('000073U', StrSubstNo(MergeAllIntoNewCollectionAggregateNotificationMsg, SubscriptionSystemId, DateTimeToString(APIWebhookNotification."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", APIWebhookNotification."Subscription ID"); if not TempAPIWebhookNotificationAggr.FindFirst() then begin Session.LogMessage('000073V', StrSubstNo(CannotFindCachedAggregateNotificationErr, SubscriptionSystemId), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; CountPerSubscription := TempAPIWebhookNotificationAggr.Count(); FirstNotificationId := TempAPIWebhookNotificationAggr.ID; FirstModifiedDateTime := 0DT; if TempAPIWebhookNotificationAggr."Last Modified Date Time" <> 0DT then if APIWebhookNotification."Change Type" <> APIWebhookNotification."Change Type"::Deleted then if not HasNotificationOnDelete(APIWebhookNotification."Subscription ID") then FirstModifiedDateTime := TempAPIWebhookNotificationAggr."Last Modified Date Time"; TempAPIWebhookNotificationAggr."Last Modified Date Time" := FirstModifiedDateTime; TempAPIWebhookNotificationAggr."Change Type" := TempAPIWebhookNotificationAggr."Change Type"::Collection; TempAPIWebhookNotificationAggr.Modify(true); LastModifiedDateTime := APIWebhookNotification."Last Modified Date Time"; Session.LogMessage('0000714', StrSubstNo(MergeNotificationsIntoOneOfTypeCollectionMsg, SubscriptionSystemId, CountPerSubscription, DateTimeToString(FirstModifiedDateTime), DateTimeToString(LastModifiedDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); CollectFirstModifiedTimeBySubscriptionId(APIWebhookNotification."Subscription ID", FirstModifiedDateTime); ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", APIWebhookNotification."Subscription ID"); TempAPIWebhookNotificationAggr.SetFilter(ID, '<>%1', FirstNotificationId); TempAPIWebhookNotificationAggr.DeleteAll(); TempAPIWebhookNotificationAggr.TransferFields(APIWebhookNotification, true); TempAPIWebhookNotificationAggr."Last Modified Date Time" := LastModifiedDateTime; TempAPIWebhookNotificationAggr."Change Type" := TempAPIWebhookNotificationAggr."Change Type"::Collection; if not TempAPIWebhookNotificationAggr.Insert() then begin Session.LogMessage('0000739', StrSubstNo(CannotInsertAggregateNotificationErr, SubscriptionSystemId, TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time"), TempAPIWebhookNotificationAggr."Attempt No.", DateTimeToString(TempAPIWebhookNotificationAggr."Sending Scheduled Date Time")), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; end; local procedure GetLastNotification(var APIWebhookNotification: Record "API Webhook Notification"; SubscriptionId: Text[150]) begin APIWebhookNotification.SetRange("Subscription ID", SubscriptionId); APIWebhookNotification.SetCurrentKey("Last Modified Date Time", "Change Type"); APIWebhookNotification.Ascending(true); APIWebhookNotification.FindLast(); end; local procedure HasNotificationOnDelete(SubscriptionId: Text[150]): Boolean var APIWebhookNotification: Record "API Webhook Notification"; begin APIWebhookNotification.SetRange("Subscription ID", SubscriptionId); APIWebhookNotification.SetRange("Change Type", APIWebhookNotification."Change Type"::Deleted); exit(not APIWebhookNotification.IsEmpty()); end; local procedure IsNullUpdate(var APIWebhookNotification: Record "API Webhook Notification"): Boolean var RecordRef: RecordRef; ModifiedAt: DateTime; TableId: Integer; begin if APIWebhookNotification."Change Type" <> APIWebhookNotification."Change Type"::Updated then exit(false); if IsNullGuid(APIWebhookNotification."Entity ID") then exit(false); TableId := GetTableIdBySubscriptionId(APIWebhookNotification."Subscription ID"); if TableId = 0 then exit(false); RecordRef.Open(TableId); if not RecordRef.GetBySystemId(APIWebhookNotification."Entity ID") then begin // record has already been deleted Session.LogMessage('0000EW4', StrSubstNo(MissingEntityForNotificationTxt, GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"), APIWebhookNotification."Entity ID", DateTimeToString(APIWebhookNotification."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; ModifiedAt := RecordRef.Field(RecordRef.SystemModifiedAtNo).Value(); // "Last Modified Date Time" is set by a subscriber to OnDatabaseModify. // Platform updates $systemModifiedAt after OnDatabaseModify but only in case of actual change. if ModifiedAt > APIWebhookNotification."Last Modified Date Time" then // actual change as $systemModifiedAt is updated after OnDatabaseModify exit(false); if ModifiedAt > APIWebhookNotification."Last Modified Date Time" - NullUpdateTreshold() then begin // change could be actual if another subscriber to OnDatabaseModify modified the record Session.LogMessage('0000EW5', StrSubstNo(EntityUpdatedJustBeforeNotificationTxt, GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"), APIWebhookNotification."Entity ID", DateTimeToString(ModifiedAt), DateTimeToString(APIWebhookNotification."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; // null update - no one field has been changed Session.LogMessage('0000EV7', StrSubstNo(IgnoreNotificationOnNullUpdateTxt, GetSystemIdBySubscriptionId(APIWebhookNotification."Subscription ID"), APIWebhookNotification."Entity ID", DateTimeToString(ModifiedAt), DateTimeToString(APIWebhookNotification."Last Modified Date Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(true); end; local procedure CollectValuesInDictionaries(var APIWebhookSubscription: Record "API Webhook Subscription") begin CollectSystemIdBySubscriptionId(APIWebhookSubscription); CollectTableIdBySubscriptionId(APIWebhookSubscription); CollectKeyFieldTypeBySubscriptionId(APIWebhookSubscription); CollectResourceUrlBySubscriptionId(APIWebhookSubscription); CollectNotificationUrlBySubscriptionId(APIWebhookSubscription); CollectSubscriptionsPerNotificationUrl(APIWebhookSubscription); CollectSubscriptionTypesPerNotificationUrl(APIWebhookSubscription); end; local procedure CollectSystemIdBySubscriptionId(var APIWebhookSubscription: Record "API Webhook Subscription") begin if SystemIdBySubscriptionIdDictionary.ContainsKey(APIWebhookSubscription."Subscription Id") then exit; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000EVE', StrSubstNo(CachingSystemIdForSubscriptionIdMsg, APIWebhookSubscription."Subscription Id"), Verbosity::Normal, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); SubscriptionIdList.Add(APIWebhookSubscription."Subscription Id"); SystemIdBySubscriptionIdDictionary.Add(APIWebhookSubscription."Subscription Id", APIWebhookSubscription.SystemId); end; local procedure CollectTableIdBySubscriptionId(var APIWebhookSubscription: Record "API Webhook Subscription") begin if TableIdBySubscriptionIdDictionary.ContainsKey(APIWebhookSubscription."Subscription Id") then exit; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000EWD', StrSubstNo(CachingTableIdForSubscriptionIdMsg, APIWebhookSubscription."Subscription Id"), Verbosity::Normal, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); TableIdBySubscriptionIdDictionary.Add(APIWebhookSubscription."Subscription Id", APIWebhookSubscription."Source Table Id"); end; local procedure CollectKeyFieldTypeBySubscriptionId(var APIWebhookSubscription: Record "API Webhook Subscription") var ApiWebhookEntity: Record "Api Webhook Entity"; RecRef: RecordRef; FieldRef: FieldRef; KeyFieldType: Text; begin if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000702', StrSubstNo(CachingEntityKeyFieldTypeForSubscriptionIdMsg, APIWebhookSubscription.SystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if not APIWebhookNotificationMgt.GetEntity(APIWebhookSubscription, ApiWebhookEntity) then exit; RecRef.Open(APIWebhookSubscription."Source Table Id", true); if not APIWebhookNotificationMgt.TryGetEntityKeyField(APIWebhookSubscription, ApiWebhookEntity, RecRef, FieldRef) then exit; KeyFieldType := Format(FieldRef.Type); if not KeyFieldTypeBySubscriptionId.ContainsKey(APIWebhookSubscription."Subscription Id") then KeyFieldTypeBySubscriptionId.Add(APIWebhookSubscription."Subscription Id", KeyFieldType); end; local procedure CollectFirstModifiedTimeBySubscriptionId(SubscriptionId: Text[150]; FirstModifiedDateTime: DateTime) var OldValue: DateTime; NewValue: DateTime; SubscriptionSystemId: Guid; begin SubscriptionSystemId := GetSystemIdBySubscriptionId(SubscriptionId); OldValue := 0DT; NewValue := FirstModifiedDateTime; TempFirstModifiedDateTimeAPIWebhookNotification.SetRange("Subscription ID", SubscriptionId); if not TempFirstModifiedDateTimeAPIWebhookNotification.FindFirst() then begin Session.LogMessage('000072X', StrSubstNo(CachingFirstModifiedTimeForSubscriptionIdMsg, SubscriptionSystemId, OldValue, NewValue), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); Clear(TempFirstModifiedDateTimeAPIWebhookNotification); TempFirstModifiedDateTimeAPIWebhookNotification.ID := CreateGuid(); TempFirstModifiedDateTimeAPIWebhookNotification."Subscription ID" := SubscriptionId; TempFirstModifiedDateTimeAPIWebhookNotification."Last Modified Date Time" := FirstModifiedDateTime; TempFirstModifiedDateTimeAPIWebhookNotification.Insert(); exit; end; OldValue := TempFirstModifiedDateTimeAPIWebhookNotification."Last Modified Date Time"; if NewValue < OldValue then begin Session.LogMessage('000072Y', StrSubstNo(CachingFirstModifiedTimeForSubscriptionIdMsg, SubscriptionSystemId, OldValue, NewValue), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); TempFirstModifiedDateTimeAPIWebhookNotification."Last Modified Date Time" := NewValue; TempFirstModifiedDateTimeAPIWebhookNotification.Modify(); exit; end; Session.LogMessage('000072Z', StrSubstNo(NewFirstModifiedTimeLaterThanCachedMsg, SubscriptionSystemId, OldValue, NewValue), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); end; local procedure CollectResourceUrlBySubscriptionId(var APIWebhookSubscription: Record "API Webhook Subscription") var ResourceUrl: Text; begin if ResourceUrlBySubscriptionIdDictionary.ContainsKey(APIWebhookSubscription."Subscription Id") then begin if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000703', StrSubstNo(CachedResourceUrlForSubscriptionIdMsg, APIWebhookSubscription.SystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000704', StrSubstNo(CachingResourceUrlForSubscriptionIdMsg, APIWebhookSubscription.SystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); ResourceUrl := GetResourceUrl(APIWebhookSubscription); ResourceUrlBySubscriptionIdDictionary.Set(APIWebhookSubscription."Subscription Id", ResourceUrl); end; local procedure CollectNotificationUrlBySubscriptionId(var APIWebhookSubscription: Record "API Webhook Subscription") var NotificationUrl: Text; begin if NotificationUrlBySubscriptionIdDictionary.ContainsKey(APIWebhookSubscription."Subscription Id") then begin if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000705', StrSubstNo(CachedNotificationUrlForSubscriptionIdMsg, APIWebhookSubscription.SystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000706', StrSubstNo(CachingNotificationUrlForSubscriptionIdMsg, APIWebhookSubscription.SystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); NotificationUrl := GetNotificationUrl(APIWebhookSubscription); NotificationUrlBySubscriptionIdDictionary.Set(APIWebhookSubscription."Subscription Id", NotificationUrl); end; local procedure CollectSubscriptionsPerNotificationUrl(var APIWebhookSubscription: Record "API Webhook Subscription") var SubscriptionIds: List of [Text[150]]; SubscriptionId: Text[150]; NotificationUrl: Text; begin SubscriptionId := APIWebhookSubscription."Subscription Id"; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000707', StrSubstNo(CachingSubscriptionsForNotificationUrlMsg, APIWebhookSubscription.SystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); NotificationUrl := GetNotificationUrlBySubscriptionId(SubscriptionId); if NotificationUrl = '' then exit; if SubscriptionsPerNotificationUrlDictionary.ContainsKey(NotificationUrl) then begin SubscriptionIds := SubscriptionsPerNotificationUrlDictionary.Get(NotificationUrl); if not SubscriptionIds.Contains(SubscriptionId) then SubscriptionIds.Add(SubscriptionId); end else SubscriptionIds.Add(SubscriptionId); SubscriptionsPerNotificationUrlDictionary.Set(NotificationUrl, SubscriptionIds); end; local procedure CollectSubscriptionTypesPerNotificationUrl(var APIWebhookSubscription: Record "API Webhook Subscription") var SubscriptionType: Option Regular,Dataverse; NotificationUrl: Text; begin SubscriptionType := APIWebhookSubscription."Subscription Type"; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000GIM', StrSubstNo(CachingSubscriptionTypesForNotificationUrlMsg, APIWebhookSubscription.SystemId), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); NotificationUrl := GetNotificationUrlBySubscriptionId(APIWebhookSubscription."Subscription Id"); if NotificationUrl = '' then exit; if SubscriptionsTypeNotificationUrlDictionary.ContainsKey(NotificationUrl) then begin if SubscriptionsTypeNotificationUrlDictionary.Get(NotificationUrl) <> SubscriptionType then Error(SameNotificationUrlDifferentTypeErr); end else SubscriptionsTypeNotificationUrlDictionary.Add(NotificationUrl, SubscriptionType); end; local procedure DeleteNotifications(var SubscriptionIds: List of [Text[150]]) var SubscriptionId: Text[150]; begin Session.LogMessage('0000708', StrSubstNo(DeleteNotificationsForSubscriptionsMsg, SubscriptionIds.Count()), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); foreach SubscriptionId in SubscriptionIds do begin Session.LogMessage('0000709', StrSubstNo(DeleteNotificationsForSubscriptionMsg, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if SubscriptionId <> '' then begin ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", SubscriptionId); TempAPIWebhookNotificationAggr.DeleteAll(); end; end; end; local procedure DeleteInvalidSubscriptions(var SubscriptionIds: List of [Text[150]]) var APIWebhookSubscription: Record "API Webhook Subscription"; SubscriptionId: Text[150]; begin Session.LogMessage('000070A', StrSubstNo(DeleteInvalidSubscriptionsMsg, SubscriptionIds.Count()), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); foreach SubscriptionId in SubscriptionIds do begin Session.LogMessage('00006SJ', StrSubstNo(DeleteInvalidSubscriptionMsg, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if SubscriptionId <> '' then if APIWebhookSubscription.Get(SubscriptionId) then begin LogActivity(false, DeleteInvalidSubscriptionTitleTxt, GetSubscriptionDetails(SubscriptionId)); APIWebhookNotificationMgt.DeleteSubscription(APIWebhookSubscription); end; end; end; local procedure DeleteObsoleteNotifications() var ActiveSubscriptionDictionary: Dictionary of [Text[150], Boolean]; DeletedSubscriptionDictionary: Dictionary of [Text[150], Boolean]; DeletedSubscriptionList: List of [Text[150]]; ProcessingTime: DateTime; begin ProcessingTime := CurrentDateTime(); GetActiveSubscriptions(ProcessingTime, ActiveSubscriptionDictionary); GetDeletedSubscriptionsByAggregateNotifications(ProcessingTime, ActiveSubscriptionDictionary, DeletedSubscriptionDictionary); DeletedSubscriptionList := DeletedSubscriptionDictionary.Keys(); DeleteObsoleteAggregateNotifications(DeletedSubscriptionList); DeleteObsoleteNotifications(DeletedSubscriptionList); Clear(DeletedSubscriptionDictionary); GetDeletedSubscriptionsByNotifications(ProcessingTime, ActiveSubscriptionDictionary, DeletedSubscriptionDictionary); DeletedSubscriptionList := DeletedSubscriptionDictionary.Keys(); DeleteObsoleteNotifications(DeletedSubscriptionList); end; local procedure GetActiveSubscriptions(ProcessingTime: DateTime; var ActiveSubscriptionDictionary: Dictionary of [Text[150], Boolean]) var APIWebhookSubscription: Record "API Webhook Subscription"; begin APIWebhookSubscription.SetFilter(SystemModifiedAt, '<%1', ProcessingTime); if APIWebhookSubscription.FindSet() then repeat ActiveSubscriptionDictionary.Add(APIWebhookSubscription."Subscription Id", true); until APIWebhookSubscription.Next() = 0; end; local procedure GetDeletedSubscriptionsByAggregateNotifications(ProcessingTime: DateTime; var ActiveSubscriptionDictionary: Dictionary of [Text[150], Boolean]; var DeletedSubscriptionDictionary: Dictionary of [Text[150], Boolean]) var APIWebhookNotificationAggr: Record "API Webhook Notification Aggr"; begin APIWebhookNotificationAggr.SetFilter(SystemCreatedAt, '<%1', ProcessingTime); if APIWebhookNotificationAggr.FindSet() then repeat if not ActiveSubscriptionDictionary.ContainsKey(APIWebhookNotificationAggr."Subscription ID") then if not DeletedSubscriptionDictionary.ContainsKey(APIWebhookNotificationAggr."Subscription ID") then DeletedSubscriptionDictionary.Add(APIWebhookNotificationAggr."Subscription Id", true); until APIWebhookNotificationAggr.Next() = 0; end; local procedure GetDeletedSubscriptionsByNotifications(ProcessingTime: DateTime; var ActiveSubscriptionDictionary: Dictionary of [Text[150], Boolean]; var DeletedSubscriptionDictionary: Dictionary of [Text[150], Boolean]) var APIWebhookNotification: Record "API Webhook Notification"; begin APIWebhookNotification.SetFilter(SystemCreatedAt, '<%1', ProcessingTime); if APIWebhookNotification.FindSet() then repeat if not ActiveSubscriptionDictionary.ContainsKey(APIWebhookNotification."Subscription ID") then if not DeletedSubscriptionDictionary.ContainsKey(APIWebhookNotification."Subscription ID") then DeletedSubscriptionDictionary.Add(APIWebhookNotification."Subscription Id", true); until APIWebhookNotification.Next() = 0; end; local procedure DeleteObsoleteNotifications(var DeletedSubscriptionList: List of [Text[150]]) var APIWebhookNotification: Record "API Webhook Notification"; [SecurityFiltering(SecurityFilter::Ignored)] APIWebhookNotification2: Record "API Webhook Notification"; SubscriptionId: Text[150]; begin Session.LogMessage('0000EFP', StrSubstNo(DeleteNotificationsForDeletedSubscriptionsMsg, DeletedSubscriptionList.Count()), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if not APIWebhookNotification2.WritePermission() then begin Session.LogMessage('0000EFQ', NoPermissionsTxt, Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; foreach SubscriptionId in DeletedSubscriptionList do begin Session.LogMessage('0000EVF', StrSubstNo(DeleteNotificationsForDeletedSubscriptionMsg, SubscriptionId), Verbosity::Normal, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); APIWebhookNotification.SetRange("Subscription ID", SubscriptionId); APIWebhookNotificationMgt.ForceDeleteAPIWebhookNotifications(APIWebhookNotification); end; end; local procedure DeleteObsoleteAggregateNotifications(var DeletedSubscriptionList: List of [Text[150]]) var APIWebhookNotificationAggr: Record "API Webhook Notification Aggr"; [SecurityFiltering(SecurityFilter::Ignored)] APIWebhookNotificationAggr2: Record "API Webhook Notification Aggr"; SubscriptionId: Text[150]; begin Session.LogMessage('0000EFR', StrSubstNo(DeleteAggrNotificationsForDeletedSubscriptionsMsg, DeletedSubscriptionList.Count()), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if not APIWebhookNotificationAggr2.WritePermission() then begin Session.LogMessage('0000EFS', NoPermissionsTxt, Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; foreach SubscriptionId in DeletedSubscriptionList do begin Session.LogMessage('0000EVT', StrSubstNo(DeleteAggrNotificationsForDeletedSubscriptionMsg, SubscriptionId), Verbosity::Normal, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); APIWebhookNotificationAggr.SetRange("Subscription ID", SubscriptionId); APIWebhookNotificationAggr.DeleteAll(); end; end; local procedure IncreaseAttemptNumber(var SubscriptionIds: List of [Text[150]]) var SubscriptionId: Text[150]; SubscriptionSystemId: Guid; begin Session.LogMessage('000070B', StrSubstNo(IncreaseAttemptNumberForSubscriptionsMsg, DateTimeToString(ProcessingDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); foreach SubscriptionId in SubscriptionIds do begin Session.LogMessage('000070C', StrSubstNo(IncreaseAttemptNumberForSubscriptionMsg, GetSystemIdBySubscriptionId(SubscriptionId), DateTimeToString(ProcessingDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if SubscriptionId <> '' then begin LogActivity(false, IncreaseAttemptNumberTitleTxt, GetSubscriptionDetails(SubscriptionId)); ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetRange("Subscription ID", SubscriptionId); if TempAPIWebhookNotificationAggr.Find('-') then repeat SubscriptionSystemId := GetSystemIdBySubscriptionId(SubscriptionId); if TempAPIWebhookNotificationAggr."Sending Scheduled Date Time" <= ProcessingDateTime then begin TempAPIWebhookNotificationAggr."Attempt No." += 1; TempAPIWebhookNotificationAggr.Modify(); Session.LogMessage('000070Q', StrSubstNo(IncreaseAttemptNumberForNotificationMsg, SubscriptionSystemId, TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time"), TempAPIWebhookNotificationAggr."Attempt No.", DateTimeToString(TempAPIWebhookNotificationAggr."Sending Scheduled Date Time"), DateTimeToString(ProcessingDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); end else Session.LogMessage('000075T', StrSubstNo(DoNotIncreaseAttemptNumberForNotificationMsg, SubscriptionSystemId, TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), DateTimeToString(TempAPIWebhookNotificationAggr."Last Modified Date Time"), TempAPIWebhookNotificationAggr."Attempt No.", DateTimeToString(TempAPIWebhookNotificationAggr."Sending Scheduled Date Time"), DateTimeToString(ProcessingDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); until TempAPIWebhookNotificationAggr.Next() = 0; end; end; end; local procedure UpdateTablesFromBuffer(var EarliestRescheduleDateTime: DateTime) begin DeleteSubscriptionsWithTooManyFailures(); DeleteProcessedNotifications(); SaveFailedAggregateNotifications(EarliestRescheduleDateTime); end; local procedure DeleteProcessedNotifications() var APIWebhookNotification: Record "API Webhook Notification"; SubscriptionId: Text[150]; begin Session.LogMessage('000070D', StrSubstNo(DeleteProcessedNotificationsMsg, DateTimeToString(ProcessingDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); foreach SubscriptionId in SubscriptionIdList do begin APIWebhookNotification.SetRange("Subscription ID", SubscriptionId); APIWebhookNotification.SetFilter("Last Modified Date Time", '<=%1', ProcessingDateTime); APIWebhookNotificationMgt.ForceDeleteAPIWebhookNotifications(APIWebhookNotification); end; end; local procedure SaveFailedAggregateNotifications(var EarliestScheduledDateTime: DateTime) var APIWebhookNotificationAggr: Record "API Webhook Notification Aggr"; ScheduledDateTime: DateTime; begin EarliestScheduledDateTime := 0DT; if not APIWebhookNotificationAggr.IsEmpty() then APIWebhookNotificationAggr.DeleteAll(true); ClearFiltersFromNotificationsBuffer(); if not TempAPIWebhookNotificationAggr.Find('-') then exit; repeat APIWebhookNotificationAggr.TransferFields(TempAPIWebhookNotificationAggr, true); if APIWebhookNotificationAggr."Sending Scheduled Date Time" < ProcessingDateTime then begin ScheduledDateTime := ProcessingDateTime + GetDelayTimeForAttempt(TempAPIWebhookNotificationAggr."Attempt No."); APIWebhookNotificationAggr."Sending Scheduled Date Time" := ScheduledDateTime; if (ScheduledDateTime < EarliestScheduledDateTime) or (EarliestScheduledDateTime = 0DT) then EarliestScheduledDateTime := ScheduledDateTime; end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('000070F', StrSubstNo(SaveFailedNotificationMsg, GetSystemIdBySubscriptionId(APIWebhookNotificationAggr."Subscription ID"), APIWebhookNotificationAggr."Entity ID", ChangeTypeToString(APIWebhookNotificationAggr."Change Type"), DateTimeToString(APIWebhookNotificationAggr."Last Modified Date Time"), APIWebhookNotificationAggr."Attempt No."), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if not APIWebhookNotificationAggr.Insert(true) then begin Session.LogMessage('000073A', StrSubstNo(CannotInsertAggregateNotificationErr, GetSystemIdBySubscriptionId(APIWebhookNotificationAggr."Subscription ID"), APIWebhookNotificationAggr."Entity ID", ChangeTypeToString(APIWebhookNotificationAggr."Change Type"), DateTimeToString(APIWebhookNotificationAggr."Last Modified Date Time"), APIWebhookNotificationAggr."Attempt No.", DateTimeToString(APIWebhookNotificationAggr."Sending Scheduled Date Time")), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit; end; until TempAPIWebhookNotificationAggr.Next() = 0; Session.LogMessage('000070E', StrSubstNo(SavedFailedNotificationsMsg, DateTimeToString(EarliestScheduledDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); end; local procedure SendNotification(NotificationUrlNumber: Integer; NotificationUrl: Text; NotificationPayload: Text; var Reschedule: Boolean): Boolean var HttpStatusCode: DotNet HttpStatusCode; SubscriptionType: Option Regular,Dataverse; HttpStatusCodeNumber: Integer; ResponseBody: Text; ErrorMessage: Text; ErrorDetails: Text; Success: Boolean; IsDataverseSubscription: Boolean; begin if NotificationUrl = '' then begin Session.LogMessage('000029Z', StrSubstNo(EmptyNotificationUrlErr, NotificationUrlNumber), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(true); end; if NotificationPayload = '' then begin Session.LogMessage('00002A0', StrSubstNo(EmptyPayloadPerNotificationUrlErr, NotificationUrlNumber), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(true); end; OnBeforeSendNotification(NotificationUrl, NotificationPayload); Session.LogMessage('000029B', StrSubstNo(SendNotificationMsg, NotificationUrlNumber), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); Success := SendRequest( NotificationUrlNumber, NotificationUrl, NotificationPayload, ResponseBody, ErrorMessage, ErrorDetails, HttpStatusCode); if not Success then ErrorMessage += GetLastErrorText + ErrorMessage; if not IsNull(HttpStatusCode) then HttpStatusCodeNumber := HttpStatusCode; OnAfterSendNotification(ErrorMessage, ErrorDetails, HttpStatusCode); OnAfterSendNotificationWithStatusNumber(ErrorMessage, ErrorDetails, HttpStatusCodeNumber); if not Success then begin IsDataverseSubscription := SubscriptionsTypeNotificationUrlDictionary.Get(NotificationUrl) = SubscriptionType::Dataverse; Reschedule := ShouldReschedule(HttpStatusCode) or IsDataverseSubscription; Session.LogMessage('000076N', StrSubstNo(SendingNotificationFailedErr, NotificationUrl, HttpStatusCode, ErrorMessage, ErrorDetails), Verbosity::Warning, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); LogActivity(true, NotificationFailedTitleTxt, StrSubstNo(FailedNotificationDetailsTxt, NotificationUrl, HttpStatusCode, ErrorMessage, ErrorDetails)); if Reschedule then begin Session.LogMessage('000029C', StrSubstNo(FailedNotificationRescheduleMsg, NotificationUrlNumber, HttpStatusCode), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; Session.LogMessage('000029D', StrSubstNo(FailedNotificationRejectedMsg, NotificationUrlNumber, HttpStatusCode), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; Session.LogMessage('000029E', StrSubstNo(SucceedNotificationMsg, NotificationUrlNumber), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(true); end; [TryFunction] local procedure SendRequest(NotificationUrlNumber: Integer; NotificationUrl: Text; NotificationPayload: Text; var ResponseBody: Text; var ErrorMessage: Text; var ErrorDetails: Text; var HttpStatusCode: DotNet HttpStatusCode) var APIWebhookSubscription: Record "API Webhook Subscription"; HttpWebRequestMgt: Codeunit "Http Web Request Mgt."; ResponseHeaders: DotNet NameValueCollection; UTF8Encoding: DotNet UTF8Encoding; MaskedUrl: Text; HttpStatusCodeNumber: Integer; HttpStatusCodeText: Integer; CorrelationGuid: Text; begin if NotificationUrl = '' then begin Session.LogMessage('00002A1', StrSubstNo(EmptyNotificationUrlErr, NotificationUrlNumber), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); Error(EmptyNotificationUrlErr, NotificationUrlNumber); end; if NotificationPayload = '' then begin Session.LogMessage('00002A2', StrSubstNo(EmptyPayloadPerNotificationUrlErr, NotificationUrlNumber), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); Error(EmptyPayloadPerNotificationUrlErr, NotificationUrlNumber); end; CorrelationGuid := LowerCase(System.Format(CreateGuid(), 0, 4)); HttpWebRequestMgt.Initialize(NotificationUrl); HttpWebRequestMgt.DisableUI(); HttpWebRequestMgt.SetMethod('POST'); HttpWebRequestMgt.SetReturnType('application/json'); HttpWebRequestMgt.SetContentType('application/json'); HttpWebRequestMgt.AddHeader('clientRequestId', CorrelationGuid); HttpWebRequestMgt.AddHeader('x-ms-correlation-id', CorrelationGuid); Session.LogMessage('0000KX7', StrSubstNo(PostCorrelationGuidTxt, CorrelationGuid), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if SubscriptionsTypeNotificationUrlDictionary.Get(NotificationUrl) = APIWebhookSubscription."Subscription Type"::Dataverse then AddTokenToRequestHeader(HttpWebRequestMgt); HttpWebRequestMgt.SetTimeout((GetSendingNotificationTimeout())); // false is to do not add byte order mark UTF8Encoding := UTF8Encoding.UTF8Encoding(false); HttpWebRequestMgt.AddBodyAsTextWithEncoding(NotificationPayload, UTF8Encoding); OnSendRequestOnBeforeSendRequestAndReadTextResponse(HttpWebRequestMgt); MaskedUrl := GetMaskedUrl(NotificationUrl); Session.LogMessage('0000FBA', StrSubstNo(PostEmittedTxt, MaskedUrl), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if not HttpWebRequestMgt.SendRequestAndReadTextResponse(ResponseBody, ErrorMessage, ErrorDetails, HttpStatusCode, ResponseHeaders) then begin if IsNull(HttpStatusCode) then Session.LogMessage('00002A3', StrSubstNo(CannotGetResponseErr, NotificationUrlNumber), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl) else begin HttpStatusCodeNumber := HttpStatusCode; HttpStatusCodeText := HttpStatusCodeNumber; end; Session.LogMessage('0000FBB', StrSubstNo(PostFailedTxt, GetMaskedUrl(MaskedUrl), HttpStatusCodeText), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); Error(CannotGetResponseErr, NotificationUrlNumber); end; end; local procedure AddTokenToRequestHeader(var HttpWebRequestMgt: Codeunit "Http Web Request Mgt.") var CDSConnectionSetup: Record "CDS Connection Setup"; CDSIntegrationImpl: Codeunit "CDS Integration Impl."; Token: SecretText; begin if CDSConnectionSetup.Get() then CDSIntegrationImpl.GetBusinessEventAccessToken(CDSConnectionSetup."Server Address", false, Token); HttpWebRequestMgt.AddHeader('Authorization', SecretStrSubstNo('Bearer %1', Token)); end; local procedure GetMaskedUrl(Url: Text): Text var Uri: DotNet Uri; UriKind: DotNet UriKind; Mask: Text; Www: Text; Host: Text; Path: Text; MaskedUrl: Text; begin Mask := '***'; Www := 'www.'; if not Uri.TryCreate(Url, UriKind.Absolute, Uri) then exit(Mask); MaskedUrl := Uri.Scheme.ToLower() + '://'; Host := Uri.Host.ToLower(); if Host.StartsWith(Www) then begin MaskedUrl += Www; Host := CopyStr(Host, StrLen(Www)); end; if StrLen(Host) >= 2 then MaskedUrl += CopyStr(Host, 1, 2); MaskedUrl += Mask; Path := Uri.AbsolutePath.ToLower(); if StrLen(Path) >= 2 then MaskedUrl += CopyStr(Path, 1, 2); MaskedUrl += Mask; exit(MaskedUrl); end; local procedure ShouldReschedule(var HttpStatusCode: DotNet HttpStatusCode): Boolean var HttpStatusCodeNumber: Integer; begin if IsNull(HttpStatusCode) then exit(true); HttpStatusCodeNumber := HttpStatusCode; // 5xx range - Server error // 408 - Request Timeout, 429 - Too Many Requests if ((HttpStatusCodeNumber >= 500) and (HttpStatusCodeNumber <= 599)) or (HttpStatusCodeNumber = 408) or (HttpStatusCodeNumber = 429) then exit(true); exit(false); end; local procedure GetEntityJObject(var TempAPIWebhookNotificationAggr: Record "API Webhook Notification Aggr" temporary; var JSONObject: DotNet JObject): Boolean var JSONManagement: Codeunit "JSON Management"; ResourceUrl: Text; LastModifiedDateTime: DateTime; SubscriptionSystemId: Guid; begin SubscriptionSystemId := GetSystemIdBySubscriptionId(TempAPIWebhookNotificationAggr."Subscription ID"); ClearFiltersFromSubscriptionsBuffer(); TempAPIWebhookSubscription.SetRange("Subscription Id", TempAPIWebhookNotificationAggr."Subscription ID"); if not TempAPIWebhookSubscription.FindFirst() then begin Session.LogMessage('000070G', StrSubstNo(CannotFindSubscriptionErr, SubscriptionSystemId), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; ResourceUrl := GetEntityUrl(TempAPIWebhookNotificationAggr, TempAPIWebhookSubscription); if ResourceUrl = '' then exit(false); LastModifiedDateTime := TempAPIWebhookNotificationAggr."Last Modified Date Time"; if LastModifiedDateTime = 0DT then if TempAPIWebhookNotificationAggr."Change Type" = TempAPIWebhookNotificationAggr."Change Type"::Collection then LastModifiedDateTime := CurrentDateTime() else Session.LogMessage('00006P3', StrSubstNo(EmptyLastModifiedDateTimeMsg, SubscriptionSystemId, TempAPIWebhookNotificationAggr."Entity ID", ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type"), TempAPIWebhookNotificationAggr."Attempt No."), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); JSONManagement.InitializeEmptyObject(); JSONManagement.GetJSONObject(JSONObject); JSONManagement.AddJPropertyToJObject(JSONObject, 'subscriptionId', TempAPIWebhookSubscription."Subscription Id"); JSONManagement.AddJPropertyToJObject(JSONObject, 'clientState', TempAPIWebhookSubscription."Client State"); JSONManagement.AddJPropertyToJObject(JSONObject, 'expirationDateTime', TempAPIWebhookSubscription."Expiration Date Time"); JSONManagement.AddJPropertyToJObject(JSONObject, 'resource', ResourceUrl); JSONManagement.AddJPropertyToJObject(JSONObject, 'changeType', ChangeTypeToString(TempAPIWebhookNotificationAggr."Change Type")); JSONManagement.AddJPropertyToJObject(JSONObject, 'lastModifiedDateTime', LastModifiedDateTime); if ((TempAPIWebhookSubscription."Subscription Type" = TempAPIWebhookSubscription."Subscription Type"::Dataverse) and (TempAPIWebhookNotificationAggr."Change Type" <> TempAPIWebhookNotificationAggr."Change Type"::Collection)) then JSONManagement.AddJPropertyToJObject(JSONObject, 'initiatingAadUserId', GetAadUserId(TempAPIWebhookNotificationAggr."Created By User SID")); exit(true); end; local procedure GetAadUserId(UserGuid: Guid): Text var UserProperty: Record "User Property"; GraphMgtGeneralTools: Codeunit "Graph Mgt - General Tools"; EmptyGuid: Guid; begin if UserProperty.Get(UserGuid) then if (UserProperty."Authentication Object ID" <> '') then exit(UserProperty."Authentication Object ID"); exit(GraphMgtGeneralTools.StripBrackets(EmptyGuid)); end; local procedure ChangeTypeToString(ChangeType: Option Created,Updated,Deleted,Collection): Text begin case ChangeType of ChangeType::Created: exit(ChangeTypeCreatedTok); ChangeType::Updated: exit(ChangeTypeUpdatedTok); ChangeType::Deleted: exit(ChangeTypeDeletedTok); ChangeType::Collection: exit(ChangeTypeCollectionTok); end; end; local procedure GetEntityUrl(var TempAPIWebhookNotificationAggr: Record "API Webhook Notification Aggr" temporary; var TempAPIWebhookSubscription: Record "API Webhook Subscription" temporary): Text var EntityUrl: Text; begin if TempAPIWebhookNotificationAggr."Change Type" <> TempAPIWebhookNotificationAggr."Change Type"::Collection then EntityUrl := GetSingleEntityUrl(TempAPIWebhookNotificationAggr, TempAPIWebhookSubscription) else EntityUrl := GetEntityCollectionUrl(TempAPIWebhookNotificationAggr, TempAPIWebhookSubscription); exit(EntityUrl); end; local procedure GetSingleEntityUrl(var TempAPIWebhookNotificationAggr: Record "API Webhook Notification Aggr" temporary; var TempAPIWebhookSubscription: Record "API Webhook Subscription" temporary): Text var ResourceUrl: Text; EntityUrl: Text; EntityKeyFieldType: Text; EntityKeyValue: Text; begin ResourceUrl := GetResourceUrlBySubscriptionId(TempAPIWebhookSubscription."Subscription Id"); if ResourceUrl = '' then exit(''); if TempAPIWebhookSubscription."Subscription Type" = TempAPIWebhookSubscription."Subscription Type"::Dataverse then AddCompanyIdToResource(TempAPIWebhookSubscription, ResourceUrl); EntityKeyFieldType := GetEntityKeyFieldTypeBySubscriptionId(TempAPIWebhookSubscription."Subscription Id"); if EntityKeyFieldType = '' then exit(''); EntityKeyValue := GetUriEscapeFieldValue(EntityKeyFieldType, TempAPIWebhookNotificationAggr."Entity Key Value"); EntityUrl := StrSubstNo(SingleEntityUrlTemplateTxt, ResourceUrl, EntityKeyValue); exit(EntityUrl); end; local procedure GetEntityCollectionUrl(var TempAPIWebhookNotificationAggr: Record "API Webhook Notification Aggr" temporary; var TempAPIWebhookSubscription: Record "API Webhook Subscription" temporary): Text var ResourceUrl: Text; EntityUrl: Text; FirstModifiedDateTimeUtcString: Text; FirstModifiedDateTimeAdjusted: DateTime; FirstModifiedDateTime: DateTime; begin ResourceUrl := GetResourceUrlBySubscriptionId(TempAPIWebhookSubscription."Subscription Id"); if ResourceUrl = '' then exit(''); if TempAPIWebhookSubscription."Subscription Type" = TempAPIWebhookSubscription."Subscription Type"::Dataverse then AddCompanyIdToResource(TempAPIWebhookSubscription, ResourceUrl); FirstModifiedDateTime := GetFirstModifiedTimeBySubscriptionId(TempAPIWebhookNotificationAggr."Subscription ID"); if FirstModifiedDateTime = 0DT then exit(ResourceUrl); if not HasLastModifiedDateTimeField(TempAPIWebhookSubscription) then exit(ResourceUrl); // Subtract 50 milliseconds to be sure we get all the changes since the SQL rounds in the different way than C# / AL. FirstModifiedDateTimeAdjusted := FirstModifiedDateTime - 50; FirstModifiedDateTimeUtcString := DateTimeToUtcString(FirstModifiedDateTimeAdjusted); EntityUrl := ResourceUrl + '?$filter=lastModifiedDateTime%20gt%20' + FirstModifiedDateTimeUtcString; exit(EntityUrl); end; local procedure GetUriEscapeFieldValue(FieldType: Text; FieldValue: Text): Text var FormattedValue: Text; begin case FieldType of 'Code', 'Text': if FieldValue <> '' then FormattedValue := AddQuotes(TypeHelper.UriEscapeDataString(FieldValue)) else FormattedValue := AddQuotes(FieldValue); 'Option': FormattedValue := AddQuotes(TypeHelper.UriEscapeDataString(FieldValue)); 'DateFormula': FormattedValue := AddQuotes(FieldValue); else FormattedValue := FieldValue; end; exit(FormattedValue); end; local procedure AddQuotes(InText: Text) OutText: Text begin OutText := '''' + InText + ''''; end; local procedure GetEntityKeyFieldTypeBySubscriptionId(SubscriptionId: Text[150]): Text var EntityKeyFieldType: Text; begin if not KeyFieldTypeBySubscriptionId.ContainsKey(SubscriptionId) then begin Session.LogMessage('00002A5', StrSubstNo(CannotFindCachedEntityKeyFieldTypeForSubscriptionIdErr, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(''); end; EntityKeyFieldType := KeyFieldTypeBySubscriptionId.Get(SubscriptionId); if EntityKeyFieldType = '' then begin Session.LogMessage('000070T', StrSubstNo(CannotFindCachedEntityKeyFieldTypeForSubscriptionIdErr, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(''); end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('000070U', StrSubstNo(FoundCachedEntityKeyFieldTypeForSubscriptionIdMsg, GetSystemIdBySubscriptionId(SubscriptionId), EntityKeyFieldType), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(EntityKeyFieldType); end; local procedure GetFirstModifiedTimeBySubscriptionId(SubscriptionId: Text[150]): DateTime var FirstModifiedDateTime: DateTime; begin TempFirstModifiedDateTimeAPIWebhookNotification.SetRange("Subscription ID", SubscriptionId); if not TempFirstModifiedDateTimeAPIWebhookNotification.FindFirst() then begin Session.LogMessage('0000730', StrSubstNo(CannotFindCachedFirstModifiedTimeForSubscriptionIdMsg, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(0DT); end; FirstModifiedDateTime := TempFirstModifiedDateTimeAPIWebhookNotification."Last Modified Date Time"; if FirstModifiedDateTime = 0DT then begin Session.LogMessage('0000731', StrSubstNo(CannotFindCachedFirstModifiedTimeForSubscriptionIdMsg, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(0DT); end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000732', StrSubstNo(FoundCachedFirstModifiedTimeForSubscriptionIdMsg, GetSystemIdBySubscriptionId(SubscriptionId), DateTimeToString(FirstModifiedDateTime)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(FirstModifiedDateTime); end; local procedure GetSystemIdBySubscriptionId(SubscriptionId: Text[150]): Guid var SubscriptionSystemId: Guid; begin if not SystemIdBySubscriptionIdDictionary.ContainsKey(SubscriptionId) then begin Session.LogMessage('0000EV8', StrSubstNo(CannotFindSystemIdForSubscriptionIdTxt, SubscriptionId), Verbosity::Error, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); exit(SubscriptionSystemId); end; SubscriptionSystemId := SystemIdBySubscriptionIdDictionary.Get(SubscriptionId); if IsNullGuid(SubscriptionSystemId) then Session.LogMessage('0000EV9', StrSubstNo(CannotFindSystemIdForSubscriptionIdTxt, SubscriptionId), Verbosity::Error, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); exit(SubscriptionSystemId); end; local procedure GetTableIdBySubscriptionId(SubscriptionId: Text[150]): Integer var TableId: Integer; begin if not TableIdBySubscriptionIdDictionary.ContainsKey(SubscriptionId) then begin Session.LogMessage('0000EWE', StrSubstNo(CannotFindTableIdForSubscriptionIdTxt, SubscriptionId), Verbosity::Error, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); exit(0); end; TableId := TableIdBySubscriptionIdDictionary.Get(SubscriptionId); if TableId = 0 then Session.LogMessage('0000EWF', StrSubstNo(CannotFindTableIdForSubscriptionIdTxt, SubscriptionId), Verbosity::Error, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); exit(TableId); end; local procedure GetResourceUrlBySubscriptionId(SubscriptionId: Text[150]): Text var ResourceUrl: Text; begin if not ResourceUrlBySubscriptionIdDictionary.ContainsKey(SubscriptionId) then begin Session.LogMessage('00002A6', StrSubstNo(CannotFindCachedResourceUrlForSubscriptionIdErr, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(''); end; ResourceUrl := ResourceUrlBySubscriptionIdDictionary.Get(SubscriptionId); if ResourceUrl = '' then begin Session.LogMessage('000070V', StrSubstNo(CannotFindCachedResourceUrlForSubscriptionIdErr, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(''); end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('000070W', StrSubstNo(FoundCachedResourceUrlForSubscriptionIdMsg, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(ResourceUrl); end; local procedure GetNotificationUrlBySubscriptionId(SubscriptionId: Text[150]): Text var NotificationUrl: Text; begin if not NotificationUrlBySubscriptionIdDictionary.ContainsKey(SubscriptionId) then begin Session.LogMessage('00002A7', StrSubstNo(CannotFindCachedNotificationUrlForSubscriptionIdErr, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(''); end; NotificationUrl := NotificationUrlBySubscriptionIdDictionary.Get(SubscriptionId); if NotificationUrl = '' then begin Session.LogMessage('000070X', StrSubstNo(CannotFindCachedNotificationUrlForSubscriptionIdErr, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(''); end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('000070Y', StrSubstNo(FoundCachedNotificationUrlForSubscriptionIdMsg, GetSystemIdBySubscriptionId(SubscriptionId)), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(NotificationUrl); end; local procedure GetSubscriptionsPerNotificationUrl(NotificationUrlNumber: Integer; var NotificationUrl: Text; var SubscriptionIds: List of [Text[150]]): Boolean begin if (NotificationUrlNumber < 1) or (NotificationUrlNumber > SubscriptionsPerNotificationUrlDictionary.Keys().Count()) then begin Session.LogMessage('000070H', StrSubstNo(CannotFindCachedSubscriptionsForNotificationUrlNumberErr, NotificationUrlNumber), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; NotificationUrl := SubscriptionsPerNotificationUrlDictionary.Keys().Get(NotificationUrlNumber); if NotificationUrl = '' then begin Session.LogMessage('000070Z', StrSubstNo(CannotFindCachedSubscriptionsForNotificationUrlNumberErr, NotificationUrlNumber), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; SubscriptionIds := SubscriptionsPerNotificationUrlDictionary.Get(NotificationUrl); if SubscriptionIds.Count() = 0 then begin Session.LogMessage('0000710', StrSubstNo(CannotFindCachedNotificationUrlForNotificationUrlNumberErr, NotificationUrlNumber), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(false); end; if APIWebhookNotificationMgt.IsDetailedLoggingEnabled() then Session.LogMessage('0000711', StrSubstNo(FoundCachedSubscriptionsForNotificationUrlNumberMsg, SubscriptionIds.Count(), NotificationUrlNumber), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); exit(true); end; local procedure GetResourceUrl(var APIWebhookSubscription: Record "API Webhook Subscription"): Text var InStream: InStream; ResourceUrl: Text; begin APIWebhookSubscription."Resource Url Blob".CreateInStream(InStream); InStream.Read(ResourceUrl); exit(ResourceUrl); end; local procedure GetNotificationUrl(var APIWebhookSubscription: Record "API Webhook Subscription"): Text var InStream: InStream; NotificationUrl: Text; begin APIWebhookSubscription."Notification Url Blob".CreateInStream(InStream); InStream.Read(NotificationUrl); exit(NotificationUrl); end; local procedure HasLastModifiedDateTimeField(var APIWebhookSubscription: Record "API Webhook Subscription"): Boolean var ApiWebhookEntity: Record "Api Webhook Entity"; PageControlField: Record "Page Control Field"; RecordRef: RecordRef; begin if not APIWebhookNotificationMgt.GetEntity(APIWebhookSubscription, ApiWebhookEntity) then exit(false); if ApiWebhookEntity."Object Type" <> ApiWebhookEntity."Object Type"::Page then exit(false); PageControlField.SetRange(PageNo, ApiWebhookEntity."Object ID"); PageControlField.SetRange(ControlName, 'lastModifiedDateTime'); PageControlField.SetFilter(Visible, '%1', '@true'); if not PageControlField.FindFirst() then exit(false); RecordRef.Open(PageControlField.TableNo); if RecordRef.Field(PageControlField.FieldNo).Type <> FieldType::DateTime then exit(false); exit(true); end; local procedure GetActiveSubscriptions(): Boolean var APIWebhookSubscription: Record "API Webhook Subscription"; begin APIWebhookSubscription.SetAutoCalcFields("Notification Url Blob", "Resource Url Blob"); APIWebhookSubscription.SetFilter("Expiration Date Time", '>=%1', ProcessingDateTime); APIWebhookSubscription.SetFilter("Company Name", '%1|%2', CompanyName, ''); APIWebhookSubscription.SetFilter("Subscription Id", '<>%1', ''); if not APIWebhookSubscription.FindSet() then exit(false); repeat Clear(TempAPIWebhookSubscription); TempAPIWebhookSubscription.Init(); TempAPIWebhookSubscription.TransferFields(APIWebhookSubscription, true); Clear(TempAPIWebhookSubscription."Notification Url Blob"); Clear(TempAPIWebhookSubscription."Resource Url Blob"); TempAPIWebhookSubscription.Insert(); CollectValuesInDictionaries(APIWebhookSubscription); until APIWebhookSubscription.Next() = 0; exit(true); end; local procedure DeleteObsoleteSubscriptions() var APIWebhookSubscription: Record "API Webhook Subscription"; ApiWebhookEntity: Record "Api Webhook Entity"; begin if not APIWebhookSubscription.FindSet() then exit; repeat if not APIWebhookNotificationMgt.GetEntity(APIWebhookSubscription, ApiWebhookEntity) then begin Session.LogMessage('0000299', StrSubstNo(DeleteObsoleteSubscriptionMsg, APIWebhookSubscription.SystemId, DateTimeToString(APIWebhookSubscription."Expiration Date Time"), APIWebhookSubscription."Source Table Id"), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); LogActivity(false, DeleteObsoleteSubscriptionTitleTxt, GetSubscriptionDetails(APIWebhookSubscription."Subscription Id")); APIWebhookNotificationMgt.DeleteSubscription(APIWebhookSubscription); end; until APIWebhookSubscription.Next() = 0; end; local procedure DeleteExpiredSubscriptions() var APIWebhookSubscription: Record "API Webhook Subscription"; begin APIWebhookSubscription.SetFilter("Expiration Date Time", '<%1', ProcessingDateTime); APIWebhookSubscription.SetFilter("Company Name", '%1|%2', CompanyName, ''); if not APIWebhookSubscription.FindSet() then exit; repeat Session.LogMessage('000029A', StrSubstNo(DeleteExpiredSubscriptionMsg, APIWebhookSubscription.SystemId, DateTimeToString(APIWebhookSubscription."Expiration Date Time"), APIWebhookSubscription."Source Table Id"), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); LogActivity(false, DeleteExpiredSubscriptionTitleTxt, GetSubscriptionDetails(APIWebhookSubscription."Subscription Id")); APIWebhookNotificationMgt.DeleteSubscription(APIWebhookSubscription); until APIWebhookSubscription.Next() = 0; end; local procedure DeleteSubscriptionsWithTooManyFailures() var APIWebhookSubscription: Record "API Webhook Subscription"; begin ClearFiltersFromNotificationsBuffer(); TempAPIWebhookNotificationAggr.SetFilter("Attempt No.", '>%1', GetMaxNumberOfAttempts()); if not TempAPIWebhookNotificationAggr.Find('-') then exit; repeat if APIWebhookSubscription.Get(TempAPIWebhookNotificationAggr."Subscription ID") then begin Session.LogMessage('00007MN', StrSubstNo(DeleteSubscriptionWithTooManyFailuresMsg, APIWebhookSubscription.SystemId, DateTimeToString(APIWebhookSubscription."Expiration Date Time"), APIWebhookSubscription."Source Table Id", TempAPIWebhookNotificationAggr."Attempt No."), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); LogActivity(false, DeleteSubscriptionWithTooManyFailuresTitleTxt, GetSubscriptionDetails(APIWebhookSubscription."Subscription Id")); APIWebhookNotificationMgt.DeleteSubscription(APIWebhookSubscription); end; until TempAPIWebhookNotificationAggr.Next() = 0; TempAPIWebhookNotificationAggr.DeleteAll(); end; local procedure DeleteInactiveJobs() var JobQueueEntry: Record "Job Queue Entry"; begin OnBeforeDeleteInactiveJobs(); JobQueueEntry.SetRange("Object Type to Run", JobQueueEntry."Object Type to Run"::Codeunit); JobQueueEntry.SetRange("Object ID to Run", CODEUNIT::"API Webhook Notification Send"); JobQueueEntry.SetFilter(Status, '<>%1&<>%2', JobQueueEntry.Status::"In Process", JobQueueEntry.Status::Ready); if JobQueueEntry.FindSet() then repeat Session.LogMessage('000070N', StrSubstNo(DeleteInactiveJobMsg, JobQueueEntry.Status, DateTimeToString(JobQueueEntry."Earliest Start Date/Time")), Verbosity::Normal, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if JobQueueEntry.Delete(true) then; until JobQueueEntry.Next() = 0; JobQueueEntry.SetRange(Status, JobQueueEntry.Status::Ready); if JobQueueEntry.FindSet() then repeat if (JobQueueEntry."Job Queue Category Code" <> JobQueueCategoryCodeLbl) or JobQueueEntry."Recurring Job" then begin Session.LogMessage('000029Q', StrSubstNo(DeleteJobWithWrongParametersMsg, JobQueueEntry."Job Queue Category Code", JobQueueEntry."Recurring Job", DateTimeToString(JobQueueEntry."Earliest Start Date/Time")), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if JobQueueEntry.Delete(true) then; end else begin JobQueueEntry.CalcFields(Scheduled); if not JobQueueEntry.Scheduled then begin Session.LogMessage('000075S', StrSubstNo(DeleteReadyButNotScheduledJobMsg, DateTimeToString(JobQueueEntry."Earliest Start Date/Time")), Verbosity::Warning, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); if JobQueueEntry.Delete(true) then; end; end; until JobQueueEntry.Next() = 0; end; local procedure ClearFiltersFromNotificationsBuffer() begin TempAPIWebhookNotificationAggr.SetRange(ID); TempAPIWebhookNotificationAggr.SetRange("Subscription ID"); TempAPIWebhookNotificationAggr.SetRange("Entity Key Value"); TempAPIWebhookNotificationAggr.SetRange("Attempt No."); TempAPIWebhookNotificationAggr.SetRange("Change Type"); end; local procedure ClearFiltersFromSubscriptionsBuffer() begin TempAPIWebhookSubscription.SetRange("Subscription Id"); end; local procedure IsApiSubscriptionEnabled(): Boolean var GraphMgtGeneralTools: Codeunit "Graph Mgt - General Tools"; begin exit(GraphMgtGeneralTools.IsApiSubscriptionEnabled()); end; procedure GetMaxNumberOfLoggedNotifications(): Integer begin exit(1000000); end; procedure GetMaxNumberOfNotifications(): Integer var ServerSetting: Codeunit "Server Setting"; Handled: Boolean; MaxNumberOfNotifications: Integer; begin OnGetMaxNumberOfNotifications(Handled, MaxNumberOfNotifications); if Handled then exit(MaxNumberOfNotifications); MaxNumberOfNotifications := ServerSetting.GetApiSubscriptionMaxNumberOfNotifications(); exit(MaxNumberOfNotifications); end; local procedure GetMaxNumberOfAttempts(): Integer var Handled: Boolean; Value: Integer; begin OnGetMaxNumberOfAttempts(Handled, Value); if Handled then exit(Value); exit(5); end; local procedure GetSendingNotificationTimeout(): Integer var ServerSetting: Codeunit "Server Setting"; Handled: Boolean; Timeout: Integer; begin OnGetSendingNotificationTimeout(Handled, Timeout); if Handled then exit(Timeout); Timeout := ServerSetting.GetApiSubscriptionSendingNotificationTimeout(); exit(Timeout); end; local procedure GetDelayTimeForAttempt(AttemptNumber: Integer): Integer begin case AttemptNumber of 0, 1, 2: exit(60000); 3: exit(600000); 4: exit(6000000); else exit(60000000); end; end; local procedure AddCompanyIdToResource(TempAPIWebhookSubscription: Record "API Webhook Subscription" temporary; var ResourceUrl: Text) var Company: Record Company; CompanyId: Text; EntityUrlVersionIndex: Integer; begin if TempAPIWebhookSubscription."Subscription Type" = TempAPIWebhookSubscription."Subscription Type"::Dataverse then begin Company.Get(CompanyName()); CompanyId := LowerCase(Format(Company.SystemId, 0, 4)); EntityUrlVersionIndex := ResourceUrl.IndexOf(TempAPIWebhookSubscription."Entity Version") + StrLen(TempAPIWebhookSubscription."Entity Version"); ResourceUrl := StrSubstNo(DataverseEntityUrlTemplateTxt, ResourceUrl.Substring(1, EntityUrlVersionIndex), CompanyId, ResourceUrl.Substring(EntityUrlVersionIndex + 1)); end; end; [EventSubscriber(ObjectType::Table, Database::"Job Queue Entry", 'OnBeforeInsertLogEntry', '', false, false)] local procedure HandleOnBeforeInsertJobQueueLogEntry(var JobQueueLogEntry: Record "Job Queue Log Entry"; var JobQueueEntry: Record "Job Queue Entry") begin if JobQueueLogEntry.IsTemporary then exit; if JobQueueLogEntry.Status <> JobQueueLogEntry.Status::Error then exit; if JobQueueEntry."Object ID to Run" <> CODEUNIT::"API Webhook Notification Send" then exit; if JobQueueEntry."Object Type to Run" <> JobQueueEntry."Object Type to Run"::Codeunit then exit; Session.LogMessage('000075U', StrSubstNo(SendingJobFailedMsg, DateTimeToString(JobQueueEntry."Earliest Start Date/Time")), Verbosity::Error, DataClassification::SystemMetadata, TelemetryScope::All, 'Category', APIWebhookCategoryLbl); Session.LogMessage('000076O', StrSubstNo(FailedJobDetailsMsg, JobQueueLogEntry."Error Message"), Verbosity::Error, DataClassification::CustomerContent, TelemetryScope::ExtensionPublisher, 'Category', APIWebhookCategoryLbl); LogActivity(true, JobFailedTitleTxt, JobQueueLogEntry."Error Message"); end; [IntegrationEvent(false, false)] local procedure OnBeforeProcessNotifications() begin end; [IntegrationEvent(false, false)] local procedure OnAfterProcessNotifications() begin end; [IntegrationEvent(false, false)] local procedure OnBeforeDeleteInactiveJobs() begin end; [IntegrationEvent(false, false)] local procedure OnBeforeSendNotification(NotificationUrl: Text; Payload: Text) begin end; [IntegrationEvent(false, false)] local procedure OnAfterSendNotification(var ErrorMessage: Text; var ErrorDetails: Text; var HttpStatusCode: DotNet HttpStatusCode) begin end; [IntegrationEvent(false, false)] local procedure OnAfterSendNotificationWithStatusNumber(var ErrorMessage: Text; var ErrorDetails: Text; HttpStatusCode: Integer) begin end; [IntegrationEvent(false, false)] local procedure OnGetMaxNumberOfNotifications(var Handled: Boolean; var Value: Integer) begin end; [IntegrationEvent(false, false)] local procedure OnGetMaxNumberOfAttempts(var Handled: Boolean; var Value: Integer) begin end; [IntegrationEvent(false, false)] local procedure OnGetSendingNotificationTimeout(var Handled: Boolean; var Value: Integer) begin end; local procedure DateTimeToString(Value: DateTime): Text begin exit(Format(Value, 0, '<Year4>-<Month,2>-<Day,2> <Hours24>:<Minutes,2>:<Seconds,2><Second dec.><Comma,.>')); end; local procedure NullUpdateTreshold(): Integer begin exit(2000); // milliseconds end; [Scope('OnPrem')] procedure DateTimeToUtcString(DateTimeValue: DateTime): Text var JSONManagement: Codeunit "JSON Management"; JsonObject: DotNet JObject; UtcDateTimeString: Text; begin // TODO replace getting UTC through JSON with the new function when such function is implemented on the platform side JSONManagement.InitializeEmptyObject(); JSONManagement.GetJSONObject(JsonObject); JSONManagement.AddJPropertyToJObject(JsonObject, 'value', DateTimeValue); JSONManagement.GetStringPropertyValueFromJObjectByName(JsonObject, 'value', UtcDateTimeString); exit(UtcDateTimeString); end; local procedure LogActivity(ActivityFailed: Boolean; ActivityDescription: Text; ActivityMessage: Text) var DummyAPIWebhookSubscription: Record "API Webhook Subscription"; ActivityLog: Record "Activity Log"; ActivityStatus: Option; begin if ActivityFailed then ActivityStatus := ActivityLog.Status::Failed else ActivityStatus := ActivityLog.Status::Success; ActivityLog.LogActivity(DummyAPIWebhookSubscription.RecordId, ActivityStatus, ActivityLogContextLbl, ActivityDescription, ActivityMessage); end; local procedure GetSubscriptionDetails(SubscriptionId: Text[150]): Text var ResourceUrl: Text; NotificationUrl: Text; begin ResourceUrl := GetResourceUrlBySubscriptionId(SubscriptionId); NotificationUrl := GetNotificationUrlBySubscriptionId(SubscriptionId); exit(StrSubstNo(SubscriptionDetailsTxt, SubscriptionId, ResourceUrl, NotificationUrl)); end; [IntegrationEvent(false, false)] local procedure OnSendRequestOnBeforeSendRequestAndReadTextResponse(var HttpWebRequestMgt: Codeunit "Http Web Request Mgt.") begin end;}