How to : generate an external trigger after the completion of BYODW export using the business event in Dynamics 365 Finance and Operations

In BI projects for Dynamics 365 Finance and Operations, the most common requirement is the trigger when the BYODW batch job completes the data population. Usually, to start another process on exported data.

After some research, we found the best solution for this is to create a custom business event. Business events in Dynamics 365 are robust and flexible enough to be used for many different scenarios.

To understand the Business events framework, please go through https://docs.microsoft.com/en-us/dynamics365/fin-ops-core/dev-itpro/business-events/home-page

The business events framework provides different endpoints for the consumption of the trigger.


  • Azure Service Bus Queue
  • Azure Service Bus Topic
  • Azure Event Grid
  • Azure Event Hub
  • HTTPS
  • Microsoft Power Automate

Below is the custom code required for the generation of events.

We need 4 classes: 
1. BYODWBusinessEvent 
2. BYODWBusinessEventContract
3. DMFPackageExporter_Extension (This is for manual execution)
4. DMFExportEntityWriter_Extension (This is for a batch execution)

1. BYODWBusinessEvent class extends the BusinessEventsBase class.

/// <summary>
/// BYODW business event.
/// </summary>
[BusinessEvents(classStr(BYODWBusinessEventContract), 'BYODW Business Event', 'BYODW Business Event', ModuleAxapta::DIXF)]
public final class BYODWBusinessEvent extends BusinessEventsBase
{
    private DMFExecution dmfExecution;

    private DMFExecution parmDMFExecution(DMFExecution _dmfExecution = dmfExecution)
    {
        dmfExecution = _dmfExecution;

        return dmfExecution;
    }

    /// <summary>
    /// Creates a <c>BYODWBusinessEvent</c> from a <c>DMFExecution</c> record.
    /// </summary>
    /// <param name = "_transferTable"> A <c>DMFExecution</c> record.</param>
    /// <returns>A <c>BYODWBusinessEvent</c>.</returns>
    public static BYODWBusinessEvent newFromDMFExecution(DMFExecution _dmfExecution)
    {
        BYODWBusinessEvent businessEvent = new BYODWBusinessEvent();
        businessEvent.parmDMFExecution(_dmfExecution);

        return businessEvent;
    }

    private void new()
    {
    }

    [Wrappable(true), Replaceable(true)]
    public BusinessEventsContract buildContract()
    {
        return BYODWBusinessEventContract::newFromDMFExecution(dmfExecution);
    }

}

2. Contract class for BYODWBusinessEvent extends the BusinessEventsContract class.

/// <summary>
/// The data contract for a <c>BYODWBusinessEventContract</c>.
/// </summary>
[DataContract]
public final class BYODWBusinessEventContract extends BusinessEventsContract
{
    private DMFExecutionSummaryStatus   dmfExecutionSummaryStatus;
    private EndDateTime                 endDateTime;
    private DMFExecutionId              dmfExecutionId;
    private DMFDefinitionGroupName      dmfDefinitionGroupName;

    /// <summary>
    /// Creates a <c>BYODWBusinessEventContract</c> from a <c>InventTransferTable</c> record.
    /// </summary>
    /// <param name = "_transferOrder">DMFExecutionId</param>
    /// <returns>A <c>BYODWBusinessEventContract</c>.</returns>
    public static BYODWBusinessEventContract newFromDMFExecution(DMFExecution _dmfExecution) 
    {
        var contract = new BYODWBusinessEventContract();
        contract.initialize(_dmfExecution);
        return contract;
    }

    private void initialize(DMFExecution _dmfExecution)
    {
        dmfExecutionSummaryStatus   = _dmfExecution.GetExecutionSummaryStatus();
        endDateTime                 = _dmfExecution.getExecutionEndDateTime();
        dmfExecutionId              = _dmfExecution.ExecutionId;
        dmfDefinitionGroupName      = _dmfExecution.DefinitionGroup;
    }

    [DataMember('DMFExecutionSummaryStatus'), BusinessEventsDataMember("DMFExecutionSummaryStatus")] 
    public DMFExecutionSummaryStatus parmDMFExecutionSummaryStatus(DMFExecutionSummaryStatus _dmfExecutionSummaryStatus = dmfExecutionSummaryStatus)
    {
        dmfExecutionSummaryStatus = _dmfExecutionSummaryStatus;

        return dmfExecutionSummaryStatus;
    }

    [DataMember('EndDateTime'), BusinessEventsDataMember("EndDateTime")]
    public EndDateTime parmEndDateTime(EndDateTime _endDateTime = endDateTime)
    {
        endDateTime = _endDateTime;

        return endDateTime;
    }

    [DataMember('DMFExecutionId'), BusinessEventsDataMember("DMFExecutionId")]
    public DMFExecutionId parmDMFExecutionId(DMFExecutionId _dmfExecutionId = dmfExecutionId)
    {
        dmfExecutionId = _dmfExecutionId;

        return dmfExecutionId;
    }

    [DataMember('DMFDefinitionGroupName'), BusinessEventsDataMember("DMFDefinitionGroupName")]
    public DMFDefinitionGroupName parmDMFDefinitionGroupName(DMFDefinitionGroupName _dmfDefinitionGroupName = dmfDefinitionGroupName)
    {
        dmfDefinitionGroupName = _dmfDefinitionGroupName;

        return dmfDefinitionGroupName;
    }

}

3. DMFPackageExporter_Extension which generates the trigger in manual execution

/// <summary>
/// Extension class for DMFPackageExporter
/// </summary>
[ExtensionOf(classstr(DMFPackageExporter))]
final class DMFPackageExporter_Extension
{
    /// <summary>
    /// Export a package for the specified definition group
    /// </summary>
    /// <param name = "packageName">Name of package to generate</param>
    /// <param name = "packageUrl">Url to upload the package to</param>
    /// <param name = "definitionGroupId">Definition group name</param>
    /// <param name = "executionId">Job id</param>
    /// <param name = "reExecute">Indicate if data from target to staging is to be moved</param>
    /// <param name = "legalEntityId">Legal entity context for the operation</param>
    /// <param name = "createPackage">Specify if only the files are needed or if the package is also to be generated</param>
    /// <param name="entitySyncVersion">List of entity and the associated sync version range. This is only required for rerun scenario for older executions. Not enabled for AX UI</param>
    /// <param name="previewCount">Preview count for export.</param>
    /// <param name="_messageId">Message ID.</param>
    /// <returns>ExecutionId for preoject execution.</returns>
    public DMFExecutionId exportToPackageV2(DMFPackageName packageName, SharedServiceUnitURL packageUrl, 
        DMFDefinitionGroupName definitionGroupId, DMFExecutionId executionId, boolean reExecute, 
        DataAreaName legalEntityId, boolean createPackage, Map entitySyncVersion, int previewCount, str _messageId)

    {
        DMFExecutionId localDMFExecutionId = next exportToPackageV2(packageName,packageUrl, definitionGroupId, executionId, reExecute,
            legalEntityId, createPackage, entitySyncVersion, previewCount, _messageId);
        BYODWBusinessEvent businessEvent;
        DMFExecution    localDMFExecution = DMFExecution::find(localDMFExecutionId);
        DMFDefinitionGroup  dmfDefinitionGroup = DMFDefinitionGroup::find(localDMFExecution.DefinitionGroup);
        DMFExecutionSummaryStatus DMFExecutionSummaryStatus = localDMFExecution.GetExecutionSummaryStatus();
    
        switch(DMFExecutionSummaryStatus)
        {
            case DMFExecutionSummaryStatus::Succeeded:
                businessEvent= BYODWBusinessEvent::newFromDMFExecution(localDMFExecution); 
                if(businessEvent && dmfDefinitionGroup.BusinessEventSucess)
                {
                    businessEvent.send();
                }
                break;
            case DMFExecutionSummaryStatus::PartiallySucceeded:
                businessEvent = BYODWBusinessEvent::newFromDMFExecution(localDMFExecution);
                if(businessEvent && dmfDefinitionGroup.BusinessEventPartialSucess)
                {
                    businessEvent.send();
                }
                break;
            case DMFExecutionSummaryStatus::Failed:
                businessEvent = BYODWBusinessEvent::newFromDMFExecution(localDMFExecution);
                if(businessEvent && dmfDefinitionGroup.BusinessEventFail)
                {
                    businessEvent.send();
                }
                break;

        }
        return localDMFExecutionId;
    }

}



4. DMFExportEntityWriter_Extension which generates the trigger in batch execution

/// <summary>
/// Extension class for DMFExportEntityWriter for the business event trigger when export is happening in Batch mode
/// </summary>
[ExtensionOf(classstr(DMFExportEntityWriter))]
final class PgonDMFExportEntityWriter_Extension
{
     public void run()
    {
        next run();
        PgonBYODWBusinessEvent businessEvent;
        DMFExecution    localDMFExecution = DMFExecution::find(this.parmExecutionId());
        DMFDefinitionGroup  dmfDefinitionGroup = DMFDefinitionGroup::find(localDMFExecution.DefinitionGroup);
        DMFExecutionSummaryStatus DMFExecutionSummaryStatus = localDMFExecution.GetExecutionSummaryStatus();
 
        switch(DMFExecutionSummaryStatus)
        {
            case DMFExecutionSummaryStatus::Succeeded:
                businessEvent= PgonBYODWBusinessEvent::newFromDMFExecution(localDMFExecution);
                if(businessEvent && dmfDefinitionGroup.PgonBusinessEventSucess)
                {
                    businessEvent.send();
                }
                break;
            case DMFExecutionSummaryStatus::PartiallySucceeded:
                businessEvent = PgonBYODWBusinessEvent::newFromDMFExecution(localDMFExecution);
                if(businessEvent && dmfDefinitionGroup.PgonBusinessEventPartialSucess)
                {
                    businessEvent.send();
                }
                break;
            case DMFExecutionSummaryStatus::Failed:
                businessEvent = PgonBYODWBusinessEvent::newFromDMFExecution(localDMFExecution);
                if(businessEvent && dmfDefinitionGroup.PgonBusinessEventFail)
                {
                    businessEvent.send();
                }
                break;

        }

    }


}

We also added the parameters in data projects as follows:


Now we just need to configure the business events in System administrator -> Setup -> Business events - > Business events catalog

Business event catalog :


Below is the contents of generated events from Azure Service Bus.


We had configured the Azure Service Bus to capture the event and trigger 3rd party code to process the data further. We can configure Microsoft Power automate (FLOW) to process the event as well.

  

Comments

Post a Comment

Popular posts from this blog

How to : get the Deep URL for a particular form with filter in Dynamics 365 Finance and Operations

Image
 If you are a developer and need to generate the Deep-link then you can follow the code mentioned in MS docs at https://docs.microsoft.com/en-us/dynamics365/fin-ops-core/dev-itpro/user-interface/create-deep-links But if you want to share a few URLs with filters already applied to other users then you can use the feature of  'Get a link' in D365FO. Suppose I want to share the list of all sales orders for customer 'US-001'. Go to Account Receivable -> Orders -> All sales orders  Filter by customer account 'US-001' Then in the navigation ribbon, go to Options and click on 'Get a link'   Copy all and paste the URL into new browser window. You will only see the sales orders for US-001. If you want to generate lot of deep URLs then you can also enable  'Automatically update query parameter' Once you enable this, as soon as you apply a filter on forms URL will be updated with the query parameters like below: You can copy and share the link directl
Read more

How to: Solve issue when DVT script for service model MRApplicationService on machine XXX failed

Image
I was running binary update from LCS when my deployment failed. The step which failed had a description " DVT script for service model MRApplicationService on machine XXX failed" When I checked the log, It was showing "Financial Reporting DVTs ran with 2 failures". To resolve it, I just reset the DataMart and resumed the deployment from LCS which then completed successfully. Those who do not know how to reset DataMart, We have to run the following command in Windows PowerShell. cd J:\MROneBox\MRInstallDirectory\Server\MRDeploy Import-module .\MRDeploy.psd1 Reset-DatamartIntegration -Reason OTHER -ReasonDetail "DB Refresh" 1st line is to change the directory where MRDeploy.psd1 script exists. depending on the environment typologies  some other common places where it can be found is G:\MRApplicationService\MRInstallDirectory\Server\MRDeploy K:\MROneBox\MRInstallDirectory\Server\MRDeploy 2nd line is to import the Script 3rd line is for
Read more

How to: Display individual financial dimension value in grid control

Image
To display inventory dimensions in the grid we have control of dimension display which can be set up as per the requirement.  But there is no control in D365FO to display financial dimensions in grid control.  There are 2 ways it can be done.  1. Create display methods to display particular financial dimensions like the below method which displays division. I have seen many examples on the internet using multiple find methods but I prefer it by doing one query with joins to improve performance issues. public display DimensionValue getDimensionDivision() {         DimensionAttributeValueSetItem  dimensionAttributeValueSetItem;         DimensionAttributeValue                dimensionAttributeValue;         DimensionAttribute                        dimensionAttribute;               select DisplayValue from dimensionAttributeValueSetItem             join dimensionAttributeValue             join dimensionAttribute             where dimensionAttributeValueSetItem.DimensionAttributeV
Read more