Microsoft Dynamics AX API - Part 3 "book of orders"

From:http://blog.ak-home.net/CategoryView,category,Dynamics%2BAx%2cProgrammierung%2cAPI.aspx

 

The book of orders in Microsoft Dynamics AX is done with the class "SalesFormLetter" or one of its derived class. Each booking type(e.g. Confirmation, delivery note, invoice) is represented by a class which is derived from the base class "SalesFormLetter".

 

To book an order by code, an object of class "SalesFormLetter" should be created:

 

salesFormLetter = SalesFormLetter::construct(DocumentStatus::Confirmation);

 

The "construct" method is as usual in AX, the parameters must be specified with desired type of booking(e.g. Confirmation, delivery note, Invoice).  The "construct" method generate and return object or instance of appropriate derived class(in this case, a "SalesFormLetter_Confirm" object is created). The actual book is done by calling method "update". This method select all necessary data when booking as parameters.

 

For example:

 

// --- Book without expression --- static void PostingConfimation(Args _args) { SalesFormLetter salesFormLetter; SalesTable salesTable; SalesId salesId; PrintJobSettings printJobSettings; ; //Indication of the order which is to be posted. salesId = "00423_036"; salesTable = SalesTable::find(salesId); // Determine the type of booking by giving the Document Status salesFormLetter = SalesFormLetter::construct(DocumentStatus::Confirmation); // Book of the contract (but not printing) salesFormLetter.update(salesTable, SystemDateGet(), SalesUpdate::All, AccountOrder::None, NoYes::No, NoYes::No); }

 

This is a good example to show the necessary steps for posting:

1. Using the method "construct" to generate a object of appropriate booking class.

2. book the order by calling the method "Update"

 

There are much more specific scenarios with booking, for example it is possible to print the documents when posting. The booking class has much more methods mapped for these scenarios.

 

Just one more example of booking and print sales order:

 

// --- Book with expression --- static void PostingConfimation(Args _args) { SalesFormLetter salesFormLetter; SalesTable salesTable; SalesId salesId; PrintJobSettings printJobSettings; ; //Indication of the order which is to be posted. salesId = "00423_036"; salesTable = SalesTable::find(salesId); salesFormLetter = SalesFormLetter::construct(DocumentStatus::Confirmation); //Book of the contract and print (print media from hour setting). salesFormLetter.update(salesTable, SystemDateGet(), SalesUpdate::All, AccountOrder::None, NoYes::No, NoYes::Yes); //2nd term. printJobSettings = new PrintJobSettings(salesFormLetter.printerSettingsFormletter( PrintSetupOriginalCopy::Original)); //where we want to print(file) printJobSettings.setTarget(PrintMedium::File); //In which format should we print(PDF here) printJobSettings.format(PrintFormat::PDF); printJobSettings.fileName(@"C:/Test_Order.pdf"); //Transfer of printing options to the SalesFormLetter object salesFormLetter.updatePrinterSettingsFormLetter(printJobSettings.packPrintJobSettings()); salesFormLetter.printJournal(); }