LC0063

Consider naming field with a more descriptive name

This rule will suggest to give certain fields a more describing name on pages of type API for these fields;

• id for field Rec.SystemId
• number for field Rec."No."
• displayName for field Rec.Name

Additional it will look for other "No." fields, like

• customerNumber for field Rec."Customer No."
• maximumNumberOfAttempts for field Rec."Maximum No. of Attempts"

AZ AL Dev Tools

The alOutline.apiFieldNamesConversion setting of the AZ AL Dev Tools/AL Code Outline can assist with assigning fieldnames.

"alOutline.apiFieldNamesConversion": [
        {
            "searchRegExp": "^no$",
            "newValue": "number"
        },
        {
            "searchRegExp": "No$",
            "newValue": "Number"
        },
        {
            "searchRegExp": "^systemId$",
            "newValue": "id"
        },
        {
            "searchRegExp": "^systemModifiedAt$",
            "newValue": "lastModifiedDateTime"
        }
    ],

External references

• API Page / Query | alguidelines.dev - Business Central Design Patterns
• API Pages - Mandatory fields · anzwdev/al-code-outline (github.com)