alguidelines.dev - Business Central Design Patterns – Best Practices

Docs: begin as an afterword

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

When begin follows then, else, do, it should be on the same line, preceded by one space character.

Bad code

 if ICPartnerRefType = ICPartnerRefType::"Common Item No." then
 begin
 ...
 end;

Good code

 if ICPartnerRefType = ICPartnerRefType::"Common Item No." then begin
 ...
 end;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Begin-End - Compound Only

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Only use begin..end to enclose compound statements.

Bad code

if FindSet() then begin
 repeat
 ...
 until next() = 0;
end;

Good code

if FindSet() then
 repeat
 ...
 until next() = 0;

Bad code

if IsAssemblyOutputLine then begin
 TestField("Order Line No.", 0);
end;

Good code

if IsAssemblyOutputLine then
 TestField("Order Line No.", 0);

Exception

// Except for this case
if X then begin
 if Y then
 //DO SOMETHING;
end else
 (not X)

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Binary Operator to Start Line

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

Do not start a line with a binary operator.

Bad code

"Quantity to Ship" :=
Quantity
- "Quantity Shipped"

Good code

"Quantity to Ship" :=
Quantity -
"Quantity Shipped"

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: CASE Action on next line

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

A CASE action should start on a line after the possibility.

Bad code

 case Letter of
 'A': Letter2 := '10';
 'B': Letter2 := '11';
 end;

Good code

 case Letter of
 'A':
 Letter2 := '10';
 'B':
 Letter2 := '11';
 end;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Comment Spacing

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

Always start comments with // followed by one space character.

Bad code

RowNo += 1000; //Move way below the budget

Good code

RowNo += 1000; // Move way below the budget

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: DeleteAll

Mon, 01 Jan 0001 00:00:00 +0000

Created by waldo, Described by waldo

Description

When you perform a “DeleteAll” when there is nothing to delete, it will still perform a lock. When you for example perform a DeleteAll on an empty table, it will result in a table lock. Therefore it’s good practice to always check if the table is empty when performing a DeleteAll.

Bad code

 EmptyTableWLD.SetRange(Code, 'AJ');
 EmptyTableWLD.DeleteAll(true);

Good code

 EmptyTableWLD.SetRange(Code, 'AJ');
 if not EmptyTableWLD.IsEmpty() then
 EmptyTableWLD.DeleteAll(true);

Discussions

You can discuss the guideline here

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: end else pair

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

The end else pair should always appear on the same line.

Bad code

 if OppEntry.Find('-') then
 if SalesCycleStage.Find('-') then begin
 ...
 end
 else
 begin
 ...
 end;

Good code

 if OppEntry.Find('-') then
 if SalesCycleStage.Find('-') then begin
 ...
 end else begin
 ...
 end;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Keyword Pairs - Indentation

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

The if..then pair, while..do pair, and for..do pair must appear on the same line or the same level of indentation. If possible, you can align the lines it is even much more readable.

Bad code

 if (x = y) and
 (a = b) then

Good code

 if (x = y) and
 (a = b)
 then

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Line Start Keywords

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

The end, if, repeat, for, while, else and case statement should always start a line.

Bad code

 if IsContactName then ValidateContactName()
 else if IsSalespersonCode then ValidateSalespersonCode()
 else if IsSalesCycleCode then ValidatSalesCycleCode();

Good code

 if IsContactName then
 ValidateContactName()
 else
 if IsSalespersonCode then
 ValidateSalespersonCode()
 else
 if IsSalesCycleCode then
 ValidatSalesCycleCode();

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Lonely Repeat

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

The repeat statement should always be alone on a line.

Bad code

 if ReservEntry.FindSet() then repeat

Good code

 if ReservEntry.FindSet() then
 repeat

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Named Invocations

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

When calling an object statically use the Object Name, not the Object Id.

Bad code

 Page.RunModal(525, SalesShptLine);

Good code

 Page.RunModal(Page::"Posted Sales Shipment Lines", SalesShptLine);

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: One Statement per Line

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

A line of code should not have more than one statement.

Bad code

 if OppEntry.Find('-') then exit;

Good code

 if OppEntry.Find('-') then
 exit;

Bad code

 TotalCost += Cost; TotalAmt += Amt;

Good code

 TotalCost += Cost;
 TotalAmt += Amt;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Seperate if and else

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

if and else statements should be on separate lines.

Bad code

 if Atom = '\>' then HasLogicalOperator := true else begin
 ...
 end;

Good code

 if Atom = '\>' then
 HasLogicalOperator := true
 else begin
 ...
 end;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Spacing Binary Operators

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

There must be exactly one space character on each side of a binary operator such as = + - AND OR =. The parameter comma operator however, should have a space after the comma.

Bad code

 "Line Discount %" := "Line Discount Amount"/"Line Value"*100;

Good code

 "Line Discount %" := "Line Discount Amount" / "Line Value" * 100;

Bad code

 StartDate := CalcDate('<+'+Format(Days+i)+'D\>',StartDate);

Good code

 StartDate := CalcDate('<+' + Format(Days + i) + 'D\>', StartDate);

Bad code

 StartDate:=0D; // Initialize

Good code

 StartDate := 0D; // Initialize

Docs: Subscriber Codeunits

Mon, 01 Jan 0001 00:00:00 +0000

Created by waldo, Described by waldo

Description

In general, subscribers have to be put in codeunits. There are a few performance considerations that you should keep in the back of your minds, when designing such a codeunit.

Keep the codeunit as small as possible
Work with a single instance codeunit
only subscribe when necessary
Avoid generic OnInsert/OnModify/OnDelete

Let’s discuss all points

Keep the codeunit as small as possible

Every time a subscriber gets called, a new instance of the codeunit is being loaded in memory, which takes memory and processing power. The smaller the codeunit, the less memory, and the faster it is.

Therefore, it’s suggested to split the subscribers by functionality and avoid putting business logic in the actual codeunit. Tip: put all business logic in an “Method Codeunit”.

Examples:

if you app does things on Sales and Purchase, create a Sales-subs codeunit, and a Purchase-subs.
if you have multiple functionalities in your app (let’s call’m modules), create a subs-codeunit per module, and only add the subscribers in there that are necessary for that module.

Bad code

codeunit 2037325 "Setup Subs"
{
 SingleInstance = true;

 [EventSubscriber(ObjectType::Codeunit, Codeunit::"Manual Setup", 'OnRegisterManualSetup', '', false, false)]
 local procedure OnRegisterManualSetup(sender: Codeunit "Manual Setup")
 var
 AppId: ModuleInfo;
 NameListLbl: Label 'Linked Texts Framework - List', Locked = true;
 DescriptionListLbl: Label 'Edit linked texts', Locked = true;
 KeyWordListLbl: Label 'LT,Distri,Technical,Functional,Reports', Locked = true;
 NameReportLbl: Label 'Linked Texts Framework - Reports', Locked = true;
 DescriptionReportLbl: Label 'View linked texts reports', Locked = true;
 KeyWordReportLbl: Label 'LT,Distri,Technical,Functional,Reports', Locked = true;
 begin
 navapp.GetCurrentModuleInfo(AppId);
 Sender.Insert(NameListLbl, DescriptionListLbl, KeyWordListLbl, page::"LTE Linked Text List", AppId.Id(), "Manual Setup Category"::General);
 Sender.Insert(NameReportLbl, DescriptionReportLbl, KeyWordReportLbl, page::"LTE Linked Texts Reports", AppId.Id(), "Manual Setup Category"::General);
 end;

 [EventSubscriber(ObjectType::Codeunit, codeunit::"Manual Setup", 'OnRegisterManualSetup', '', false, false)]
 local procedure OnRegisterManualSetup(sender: Codeunit "Manual Setup")
 var
 AppId: ModuleInfo;
 NameLayoutLbl: Label 'Report Helper - Layout', Locked = true;
 DescriptionLayoutLbl: Label 'Set up or update report layout list', Locked = true;
 KeyWordLayoutLbl: Label 'RH,Distri,Technical,Functional,Reports,Layout', Locked = true;
 NameCaptionsLbl: Label 'Report Helper - Captions', Locked = true;
 DescriptionCaptionsLbl: Label 'Set up or update captions list', Locked = true;
 KeyWordCaptionsLbl: Label 'RH,Distri,Technical,Functional,Reports,Captions', Locked = true;
 NameFunctionsLbl: Label 'Report Helper - Functions', Locked = true;
 DescriptionFunctionsLbl: Label 'Set up or disable functions', Locked = true;
 KeyWordFunctionsLbl: Label 'RH,Distri,Technical,Functional,Reports,Functions', Locked = true;
 NameDFCLbl: Label 'Report Helper - Default Footer', Locked = true;
 DescriptionDFCLbl: Label 'Set up or update default footer', Locked = true;
 KeyWordDFCLbl: Label 'RH,Distri,Technical,Functional,Reports,Default,Footer', Locked = true;
 begin
 navapp.GetCurrentModuleInfo(AppId);
 Sender.Insert(NameLayoutLbl, DescriptionLayoutLbl, KeyWordLayoutLbl, page::"RHE Report Layout List", AppId.Id(), "Manual Setup Category"::General);
 Sender.Insert(NameCaptionsLbl, DescriptionCaptionsLbl, KeyWordCaptionsLbl, page::"RHE Captions", AppId.Id(), "Manual Setup Category"::General);
 Sender.Insert(NameFunctionsLbl, DescriptionFunctionsLbl, KeyWordFunctionsLbl, page::"RHE Functions", AppId.Id(), "Manual Setup Category"::General);
 Sender.Insert(NameDFCLbl, DescriptionDFCLbl, KeyWordDFCLbl, page::"RHE Default Footer Card", AppId.Id(), "Manual Setup Category"::General);
 end;
}

Good code

Split into 2 codeunits, and move the business logic out.

codeunit 2037325 "LTE Setup Subs"
{
 SingleInstance = true;

 [EventSubscriber(ObjectType::Codeunit, Codeunit::"Manual Setup", 'OnRegisterManualSetup', '', false, false)]
 local procedure OnRegisterManualSetup(sender: Codeunit "Manual Setup")
 var
 RegisterLTEManualSetup: codeunit "Register LTE Manual Setup";
 begin
 RegisterLTEManualSetup.RegisterLTEManualSetup();
 end;
}

codeunit 2037324 "RHE Setup Subs"
{
 SingleInstance = true;

 [EventSubscriber(ObjectType::Codeunit, Codeunit::"Manual Setup", 'OnRegisterManualSetup', '', false, false)]
 local procedure OnRegisterManualSetup(sender: Codeunit "Manual Setup")
 var
 RegisterRHEManualSetup: codeunit "Register RHE Manual Setup";
 begin
 RegisterRHEManualSetup.RegisterRHEManualSetup();
 end;
}

Work with a single instance codeunit

To avoid the extra “loading of the content” while a subscriber is being executed, use Single Instance codeunit for subscribers. Do take into account, of course, that it would share the state across the entire session.

Bad code

codeunit 2037324 "RHE Setup Subs"
{
 [EventSubscriber(ObjectType::Codeunit, Codeunit::"Manual Setup", 'OnRegisterManualSetup', '', false, false)]
 local procedure OnRegisterManualSetup(sender: Codeunit "Manual Setup")
 var
 RegisterRHEManualSetup: codeunit "Register RHE Manual Setup";
 begin
 RegisterRHEManualSetup.RegisterRHEManualSetup();
 end;
}

Good code

codeunit 2037324 "RHE Setup Subs"
{
 SingleInstance = true;

 [EventSubscriber(ObjectType::Codeunit, Codeunit::"Manual Setup", 'OnRegisterManualSetup', '', false, false)]
 local procedure OnRegisterManualSetup(sender: Codeunit "Manual Setup")
 var
 RegisterRHEManualSetup: codeunit "Register RHE Manual Setup";
 begin
 RegisterRHEManualSetup.RegisterRHEManualSetup();
 end;
}

If possible, only execute the subscriber when really necessary by using Manual Binding.

Bad code

 //subscriber - code should actually only run when Color=Red.
 [EventSubscriber(ObjectType::Table, Database::"Just Some Table WLD", 'OnAfterValidateEvent', 'Message 2', false, false)]
 local procedure JustDoSomthing(var Rec: Record "Just Some Table WLD"; var xRec: Record "Just Some Table WLD")
 begin
 if Rec.color <> 'RED' then
 exit; //only execute when necessary

 ...
 end;

 //business logic
 if JustSomeTable.FindSet() then
 repeat
 JustSomeTable.Validate("Message 2", format(Random(1000)));
 until JustSomeTable.Next() < 1;

Good code

 if JustSomeTable.FindSet() then
 repeat
 if JustSomeTable.Color = 'RED' then
 BindSubscription(DemoSubs);

 JustSomeTable.Validate("Message 2", format(Random(1000)));

 if JustSomeTable.Color = 'RED' then
 UnbindSubscription(DemoSubs);
 until JustSomeTable.Next() < 1;

Avoid OnInsert/OnModify/OnDelete

The reason for this is, that it breaks the batch-calls:

Any “OnInsert” subscriber breaks the bulk inserts, simply because it needs to perform an operation after every record that was inserted
Any “OnModify” subscriber slows down the “ModifyAll”, simply because it needs to perform an operation after every record that was modified. I fact: 1 SQL call is turned into a loop of SQL calls.
Any “OnDelete” subscriber slows down the “DeleteAll”, simply because it needs to perform an operation after every record that was deleted. I fact: 1 SQL call is turned into a loop of SQL calls.

Avoid subscribers to these events.

Discussions

You can discuss this guidelines here.

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

References

The Generic Method Pattern

Docs: Suggested Abbreviations

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

Whenever possible, do not use abbreviations in variables, functions and objects names.

If there is no other choice, then use the suggestions below.

word	Abbreviation
absence	Abs
account	Acc
accounting	Acc
accumulated	Accum
action	Act
activity	Activ
additional	Add
address	Addr
adjust	Adj
adjusted	Adjd
adjustment	Adjmt
agreement	Agrmt
allocation	Alloc
allowance	Allow
alternative	Alt
amount	Amt
amounts	Amts
answer	Ans
applies	Appl
application	Appln
arrival	Arriv
assembly	Asm
assemble to order	ATO
assignment	Assgnt
associated	Assoc
attachment	Attmt
authorities	Auth
automatic	Auto
availability	Avail
average	Avg
ba db.	BA
balance	Bal
bill of materials	BOM
blanket	Blnkt
budget	Budg
buffer	Buf
business	Bus
business interaction management	BIM
buying	Buy
calculate	Calc
calculated	Calcd
calculation	Calcu
calendar	Cal
capacity	Cap
capacity requirements planning	CRP
cash flow	CF
cashflow	CF
catalog	ctlg
category	Cat
Central Processing Unit	CPU
center	Ctr
change	Chg
changes	Chgs
character	Char
characters	Chars
charge	Chrg
charges	Chrgs
check	Chk
classification	Class
collection	coll
column	col
comment	Cmt
company	Co
component	Comp
completion	Cmpltn
components	Comps
composition	Compn
compression	Compr
concurrent	Concrnt
confidential	Conf
confirmation	Cnfrmn
conflict	Confl
consolidate	Consol
consolidation	Consolid
consumption	Consump
contact	Cont
container	Cntr
contract	Contr
contracted	Contrd
control	Ctrl
controls	Ctrls
conversion	Conv
correction	Cor
correspondence	Corres
corresponding	Corresp
cost	Cst
sold	COGS
credit	Cr
cumulate	Cumul
currency	Curr
current	Crnt
customer	Cust
customer/vendor	CV
daily	Dly
dampener	Damp
database management system	DBMS
date	D
definition	Def
demonstration	Demo
department	Dept
department/project	DP
depreciation	Depr
description	Desc
detail	Dtl
detailed	Dtld
details	Dtls
deviation	Dev
difference	Diff
dimension	Dim
direct	Dir
discount	Disc
discrete	Discr
distribute	Distr
distributed	Distrd
distributor	Distbtr
distribution	Distrn
document	Doc
duplicate	Dupl
entered	Entrd
engineering	Engin
exchange	Exch
excluding	Excl
execute	Exec
expected	Expd
expedited	Exped
expense	Exp
expression	Expr
expiration	Expir
extended	Ext
explode	Expl
export	Expt
final	Fnl
finance	Fin
fiscal	Fisc
finished	Fnshd
fixed asset	FA
forward	Fwd
freight	Frt
general	Gen
general ledger	GL
group	Gr
header	Hdr
history	Hist
holiday	Hol
human resource	HR
identification	ID
import	Imp
inbound	Inbnd
including	Incl
included	Incld
incoming	Incmg
independent software vendor	ISV
industry	Indust
information	Info
initial	Init
Intrastat	Intra
interaction	Interact
integration	Integr
interest	Int
Interim	Intm
internal protocol	IP
inventory	Invt
inventoriable	Invtbl
invoice	Inv
invoiced	Invd
item tracking	IT
journal	Jnl
language	Lang
ledger	Ledg
level	Lvl
line	Ln
list	Lt
local currency	LCY
location	Loc
mailing	Mail
maintenance	Maint
management	Mgt
manual	Man
manufacturing	Mfg
manufacturer	Mfr
material	Mat
marketing	Mktg
maximum	Max
measure	Meas
message	Msg
minimum	Min
miscellaneous	Misc
modify	Mod
month	Mth
negative	Neg
non-inventoriable	NonInvtbl
notification	Notif
number	No
numbers	Nos
object	Obj
operating	Oper
opportunity	Opp
order	Ord
orders	Ords
original	Orig
organization	Org
outbound	Outbnd
Outgoing	Outg
output	Out
outstanding	Outstd
overhead	Ovhd
payment	Pmt
percent	Pct
personnel	Persnl
physical	Phys
picture	Pic
planning	Plng
posted	Pstd
posting	Post
positive	Pos
precision	Prec
prepayment	Prepmt
product	Prod
production	Prod
production order	ProdOrd
project	Proj
property	Prop
prospect	Prspct
purchase	Purch
purchases	Purch
purchaser	Purchr
purchase order	PurchOrd
quality	Qlty
quantity	Qty
questionnaire	Questn
quote	Qte
radio frequency	RF
range	Rng
receipt	Rcpt
received	Rcd
record	Rec
records	Recs
reconcile	Recncl
reconciliation	Recon
recurring	Recur
reference	Ref
register	Reg
registration	Regn
registered	Regd
relation	Rel
relations	Rels
relationship	Rlshp
release	Rlse
released	Rlsd
remaining	Rem
reminder	Rmdr
replacement	Repl
replenish	Rplnsh
replenishment	Rplnsht
report	Rpt
represent	Rep
represented	Repd
request	Rqst
required	Reqd
requirement	Reqt
requirements	Reqts
requisition	Req
reserve	Rsv
reserved	Rsvd
reservation	Reserv
resolution	Resol
resource	Res
response	Rsp
responsibility	Resp
retain	Rtn
retained	Rtnd
return	Ret
returns	Rets
revaluation	Revaln
reverse	Rev
review	Rvw
round	Rnd
rounded	Rndd
rounding	Rndg
route	Rte
routing	Rtng
routine	Rout
sales & receivables	Sales
safety	Saf
schedule	Sched
second	Sec
segment	Seg
select	Sel
selection	Selctn
sequence	Seq
serial	Ser
serial number	SN
service	Serv
sheet	Sh
shipment	Shpt
source	Src
special	Spcl
specification	Spec
specifications	Specs
standard	Std
frequency	SF
statement	Stmt
statistical	Stat
statistics	Stats
stock	Stk
stockkeeping unit	SKU
stream	Stm
structured query language	SQL
subcontract	Subcontr
subcontracted	Subcontrd
subcontracting	Subcontrg
substitute	Sub
substitution	Subst
suggest	Sug
suggested	Sugd
suggestion	Sugn
summary	Sum
suspended	Suspd
symptom	Sympt
synchronize	Synch
temporary	Temp
total	Tot
transaction	Transac
transfer	Trans
translation	Transln
tracking	Trkg
troubleshoot	Tblsht
troubleshooting	Tblshtg
unit of measure	UOM
unit test	UT
unrealized	Unreal
unreserved	Unrsvd
update	Upd
valuation	Valn
value	Val
value added tax	VAT
variance	Var
vendor	Vend
warehouse	Whse
web shop	WS
worksheet	Wksh
g/l	GL
%	Pct
3-tier	Three-Tier
Outlook Synch	Osynch

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Unnecessary else

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

else should not be used when the last action in the then part is an exit, break, skip, quit, error.

Bad code

 procedure SomeProcedure()
 begin
 if IsAdjmtBinCodeChanged() then
 Error(AdjmtBinCodeChangeNotAllowedErr, ...)
 else
 Error(BinCodeChangeNotAllowedErr, ...);
 end;

Good code

 procedure SomeProcedure()
 begin
 if IsAdjmtBinCodeChanged() then
 Error(AdjmtBinCodeChangeNotAllowedErr, ...)
 Error(BinCodeChangeNotAllowedErr, ...);
 end;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Unnecessary true/false

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

Do not use true or false keywords unnecessarily if the expression is already an logical expression.

Bad code

 if IsPositive() = true then

Good code

 if IsPositive() then

Bad code

 if Complete <> true then

Good code

 if not Complete then

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Variable Naming

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

Variables that refer to a AL object must contain the objects name, abbreviated where necessary.

A variable must begin with a capital letter.

Blanks, periods, and other characters (such as parentheses) that would make quotation marks around a variable necessary must be omitted.

If a variable is a compound of two or more words or abbreviations, each word or abbreviation should begin with a capital letter.

Bad code

 WIPBuffer: Record "Job WIP Buffer"

Good code

 JobWIPBuffer: Record "Job WIP Buffer"

Bad code

 Postline: Codeunit "Gen. Jnl.-Post Line";

Good code

 GenJnlPostLine: Codeunit "Gen. Jnl.-Post Line";

Bad code

 "Amount (LCY)": Decimal;

Good code

 AmountLCY: Decimal;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

Docs: Variables Declarations Order

Mon, 01 Jan 0001 00:00:00 +0000

Created by Microsoft, Described by waldo

Description

Variables declarations should be ordered by type. In general, object and complex variable types are listed first followed by simple variables. The order should be:

Record
Report
Codeunit
XmlPort
Page
Query
Notification
BigText
DateFormula
RecordId
RecordRef
FieldRef
FilterPageBuilder

(Ref: Microsoft Docs)

Bad code

 StartingDateFilter: Text;
 Vendor: Record Vendor;

Good code

 Vendor: Record Vendor;
 StartingDateFilter: Text;

Discussions

You can find discussions on all “Best Practices” here.

If you don’t find the discussion of this guideline, please feel free to create a new one with the same title as this article.

alguidelines.dev - Business Central Design Patterns – Best Practices

Docs: begin as an afterword

Description

Bad code

Good code

Docs: Begin-End - Compound Only

Bad code

Good code

Bad code

Good code

Exception

Docs: Binary Operator to Start Line

Description

Bad code

Good code

Docs: CASE Action on next line

Description

Bad code

Good code

Docs: Comment Spacing

Description

Bad code

Good code

Docs: DeleteAll

Description

Bad code

Good code

Discussions

Docs: end else pair

Description

Bad code

Good code

Docs: Keyword Pairs - Indentation

Description

Bad code

Good code

Docs: Line Start Keywords

Description

Bad code

Good code

Docs: Lonely Repeat

Description

Bad code

Good code

Docs: Named Invocations

Description

Bad code

Good code

Docs: One Statement per Line

Description

Bad code

Good code

Bad code

Good code

Docs: Seperate if and else

Description

Bad code

Good code

Docs: Spacing Binary Operators

Description

Bad code

Good code

Bad code

Good code

Bad code

Good code

Docs: Subscriber Codeunits

Description

Keep the codeunit as small as possible

Bad code

Good code

Work with a single instance codeunit

Bad code

Good code

only subscribe when necessary

Bad code

Good code

Avoid OnInsert/OnModify/OnDelete

References

Docs: Suggested Abbreviations