BSL172 — There is no check for the attribute DataExchange.Load in the object's event handler¶

Summary¶

There is no check for the attribute DataExchange.Load in the object's event handler

Identifiers¶

Field	Value
Rule code	`BSL172`
Compatible alias	`DataExchangeLoading`
Severity	`WARNING`
Enabled by default	Yes
Implemented	Yes
Tags	`correctness`, `data-exchange`

Behavior¶

The public identifier BSL172 and alias DataExchangeLoading are stable.
The rule reports the cases documented on this page.
Suppressions and project configuration are applied before publication.
The rule requires neither an external analyzer nor network access.

Configuration and suppression¶

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL172"]
ignore = ["DataExchangeLoading"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

noqa:

Value = "example";  // noqa: BSL172

bsl-disable:

Value = "example";  // bsl-disable: BSL172

compatible BSLLS form:

Value = "example";  // BSLLS:DataExchangeLoading-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL172
// code without this diagnostic
// noqa-enable: BSL172

// bsl-disable: BSL172
// code without this diagnostic
// bsl-enable: BSL172

// BSLLS:DataExchangeLoading-off
// code without this diagnostic
// BSLLS:DataExchangeLoading-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

Description¶

All actions in the event-handler procedures BeforeWrite, OnWrite, BeforeDelete should be performed after checking for DataExchange.Load.

This is necessary so that no business logic of the object is executed when writing the object through the data exchange mechanism, since it has already been executed for the object in the node where it was created. In this case, all data is loaded into the Information Base "as is", without distortion (changes), checks or any other actions that prevent data loading.

Examples¶

Incorrect:

Procedure BeforeWrite(Cancel)

     If Not Cancel Then
        RumMyFunction();
    EndIf;

    // other code
    //
    // ...

EndProcedure

Correct:

Procedure BeforeWrite(Cancel)

     If DataExchange.Load Then
        Return;
    EndIf;

    // other code
    //
    // ...
EndProcedure