@jwikman/bc-code-intelligence-mcp 1.5.7-dev.1

package/embedded-knowledge/domains/eva-errors/samples/fielderror-default-messages.md

@@ -0,0 +1,356 @@
+# FieldError Default Messages - AL Code Sample
+
+## Empty Field Default Messages
+
+```al
+table 50200 "Document Header"
+{
+    fields
+    {
+        field(1; "Document Type"; Enum "Sales Document Type") { }
+        field(2; "Document No."; Code[20]) { }
+        field(3; "Customer No."; Code[20]) { }
+        field(10; "Posting Date"; Date) { }
+        field(20; "Amount"; Decimal) { }
+        field(30; "Currency Code"; Code[10]) { }
+        field(40; "Description"; Text[100]) { }
+    }
+    
+    keys
+    {
+        key(PK; "Document Type", "Document No.") { Clustered = true; }
+    }
+    
+    procedure DemonstrateEmptyFieldMessages()
+    begin
+        // For empty Code field - generates specific "must have a value" message
+        "Customer No." := '';
+        // Output: "Customer No. must have a value in Document Header Document Type='Order', Document No.='DOC001'."
+        FieldError("Customer No.");
+        
+        // For zero Date field - generates specific "must be filled in" message  
+        "Posting Date" := 0D;
+        // Output: "Posting Date must be filled in in Document Header Document Type='Order', Document No.='DOC001'."
+        FieldError("Posting Date");
+        
+        // For zero Decimal field - generates "must not be 0" message
+        Amount := 0;
+        // Output: "Amount must not be 0 in Document Header Document Type='Order', Document No.='DOC001'."
+        FieldError(Amount);
+        
+        // For empty Text field - generates "must have a value" message
+        Description := '';
+        // Output: "Description must have a value in Document Header Document Type='Order', Document No.='DOC001'."
+        FieldError(Description);
+    end;
+}
+```
+
+## Non-Empty Field Default Messages
+
+```al
+table 50201 "Validation Examples"
+{
+    fields
+    {
+        field(1; "Entry No."; Integer) { }
+        field(10; "Status"; Option) { OptionMembers = " ",Open,Released,Closed; }
+        field(20; "Item No."; Code[20]) { }
+        field(30; "Quantity"; Decimal) { }
+        field(40; "Unit Price"; Decimal) { }
+    }
+    
+    keys
+    {
+        key(PK; "Entry No.") { Clustered = true; }
+    }
+    
+    procedure DemonstrateNonEmptyFieldMessages()
+    begin
+        "Entry No." := 1001;
+        "Item No." := 'ITEM001';
+        Quantity := 5.5;
+        "Unit Price" := 100.00;
+        Status := Status::Released;
+        
+        // For non-empty Code field - generates "is not valid" message
+        // Output: "Item No. ITEM001 is not valid in Validation Examples Entry No.='1001'."
+        FieldError("Item No.");
+        
+        // For non-zero Decimal field - generates "is not valid" message  
+        // Output: "Quantity 5.5 is not valid in Validation Examples Entry No.='1001'."
+        FieldError(Quantity);
+        
+        // For non-zero Option field - generates "is not valid" message
+        // Output: "Status Released is not valid in Validation Examples Entry No.='1001'."
+        FieldError(Status);
+    end;
+}
+```
+
+## Record Context in Error Messages
+
+```al
+table 50202 "Customer Transaction"
+{
+    fields
+    {
+        field(1; "Customer No."; Code[20]) { }
+        field(2; "Transaction Date"; Date) { }
+        field(3; "Transaction No."; Code[20]) { }
+        field(10; "Amount"; Decimal) { }
+        field(20; "Currency Code"; Code[10]) { }
+    }
+    
+    keys
+    {
+        key(PK; "Customer No.", "Transaction Date", "Transaction No.") { Clustered = true; }
+    }
+    
+    procedure DemonstrateRecordContextMessages()
+    begin
+        "Customer No." := 'CUST001';
+        "Transaction Date" := Today;
+        "Transaction No." := 'TXN001';
+        Amount := 0;
+        
+        // BC automatically includes primary key fields in error message
+        // Output: "Amount must not be 0 in Customer Transaction Customer No.='CUST001', Transaction Date='01/28/25', Transaction No.='TXN001'."
+        FieldError(Amount);
+        
+        // Even with custom message, record context is automatically included
+        // Output: "Amount cannot be zero for transactions in Customer Transaction Customer No.='CUST001', Transaction Date='01/28/25', Transaction No.='TXN001'."
+        FieldError(Amount, 'cannot be zero for transactions');
+    end;
+}
+```
+
+## Default vs Custom Message Comparison
+
+```al
+codeunit 50200 "Message Comparison Examples"
+{
+    procedure CompareDefaultAndCustomMessages()
+    var
+        SalesHeader: Record "Sales Header";
+        Customer: Record Customer;
+    begin
+        SalesHeader."Document Type" := SalesHeader."Document Type"::Order;
+        SalesHeader."No." := 'SO001';
+        SalesHeader."Sell-to Customer No." := '';
+        
+        // DEFAULT MESSAGE EXAMPLES
+        
+        // Empty field default message
+        // "Sell-to Customer No. must have a value in Sales Header Document Type='Order', No.='SO001'."
+        // SalesHeader.FieldError("Sell-to Customer No.");
+        
+        // Non-empty field default message  
+        SalesHeader."Sell-to Customer No." := 'INVALID';
+        // "Sell-to Customer No. INVALID is not valid in Sales Header Document Type='Order', No.='SO001'."
+        // SalesHeader.FieldError("Sell-to Customer No.");
+        
+        // CUSTOM MESSAGE EXAMPLES
+        
+        // Custom message with empty field
+        SalesHeader."Sell-to Customer No." := '';
+        // "Sell-to Customer No. is required for sales orders in Sales Header Document Type='Order', No.='SO001'."
+        // SalesHeader.FieldError("Sell-to Customer No.", 'is required for sales orders');
+        
+        // Custom message with non-empty field
+        SalesHeader."Sell-to Customer No." := 'BLOCKED';
+        // "Sell-to Customer No. customer is blocked in Sales Header Document Type='Order', No.='SO001'."
+        // SalesHeader.FieldError("Sell-to Customer No.", 'customer is blocked');
+        
+        // Complex custom message with context
+        if not Customer.Get(SalesHeader."Sell-to Customer No.") then
+            // "Sell-to Customer No. does not exist in customer master in Sales Header Document Type='Order', No.='SO001'."
+            SalesHeader.FieldError("Sell-to Customer No.", 'does not exist in customer master');
+    end;
+}
+```
+
+## Real-World Message Generation Scenarios
+
+```al
+codeunit 50201 "Real-World Validation Messages"
+{
+    // Scenario 1: Document Processing Validation
+    procedure ValidateDocumentForPosting(var SalesHeader: Record "Sales Header")
+    begin
+        // Required field validations - using default messages for consistency
+        if SalesHeader."Sell-to Customer No." = '' then
+            // "Sell-to Customer No. must have a value in Sales Header..."
+            SalesHeader.FieldError("Sell-to Customer No.");
+            
+        if SalesHeader."Posting Date" = 0D then  
+            // "Posting Date must be filled in in Sales Header..."
+            SalesHeader.FieldError("Posting Date");
+            
+        // Business rule validations - using custom messages for clarity
+        if SalesHeader."Posting Date" > WorkDate() + 30 then
+            // "Posting Date cannot be more than 30 days in future in Sales Header..."
+            SalesHeader.FieldError("Posting Date", 'cannot be more than 30 days in future');
+    end;
+    
+    // Scenario 2: Setup Validation with Detailed Messages
+    procedure ValidateCustomerSetup(var Customer: Record Customer)
+    var
+        PostCode: Record "Post Code";
+    begin
+        // Default message for required field
+        if Customer."No." = '' then
+            // "No. must have a value in Customer..."
+            Customer.FieldError("No.");
+            
+        // Custom message for business logic
+        if Customer."Credit Limit (LCY)" < 0 then
+            // "Credit Limit (LCY) cannot be negative in Customer No.='CUST001'."
+            Customer.FieldError("Credit Limit (LCY)", 'cannot be negative');
+            
+        // Validation with lookup and detailed custom message
+        if (Customer."Post Code" <> '') and not PostCode.Get(Customer."Post Code", Customer.City) then
+            // "Post Code is not valid for the specified city in Customer No.='CUST001'."
+            Customer.FieldError("Post Code", 'is not valid for the specified city');
+    end;
+    
+    // Scenario 3: Line Validation with Context
+    procedure ValidateSalesLine(var SalesLine: Record "Sales Line")
+    var
+        Item: Record Item;
+        AvailableInventory: Decimal;
+    begin
+        // Standard required field validation
+        if SalesLine."No." = '' then
+            // "No. must have a value in Sales Line Document Type='Order', Document No.='SO001', Line No.='10000'."
+            SalesLine.FieldError("No.");
+            
+        // Business logic with calculated values in message
+        if SalesLine.Type = SalesLine.Type::Item then begin
+            Item.Get(SalesLine."No.");
+            Item.CalcFields(Inventory);
+            AvailableInventory := Item.Inventory;
+            
+            if SalesLine.Quantity > AvailableInventory then
+                // "Quantity exceeds available inventory (50 units available) in Sales Line..."
+                SalesLine.FieldError(Quantity, 
+                    StrSubstNo('exceeds available inventory (%1 units available)', AvailableInventory));
+        end;
+        
+        // Price validation with business context
+        if SalesLine."Unit Price" <= 0 then
+            // "Unit Price must be positive for sales transactions in Sales Line..."
+            SalesLine.FieldError("Unit Price", 'must be positive for sales transactions');
+    end;
+}
+```
+
+## Message Formatting Rules and Patterns
+
+```al
+codeunit 50202 "Message Formatting Examples"
+{
+    procedure DemonstrateFormattingRules()
+    var
+        Item: Record Item;
+        PurchaseLine: Record "Purchase Line";
+    begin
+        Item."No." := 'ITEM001';
+        
+        // RULE 1: Default messages automatically include field value for non-empty fields
+        Item.Description := 'Invalid Description Content';
+        // "Description Invalid Description Content is not valid in Item No.='ITEM001'."
+        // Item.FieldError(Description);
+        
+        // RULE 2: Custom messages start with lowercase (BC convention)
+        // CORRECT:
+        // "Description must not contain special characters in Item No.='ITEM001'."
+        // Item.FieldError(Description, 'must not contain special characters');
+        
+        // INCORRECT (would still work but doesn't follow BC conventions):
+        // Item.FieldError(Description, 'Must not contain special characters');
+        
+        // RULE 3: Record context automatically appended using primary key
+        PurchaseLine."Document Type" := PurchaseLine."Document Type"::Order;
+        PurchaseLine."Document No." := 'PO001';
+        PurchaseLine."Line No." := 10000;
+        PurchaseLine.Quantity := -5;
+        
+        // "Quantity cannot be negative in Purchase Line Document Type='Order', Document No.='PO001', Line No.='10000'."
+        PurchaseLine.FieldError(Quantity, 'cannot be negative');
+        
+        // RULE 4: Multiple primary key fields included in order
+        // All key fields shown in error context for complete record identification
+    end;
+    
+    procedure DemonstrateMessageCustomization()
+    var
+        Customer: Record Customer;
+        CreditLimit: Decimal;
+    begin
+        Customer."No." := 'CUST001';
+        Customer."Credit Limit (LCY)" := 5000;
+        CreditLimit := 10000;  // Required limit for this customer
+        
+        // Pattern: Specific business context in custom messages
+        // "Credit Limit (LCY) insufficient for customer risk category (minimum 10000 required) in Customer No.='CUST001'."
+        Customer.FieldError("Credit Limit (LCY)", 
+            StrSubstNo('insufficient for customer risk category (minimum %1 required)', CreditLimit));
+        
+        // Pattern: Action guidance in custom messages
+        // "Credit Limit (LCY) requires manager approval for amounts above 50000 in Customer No.='CUST001'."
+        Customer.FieldError("Credit Limit (LCY)", 'requires manager approval for amounts above 50000');
+        
+        // Pattern: Reference to related data in custom messages  
+        // "Credit Limit (LCY) conflicts with existing payment terms (Net 60) in Customer No.='CUST001'."
+        Customer.FieldError("Credit Limit (LCY)", 'conflicts with existing payment terms (Net 60)');
+    end;
+}
+```
+
+## Advanced Default Message Scenarios
+
+```al
+table 50203 "Advanced Message Examples"
+{
+    fields
+    {
+        field(1; "Primary Key"; Code[20]) { }
+        field(10; "Boolean Field"; Boolean) { }
+        field(20; "DateTime Field"; DateTime) { }
+        field(30; "GUID Field"; Guid) { }
+        field(40; "Blob Field"; Blob) { }
+    }
+    
+    procedure DemonstrateAdvancedDefaultMessages()
+    begin
+        "Primary Key" := 'TEST001';
+        
+        // Boolean field default messages
+        "Boolean Field" := false;
+        // "Boolean Field No is not valid in Advanced Message Examples Primary Key='TEST001'."
+        // FieldError("Boolean Field");
+        
+        "Boolean Field" := true;  
+        // "Boolean Field Yes is not valid in Advanced Message Examples Primary Key='TEST001'."
+        // FieldError("Boolean Field");
+        
+        // DateTime field default messages
+        "DateTime Field" := 0DT;
+        // "DateTime Field must be filled in in Advanced Message Examples Primary Key='TEST001'."
+        // FieldError("DateTime Field");
+        
+        "DateTime Field" := CurrentDateTime;
+        // "DateTime Field 01/28/25 09:30:00 is not valid in Advanced Message Examples Primary Key='TEST001'."
+        // FieldError("DateTime Field");
+        
+        // GUID field default messages
+        Clear("GUID Field");
+        // "GUID Field must have a value in Advanced Message Examples Primary Key='TEST001'."
+        // FieldError("GUID Field");
+        
+        "GUID Field" := CreateGuid();
+        // "GUID Field {12345678-1234-1234-1234-123456789012} is not valid in Advanced Message Examples Primary Key='TEST001'."
+        // FieldError("GUID Field");
+    end;
+}

package/embedded-knowledge/domains/eva-errors/samples/fielderror-syntax.md

@@ -0,0 +1,256 @@
+# FieldError Method Syntax - AL Code Sample
+
+## Basic FieldError Syntax
+
+```al
+// Basic FieldError syntax with automatic message
+table 50100 "Sales Document"
+{
+    fields
+    {
+        field(1; "Document Type"; Enum "Sales Document Type") { }
+        field(2; "Document No."; Code[20]) { }
+        field(3; "Sell-to Customer No."; Code[20]) { }
+        field(10; "Currency Code"; Code[10]) { }
+        field(20; "Amount"; Decimal) { }
+    }
+    
+    trigger OnInsert()
+    begin
+        // Validate required fields before insert
+        ValidateRequiredFields();
+    end;
+    
+    local procedure ValidateRequiredFields()
+    begin
+        // FieldError assumes validation already failed - no testing performed
+        if "Sell-to Customer No." = '' then
+            FieldError("Sell-to Customer No.");  // Generates: "Sell-to Customer No. must have a value in Sales Document Document Type='Order', Document No.='SO001'."
+            
+        if Amount <= 0 then
+            FieldError(Amount);  // Generates: "Amount must not be 0 in Sales Document..."
+    end;
+}
+```
+
+## FieldError vs TestField Comparison
+
+```al
+codeunit 50100 "Validation Examples"
+{
+    procedure DemonstrateFieldErrorVsTestField()
+    var
+        SalesHeader: Record "Sales Header";
+        Customer: Record Customer;
+    begin
+        SalesHeader.Get(SalesHeader."Document Type"::Order, 'SO001');
+        
+        // TestField approach - tests condition AND throws error if failed
+        SalesHeader.TestField("Sell-to Customer No.");  // Tests if empty, then errors
+        SalesHeader.TestField(Amount);  // Tests if zero, then errors
+        
+        // FieldError approach - assumes you already validated the condition
+        if SalesHeader."Sell-to Customer No." = '' then
+            SalesHeader.FieldError("Sell-to Customer No.");  // Only errors, no testing
+            
+        if SalesHeader.Amount <= 0 then
+            SalesHeader.FieldError(Amount, 'must be positive');  // Custom message
+            
+        // Practical usage: FieldError for complex validation logic
+        if not Customer.Get(SalesHeader."Sell-to Customer No.") then
+            SalesHeader.FieldError("Sell-to Customer No.", 'customer does not exist');
+            
+        if Customer.Blocked <> Customer.Blocked::" " then
+            SalesHeader.FieldError("Sell-to Customer No.", 
+                StrSubstNo('customer is blocked (%1)', Customer.Blocked));
+    end;
+}
+```
+
+## Custom Message Examples
+
+```al
+table 50101 "Purchase Document"
+{
+    fields
+    {
+        field(1; "Document Type"; Enum "Purchase Document Type") { }
+        field(2; "Document No."; Code[20]) { }
+        field(3; "Buy-from Vendor No."; Code[20]) { }
+        field(10; "Expected Receipt Date"; Date) { }
+        field(20; "Amount Including VAT"; Decimal) { }
+    }
+    
+    procedure ValidateBusinessRules()
+    var
+        Vendor: Record Vendor;
+    begin
+        // Custom message examples - note lowercase first word convention
+        if "Expected Receipt Date" < WorkDate() then
+            FieldError("Expected Receipt Date", 'cannot be in the past');
+            
+        if "Amount Including VAT" > 10000 then
+            FieldError("Amount Including VAT", 'exceeds approval limit');
+            
+        // Complex validation with detailed custom message
+        if Vendor.Get("Buy-from Vendor No.") then begin
+            if Vendor.Blocked <> Vendor.Blocked::" " then
+                FieldError("Buy-from Vendor No.", 
+                    StrSubstNo('vendor is blocked for %1', Vendor.Blocked));
+                    
+            if (Vendor."Payment Terms Code" = '') and ("Amount Including VAT" > 1000) then
+                FieldError("Buy-from Vendor No.", 
+                    'requires payment terms for amounts over 1000');
+        end else
+            FieldError("Buy-from Vendor No.", 'vendor does not exist');
+    end;
+}
+```
+
+## Real-World Posting Codeunit Pattern
+
+```al
+codeunit 50102 "Sales Document Validation"
+{
+    // Pattern used in standard BC posting codeunits (12, 80, 90)
+    
+    procedure ValidateSalesDocument(var SalesHeader: Record "Sales Header")
+    begin
+        // Comprehensive validation before posting
+        with SalesHeader do begin
+            // Required field validation
+            if "Sell-to Customer No." = '' then
+                FieldError("Sell-to Customer No.");
+                
+            if "Document Date" = 0D then
+                FieldError("Document Date");
+                
+            // Business logic validation with custom messages
+            if "Posting Date" < "Document Date" then
+                FieldError("Posting Date", 'cannot be before document date');
+                
+            if Status <> Status::Released then
+                FieldError(Status, 'must be Released before posting');
+                
+            // Complex validation scenarios
+            ValidateCustomerCredit(SalesHeader);
+            ValidateDimensions(SalesHeader);
+        end;
+    end;
+    
+    local procedure ValidateCustomerCredit(var SalesHeader: Record "Sales Header")
+    var
+        Customer: Record Customer;
+        CustLedgerEntry: Record "Cust. Ledger Entry";
+        RemainingAmount: Decimal;
+    begin
+        Customer.Get(SalesHeader."Sell-to Customer No.");
+        
+        // Calculate customer's remaining credit
+        CustLedgerEntry.SetRange("Customer No.", Customer."No.");
+        CustLedgerEntry.SetRange(Open, true);
+        CustLedgerEntry.CalcSums("Remaining Amt. (LCY)");
+        RemainingAmount := CustLedgerEntry."Remaining Amt. (LCY)";
+        
+        // Validate credit limit
+        if (Customer."Credit Limit (LCY)" > 0) and 
+           (RemainingAmount + SalesHeader."Amount Including VAT" > Customer."Credit Limit (LCY)") then
+            SalesHeader.FieldError("Sell-to Customer No.", 
+                StrSubstNo('credit limit exceeded. Available credit: %1', 
+                          Customer."Credit Limit (LCY)" - RemainingAmount));
+    end;
+    
+    local procedure ValidateDimensions(var SalesHeader: Record "Sales Header")
+    var
+        DimMgt: Codeunit DimensionManagement;
+        DimSetID: Integer;
+    begin
+        DimSetID := SalesHeader."Dimension Set ID";
+        
+        // Validate required dimensions
+        if not DimMgt.CheckDimIDComb(DimSetID) then
+            SalesHeader.FieldError("Dimension Set ID", 'invalid dimension combination');
+            
+        // Validate dimension values against posting rules
+        if not DimMgt.CheckDimValuePosting(DimSetID, DATABASE::"Sales Header", SalesHeader."No.") then
+            SalesHeader.FieldError("Dimension Set ID", 'dimension values not allowed for posting');
+    end;
+}
+```
+
+## Advanced FieldError Patterns
+
+```al
+codeunit 50103 "Advanced Validation Patterns"
+{
+    // Pattern: Conditional validation with detailed context
+    procedure ValidateItemAvailability(var SalesLine: Record "Sales Line")
+    var
+        Item: Record Item;
+        AvailableQty: Decimal;
+    begin
+        if SalesLine.Type <> SalesLine.Type::Item then
+            exit;  // Only validate items
+            
+        Item.Get(SalesLine."No.");
+        Item.CalcFields(Inventory, "Reserved Qty. on Inventory");
+        AvailableQty := Item.Inventory - Item."Reserved Qty. on Inventory";
+        
+        if SalesLine.Quantity > AvailableQty then
+            SalesLine.FieldError(Quantity, 
+                StrSubstNo('exceeds available inventory (%1 available)', AvailableQty));
+    end;
+    
+    // Pattern: Multi-field validation with specific field error
+    procedure ValidatePriceAndDiscount(var SalesLine: Record "Sales Line")
+    begin
+        // Validate that discount doesn't exceed unit price
+        if (SalesLine."Unit Price" > 0) and 
+           (SalesLine."Line Discount Amount" > SalesLine."Unit Price" * SalesLine.Quantity) then
+            SalesLine.FieldError("Line Discount Amount", 
+                'cannot exceed line amount');
+                
+        // Validate price against minimum price rules
+        if SalesLine."Unit Price" < GetMinimumPrice(SalesLine) then
+            SalesLine.FieldError("Unit Price", 
+                StrSubstNo('cannot be below minimum price (%1)', GetMinimumPrice(SalesLine)));
+    end;
+    
+    local procedure GetMinimumPrice(SalesLine: Record "Sales Line"): Decimal
+    var
+        Item: Record Item;
+    begin
+        if Item.Get(SalesLine."No.") then
+            exit(Item."Unit Cost" * 1.1)  // 10% markup minimum
+        else
+            exit(0);
+    end;
+}
+```
+
+## Error Context and Message Output Examples
+
+```al
+// When this validation fails:
+procedure ExampleValidationScenarios()
+var
+    SalesHeader: Record "Sales Header";
+begin
+    SalesHeader."Document Type" := SalesHeader."Document Type"::Order;
+    SalesHeader."No." := 'SO001';
+    SalesHeader."Sell-to Customer No." := '';  // Empty value
+    
+    // This will generate message:
+    // "Sell-to Customer No. must have a value in Sales Header Document Type='Order', No.='SO001'."
+    SalesHeader.FieldError("Sell-to Customer No.");
+    
+    // With custom message:
+    // "Sell-to Customer No. is required for orders in Sales Header Document Type='Order', No.='SO001'."
+    SalesHeader.FieldError("Sell-to Customer No.", 'is required for orders');
+    
+    // For non-empty field with custom message:
+    SalesHeader."Sell-to Customer No." := 'INVALID';
+    // "Sell-to Customer No. customer does not exist in Sales Header Document Type='Order', No.='SO001'."
+    SalesHeader.FieldError("Sell-to Customer No.", 'customer does not exist');
+end;
+```