bc-al-component

BC AL Component Scaffolding

When to Use

• User wants to add a new feature area (e.g., "add warranty tracking")
• User says "create a new component" or "new module"
• Starting a feature that needs tables, pages, codeunits, and permissions

Step 1: Read app.json

Get prefix, idRanges, dependencies from the repo's app.json.

Step 2: Plan Objects

Before writing code, determine:

• What new tables are needed?
• What new pages (list, card, API)?
• What codeunits for business logic?
• Which BC base tables/pages need extension?
• Which permission module does this belong to?

Step 3: Create Folder Structure

src/components/<ComponentName>/
  Tables/
  Pages/
  Codeunits/
  TableExtensions/
  PageExtensions/
  PermissionSetExtensions/

Step 4: Create Objects

Follow bc-al-new-object skill for each object. Key patterns:

New Table

table <id> "<PREFIX> <Name>"
{
    Caption = '<Name>';
    DataClassification = CustomerContent;
    LookupPageId = "<PREFIX> <Name>s";
    DrillDownPageId = "<PREFIX> <Name>s";
    DataCaptionFields = Code, Description;

    fields
    {
        field(1; Code; Code[20])
        {
            Caption = 'Code';
            DataClassification = CustomerContent;
            NotBlank = true;
        }
        field(2; Description; Text[100])
        {
            Caption = 'Description';
            DataClassification = CustomerContent;
        }
        field(3; Blocked; Boolean)
        {
            Caption = 'Blocked';
            DataClassification = CustomerContent;
        }
    }

    keys
    {
        key(PK; Code) { Clustered = true; }
    }

    fieldgroups
    {
        fieldgroup(DropDown; Code, Description) { }
    }
}

List Page

page <id> "<PREFIX> <Name>s"
{
    Caption = '<Name>s';
    PageType = List;
    SourceTable = "<PREFIX> <Name>";
    ApplicationArea = All;
    UsageCategory = Lists;
    Editable = true;

    layout
    {
        area(content)
        {
            repeater(General)
            {
                field(Code; Rec.Code)
                {
                    ApplicationArea = All;
                    ToolTip = 'Specifies the code.';
                }
                field(Description; Rec.Description)
                {
                    ApplicationArea = All;
                    ToolTip = 'Specifies the description.';
                }
            }
        }
    }
}

Table Extension

tableextension <id> "<PREFIX> <BaseTable> Tbl Ext" extends <BaseTable>
{
    fields
    {
        field(<fieldId>; "<PREFIX> <FieldName>"; Code[20])
        {
            Caption = '<Label>';
            DataClassification = CustomerContent;
            TableRelation = "<PREFIX> <RelatedTable>".Code where(Blocked = const(false));
            ToolTip = 'Specifies <description>.';
        }
    }
}

Page Extension

pageextension <id> "<PREFIX> <BasePage> Ext" extends "<BasePage>"
{
    layout
    {
        addafter(<AnchorField>)
        {
            field(<VarName>; Rec."<PREFIX> <FieldName>")
            {
                ApplicationArea = All;
                Lookup = true;
                ToolTip = 'Specifies <description>.';
            }
        }
    }
}

Step 5: Create Permission Extensions

Follow bc-al-permissions skill. Create both Edit and Read extensions for each new table/page.

Step 6: Integration

If the component extends base BC functionality, use events/subscriptions in codeunits rather than modifying base objects directly.

Existing Components (reference)

Component	Objects	Module
CustomerType	Table, Page, TableExt, PageExt	Sales
CustomerLedgerAPI	Page (API)	Sales
SalesEntries	Page (API), TableExt, PageExt	Sales
Location	TableExt	Warehouse