Skip to content

BSL268 — Using FindByName, FindByCode and FindByNumber

← All rules

Summary

Using FindByName, FindByCode and FindByNumber

Identifiers

Field Value
Rule code BSL268
Compatible alias UsingFindElementByString
Severity WARNING
Enabled by default Yes
Implemented Yes
Tags performance

Behavior

  • The public identifier BSL268 and alias UsingFindElementByString 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 = ["BSL268"]
ignore = ["UsingFindElementByString"]

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: BSL268
  • bsl-disable:
Value = "example";  // bsl-disable: BSL268
  • compatible BSLLS form:
Value = "example";  // BSLLS:UsingFindElementByString-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: BSL268
// code without this diagnostic
// noqa-enable: BSL268

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

// BSLLS:UsingFindElementByString-off
// code without this diagnostic
// BSLLS:UsingFindElementByString-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

The rule finds the use of the FindByName, FindByCode or FindByNumber methods using specific numbers, codes and names of elements or documents. Similar code may not work correctly in other databases. Often such code is test code included in the release version, which is also not recommended.

It is recommended to specify constant data values ​​from the database in "Сonstants" or predefined metadata elements.

Examples

Incorrect: 

Position = Catalogs.Positions.FindByName("Senior Accountant");
or 
Position = Catalogs.Positions.FindByCode("00-0000001");

or

Object = Documents.Invoice.FindByNumber("0000-000001", CurrentDate());

Acceptable use: 

Catalogs.Currencies.FindByCode(CurrentData.CurrencyCodeDigital);

Catalogs.BankClassifier.FindByCode(BankDetails.BIK);


Documents.Invoice.FindByNumber(Number);