Table extension 8054 Sales Line
src/Apps/W1/Subscription Billing/App/Sales Service Commitments/Table Extensions/SalesLine.TableExt.al440 lines, Copyright (c) Microsoft Corporation. MIT
namespace Microsoft.SubscriptionBilling;using Microsoft.Finance.Dimension;using Microsoft.Inventory.Item;using Microsoft.Sales.Document;tableextension 8054 "Sales Line" extends "Sales Line"{ fields { field(8053; "Recurring Billing from"; Date) { Caption = 'Recurring Billing from'; DataClassification = CustomerContent; } field(8054; "Recurring Billing to"; Date) { Caption = 'Recurring Billing to'; DataClassification = CustomerContent; } field(8055; "Subscription Lines"; Integer) { Caption = 'Subscription Lines'; FieldClass = FlowField; CalcFormula = count("Sales Subscription Line" where("Document Type" = field("Document Type"), "Document No." = field("Document No."), "Document Line No." = field("Line No."))); Editable = false; } field(8057; "Subscription Option"; Enum "Item Service Commitment Type") { Caption = 'Subscription Option'; FieldClass = FlowField; CalcFormula = lookup(Item."Subscription Option" where("No." = field("No."))); Editable = false; } field(8058; "Discount"; Boolean) { Caption = 'Discount'; Editable = false; DataClassification = CustomerContent; } field(8059; "Exclude from Doc. Total"; Boolean) { Caption = 'Exclude from Document Total'; DataClassification = CustomerContent; } modify(Type) { trigger OnBeforeValidate() begin ErrorIfServiceObjectTypeCannotBeSelectedManually(); end; trigger OnAfterValidate() begin CheckAndDeleteServiceCommitmentsForSalesLine(Rec, xRec); end; } modify("No.") { TableRelation = if (Type = const("Service Object")) "Subscription Header" where("End-User Customer No." = field("Sell-to Customer No.")); trigger OnAfterValidate() var SalesServiceCommitmentMgmt: Codeunit "Sales Subscription Line Mgmt."; begin SetExcludeFromDocTotal(); if xRec."No." = Rec."No." then exit; CheckAndDeleteServiceCommitmentsForSalesLine(Rec, xRec); // During Explode BOM the Subscription Lines are added from OnExplodeBOMCompLinesOnAfterToSalesLineInsert, // where the line is inserted and the quantity is set. Adding them here as well offers the Subscription Packages twice per component. if SalesServiceCommitmentMgmt.IsSalesLineBeingExploded(Rec) then exit; SalesServiceCommitmentMgmt.AddSalesServiceCommitmentsForSalesLine(Rec, false); end; } modify(Quantity) { trigger OnAfterValidate() begin UpdateSalesServiceCommitmentCalculationBaseAmount(Rec, xRec); end; } modify("Unit Price") { trigger OnAfterValidate() begin UpdateSalesServiceCommitmentCalculationBaseAmount(Rec, xRec); end; } modify("Unit Cost (LCY)") { trigger OnAfterValidate() begin UpdateSalesServiceCommitmentCalculationBaseAmount(Rec, xRec); end; } modify("Line Discount %") { trigger OnAfterValidate() var SalesServiceCommitmentMgmt: Codeunit "Sales Subscription Line Mgmt."; begin UpdateSalesServiceCommitmentCalculationBaseAmount(Rec, xRec); if Rec."Line Discount %" <> xRec."Line Discount %" then SalesServiceCommitmentMgmt.NotifyIfDiscountIsNotTransferredFromSalesLine(Rec); end; } modify("Line Discount Amount") { trigger OnAfterValidate() var SalesServiceCommitmentMgmt: Codeunit "Sales Subscription Line Mgmt."; begin UpdateSalesServiceCommitmentCalculationBaseAmount(Rec, xRec); if Rec."Line Discount Amount" <> xRec."Line Discount Amount" then SalesServiceCommitmentMgmt.NotifyIfDiscountIsNotTransferredFromSalesLine(Rec); end; } modify("Customer Price Group") { trigger OnAfterValidate() var SalesServiceCommitment: Record "Sales Subscription Line"; begin if xRec."Customer Price Group" = Rec."Customer Price Group" then exit; SalesServiceCommitment.FilterOnSalesLine(Rec); SalesServiceCommitment.ModifyAll("Customer Price Group", Rec."Customer Price Group", false); end; } modify("Unit Cost") { trigger OnAfterValidate() begin UpdateSalesServiceCommitmentCalculationBaseAmount(Rec, xRec); end; } modify("Allow Invoice Disc.") { trigger OnAfterValidate() var Item: Record Item; begin if Rec."Allow Invoice Disc." then if IsServiceCommitmentItem() then Error(Item.GetDoNotAllowInvoiceDiscountForServiceCommitmentItemErrorText()); end; } modify("Deferral Code") { trigger OnAfterValidate() begin if Rec."Deferral Code" <> '' then if Rec.IsLineAttachedToBillingLine() then if Rec.CreateContractDeferrals() then Error(DeferralCodeCannotBeUsedWithContractDeferralsErr); end; } } var BillingLineExist, IsBillingLineCached : Boolean; CachedBillingLineDocumentType: Enum "Sales Document Type"; CachedBillingLineDocumentNo: Code[20]; CachedBillingLineNo: Integer; trigger OnDelete() begin DeleteSalesServiceCommitment(); end; procedure InitCachedVar() begin IsBillingLineCached := false; end; procedure IsSalesDocumentTypeWithServiceCommitments(): Boolean begin exit( Rec."Document Type" in [Rec."Document Type"::Quote, Rec."Document Type"::Order, Rec."Document Type"::"Blanket Order"]); end; var DimMgt: Codeunit DimensionManagement; TypeCannotBeSelectedManuallyErr: Label 'Type "%1" cannot be selected manually.', Comment = '%1 = Sales Line Type'; DeferralCodeCannotBeUsedWithContractDeferralsErr: Label 'A Deferral Code cannot be used on a line where Subscription Contract Deferrals are active. Either remove the Deferral Code or disable Contract Deferrals on the subscription line or contract.'; procedure InitFromSalesHeader(SourceSalesHeader: Record "Sales Header") begin Rec.Init(); Rec."Document Type" := SourceSalesHeader."Document Type"; Rec."Document No." := SourceSalesHeader."No."; Rec."Line No." := SourceSalesHeader.GetNextLineNo(); Rec."Sell-to Customer No." := SourceSalesHeader."Sell-to Customer No."; end; /// <summary> /// Deletes the Sales Subscription Lines that belong to this Sales Line. /// Call this whenever a Sales Line is removed without running its triggers (Delete(false), DeleteAll(false)), /// because the OnDelete() trigger of this table extension does not fire in that case and the /// Sales Subscription Lines would be left behind as orphaned records. /// Temporary records and document types that cannot carry Sales Subscription Lines are skipped, /// so the call is safe for any Sales Line. /// </summary> procedure DeleteSalesServiceCommitment() var SalesServiceCommitment: Record "Sales Subscription Line"; begin if Rec.IsTemporary() then exit; if not Rec.IsSalesDocumentTypeWithServiceCommitments() then exit; SalesServiceCommitment.FilterOnSalesLine(Rec); if SalesServiceCommitment.IsEmpty() then exit; SalesServiceCommitment.DeleteAll(false); end; internal procedure GetCombinedDimensionSetID(DimSetID1: Integer; DimSetID2: Integer) var DimSetIDArr: array[10] of Integer; begin DimSetIDArr[1] := DimSetID1; DimSetIDArr[2] := DimSetID2; "Dimension Set ID" := DimMgt.GetCombinedDimensionSetID(DimSetIDArr, "Shortcut Dimension 1 Code", "Shortcut Dimension 2 Code"); end; local procedure CheckAndDeleteServiceCommitmentsForSalesLine(SalesLine: Record "Sales Line"; xSalesLine: Record "Sales Line") begin if (SalesLine."No." <> xSalesLine."No.") or (SalesLine.Type <> xSalesLine.Type) then SalesLine.DeleteSalesServiceCommitment(); end; local procedure UpdateSalesServiceCommitmentCalculationBaseAmount(var SalesLine: Record "Sales Line"; xSalesLine: Record "Sales Line") var SalesServiceCommitment: Record "Sales Subscription Line"; begin if SalesLine.IsTemporary() then exit; if (xSalesLine.Quantity = SalesLine.Quantity) and (xSalesLine."Unit Price" = SalesLine."Unit Price") and (xSalesLine."Line Discount %" = SalesLine."Line Discount %") and (xSalesLine."Line Discount Amount" = SalesLine."Line Discount Amount") and (xSalesLine."Unit Cost" = SalesLine."Unit Cost") and (xSalesLine."Unit Cost (LCY)" = SalesLine."Unit Cost (LCY)") then exit; SalesServiceCommitment.FilterOnSalesLine(SalesLine); if SalesServiceCommitment.IsEmpty() then exit; if SalesServiceCommitment.FindSet() then repeat SalesServiceCommitment.SetSalesLine(Rec); SalesServiceCommitment.CalculateCalculationBaseAmount(); until SalesServiceCommitment.Next() = 0; OnAfterUpdateSalesSubscriptionLineCalculationBaseAmount(SalesLine, xSalesLine); end; internal procedure IsServiceCommitmentItem(): Boolean begin if (Rec.Type <> Rec.Type::Item) or ("No." = '') then exit(false); if Rec."Subscription Option".AsInteger() = 0 then Rec.CalcFields("Subscription Option"); exit(Rec."Subscription Option" = "Item Service Commitment Type"::"Service Commitment Item"); end; local procedure ErrorIfServiceObjectTypeCannotBeSelectedManually() var IsHandled: Boolean; begin IsHandled := false; OnBeforeErrorIfServiceObjectTypeCannotBeSelectedManually(Rec, CurrFieldNo, IsHandled); if IsHandled then exit; if (CurrFieldNo = 0) or (not Rec.IsTypeServiceObject()) then exit; Error(TypeCannotBeSelectedManuallyErr, Rec.Type); end; internal procedure SetExcludeFromDocTotal() var ItemManagement: Codeunit "Sub. Contracts Item Management"; IsContractRenewalLocal: Boolean; IsHandled: Boolean; begin OnBeforeSetExcludeFromDocTotal(Rec, IsHandled); if IsHandled then exit; IsContractRenewalLocal := Rec.IsContractRenewal(); if IsContractRenewalLocal then begin if Rec.IsTypeServiceObject() then Rec.Validate("Exclude from Doc. Total", IsContractRenewalLocal); end else if Rec.IsSalesDocumentTypeWithServiceCommitments() then if ((Rec.Type = Rec.Type::Item) and (Rec."No." <> '')) then Rec.Validate("Exclude from Doc. Total", ItemManagement.IsServiceCommitmentItem(Rec."No.")); end; internal procedure IsLineWithServiceObject(): Boolean begin exit((Rec.Type = "Sales Line Type"::"Service Object") and (Rec."No." <> '')); end; internal procedure IsTypeServiceObject(): Boolean begin exit(Rec.Type = "Sales Line Type"::"Service Object"); end; procedure InsertDescriptionSalesLine(SourceSalesHeader: Record "Sales Header"; NewDescription: Text; AttachedToLineNo: Integer) var SalesLine: Record "Sales Line"; begin SalesLine.CreateAttachedSalesLine(SourceSalesHeader, NewDescription, AttachedToLineNo); end; internal procedure CreateAttachedSalesLine(SourceSalesHeader: Record "Sales Header"; NewDescription: Text; AttachedToLineNo: Integer) begin Rec.InitFromSalesHeader(SourceSalesHeader); Rec."Attached to Line No." := AttachedToLineNo; Rec.Description := CopyStr(NewDescription, 1, MaxStrLen(Rec.Description)); Rec.Insert(false); end; internal procedure RetrieveFirstContractNo(ServicePartner: Enum "Service Partner"; Process: Enum Process): Code[20] var SalesServiceCommitment: Record "Sales Subscription Line"; begin SalesServiceCommitment.SetRange("Document Type", Rec."Document Type"); SalesServiceCommitment.SetRange("Document No.", Rec."Document No."); SalesServiceCommitment.SetRange("Document Line No.", Rec."Line No."); SalesServiceCommitment.SetRange(Partner, ServicePartner); SalesServiceCommitment.SetRange(Process, Process); if not SalesServiceCommitment.FindFirst() then SalesServiceCommitment.Init(); exit(SalesServiceCommitment."Linked to No."); end; /// <summary> /// Checks whether this sales line is linked to a Subscription Billing Line. /// The result is cached per line, so repeated calls on the same line do not re-query the database. /// </summary> /// <returns>True if a Billing Line exists for this line's document type, document number and line number; otherwise false.</returns> procedure IsLineAttachedToBillingLine(): Boolean var BillingLine: Record "Billing Line"; begin // Refresh the cached result whenever the record points at a different line, so external callers // that reuse the same record variable across lines never receive a stale value from a previous line. if (not IsBillingLineCached) or (CachedBillingLineDocumentType <> Rec."Document Type") or (CachedBillingLineDocumentNo <> Rec."Document No.") or (CachedBillingLineNo <> Rec."Line No.") then begin BillingLine.FilterBillingLineOnDocumentLine(BillingLine.GetBillingDocumentTypeFromSalesDocumentType(Rec."Document Type"), Rec."Document No.", Rec."Line No."); BillingLineExist := not BillingLine.IsEmpty(); CachedBillingLineDocumentType := Rec."Document Type"; CachedBillingLineDocumentNo := Rec."Document No."; CachedBillingLineNo := Rec."Line No."; IsBillingLineCached := true; end; exit(BillingLineExist); end; internal procedure CreateContractDeferrals(): Boolean var CustomerSubscriptionContract: Record "Customer Subscription Contract"; SubscriptionLine: Record "Subscription Line"; BillingLine: Record "Billing Line"; begin BillingLine.FilterBillingLineOnDocumentLine(BillingLine.GetBillingDocumentTypeFromSalesDocumentType(Rec."Document Type"), Rec."Document No.", Rec."Line No."); if not BillingLine.FindFirst() then exit; if not SubscriptionLine.Get(BillingLine."Subscription Line Entry No.") then exit; case SubscriptionLine."Create Contract Deferrals" of Enum::"Create Contract Deferrals"::"Contract-dependent": begin CustomerSubscriptionContract.Get(BillingLine."Subscription Contract No."); exit(CustomerSubscriptionContract."Create Contract Deferrals"); end; Enum::"Create Contract Deferrals"::Yes: exit(true); Enum::"Create Contract Deferrals"::No: exit(false); end; end; internal procedure IsContractRenewalQuote(): Boolean begin if Rec."Document Type" <> Rec."Document Type"::Quote then exit(false); exit(Rec.IsContractRenewal()); end; internal procedure IsContractRenewal(): Boolean var SalesServiceCommitment: Record "Sales Subscription Line"; begin SalesServiceCommitment.FilterOnSalesLine(Rec); SalesServiceCommitment.SetRange(Process, Enum::Process::"Contract Renewal"); exit(not SalesServiceCommitment.IsEmpty()); end; internal procedure GetSalesDocumentSign(): Integer begin if Rec."Document Type" = "Sales Document Type"::"Credit Memo" then exit(-1); exit(1); end; [IntegrationEvent(false, false)] local procedure OnBeforeSetExcludeFromDocTotal(var SalesLine: Record "Sales Line"; var IsHandled: Boolean) begin end; [IntegrationEvent(false, false)] local procedure OnAfterUpdateSalesSubscriptionLineCalculationBaseAmount(var SalesLine: Record "Sales Line"; xSalesLine: Record "Sales Line") begin end; [IntegrationEvent(false, false)] local procedure OnBeforeErrorIfServiceObjectTypeCannotBeSelectedManually(var SalesLine: Record "Sales Line"; FieldNo: Integer; var IsHandled: Boolean) begin end;}