Codeunit 6133 E-Document Background Jobs

E-Document Core, Microsoft.eServices.EDocument

src/Apps/W1/EDocument/App/src/Processing/EDocumentBackgroundJobs.Codeunit.al253 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace Microsoft.eServices.EDocument;using Microsoft.eServices.EDocument.Processing.Message;using System.Telemetry;using System.Threading;codeunit 6133 "E-Document Background Jobs"{    Access = Internal;    Permissions =            tabledata "E-Document" = m,            tabledata "E-Document Service" = m,            tabledata "Job Queue Entry" = im;    procedure StartEdocumentCreatedFlow(EDocument: Record "E-Document")    begin        EDocument."Job Queue Entry ID" := ScheduleEDocumentJob(Codeunit::"E-Document Created Flow", EDocument.RecordId(), 0);        EDocument.Modify();    end;    procedure ScheduleMessageSend(EDocumentMessage: Record "E-Document Message")    begin        ScheduleEDocumentJob(Codeunit::"E-Doc. Message Send Job", EDocumentMessage.RecordId(), 0);    end;    procedure SchedulePaymentOccurrence(EDocPaymentOccurrence: Record "E-Doc. Payment Occurrence")    begin        ScheduleEDocumentJob(Codeunit::"E-Doc. Payment Occurrence Mgt.", EDocPaymentOccurrence.RecordId(), 0);    end;    procedure TrySchedulePaymentOccurrence(EDocPaymentOccurrence: Record "E-Doc. Payment Occurrence"): Boolean    begin        exit(TryScheduleEDocumentJob(Codeunit::"E-Doc. Payment Occurrence Mgt.", EDocPaymentOccurrence.RecordId(), 0));    end;    internal procedure EnsurePaymentOccurrenceDispatcher()    var        JobQueueEntry: Record "Job Queue Entry";        BlankRecordId: RecordId;    begin        JobQueueEntry.SetRange("Object Type to Run", JobQueueEntry."Object Type to Run"::Codeunit);        JobQueueEntry.SetRange("Object ID to Run", Codeunit::"E-Doc. Payment Occ. Dispatcher");        JobQueueEntry.SetFilter(Status, '<>%1', JobQueueEntry.Status::Finished);        if not JobQueueEntry.IsEmpty() then            exit;        JobQueueEntry.ScheduleRecurrentJobQueueEntryWithFrequency(            JobQueueEntry."Object Type to Run"::Codeunit, Codeunit::"E-Doc. Payment Occ. Dispatcher", BlankRecordId, 5);        JobQueueEntry."Job Queue Category Code" := JobQueueCategoryTok;        JobQueueEntry."No. of Attempts to Run" := 0;        JobQueueEntry.Modify();    end;    procedure TryScheduleMessageSend(EDocumentMessage: Record "E-Document Message"): Boolean    begin        exit(TryScheduleEDocumentJob(Codeunit::"E-Doc. Message Send Job", EDocumentMessage.RecordId(), 0));    end;    procedure ScheduleMessageResponse(EDocumentMessage: Record "E-Document Message")    begin        ScheduleEDocumentJob(Codeunit::"E-Doc. Message Response Job", EDocumentMessage.RecordId(), 300000);    end;    procedure TryScheduleMessageResponse(EDocumentMessage: Record "E-Document Message"): Boolean    begin        exit(TryScheduleEDocumentJob(Codeunit::"E-Doc. Message Response Job", EDocumentMessage.RecordId(), 300000));    end;    procedure ScheduleGetResponseJob()    begin        ScheduleGetResponseJob(true);    end;    procedure ScheduleGetResponseJob(SkipSchedulingIfJobExists: Boolean)    var        BlankRecord: RecordId;    begin        if SkipSchedulingIfJobExists and IsJobQueueScheduled(Codeunit::"E-Document Get Response") then            exit;        //  Run background job every 5 minutes (300 second) to check the status of async documents.        ScheduleEDocumentJob(Codeunit::"E-Document Get Response", BlankRecord, 300000);    end;    procedure ScheduleRecurrentBatchJob(var EDocumentService: Record "E-Document Service")    var        JobQueueEntry: Record "Job Queue Entry";        Telemetry: Codeunit Telemetry;        TelemetryDimensions: Dictionary of [Text, Text];    begin        if not IsRecurrentJobScheduledForAService(EDocumentService."Batch Recurrent Job Id") then begin            JobQueueEntry.ScheduleRecurrentJobQueueEntryWithFrequency(JobQueueEntry."Object Type to Run"::Codeunit, Codeunit::"E-Doc. Recurrent Batch Send", EDocumentService.RecordId, EDocumentService."Batch Minutes between runs", EDocumentService."Batch Start Time");            EDocumentService."Batch Recurrent Job Id" := JobQueueEntry.ID;            EDocumentService.Modify();            JobQueueEntry."Rerun Delay (sec.)" := 600;            JobQueueEntry."No. of Attempts to Run" := 0;            JobQueueEntry."Job Queue Category Code" := JobQueueCategoryTok;            JobQueueEntry.Modify();        end else begin            JobQueueEntry.Get(EDocumentService."Batch Recurrent Job Id");            JobQueueEntry."Starting Time" := EDocumentService."Batch Start Time";            JobQueueEntry."No. of Minutes between Runs" := EDocumentService."Batch Minutes between runs";            JobQueueEntry."No. of Attempts to Run" := 0;            JobQueueEntry.Modify();            if not JobQueueEntry.IsReadyToStart() then                JobQueueEntry.Restart();        end;        TelemetryDimensions.Add('Job Queue Id', JobQueueEntry.ID);        TelemetryDimensions.Add('Codeunit Id', Format(Codeunit::"E-Document Import Job"));        TelemetryDimensions.Add('Record Id', Format(EDocumentService.RecordId));        TelemetryDimensions.Add('User Session ID', Format(JobQueueEntry."User Session ID"));        TelemetryDimensions.Add('Earliest Start Date/Time', Format(JobQueueEntry."Earliest Start Date/Time"));        Telemetry.LogMessage('0000LC4', EDocumentJobTelemetryLbl, Verbosity::Normal, DataClassification::OrganizationIdentifiableInformation, TelemetryScope::All, TelemetryDimensions);    end;    procedure ScheduleRecurrentImportJob(var EDocumentService: Record "E-Document Service")    var        JobQueueEntry: Record "Job Queue Entry";        Telemetry: Codeunit Telemetry;        TelemetryDimensions: Dictionary of [Text, Text];    begin        if EDocumentService.Code = '' then            exit;        if not IsRecurrentJobScheduledForAService(EDocumentService."Import Recurrent Job Id") then begin            JobQueueEntry.ScheduleRecurrentJobQueueEntryWithFrequency(JobQueueEntry."Object Type to Run"::Codeunit, Codeunit::"E-Document Import Job", EDocumentService.RecordId, EDocumentService."Import Minutes between runs", EDocumentService."Import Start Time");            EDocumentService."Import Recurrent Job Id" := JobQueueEntry.ID;            EDocumentService.Modify();            JobQueueEntry."Rerun Delay (sec.)" := 600;            JobQueueEntry."No. of Attempts to Run" := 0;            JobQueueEntry."Job Queue Category Code" := JobQueueCategoryTok;            JobQueueEntry.Modify();        end else begin            JobQueueEntry.Get(EDocumentService."Import Recurrent Job Id");            JobQueueEntry."Starting Time" := EDocumentService."Import Start Time";            JobQueueEntry."No. of Minutes between Runs" := EDocumentService."Import Minutes between runs";            JobQueueEntry."No. of Attempts to Run" := 0;            JobQueueEntry.Modify();            if not JobQueueEntry.IsReadyToStart() then                JobQueueEntry.Restart();        end;        TelemetryDimensions.Add('Job Queue Id', JobQueueEntry.ID);        TelemetryDimensions.Add('Codeunit Id', Format(Codeunit::"E-Document Import Job"));        TelemetryDimensions.Add('Record Id', Format(EDocumentService.RecordId));        TelemetryDimensions.Add('User Session ID', Format(JobQueueEntry."User Session ID"));        TelemetryDimensions.Add('Earliest Start Date/Time', Format(JobQueueEntry."Earliest Start Date/Time"));        Telemetry.LogMessage('0000LC5', EDocumentJobTelemetryLbl, Verbosity::Normal, DataClassification::OrganizationIdentifiableInformation, TelemetryScope::All, TelemetryDimensions);    end;    procedure HandleRecurrentBatchJob(var EDocumentService: Record "E-Document Service")    begin        if (EDocumentService."Use Batch Processing") and (EDocumentService."Batch Mode" = EDocumentService."Batch Mode"::Recurrent) then begin            EDocumentService.TestField("Batch Start Time");            EDocumentService.TestField("Batch Minutes between runs");            ScheduleRecurrentBatchJob(EDocumentService);        end else            RemoveJob(EDocumentService."Batch Recurrent Job Id");    end;    procedure HandleRecurrentImportJob(var EDocumentService: Record "E-Document Service")    begin        if EDocumentService."Auto Import" then begin            EDocumentService.TestField("Import Minutes between runs");            ScheduleRecurrentImportJob(EDocumentService);        end else            RemoveJob(EDocumentService."Import Recurrent Job Id");    end;    procedure RemoveJob(JobId: Guid)    var        JobQueueEntry: Record "Job Queue Entry";    begin        if JobQueueEntry.Get(JobId) then            JobQueueEntry.Delete();    end;    local procedure IsJobQueueScheduled(CodeunitId: Integer): Boolean    var        JobQueueEntry: Record "Job Queue Entry";    begin        JobQueueEntry.SetRange("Object Type to Run", JobQueueEntry."Object Type to Run"::Codeunit);        JobQueueEntry.SetRange("Object ID to Run", CodeunitId);        JobQueueEntry.SetFilter(Status, '%1|%2', JobQueueEntry.Status::Ready, JobQueueEntry.Status::"In Process");        if not JobQueueEntry.IsEmpty() then            exit(true);    end;    local procedure IsRecurrentJobScheduledForAService(JobId: Guid): Boolean    var        JobQueueEntry: Record "Job Queue Entry";    begin        if IsNullGuid(JobId) then            exit(false);        exit(JobQueueEntry.Get(JobId));    end;    local procedure ScheduleEDocumentJob(CodeunitId: Integer; JobRecordId: RecordId; EarliestStartDateTime: Integer): Guid    var        JobQueueEntry: Record "Job Queue Entry";    begin        PrepareEDocumentJob(JobQueueEntry, CodeunitId, JobRecordId, EarliestStartDateTime);        Codeunit.Run(Codeunit::"Job Queue - Enqueue", JobQueueEntry);        exit(JobQueueEntry.ID);    end;    local procedure TryScheduleEDocumentJob(CodeunitId: Integer; JobRecordId: RecordId; EarliestStartDateTime: Integer): Boolean    var        JobQueueEntry: Record "Job Queue Entry";    begin        PrepareEDocumentJob(JobQueueEntry, CodeunitId, JobRecordId, EarliestStartDateTime);        exit(Codeunit.Run(Codeunit::"Job Queue - Enqueue", JobQueueEntry));    end;    local procedure PrepareEDocumentJob(var JobQueueEntry: Record "Job Queue Entry"; CodeunitId: Integer; JobRecordId: RecordId; EarliestStartDateTime: Integer)    var        Telemetry: Codeunit Telemetry;        TelemetryDimensions: Dictionary of [Text, Text];    begin        OnBeforeScheduleEDocumentJob(CodeunitId, JobRecordId);        JobQueueEntry.Init();        JobQueueEntry."Object Type to Run" := JobQueueEntry."Object Type to Run"::Codeunit;        JobQueueEntry."Object ID to Run" := CodeunitId;        JobQueueEntry."Record ID to Process" := JobRecordId;        JobQueueEntry."User Session ID" := SessionId();        JobQueueEntry."Job Queue Category Code" := JobQueueCategoryTok;        JobQueueEntry."No. of Attempts to Run" := 0;        JobQueueEntry."Earliest Start Date/Time" := CurrentDateTime + EarliestStartDateTime;        TelemetryDimensions.Add('Job Queue Id', JobQueueEntry.ID);        TelemetryDimensions.Add('Codeunit Id', Format(CodeunitId));        TelemetryDimensions.Add('Record Id', Format(JobRecordId));        TelemetryDimensions.Add('User Session ID', Format(JobQueueEntry."User Session ID"));        TelemetryDimensions.Add('Earliest Start Date/Time', Format(JobQueueEntry."Earliest Start Date/Time"));        Telemetry.LogMessage('0000LC6', EDocumentJobTelemetryLbl, Verbosity::Normal, DataClassification::OrganizationIdentifiableInformation, TelemetryScope::ExtensionPublisher, TelemetryDimensions);    end;    [InternalEvent(false, false)]    local procedure OnBeforeScheduleEDocumentJob(CodeunitId: Integer; JobRecordId: RecordId)    begin    end;    var        JobQueueCategoryTok: Label 'EDocument', Locked = true, Comment = 'Max Length 10';        EDocumentJobTelemetryLbl: Label 'E-Document Background Job Scheduled', Locked = true;}