Codeunit 8033 Generic Connector Processing

Subscription Billing, Microsoft.SubscriptionBilling

src/Apps/W1/Subscription Billing/App/Usage Based Billing/Codeunits/GenericConnectorProcessing.Codeunit.al370 lines, Copyright (c) Microsoft Corporation. MIT

namespace Microsoft.SubscriptionBilling;using System.IO;using System.Utilities;codeunit 8033 "Generic Connector Processing" implements "Usage Data Processing"{    var        ImportAndProcessUsageData: Codeunit "Import And Process Usage Data";        CreateUsageDataBilling: Codeunit "Create Usage Data Billing";        ProgressTracker: Codeunit "Sub. Billing Progress Tracker";        ProcessImportedLinesLbl: Label 'Processing imported usage data lines...';        CreateBillingDataLbl: Label 'Creating usage data billing...';        ImportEntryDetailLbl: Label 'Import Entry No. %1', Comment = '%1 = Usage Data Import Entry No.';        ProcessingSetupErr: Label 'You must specify either a reading/writing XMLport or a reading/writing codeunit.';        UsageDataLinesProcessingErr: Label 'Errors were found while processing the Usage Data Lines.';        NoDataFoundErr: Label 'No data found for processing step %1.', Comment = '%1 = Name of the processing step';        NoServiceObjectErr: Label 'The %1 ''%2'' is not linked to an %3.', Comment = '%1 = Table name, %2 = Entry number, %3 = Table name';        ServiceObjectProvisionEndDateErr: Label 'The %1 ''%2'' is deinstalled.', Comment = '%1 = Table name, %2 = Entry number';        ReferenceNotFoundErr: Label 'For %1 ''%2'' no linked %3 was found.', Comment = '%1 = Field name, %2 = Entry description, %3 = Table name';        NotValidServiceCommitmentErr: Label 'Subscription Line %2 found for Subscription %1 is not valid. Please check the Subscription Line and adjust the validity of the Subscription Line if necessary.', Comment = '%1 = Object number, %2 = Entry number';        UsageDataGenericImportProcessingErr: Label 'Errors were found while processing the Usage Data Generic Import.';        RetryFailedUsageDataImportTxt: Label 'There are Usage Data Generic Import records with errors for Import %1. Do you want to retry processing the failed records?', Comment = '%1 = Usage Data Import Entry No.';        NoContractErr: Label 'The %1 %2 in %3 "%4" has not been assigned to a Contract yet.', Comment = '%1 = Subscription Line, %2 = Subscription Line Entry No., %3 = Subscription, %4 = Subscription No.';        NoServiceCommitmentWithUsageBasedFlagInServiceObjectErr: Label '%1 "%2" has no valid %3 with property "%4": Yes', Comment = '%1 = Subscription, %2 = Subscription No., %3 = Subscription Line, %4 = Usage Based Billing';    procedure ImportUsageData(var UsageDataImport: Record "Usage Data Import")    var        UsageDataBlob: Record "Usage Data Blob";        UsageDataGenericImport: Record "Usage Data Generic Import";        GenericImportSettings: Record "Generic Import Settings";    begin        UsageDataImport.TestField("Supplier No.");        GenericImportSettings.Get(UsageDataImport."Supplier No.");        if GenericImportSettings."Process without UsageDataBlobs" then            exit;        UsageDataGenericImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        UsageDataGenericImport.DeleteAll(false);        UsageDataBlob.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        UsageDataBlob.SetRange("Import Status", UsageDataBlob."Import Status"::Ok);        if UsageDataBlob.FindSet() then            repeat                ImportUsageDataBlobToUsageDataGenericImport(UsageDataBlob, UsageDataImport);            until UsageDataBlob.Next() = 0        else begin            UsageDataImport.SetErrorReason(StrSubstNo(NoDataFoundErr, UsageDataImport."Processing Step"));            UsageDataImport.Modify(false);        end;    end;    local procedure ImportUsageDataBlobToUsageDataGenericImport(UsageDataBlob: Record "Usage Data Blob"; var UsageDataImport: Record "Usage Data Import")    var        DataExch: Record "Data Exch.";        DataExchDef: Record "Data Exch. Def";        GenericImportSettings: Record "Generic Import Settings";    begin        GenericImportSettings.Get(UsageDataImport."Supplier No.");        GenericImportSettings.TestField("Data Exchange Definition");        DataExchDef.Get(GenericImportSettings."Data Exchange Definition");        if (DataExchDef."Reading/Writing XMLport" <> 0) = (DataExchDef."Reading/Writing Codeunit" <> 0) then            Error(ProcessingSetupErr);        CreateDataExch(DataExch, UsageDataBlob, DataExchDef.Code);        DataExch."Related Record" := UsageDataImport.RecordId;        DataExch.Modify(false);        DataExch.ImportToDataExch(DataExchDef);        DataExchDef.ProcessDataExchange(DataExch);        DataExch.Delete(true);        OnAfterImportUsageDataBlobToUsageDataGenericImport(UsageDataBlob, UsageDataImport);    end;    local procedure CreateDataExch(var DataExch: Record "Data Exch."; UsageDataBlob: Record "Usage Data Blob"; DataExchDefCode: Code[20])    var        FileContentInStream: InStream;    begin        UsageDataBlob.CalcFields(Data);        UsageDataBlob.Data.CreateInStream(FileContentInStream);        DataExch.InsertRec(UsageDataBlob.Source, FileContentInStream, DataExchDefCode);    end;    procedure ProcessUsageData(var UsageDataImport: Record "Usage Data Import")    var        UsageDataGenericImport: Record "Usage Data Generic Import";        ServiceCommitment: Record "Subscription Line";        GenericImportSettings: Record "Generic Import Settings";        UsageDataSupplierReference: Record "Usage Data Supplier Reference";        ErrorCount: Integer;        LineCounter: Integer;        DetailText: Text;    begin        UsageDataGenericImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        this.ProgressTracker.StartActivity(ProcessImportedLinesLbl, UsageDataGenericImport.Count());        DetailText := StrSubstNo(ImportEntryDetailLbl, UsageDataImport."Entry No.");        GenericImportSettings.Get(UsageDataImport."Supplier No."); // Loop-invariant (constant Supplier No.) - read once instead of per row.        if UsageDataGenericImport.FindSet() then            repeat                LineCounter += 1;                this.ProgressTracker.UpdateProgress(LineCounter, DetailText);                UsageDataGenericImport.Validate("Processing Status", Enum::"Processing Status"::None);                CreateUsageDataCustomers(GenericImportSettings, UsageDataGenericImport, UsageDataSupplierReference, UsageDataImport."Supplier No.");                CreateUsageDataSubscriptions(GenericImportSettings, UsageDataGenericImport, UsageDataSupplierReference, UsageDataImport);                if UsageDataGenericImport."Processing Status" <> Enum::"Processing Status"::Error then                    CheckServiceCommitment(UsageDataGenericImport, UsageDataImport, ServiceCommitment);                if UsageDataGenericImport."Processing Status" <> Enum::"Processing Status"::Error then                    CheckAndAssignServiceObject(UsageDataGenericImport, ServiceCommitment);                if UsageDataGenericImport."Processing Status" = "Processing Status"::Error then                    ErrorCount += 1                else                    UsageDataGenericImport."Processing Status" := Enum::"Processing Status"::Ok;                UpdateServiceObjectConnectionStatus(ImportAndProcessUsageData, UsageDataImport, UsageDataGenericImport);                UsageDataGenericImport.Modify(false);            until UsageDataGenericImport.Next() = 0        else begin            UsageDataImport.SetErrorReason(StrSubstNo(NoDataFoundErr, UsageDataImport."Processing Step"));            UsageDataImport.Modify(false);        end;        this.ProgressTracker.Finish();        if ErrorCount <> 0 then            UsageDataImport.SetErrorReason(UsageDataLinesProcessingErr);    end;    local procedure CreateUsageDataCustomers(GenericImportSettings: Record "Generic Import Settings"; UsageDataGenericImport: Record "Usage Data Generic Import";                                            UsageDataSupplierReference: Record "Usage Data Supplier Reference"; SupplierNo: Code[20])    begin        if not GenericImportSettings."Create Customers" then            exit;        UsageDataGenericImport.TestField("Customer ID");        ImportAndProcessUsageData.CreateUsageDataCustomer(UsageDataGenericImport."Customer ID", UsageDataSupplierReference, SupplierNo);    end;    local procedure CreateUsageDataSubscriptions(GenericImportSettings: Record "Generic Import Settings"; UsageDataGenericImport: Record "Usage Data Generic Import"; UsageDataSupplierReference: Record "Usage Data Supplier Reference"; var UsageDataImport: Record "Usage Data Import")    begin        if not GenericImportSettings."Create Supplier Subscriptions" then            exit;        ImportAndProcessUsageData.CreateUsageDataSubscription(UsageDataGenericImport."Supp. Subscription ID", UsageDataGenericImport."Customer ID",                        UsageDataGenericImport."Product ID", UsageDataGenericImport."Product Name", UsageDataGenericImport."Unit",                        UsageDataGenericImport.Quantity, UsageDataGenericImport."Supp. Subscription Start Date", UsageDataGenericImport."Supp. Subscription End Date",                        UsageDataSupplierReference, UsageDataImport."Supplier No.");    end;    local procedure UpdateServiceObjectConnectionStatus(ImportAndProcessUsageDataParam: Codeunit "Import And Process Usage Data"; var UsageDataImport: Record "Usage Data Import"; var UsageDataGenericImport: Record "Usage Data Generic Import")    begin        UsageDataGenericImport."Service Object Availability" := UsageDataGenericImport."Service Object Availability"::"Not Available";        if UsageDataGenericImport."Subscription Header No." <> '' then begin            UsageDataGenericImport."Service Object Availability" := UsageDataGenericImport."Service Object Availability"::Connected;            exit;        end;        if not ImportAndProcessUsageDataParam.AvailableServiceObjectExist(UsageDataImport, UsageDataGenericImport."Supp. Subscription ID") then            exit;        UsageDataGenericImport."Service Object Availability" := UsageDataGenericImport."Service Object Availability"::Available;    end;    local procedure CheckAndAssignServiceObject(var UsageDataGenericImport: Record "Usage Data Generic Import"; ServiceCommitment: Record "Subscription Line")    var        ServiceObject: Record "Subscription Header";    begin        if ServiceCommitment."Subscription Header No." = '' then begin            UsageDataGenericImport."Processing Status" := UsageDataGenericImport."Processing Status"::Error;            UsageDataGenericImport.SetReason(StrSubstNo(NoServiceObjectErr, ServiceCommitment.TableCaption, ServiceCommitment."Entry No.", ServiceObject.TableCaption));        end else begin            ServiceObject.Get(ServiceCommitment."Subscription Header No.");            if ServiceObject."Provision End Date" <> 0D then begin                UsageDataGenericImport."Processing Status" := UsageDataGenericImport."Processing Status"::Error;                UsageDataGenericImport.SetReason(StrSubstNo(ServiceObjectProvisionEndDateErr, ServiceObject.TableCaption, ServiceObject."No."));            end else                UsageDataGenericImport."Subscription Header No." := ServiceCommitment."Subscription Header No.";        end;    end;    local procedure CheckServiceCommitment(var UsageDataGenericImport: Record "Usage Data Generic Import"; var UsageDataImport: Record "Usage Data Import"; var ServiceCommitment: Record "Subscription Line")    begin        if ImportAndProcessUsageData.GetServiceCommitmentForSubscription(UsageDataImport."Supplier No.", UsageDataGenericImport."Supp. Subscription ID", ServiceCommitment) then            CheckIfServiceCommitmentStartDateIsValid(UsageDataGenericImport, ServiceCommitment)        else            SetErrorIfServiceCommitmentDoesNotExist(UsageDataGenericImport, ServiceCommitment);    end;    local procedure SetErrorIfServiceCommitmentDoesNotExist(var UsageDataGenericImport: Record "Usage Data Generic Import"; ServiceCommitment: Record "Subscription Line")    begin        UsageDataGenericImport."Processing Status" := UsageDataGenericImport."Processing Status"::Error;        UsageDataGenericImport.SetReason(StrSubstNo(ReferenceNotFoundErr, UsageDataGenericImport.FieldCaption(UsageDataGenericImport."Supp. Subscription ID"),                                                    UsageDataGenericImport."Supp. Subscription ID", ServiceCommitment.TableCaption));    end;    local procedure CheckIfServiceCommitmentStartDateIsValid(var UsageDataGenericImport: Record "Usage Data Generic Import"; ServiceCommitment: Record "Subscription Line")    begin        if ServiceCommitment."Subscription Line Start Date" <= UsageDataGenericImport."Billing Period Start Date" then            exit;        UsageDataGenericImport."Processing Status" := UsageDataGenericImport."Processing Status"::Error;        UsageDataGenericImport.SetReason(StrSubstNo(NotValidServiceCommitmentErr, ServiceCommitment."Subscription Header No.", ServiceCommitment."Entry No."));    end;    procedure ValidateImportedData(var UsageDataImport: Record "Usage Data Import")    var        UsageDataGenImport: Record "Usage Data Generic Import";    begin        UsageDataGenImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        if UsageDataGenImport.IsEmpty() then begin            UsageDataImport.SetErrorReason(StrSubstNo(NoDataFoundErr, UsageDataImport."Processing Step"));            UsageDataImport.Modify(false);        end;    end;    procedure CreateBillingData(var UsageDataImport: Record "Usage Data Import")    var        TempServiceCommitment: Record "Subscription Line" temporary;        UsageDataBilling: Record "Usage Data Billing";        UsageDataGenericImport: Record "Usage Data Generic Import";        ConfirmManagement: Codeunit "Confirm Management";        LineCounter: Integer;        DetailText: Text;    begin        UsageDataGenericImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        UsageDataGenericImport.SetRange("Processing Status", "Processing Status"::Error);        if not UsageDataGenericImport.IsEmpty() then begin            if GuiAllowed then                if not ConfirmManagement.GetResponse(StrSubstNo(RetryFailedUsageDataImportTxt, UsageDataImport."Entry No."), false) then                    exit;        end else begin            UsageDataBilling.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");            UsageDataBilling.DeleteAll(true);            UsageDataGenericImport.SetRange("Processing Status");        end;        this.ProgressTracker.StartActivity(CreateBillingDataLbl, UsageDataGenericImport.Count());        DetailText := StrSubstNo(ImportEntryDetailLbl, UsageDataImport."Entry No.");        if UsageDataGenericImport.FindSet() then            repeat                LineCounter += 1;                this.ProgressTracker.UpdateProgress(LineCounter, DetailText);                CreateUsageDataBilling.CollectServiceCommitments(TempServiceCommitment, UsageDataGenericImport."Subscription Header No.", UsageDataGenericImport."Supp. Subscription End Date");                SetUsageDataGenericImportError(UsageDataGenericImport, '');                if not CheckServiceCommitments(UsageDataGenericImport, TempServiceCommitment) then begin                    this.ProgressTracker.Finish();                    exit;                end;                CreateUsageDataBilling.CreateUsageDataBillingFromTempServiceCommitments(TempServiceCommitment, UsageDataImport."Supplier No.", UsageDataGenericImport);            until UsageDataGenericImport.Next() = 0        else begin            UsageDataImport.SetErrorReason(StrSubstNo(NoDataFoundErr, UsageDataImport."Processing Step"));            UsageDataImport.Modify(false);        end;        this.ProgressTracker.Finish();    end;    procedure UpdateImportStatus(var UsageDataImport: Record "Usage Data Import")    var        UsageDataGenericImport: Record "Usage Data Generic Import";    begin        UsageDataGenericImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        UsageDataGenericImport.SetRange("Processing Status", UsageDataGenericImport."Processing Status"::Error);        if UsageDataGenericImport.IsEmpty() then            UsageDataImport.Validate("Processing Status", Enum::"Processing Status"::Ok)        else            UsageDataImport.SetErrorReason(UsageDataGenericImportProcessingErr);        UsageDataImport.Modify(false);    end;    local procedure CheckServiceCommitments(var UsageDataGenericImport: Record "Usage Data Generic Import"; var TempServiceCommitment: Record "Subscription Line" temporary): Boolean    var        ServiceObject: Record "Subscription Header";    begin        TempServiceCommitment.Reset();        TempServiceCommitment.SetRange("Subscription Contract No.", '');        if TempServiceCommitment.FindFirst() then begin            SetUsageDataGenericImportError(UsageDataGenericImport, StrSubstNo(NoContractErr, TempServiceCommitment.TableCaption, TempServiceCommitment."Entry No.",                                             ServiceObject.TableCaption, UsageDataGenericImport."Subscription Header No."));            exit(false);        end;        TempServiceCommitment.Reset();        if not TempServiceCommitment.FindSet() then begin            SetUsageDataGenericImportError(UsageDataGenericImport, StrSubstNo(NoServiceCommitmentWithUsageBasedFlagInServiceObjectErr, ServiceObject.TableCaption, UsageDataGenericImport."Subscription Header No.",                                             TempServiceCommitment.TableCaption, TempServiceCommitment.FieldCaption("Usage Based Billing")));            exit(false);        end;        exit(true);    end;    local procedure SetUsageDataGenericImportError(var UsageDataGenericImport: Record "Usage Data Generic Import"; Reason: Text)    begin        if Reason = '' then            UsageDataGenericImport."Processing Status" := UsageDataGenericImport."Processing Status"::Ok        else            UsageDataGenericImport."Processing Status" := UsageDataGenericImport."Processing Status"::Error;        UsageDataGenericImport.SetReason(Reason);        UsageDataGenericImport.Modify(false);    end;    procedure DeleteImportedData(var UsageDataImport: Record "Usage Data Import")    var        UsageDataGenericImport: Record "Usage Data Generic Import";    begin        UsageDataGenericImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        UsageDataGenericImport.DeleteAll(false);    end;    procedure UpdateSubscriptionHeaderNo(SupplierReference: Text[80]; SubscriptionHeaderNo: Code[20])    var        UsageDataGenericImport: Record "Usage Data Generic Import";    begin        UsageDataGenericImport.SetFilter("Processing Status", '<>%1', "Processing Status"::Ok);        UsageDataGenericImport.SetRange("Supp. Subscription ID", SupplierReference);        UsageDataGenericImport.ModifyAll("Subscription Header No.", SubscriptionHeaderNo);        UsageDataGenericImport.ModifyAll("Service Object Availability", UsageDataGenericImport."Service Object Availability"::Connected);    end;    procedure OpenSupplierSettings(var UsageDataSupplier: Record "Usage Data Supplier")    var        GenericImportSettings: Record "Generic Import Settings";    begin        GenericImportSettings.FilterGroup(2);        GenericImportSettings.SetRange("Usage Data Supplier No.", UsageDataSupplier."No.");        GenericImportSettings.FilterGroup(0);        Page.RunModal(Page::"Generic Import Settings Card", GenericImportSettings);    end;    procedure DeleteSupplierData(var UsageDataSupplier: Record "Usage Data Supplier")    var        GenericImportSettings: Record "Generic Import Settings";    begin        GenericImportSettings.SetRange("Usage Data Supplier No.", UsageDataSupplier."No.");        GenericImportSettings.DeleteAll(false);    end;    procedure GetImportedLineCount(var UsageDataImport: Record "Usage Data Import"; OnlyErrors: Boolean): Integer    var        UsageDataGenericImport: Record "Usage Data Generic Import";    begin        UsageDataGenericImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        if OnlyErrors then            UsageDataGenericImport.SetRange("Processing Status", "Processing Status"::Error);        exit(UsageDataGenericImport.Count());    end;    procedure ShowImportedLines(var UsageDataImport: Record "Usage Data Import"; ShowOnlyErrors: Boolean)    var        UsageDataGenericImport: Record "Usage Data Generic Import";    begin        UsageDataGenericImport.SetRange("Usage Data Import Entry No.", UsageDataImport."Entry No.");        if ShowOnlyErrors then            UsageDataGenericImport.SetRange("Processing Status", "Processing Status"::Error);        Page.Run(Page::"Usage Data Generic Import", UsageDataGenericImport);    end;    [EventSubscriber(ObjectType::Codeunit, Codeunit::"Process Data Exch.", OnProcessColumnMappingOnBeforeDataExchFieldMappingFindSet, '', false, false)]    local procedure SetNextEntryNoForUsageDataGenericImport(var RecordRef: RecordRef; LastKeyFieldId: Integer; CurrLineNo: Integer)    var        UsageDataGenericImport: Record "Usage Data Generic Import";        ProcessDataExch: Codeunit "Process Data Exch.";    begin        if RecordRef.Number <> Database::"Usage Data Generic Import" then            exit;        ProcessDataExch.SetFieldValue(RecordRef, LastKeyFieldId, UsageDataGenericImport.GetNextEntryNo());    end;    [IntegrationEvent(false, false)]    local procedure OnAfterImportUsageDataBlobToUsageDataGenericImport(UsageDataBlob: Record "Usage Data Blob"; var UsageDataImport: Record "Usage Data Import")    begin    end;}