Microsoft Dynamics AX FAQ

Microsoft Dynamics AX FAQ

How to find an AOT object by its property?

X++Posted by Studio Erudit team 2008-11-06 23:28

The X++ job below shows how to find all tables in the AOT where the SaveDataPerCompany property is set to No.

static void se_findAOTObjectByProperty(Args _args)
{
#AOT

TreeNode treeNodeTables = TreeNode::findNode(#TablesPath);
TreeNode treeNode;
str strPropertyName = 'SaveDataPerCompany';
str strPropertyValue = 'No';
;

// first table
treeNode = treeNodeTables.AOTfirstChild();

while (treeNode != null)
{
if (treeNode.AOTgetProperty(strPropertyName)== strPropertyValue)
{
info(treeNode.AOTname());
}

// next table
treeNode = treeNode.AOTnextSibling();
}
}

  • Comments(3)//daxfaq.studioerudit.com/#post9

How to get the top most layer of an AOT object?

X++Posted by Studio Erudit team 2008-10-19 16:10

The X++ job below shows the top most layer of an AOT object (in this example it is the Address table).

static void se_topLayer(Args _args)
{
#AOT

int i;
str strAOTObjectPath = #TablesPath + '\\' + tablestr(Address);
TreeNode treeNode = TreeNode::findNode(strAOTObjectPath);
UtilEntryLevel topLayer;
;

for (i = 0; i <= 0xf; i++)
{
if (bitTest(treeNode.applObjectLayerMask(), 1 << i))
{
topLayer = max(topLayer, i);
}
}

print topLayer;

pause;
}

  • Comments(2)//daxfaq.studioerudit.com/#post8

How to override the event methods on dialog controls?

X++Posted by Studio Erudit team 2008-04-22 22:31

Overriding the event methods (e.g. modify, validate, selectionChange) on dialog controls is not as straight forward as it is on form controls, but the good news is that it is possible!

In order to override the event methods on dialog controls, the following needs to be done (for simplicity we assume that your class extends RunBase class) :

1) The method dialogPostRun() should be overridden and following two lines are added after the super() call:

_dialog.dialogForm().formRun().controlMethodOverload(true);

_dialog.dialogForm().formRun().controlMethodOverloadObject(this);


This will allow to call the event methods of your class.


2) The actual event methods should be added.

The format of the event method name is as follows: fld<ID>_1_<event name>


Please see the example below.

This method is called whenever a value of the dialog control with ID 900 is modified. In our case it is Employee ID field.


public boolean fld900_1_modified()

{
FormStringControl control = dialog.formRun().controlCallingMethod();

boolean isFieldModified;
;

isFieldModified = control.modified();

// every time the employee id is changed, update the employee name

if(isFieldModified)
{
dlgFldEmplName.value(EmplTable::find(control.text()).Name);
}

return isFieldModified;
}

You will also need to make sure that the control “Employee ID” gets the same control ID as used in the event method name (ID 900). This should be done at the time of adding the control to the dialog. Please see below:

protected Object dialog(DialogRunbase _dialog, boolean _forceOnClient)
{
;
dialog = super(_dialog, _forceOnClient);

// Add a new field by explicitly specifying the field id.
// This field id is used to create the field event methods (e.g. fld900_1_modified()).

dlgFldEmplId = new DialogField(dialog, typeid(EmplId), #dlgFlgEmplIdFieldNo);
dialog.addCtrlDialogField(dlgFldEmplId.name());

dlgFldEmplId.init(dialog);
dlgFldEmplId.label("@SYS81251");
dlgFldEmplId.helpText("@SYS81251");
dlgFldEmplId.value(emplId);


}

As you can see the macro #dlgFlgEmplIdFieldNo is used to assign the ID to the dialog control. The macro is defined in the classDeclaration and it equals 900.

That’s all what you need to do to be able to override the events on the dialog controls.

Here you can download a complete class which has the code used in the examples above.

  • Comments(4)//daxfaq.studioerudit.com/#post7

How to import and export data in XML format using AIF framework?

AIFPosted by Studio Erudit team 2008-03-24 19:47

This is the second part of the article about import and export data in XML format.

In the first post we have shown how to import and export data in XML format using Axd classes and it was mostly oriented to X++ developers.

In this post, we will use data generated in the first post (AxBc and Axd classes) and will explain how to import and export data in XML format, but using Application Integration Framework (AIF) features and batch framework. This article is mostly oriented to end-users.

Setup part:

Setup part consists of two parts: AIF setup and Batch framework setup.

AIF setup:

Before starting AIF setup, please import the xpo file with all required objects from here. Even if you have generated these objects before as a part of the first article, you still need to import it because some objects were slightly modified in order to implement Send functionality which will be used in this article.

The path to the AIF setup forms is: Basic > Setup > Application Integration Framework.

Blog Image

Figure 0. AIF setup forms location.

1) Open Local endpoints form and create a new local endpoint for the company where you want to import data to or to export data from. In our case, it is company DAT.

Blog Image

Figure 1. Local endpoints form

2) Open Transport adapters form and create a new transport adapter for the file system. Set Direction field to "Receive or Send" and select Active checkbox.

Blog Image

Figure 2. Transport adapters form

3) Open Channels form and create two new channels - Outbound and Inbound. The channes simply specify where the files should be taken from or put in.

At first, create an outbound channel and then create an inbound one and assign the outbound channel to it. For the outbound channel, create a folder C:\AIF\Outbound and for the inbound one - C:\AIF\Inbound.

Blog Image

Figure 3. 1. A new outbound channel

Blog Image

Figure 3.2. A new inbound channel with the assigned to it outbound one.

4) Open Actions form and click "Scan and register" button in order to find new documents and generate new actions for them. In our case, the system will be looking for AxdMyTable document and will be generating Create, CreateList, FindEntityKeyList, FindList, Read and ReadList actions for that document. For all these actions, we need to manually select "Enabled" checkbox.

Blog Image

Figure 4.1. Actions form before new actions were generated.

Blog Image

Figure 4.2. Actions form - searching AOT for new documents

Blog ImageFigure 4.3. Actions form - new actions CreateMyTable and CreateListMyTable for AxdMyTable document.

Blog Image

Figure 4.4. Actions form - new actions FindEntityKeyListMyTable and FindListMyTable for AxdMyTable document.

Blog ImageFigure 4.5. Actions form - new actions ReadMyTable and ReadListMyTable for AxdMyTable document.

5) Open Endpoints form and create a new endpoint. The endpoint is used to define rules for import and export of documents (where to export, who can export, which table fields to export or to import, etc.).

Blog Image

Figure 5.1. Endpoints form, Overview tab

Blog Image

Figure 5.2. Endpoints form, General tab

Blog Image

Figure 5.3. Endpoints form, Constraints tab

Blog Image

Figure 5.4. Endpoints form, Users tab

6) In the Endpoints form, click Action policies button. In the Endpoint Action Policies form, you need to add all 6 actions generated in the Actions form in order to be able to apply these actions for the AxdMyTable document. For each action, you need to set the Status field to "Enabled" and Logging Mode to "Log All".

Blog Image

Figure 6.1. Endpoint Action Policies form - action selection

Blog Image

Figure 6.2. Endpoint Action Policies form - all actions added

7) The last step of the AIF setup part is to enable fields that can be imported or exported for each action. For that, select an action and click "Data policies" button and enable following four fields: DocPurpose, MyFieldInt, MyFieldStr, Sender as shown on the picture below. Repeat it for each action.

Blog Image

Figure 7. Data policies selection for createListMyTable action.

Batch framework setup:

8) The path to the Batch setup forms is: Basic > Setup > Application Integration Framework.

Blog Image

Figure 8. Batch setup forms location.

9) Open Batch groups form and create a new batch group.

Blog Image

Figure 9. Batch group form with a new batch group 'AIF'.

10) Open Journal types form and create a new batch journal type. On the General tab, add four following classes that will be run by batch framework in order to import or export data: AifGatewayReceiveService, AifInboundProcessingService, AifOutboundProcessingService, AifGatewaySendService. The sequence in which you add them is not important at this point.

Blog Image

Figure 10.1. Batch journal type form.

Blog Image

Figure 10.2. AIF RunBaseBatch based classes added to the batch journal type.

11) Open Journal names form and create a new journal name. Give it a name 'AIF' and in the Journal type field, select 'AIF' journal type created in the previous step.

Blog Image

Figure 11. Batch journal name form.

12) In the Batch journal name form, click Jobs button. In the Batch journal line form, click Ctrl+N and select a class name from the lookup form. Repeat it for each class name. After all four classes are added, sort them using Up and Down buttons so that they are listed in the following order:

1. AifGatewayReceiveService

2. AifInboundProcessingService

3. AifOutboundProcessingService

4. AifGatewaySendService

Blog Image

Figure 12.1. Batch journal line form - class name selection.

Blog Image

Figure 12.2. Batch journal line form - classes are in the correct positions.

That's it with the setup part.

Let's go to execution phase.

Execution part:

1) Import from XML file.

1.1) Copy the createListMyTable.xml file to the C:\AIF\Inbound folder.

1.2) Go to Basic > Periodic > Batch and open Batch journal execution form. Specify a journal name, a batch group and recurrence if necessary, and select the batch processing checkbox and click OK button.

Blog Image

Figure 1.1. Batch execution forms

Blog Image

Figure 1.2. Batch journal execution form - the journal name selection

Blog Image

Figure 1.3. Batch journal execution form - the batch processing, the batch group and the recurrence selection.

1.3) Open Processing form, select 'AIF' batch group and click OK.

Blog Image

Figure 1.4. Batch processing form

Now the createListMyTable.xml file should be imported into MyTable table and if you open the form MyTable form (it is a part of the xpo project imported in the beginning of AIF setup) you should be able to see two records:

Blog Image

Figure 1.5. Two records imported from the XML file

2) Export into XML file

2.1) Open MyTable form (select the form in AOT and click Open icon), select the first record and click Send electronically button. Now the job is added to the gateway queue and as soon as you run the batch jobs this document will be exported.

2.2) Repeat the steps 1.2 and 1.3 from the Import part. This will run the batch jobs.

2.3) Now the first record from the MyTable table should have been exported into XML file and you should be able to find it in C:\AIF\Outbound folder.

Blog Image

Figure 1.6. The exported 20083624_213604_2113008_00001.xml file.

That's all.

A hint:

If you have a problem and don't know why data was not imported or exported, look at the Basic > Periodic > Application Integration Framework > Exceptions form. This form has a log of all errors occurred during AIF processes and an explanation why they occurred.

Good luck!

P.S.

More info regarding AIF you can find in MSDN: http://msdn2.microsoft.com/en-us/library/aa570087.aspx

  • Comments(4)//daxfaq.studioerudit.com/#post6

What is the folder structure in Dynamics AX4?

AdministrationPosted by Studio Erudit team 2008-03-21 19:03

The installation of Dynamics AX 4 consists of three main parts:

1) Server installation

2) Client installation

3) Application installation

The path to the installation folders may be changed in the Dynamics AX Setup Wizard. However, if the default paths are used and all three parts are installed on the same machine, then the folder structure will look like below:

Blog Image

Figure 1. Microsoft Dynamics AX 4 folder free.

Folder description:

Application\Appl - contains the application files (business logic) and label files (.ald) for each language. The main application file is Ax<Layer ID>.aod containing the entire application (X++) code per layer.

Application\Appl\Standard\Db - MSDE database files.

Application\Appl\Standard\Tmp - Temporary files generated by the system.

Application\Appl\Standard\Old - during an upgrade the old application files are copied here.

Client\Bin - executable, dll files used on the client side and language dependent text files (.ktd) used by executables.

Server\DynamicsAX\Bin - executable, dll files used on the server side and language dependent text files (.ktd) used by executables. Note, 'DynamicsAX' here is an instance name specified during the Dynamics AX setup. By default it is 'Company1', but it can be changed to something more meaningful.

  • Comments(0)//daxfaq.studioerudit.com/#post5

How to import and export data in XML format using Axd classes?

AIFPosted by Studio Erudit team 2008-03-03 16:11

We often receive questions regarding import and export data in XML format in Dynamics AX 4.

We have decided to post two articles:

1) (this article) Import and export data in XML format using Axd classes (end-user and X++ developer oriented).

2) (next article) Import and export data in XML format using AIF framework (end-user oriented).

This article explains how to use Axd-classes in order to import XML files into Dynamics AX and export Dynamics AX data into XML files. The setup part could be useful for both end-users and developers, however the execution part is mostly concerning X++ developers.

Setup part:

In order to import or export Dynamics AX data in XML format the following objects need to exist:

a) A table - where the data will be imported to or exported from.

b) An AxBC class - which is a wrapper for the table and it is used by Axd-framework to default data into the table fields and update the related tables.

c) A query - which is used by Axd-framework to select data from the table or from the XML file.

d) An Axd-class - which represents the XML document and it is used by Axd-framework to import or export data from and to Dynamics AX.

All these objects except the table and the query can be generated automatically using the Axd Wizard.

Let's create a table MyTable, insert several records into it and generate all the objects mentioned above using Axd Wizard. Afterwards, in the execution part, we will export the records from MyTable table into XML file and import the data from the XML file into MyTable table.

1) Create a new table MyTable.

Blog Image

Figure 1. A new table MyTable.

2) Using Table browser, insert two records into MyTable table. Later these records will be exported into an XML file.

Blog Image

Figure 2. Path to the Table browser menu item.

Blog Image

Figure 3. Insert two new records into MyTable table.

3) Create a new query that will be used to export the data from MyTable table into XML file and import the data from the XML file into MyTable table. The query name should start with Axd in order to easily distinguish betwean standard queries and Axd queries.

Blog Image

Figure 4. A new query AxdMyTable.

4) Go to Tools - Development tools - Wizards - and select Axd Wizard.

Blog Image

Figure 5. Path to the Axd Wizard menu item.

5) Axd Wizard will start. In the Welcome page, click Next button.

Blog Image

Figure 6. The Welcome page of the Axd Wizard.

6) Select the AxdMyTable query created in the step 3 and click Next button.

Blog Image

Figure 7. The Select query page of the Axd Wizard.

7) Select all actions to be able to import and export multiple records of the document (in our case multiple records of the MyTable table). Actually for import and export using Axd classes you don't need Find actions, but they will be needed later for the AIF import article where we will use the data from this setup.

Specify a document description in the Label field and click Next button.

Blog Image

Figure 8. The Select a label and methods page of the Axd Wizard.

8) Click Generate button in the Generate code tab page.

Blog Image

Figure 9. The Generate code page of the Axd Wizard.

9) After all required objects have been generated, the final page appears. Click Finish button.

Blog Image

Figure 10. The final page of the Axd Wizard.

10) If you look at Compiler output window, most likely you will find several errors in the AxMyTable class.

Blog Image

Figure 10. The Compiler output window after the Axd Wizard has completed.

11) In order to fix the compiler errors you need to go to the newly created project AxdMyTable, delete two methods cacheObject and cacheRecordRecord from the AxMyTable class and recompile the entire project.

Blog Image

Figure 11. The AxdMyTable project generated by Axd Wizard.

Blog Image

Figure 12. Deletion of the failing methods cacheObject and cacheRecordRecord.

Blog Image

Figure 13. Recompilation of the entire project.

Now all required objects have been created by Axd Wizard and we are ready to export and import the data in XML format.

Execution part:

1) Export data from MyTable table into XML file using AxdMyTable class.

The X++ job below exports records from MyTable table into XML file C:\Temp\AxdMyTable_Outbound.xml. Please make sure the C:\Temp directorty exists before running this job.

static void exportAxdMyTable(Args _args)
{
MyTable myTable;
AxdMyTable axdMyTable = AxdBase::newClassId(classnum(AxdMyTable));
AifEntityKeyList aifEntiryKeyList = new AifEntityKeyList();
AifDocumentXml aifDocumentXml;
XmlDocument xmlDocument;

// convert a record to the entity key
AifEntityKey getEntityKey(Common _record)
{
AifEntityKey aifEntityKey = AifEntityKey::construct();
List keyFields = SysDictTable::getUniqueIndexFields(_record.TableId);
Map keyMap = SysDictTable::mapFieldIds2Values(keyFields,_record);
;
aifEntityKey.parmKeyDataMap(keyMap);
aifEntityKey.parmTableId(_record.TableId);
aifEntityKey.parmRecId(_record.RecId);

return aifEntityKey;
}
;

// add all records to be exported into the entity key list
while select myTable
{
aifEntiryKeyList.addEntityKey(getEntityKey(myTable));
}

// create an xml document containg the records
aifDocumentXml = axdMyTable.readList(aifEntiryKeyList,
null,
new AifEndpointActionPolicyInfo(),
new AifConstraintListCollection(),
connull());

xmlDocument = XMLDocument::newXML(aifDocumentXML);

// save the xml document on the disk
xmlDocument.save('C:\\Temp\\AxdMyTable_Outbound.xml');
}

The generated XML file will look like this:

Blog Image

Figure 14. AxdMyTable_Outbound.xml file created by exportAxdMyTable X++ job.

2) Import data from the XML file into MyTable table using AxdMyTable class.

For testing purposes you can use the XML file AxdMyTable_Outbound.xml created by the exportAxdMytable job and simply rename it to axdMyTable_Inbound.xml.

static void importAxdMyTable(Args _args)
{
AxdMyTable axdMyTable;
AifDocumentXml xml;
XmlDocument xmlDocument;
;

// create an xml document from file
xmlDocument = XmlDocument::newFile("C:\\Temp\\axdMyTable_Inbound.xml");
xml = xmlDocument.xml();

axdMyTable = AxdBase::newClassId(classnum(AxdMyTable));

// insert data from the xml document into Dynamics AX
axdMyTable.createList(xml,
new AifEndpointActionPolicyInfo(),
new AifConstraintListCollection());
}

The entire X++ project can be dowloaded from here.

Enjoy! smiley

  • Comments(15)//daxfaq.studioerudit.com/#post4

Welcome

WelcomePosted by Studio Erudit team 2007-08-26 12:11

Welcome to Studio Erudit's Microsoft Dynamics AX FAQ site.

We are glad to share with you our discoveries about Microsoft Dynamics AX system and hope it will be useful for you.

Best wishes,

Studio Erudit team.

  • Comments(7)//daxfaq.studioerudit.com/#post1