Table 1220 - Data Exch. - [Procedure - ImportToDataExch] (SoftwareOne - Company Details)

[Pardeep-Saini-Soft]

Why do you need this change?

Required to allow custom import processing for Data Exchange before standard Codeunit/XMLport import execution.

Describe the request

Current Code
procedure ImportToDataExch(DataExchDef: Record "Data Exch. Def"): Boolean
var
Source: InStream;
ProgressWindow: Dialog;
begin
if not "File Content".HasValue() then
if not ImportFileContent(DataExchDef) then
exit(false);

    ProgressWindow.Open(ProgressWindowMsg);

    "File Content".CreateInStream(Source);
    SetRange("Entry No.", "Entry No.");
    if DataExchDef."Reading/Writing Codeunit" > 0 then
        CODEUNIT.Run(DataExchDef."Reading/Writing Codeunit", Rec)
    else begin
        DataExchDef.TestField("Reading/Writing XMLport");
        XMLPORT.Import(DataExchDef."Reading/Writing XMLport", Source, Rec);
    end;

    ProgressWindow.Close();

    exit(true);
end;

Requested Change
procedure ImportToDataExch(DataExchDef: Record "Data Exch. Def"): Boolean
var
Source: InStream;
ProgressWindow: Dialog;
IsHandled: Boolean;
begin
if not "File Content".HasValue() then
if not ImportFileContent(DataExchDef) then
exit(false);

    **IsHandled := false;
    OnBeforeImportToDataExch(Rec, DataExchDef, IsHandled);
    if not IsHandled then begin
        ProgressWindow.Open(ProgressWindowMsg);**

        "File Content".CreateInStream(Source);
        SetRange("Entry No.", "Entry No.");
        if DataExchDef."Reading/Writing Codeunit" > 0 then
            CODEUNIT.Run(DataExchDef."Reading/Writing Codeunit", Rec)
        else begin
            DataExchDef.TestField("Reading/Writing XMLport");
            XMLPORT.Import(DataExchDef."Reading/Writing XMLport", Source, Rec);
        end;

        ProgressWindow.Close();
    end;

    exit(true);
end;

Requested Event Publisher
[IntegrationEvent(false, false)]
local procedure (var DataExch: Record "Data Exch."; var DataExchDef: Record "Data Exch. Def"; var IsHandled: Boolean)
begin
end;

[github-actions]

Hi @Pardeep-Saini-Soft,

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:

• Existing events or alternative extensibility patterns evaluated: Explain which existing events or other extensibility approaches were considered and why they are insufficient.
• IsHandled justification: Explain why an IsHandled bypass is required instead of a regular event or redesign.
• Execution frequency and performance impact: Describe how often this code path is expected to run and any performance considerations.
• Data sensitivity/security review: Clarify whether any sensitive or private data could be exposed and note any security considerations.
• Multi-extension subscriber conflicts: Explain how conflicts between multiple extensions subscribing to this IsHandled event 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.

[Pardeep-Saini-Soft]

Existing events or alternative extensibility patterns evaluated:
We reviewed the existing extensibility options available for Data Exchange processing, including Data Exchange related events, XMLport customization options, and subscriber-based processing after import execution.

These options are insufficient for our requirement because the customization must occur before the standard import process starts.
Our requirements are:

• Suppress the standard Progress Window shown by ImportToDataExch().
• Prepare or populate the file content from an alternative source before the import begins.

Currently, there is no event available before the Progress Window is opened and before the standard XMLport/Codeunit import execution starts.
As a result, existing events do not provide a way to control the Progress Window behavior or prepare custom file content before the standard import processing begins.

IsHandled justification:
An IsHandled pattern is not required for our scenario. A regular IntegrationEvent before the standard import execution would be sufficient. The purpose of the event is to allow extensions to prepare custom file content and control UI behavior such as the Progress Window before the standard import logic executes.

Execution frequency and performance impact:
This code path is executed only when a Data Exchange import is initiated.
The process is user-driven or integration-driven and is not part of high-frequency transactional operations. The proposed event would be executed once per import operation.

The event would only add a single event publisher call before the standard import process starts. When no subscribers are present, the performance impact is negligible.

No additional database operations or significant processing overhead are introduced by the proposed event.

Data sensitivity / security review:

The requested event would expose only the Data Exch. and Data Exch. Def. records that are already available within the standard import process.

No additional customer, financial, personal, or confidential data would be exposed beyond what is already accessible to the standard Data Exchange framework.

The event is intended only to allow extensions to control the Progress Window behavior and prepare file content before the standard import execution starts.

No elevation of privileges, security bypass, or additional data access is introduced by this change. Therefore, no additional security risks are expected.

Multi-extension subscriber conflicts:
The proposed extensibility point does not require an IsHandled pattern.

The event is intended to expose a configurable parameter (ShowProgressWindow) before the standard import process starts. Multiple subscribers can participate in the standard Business Central event model without replacing the base implementation.

As the standard import process continues to execute, the risk of extension conflicts is significantly lower than with an IsHandled-based event.

If multiple extensions modify the ShowProgressWindow parameter, the behavior follows the standard Business Central event subscriber execution model and is consistent with other existing extensibility points.

After further review, a regular IntegrationEvent would be sufficient for our scenario.
The primary requirements are:

1. Ability to suppress the standard Progress Window.
2. Ability to prepare file content from an alternative source before the standard import execution starts.

Therefore, an event with a ShowProgressWindow parameter may be preferable to an IsHandled implementation.

Requested Change:
procedure ImportToDataExch(DataExchDef: Record "Data Exch. Def"): Boolean
var
Source: InStream;
ProgressWindow: Dialog;
ShowProgressWindow: Boolean;
begin
if not "File Content".HasValue() then
if not ImportFileContent(DataExchDef) then
exit(false);

ShowProgressWindow := true;
OnBeforeImportToDataExch(Rec, DataExchDef, ShowProgressWindow);

if ShowProgressWindow then
    ProgressWindow.Open(ProgressWindowMsg);

"File Content".CreateInStream(Source);
SetRange("Entry No.", "Entry No.");

if DataExchDef."Reading/Writing Codeunit" > 0 then
    CODEUNIT.Run(DataExchDef."Reading/Writing Codeunit", Rec)
else begin
    DataExchDef.TestField("Reading/Writing XMLport");
    XMLPORT.Import(DataExchDef."Reading/Writing XMLport", Source, Rec);
end;

if ShowProgressWindow then
    ProgressWindow.Close();

exit(true);

end;

Requested Integration Event
[IntegrationEvent(false, false)]
local procedure OnBeforeImportToDataExch(
var DataExch: Record "Data Exch.";
var DataExchDef: Record "Data Exch. Def";
var ShowProgressWindow: Boolean)
begin
end;

[github-actions]

Hi @Pardeep-Saini-Soft,

Thank you for your extensibility request.

The code you'd like to change is part of the BCApps repository. To have this change made, it needs to go through a contribution.
Please refer to the contribution guide for instructions on how to proceed: https://github.com/microsoft/BCApps/blob/main/CONTRIBUTING.md

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.