Dynamics 365 Customization: Prepopulating Child Activity Forms Using JavaScript

 

Scenario

In our scenario, users need to send emails related to specific receipt records. Automating the process to open an email form prepopulated with relevant data from the tri_receipt form saves time and minimizes data entry errors.

Correct Usage of Dynamics 365 API to Open and Populate Forms

Below, we provide a JavaScript function that demonstrates how to open an email form and populate it with data from the tri_receipt entity. We'll address common misunderstandings, such as the misuse of the createFromEntity property, which does not support setting the Regarding field directly.

Retrieve Required Data

Gather all necessary data from the parent form to be used in populating the email form.

var formContext = primaryControl; // Assuming primaryControl is passed to the function

var relatedEntity = formContext.getAttribute("tri_relatedentitylookup");

if (relatedEntity && relatedEntity.getValue()) {

    var entityId = relatedEntity.getValue()[0].id;

    var entityName = relatedEntity.getValue()[0].entityType;

}

Configure and Open the Email Form

Here, we use the Xrm.Navigation.openForm method correctly by setting the email form parameters without relying on createFromEntity for the Regarding field.

var entityFormOptions = {

    entityName: "email",

    openInNewWindow: true

};

var parameters = {

    "regardingobjectid": formContext.data.entity.getId(), // ID of the current receipt record

    "regardingobjectidname": formContext.getAttribute("tri_receiptnumber").getValue(), // Name or number of the receipt

    "regardingobjectidtype": formContext.data.entity.getEntityName(), // Entity name of the receipt

    "to": [{

        id: entityId, // ID from the related entity lookup

        entityType: entityName, // Type of the related entity

        name: "Associated Record" // General name for the recipient

    }]

};

Xrm.Navigation.openForm(entityFormOptions, parameters).then(

    function (success) {

        console.log("Email form opened successfully.");

    },

    function (error) {

        console.log("Error opening form:", error);

    }

);

Explanation of the Code

• Data Retrieval: The script dynamically fetches necessary data from the parent form, including details from a related entity lookup.
• Form Population: Parameters are meticulously set to prepopulate the email form, ensuring fields like "Regarding" and "To" are correctly filled with relevant data. Note that createFromEntity is not used for setting the Regarding field as it does not support direct linkage; parameters must be set manually.
• Opening the Form: Configured to open in a new window, this enhances user experience by keeping the parent record accessible.

Conclusion

This approach to prepopulating child activity forms in Dynamics 365 significantly enhances operational efficiency and ensures data accuracy across related records. The detailed explanation provided emphasizes correct API usage and dispels common misconceptions, ensuring developers can implement similar functionalities effectively.