[W1][Report][1701][Deferral Summary - Sales] Add integration event OnBeforeReturnSalesDocTypeString in ReturnSalesDocTypeString Procedure

[mavohra]

Why do you need this change?

We need to override the procedure that converts a sales document type integer into its display string inside ReturnSalesDocTypeString. The standard code uses a hardcoded case statement with label constants to return the string for each document type, but our customization requires using the "Sales Comment Document Type" enum's FromInteger and Format functions to derive the string, ensuring the output is always consistent with the enum's caption without maintaining separate label constants.

The standard implementation hardcodes label mappings for each integer value (0–9). All calls to ReturnSalesDocTypeString in the report depend on the returned string being correct for display purposes. There is no way to intercept or replace the return value after the procedure has already exited.

No event exists inside or around ReturnSalesDocTypeString that exposes the SalesDocType input and the Result output before the procedure returns. The procedure is local, so it cannot be overridden from a report extension.

Describe the request

Add an integration event OnBeforeReturnSalesDocTypeString in ReturnSalesDocTypeString in Report "Customer Deferred Revenue" before the case block, with an IsHandled guard to allow subscribers to fully replace the return value.

local procedure ReturnSalesDocTypeString(SalesDocType: Integer): Text
    begin
        IsHandled := false;
        OnBeforeReturnSalesDocTypeString(SalesDocType, Result, IsHandled); 
        if IsHandled then
            exit(Result);
        case SalesDocType of
            0:
                exit(QuoteLbl);
            1:
                exit(OrderLbl);
            2:
                exit(InvoiceLbl);
            3:
                exit(CreditMemoLbl);
            4:
                exit(BlanketOrderLbl);
            5:
                exit(ReturnOrderLbl);
            6:
                exit(ShipmentLbl);
            7:
                exit(PostedInvoiceLbl);
            8:
                exit(PostedCreditMemoLbl);
            9:
                exit(PostedReturnReceiptLbl);
            else
                exit('');
        end;
    end;

Event Signature:

[IntegrationEvent(false, false)]
    local procedure OnBeforeReturnSalesDocTypeString(SalesDocType: Integer; var Result: Text; var IsHandled: Boolean)
    begin
    end;

Alternatives evaluated:
No event currently exists inside or around ReturnSalesDocTypeString. The procedure is local, so report extensions cannot override it. Adding logic after the call to ReturnSalesDocTypeString in the trigger would be too late since the return value is already assigned to DocumentTypeString and cannot be intercepted without the event.

[github-actions]

Hi @mavohra,

Thank you for your extensibility request. To help us process it efficiently, please update the issue to include the required information.

📚 Extensibility Guidelines

Missing Information:

• Performance considerations: Please describe the expected execution frequency of this event and any anticipated performance impact.
• Data sensitivity review: Please confirm whether this change would expose any sensitive data.
• Multi-extension interaction assessment: Please explain whether multiple subscribers could conflict and how that risk would be handled.

Please update the issue with the missing details. We'll automatically re-analyze once updated.

Note

Automatically generated by the Triage Agent — advisory only. An engineer will review before any action is taken.

Tip

Not accurate? Reply with /not-accurate (optional: add a short explanation). Your feedback improves future responses.

[mavohra]

Performance considerations

The event fires once per call to ReturnSalesDocTypeString during the Deferral Summary report, typically a few times per report execution. It is [IntegrationEvent(false, false)] with three parameters. Overhead is negligible compared to the case statement or enum conversion that follows.

Data sensitivity/security review

The event exposes only an integer (SalesDocType) and a text output (Result). No records, no customer/vendor data, no financial dimensions.

Multi-extension interaction assessment

Unlikely.

[github-actions]

✅ Analysis complete - ready for further processing

---

Implementation:

Add a new integration event in ReturnSalesDocTypeString of Report 1701 "Deferral Summary - Sales" before the case block so subscribers can override the returned document type text by using an IsHandled pattern.

Location in ReturnSalesDocTypeString() procedure:

local procedure ReturnSalesDocTypeString(SalesDocType: Integer): Text
var
    Result: Text;
    IsHandled: Boolean;
begin
    IsHandled := false;
    OnBeforeReturnSalesDocTypeString(SalesDocType, Result, IsHandled);
    if IsHandled then
        exit(Result);

    case SalesDocType of
        0:
            exit(QuoteLbl);
        1:
            exit(OrderLbl);
        2:
            exit(InvoiceLbl);
        3:
            exit(CreditMemoLbl);
        4:
            exit(BlanketOrderLbl);
        5:
            exit(ReturnOrderLbl);
        6:
            exit(ShipmentLbl);
        7:
            exit(PostedInvoiceLbl);
        8:
            exit(PostedCreditMemoLbl);
        9:
            exit(PostedReturnReceiptLbl);
        else
            exit('');
    end;
end;

Event Publisher (add at the end of the codeunit with other events):

[IntegrationEvent(false, false)]
local procedure OnBeforeReturnSalesDocTypeString(SalesDocType: Integer; var Result: Text; var IsHandled: Boolean)
begin
end;

---

File: DeferralSummarySales.Report.al

Note

Automatically generated by the Triage Agent — advisory only. An engineer will review before any action is taken.

Tip

Not accurate? Reply with /not-accurate (optional: add a short explanation). Your feedback improves future responses.

[JesperSchulz]

🤖 AI triage completed. Product group, please validate the triage report (Microsoft internal access only, use Ctrl+Click to open in new tab).

---

_{Was this triage helpful? React with 👍 or 👎 on this comment to provide feedback.}