Modifying a DMF data entity query dynamically, from another query, for filteration in D365FO

 


Problem statement 

Have you ever came across a situation where you needed to run your data entity through a batch, and in your batch you have a very complex composite query (where the query ranges could be anything -- the user can keep adding new ranges to the query) and you need pass on the query range values to your data entity query. I bet you must have faced this: say, your data contract is having an AOT query called PurchContractQry where you have PurchTable, Purchline, InventDim, PurchParmLine and a litter of related tables. You have an entity that does have a different query (as you know Data entities store queries as packed data in DMFDefinitionGroupEntity)-- how could you possibly make the ranges flow to your Entity, then?

The following blog explains the same.

As an example: we have created a Data entity called D365DataEntityPurchExport, which exports records based on the ranges supplied in a query coming from a contract Class, called PurchContractQry. We need to get the ranges which user is selecting/enetering and pass them on to the entity and run it accordingly. 

Step 1: in your service class, you can get query from dataContract:

_contract.getQuery();

You can also get the query of your entity by simply saying:

Query    purchEnttQuery = new Query(DMFUtil::getDefaultQueryForEntityV3(_entityName));

Where _entityName is the name of the Entity you are using (in our case, it's DMFDefinitionGroupEntity).

Hence you can create a new query for your entity and get the contents of your query like this:

purchEnttQuery = this.addAdditionalRanges(_contract.getQuery(), purchEnttQuery ) ;

We are going to create a new method to get the ranges from our contract class, like this:

private Query addAdditionalRanges(Query _contractQry, Query    _entityQuery)

    {

        Counter totalDSources = _contractQry.dataSourceCount();

        QueryBuildDataSource qbdsPurch = _entityQuery.dataSourceTable(tableNum(D365DataEntityPurchExport));

        for(int ds =1; ds<= totalDSources ; ds++)

        {

            QueryBuildDataSource    qbds = _contractQry.dataSourceNo(ds);

            Counter totalRanges = qbds.rangeCount();

            for(int r =1; r<= totalRanges; r++)

            {

                QueryBuildRange qbr =  qbds.range(r);

                SysQuery::findOrCreateRange(qbdsPurch , fieldName2Id(tableNum(D365DataEntityPurchExport), qbr.fieldName())).value(qbr.value());

            }

        }

        return _entityQuery;

    }

Where dynamically your are setting the name of the query ranges in your data entity, by getting the values from your contract class Query.

Step2: We can execute an entity like this very easily:

            DMFEntityExporter exporter = new DMFEntityExporter();

            SharedServiceUnitFileID fileId = exporter.exportToFile(

                                           entityName,

                                           _dataContract.parmDefinitionGroupName(),

                                           '',

                                           DXCMVTExportMacros::csvFile,

                                           #FieldGroupName_AllFields,

                                           conNull(),                                           

                                           curExt(),

                                           null,               

                                           true,                

                                           false

                                           );

We can add this in the process method of our Service class. But the problem with this method is: it doesn't update the query you want it to execute -- it will make the entity to execute default version of the query. 

Why?

Well, look at the following code inside the above method:



Which means it will update the query of the entity, only when the definition group provided is blank. But what if, your definiton group is not blank -- purposely you want to execute your entity against any defintion group? 

Step 3: For this -- you can force the Definiton group entity to accept the packed query like this, before hand:

DMFDefinitionGroupEntity definitionGroupEntity = DMFDefinitionGroupEntity::find(_contract.parmDefinitionGroupName(), 

                                                                                        _entityName, 

                                                                                        true);

        if (definitionGroupEntity)

        {

            ttsbegin;

            definitionGroupEntity.QueryData = _query.pack();

            definitionGroupEntity.update();

            ttsCommit;

        }

As a result, the defintion group will be updated with the query value and be assigned to the entity:



 


Comments

Post a Comment

Popular posts from this blog

Make your menu items visible on main menu, conditionally,, using this cool feature of D365FO

Image
  Wassup guys? I am sure you must have encountered this situation where you needed to display your menuItems, on main menu, based on some condition, haven't you? This was only possible by using config keys and flights. Things get a bit tricky,  when suppose you have a requirement like this: you need to make it dynamic, by introducing a toggle switch on a field on a paremeter form.  Suppose on Accounts Receivables Parameters >> You have a field called ' Show US customer '. You have a requirement that says when you turn on this toggle, then only the menuItem ' Input SSN details ', under AR module. This is now highly acheivable by leveraging subscription to 'SysMenuNavigationObjectFactory' class, simply by saying a. Create a new class USMenuItemsVisibilityManager b. Copy the following method, with proper documentation (don't change signature/anything else) [SubscribesTo(classstr(SysMenuNavigationObjectFactory), staticdelegatestr(SysMenuNavigationObjec...
Read more

X++ : mistakes which developers commit the most

Image
   The most important thing is to remember where and when to write the code. a. Developers have an inherent habit of writing erratic select statements: select * from custTable where custTable.AccountNum == <SomeValue> Where in essence we need to make use of optimized choice of fields in the select statement. b. Making use of 'continue' keywords: While select custTrans where <someConditions> { if (cusTTrans.CustGroup != mappingTable.CustGroup) { continue; } } 'Continue' statements are precisely a very unhygienic way of designing your code. The above statement could have been easily ornamented by using exists/not exists joins. Using Continue statements would eventually result in a high performance impact. Also select statements should be made punctuated with a 'firstonly' clause -- just not from best practise standpoint, but also from performance considerations. c. Writing nested loops: This is a common mistake that perha...
Read more

Are you still using macros? Be sure you read this.

Image
  You still use a lot of macros in your code, don't you? Of course you should: Macros, as per Microsoft,  are p recompiler directives are processed before the code is compiled. The directives declare and handle macros and their values. The directives are removed by the precompiler so that the X++ compiler never encounters them. The X++ compiler only sees the sequence of characters written into the X++ code by the directives. However macros, are not quite recomended by Microsoft. They are slow, they can be subsequently deorectaed at any later time.  The Macros are  actually  a type of classes, only that they are not instantiated and not need be defined as classes. Hence runtime garbage collection could be a huge issue, consquently (a class when gets out of scope, gets garbage-collected owing to the destructor classes of DOT net instrumentation classes). Summing up, macrros are a bit old way of writing code. Use static classes instead. public static class MyIdenti...
Read more