Skip to main content

🚀 How to Dynamically Copy Matching Fields Between Tables in X++ using DictTable

 In Microsoft Dynamics AX (X++), there are many scenarios where you need to duplicate data from one table to another—especially during custom import, duplication, or versioning processes. Traditionally, this is done by manually assigning each field: targetTable.Field1 = sourceTable.Field1; targetTable.Field2 = sourceTable.Field2; ... But what if the tables have many fields ? Or maybe you’re dealing with multiple similar table pairs? That’s where the powerful DictTable class comes in. Let’s walk through how to use it to copy matching fields dynamically between two tables. 💡 Use Case: Copy Customer Templates Let’s assume you have these tables: CustTemplateHeader – stores predefined customer templates. CustTemplateHeaderHistory – a historical copy of templates for versioning. You want to copy records from CustTemplateHeader to CustTemplateHeaderHistory , but only for fields that exist in both tables. ✅ The Solution Using DictTable SalesHeaderTemplate   ...

🚀 How to Dynamically Copy Matching Fields Between Tables in X++ using DictTable

 In Microsoft Dynamics AX (X++), there are many scenarios where you need to duplicate data from one table to another—especially during custom import, duplication, or versioning processes.

Traditionally, this is done by manually assigning each field:

targetTable.Field1 = sourceTable.Field1;

targetTable.Field2 = sourceTable.Field2;

...

But what if the tables have many fields? Or maybe you’re dealing with multiple similar table pairs?

That’s where the powerful DictTable class comes in. Let’s walk through how to use it to copy matching fields dynamically between two tables.


💡 Use Case: Copy Customer Templates

Let’s assume you have these tables:

  • CustTemplateHeader – stores predefined customer templates.

  • CustTemplateHeaderHistory – a historical copy of templates for versioning.

You want to copy records from CustTemplateHeader to CustTemplateHeaderHistory, but only for fields that exist in both tables.


✅ The Solution Using DictTable

SalesHeaderTemplate   salesHeader;
SalesHeaderHistory    salesHeaderHistory;
SalesTemplateGroup    templateGroup;
SalesTemplateGroup    templateGroup_TDS;

while select salesHeader
    where salesHeader.TemplateGroupId == templateGroup.RecId
{
    salesHeaderHistory.clear();

    DictTable dictFrom = new DictTable(tableNum(SalesHeaderTemplate));
    DictTable dictTo   = new DictTable(tableNum(SalesHeaderHistory));
    int fieldId;

    for (fieldId = dictFrom.fieldNext(0); fieldId; fieldId = dictFrom.fieldNext(fieldId))
    {
        str fieldName = dictFrom.fieldName(fieldId);
        FieldId toFieldId = dictTo.fieldName2Id(fieldName);

        if (toFieldId)
        {
            anyType value = salesHeader.(fieldId);
            salesHeaderHistory.(toFieldId) = value;
        }
    }

    salesHeaderHistory.RecId = 0;
    salesHeaderHistory.TemplateGroupId = templateGroup_TDS.RecId;
    salesHeaderHistory.insert();
}

🧠 Why This Approach Rocks

  • ✅ No need to hardcode fields

  • ✅ Automatically adapts to schema changes

  • ✅ Great for data versioning or duplication logic

  • ✅ Scales across multiple similar table pairs

⚠️ Points to Remember

  • This technique only works for matching field names and compatible data types.

  • You may want to exclude system fields like RecId, CreatedDateTime, etc.

  • Set RecId = 0 to prevent conflicts and let the system assign a new one.

🔁 Bonus Tip: Turn It Into a Reusable Function

You could even encapsulate this logic into a utility method or static class so it can be reused across your project.


🔧 Reusable Utility Class: TableCopyHelper

📁 Step 1: Create a new class

Create a new class in AOT or through Visual Studio, name it something like: TableCopyHelper.

public class TableCopyHelper

{

    /// <summary>

    /// Copies matching fields from one table buffer to another.

    /// Skips the RecId field to avoid duplicate key issues.

    /// </summary>

    /// <param name="source">Source table buffer</param>

    /// <param name="target">Target table buffer</param>

    /// <param name="preserveRecId">If false, clears the RecId to force insert as a new    record</param>

    public static void copyMatchingFields(Common source, Common target, boolean preserveRecId = false)

    {

        DictTable dictFrom = new DictTable(source.TableId);

        DictTable dictTo   = new DictTable(target.TableId);

        FieldId   fieldId;

        FieldId   recIdFieldId = fieldNum(Common, RecId);


        for (fieldId = dictFrom.fieldNext(0); fieldId != 0; fieldId = dictFrom.fieldNext(fieldId))

        {

            str fieldName = dictFrom.fieldName(fieldId);

            FieldId toFieldId = dictTo.fieldName2Id(fieldName);


            // Skip if no matching field in target

            if (toFieldId == 0)

                continue;


            // Skip RecId field explicitly

            if (toFieldId == recIdFieldId)

                continue;


            anyType value = source.(fieldId);

            target.(toFieldId) = value;

        }


        if (!preserveRecId)

        {

            target.(recIdFieldId) = 0;

        }

    }

}



 Step 2: Use It in Your Code

Example: Copy from SalesHeaderTemplate to SalesHeaderHistory


SalesHeaderTemplate salesHeader;
SalesHeaderHistory  salesHeaderHistory;

while select salesHeader
    where salesHeader.TemplateGroupId == templateGroup.RecId
{
    salesHeaderHistory.clear();

    TableCopyHelper::copyMatchingFields(salesHeader, salesHeaderHistory);

    salesHeaderHistory.TemplateGroupId = templateGroup_TDS.RecId;
    salesHeaderHistory.insert();
}

🚀 Benefits

  • ✅ Reusable for any pair of similar tables.

  • 🛡 Prevents accidental copying of RecId, timestamps, or AutoIdentification fields.

  • 🧼 Cleaner calling code with less repetitive logic.

  • 📈 Easier maintenance — any future logic updates are made in one place.


Comments

Popular posts from this blog

How to Refresh a Form or Data Source in D365FO Using X++

  Introduction In Microsoft Dynamics 365 Finance & Operations (D365FO), refreshing the form after an action (like inserting, updating, or deleting a record) is essential for keeping the UI updated with the latest data. In this blog, we’ll explore two ways to refresh the form in X++: ✅ Refreshing the entire form using taskRefresh ✅ Refreshing a specific data source using research Let's dive into the best practices for implementing these refresh methods! 🔄 Refreshing the Entire Form If you need to refresh the whole form , use the taskRefresh method. This method is useful when multiple data sources are involved, and you want to reload everything. 📌 X++ Code for Full Form Refresh public void refreshForm() {     // Get the current form instance     FormRun formRun = this.formRun();     // Check if formRun is valid before refreshing     if (formRun)     {         info("Refreshing the form...");     ...

How to Open a Form with Filtered Data Using a Button in X++ – A Step-by-Step Guide

 In Dynamics 365 for Finance and Operations (D365FO), a common requirement is to open a form dynamically from another form and pass filtered data based on a specific condition. This functionality can enhance user experience by allowing them to interact with multiple forms seamlessly, while keeping the data relevant and focused. In this blog, we’ll explore how to implement such a solution using X++, where a user clicks a button on Form 1 (such as a list of sales orders), and based on a selected record, Form 2 (such as invoice details) opens with only the relevant filtered data. Scenario Overview Let’s assume the following scenario: Form 1 : Displays a list of sales orders, and each order has an OrderID , CustomerID , and OrderAmount . Form 2 : Displays details of invoices (from the InvoiceDetails table) that are linked to the selected OrderID from Form 1 . The goal is to click a button on Form 1 , pass the OrderID to Form 2 , and display only the relevant invoice records relate...

Sorting Data in X++ (D365FO) Grids Using Form Data Source Events

  Introduction : In Dynamics 365 Finance and Operations, form grids often display data retrieved from a table or query. However, the default sorting applied may not always align with business requirements. Customizing sorting behavior at runtime ensures that the grid data is presented in a meaningful order for users. This blog post demonstrates how to use the Initialized event of a form data source to apply custom sorting to a grid. We will sort the grid rows based on a specific field ( DisplayOrder ) in ascending order. Understanding the Code : Here’s the complete code snippet: --------------------------------------------------------------------------------------------------------------- [FormDataSourceEventHandler(formDataSourceStr(MyFormDataSource,  MyTable), FormDataSourceEventType::Initialized)] public static void MyFormDataSource_OnInitialized(FormDataSource sender, FormDataSourceEventArgs e) {     // It will clear if any other sorting is applied on the grid ...