bc-al-new-object

BC AL New Object Guide

When to Use

Always use before creating:

• Tables, pages, codeunits, enums, queries, reports, xmlports
• Table extensions, page extensions, enum extensions

Step 1: Read app.json

Before creating any object, read the repo's app.json to get:

• idRanges — object ID range for this extension
• name — app name (used in translations)
• publisher — publisher name
• dependencies — what this extension depends on

Step 2: Pick Object ID

Use the next available ID within the app.json idRanges. The AL compiler suggests the next ID automatically — use it.

Field IDs in extensions: start at the lower bound of idRanges (e.g., 52000 if range is 52000–52999).

Step 3: File Naming

Follow Microsoft official convention: <ObjectName>.<FullTypeName>.al

Type	Suffix	Example
Table	.Table.al	HQHUCustomerType.Table.al
Page	.Page.al	HQHUCustomerTypes.Page.al
Codeunit	.Codeunit.al	HQHUCustomerMgmt.Codeunit.al
Table Extension	.TableExt.al	HQHUCustomer.TableExt.al
Page Extension	.PageExt.al	HQHUCustomerCard.PageExt.al
Enum	.Enum.al	HQHUCustomerTypeEnum.Enum.al
Enum Extension	.EnumExt.al	HQHUCustomerTypeEnumExt.EnumExt.al
Query	.Query.al	HQHUCustomerQuery.Query.al
Report	.Report.al	HQHUCustomerReport.Report.al
XmlPort	.XmlPort.al	HQHUCustomerImport.XmlPort.al

Prefix comes from the project convention (e.g., HQHU for Hungary, HQFR for France).

Step 4: Object Naming

• Table: "<PREFIX> <Name>"
• Page: "<PREFIX> <Name>"
• Table Extension: "<PREFIX> <BaseName> Tbl Ext"
• Page Extension: "<PREFIX> <BasePage> Ext"

Step 5: Required Properties

Every Table

Caption = '<Description>';
DataClassification = CustomerContent;
LookupPageId = "<Page Name>";
DrillDownPageId = "<Page Name>";
DataCaptionFields = <Key fields>;

Every Table Extension Field

Caption = '<Label>';
DataClassification = CustomerContent;
ToolTip = 'Specifies <what the field does>.';

Every Page

Caption = '<Label>';
ApplicationArea = All;
UsageCategory = Lists;  // or Administration, Documents

Every Page Extension Field

ApplicationArea = All;
ToolTip = 'Specifies <what the field does>.';

Step 6: Folder Placement

Place in src/components/<ComponentName>/<TypeFolder>/:

Object Type	Folder
Table	Tables/
Page	Pages/
Codeunit	Codeunits/
Table Extension	TableExtensions/
Page Extension	PageExtensions/
Permission Set Extension	PermissionSetExtensions/

Step 7: Create Permission Extensions

After creating the object, create matching permission set extensions. See bc-al-permissions skill.

Checklist

1. Read app.json for idRanges and prefix
2. Pick next available object ID
3. Use correct file name pattern
4. Use correct object name pattern
5. Add required properties (Caption, DataClassification, ToolTip, ApplicationArea)
6. Place in correct component folder
7. Create matching PermissionSetExtensions (Read + Edit)