{"id":16,"date":"2016-01-19T17:35:58","date_gmt":"2016-01-19T16:35:58","guid":{"rendered":"https:\/\/kerms.hobby-site.org\/?p=16"},"modified":"2016-01-31T13:10:25","modified_gmt":"2016-01-31T12:10:25","slug":"creating-a-batch-class-in-dynamics-ax-2009","status":"publish","type":"post","link":"https:\/\/kerms.hobby-site.org\/?p=16","title":{"rendered":"Creating a batch class in Dynamics AX 2009"},"content":{"rendered":"

For creating a batch class in Dynamics AX we can start from the Tutorial_RunbaseBatch class,
\nbut here is the explanation for understanding all its methods:<\/p>\n

In the\u00a0classDeclaration<\/em>, we declare any variable that contains user’s selection or preferences
\n(for example, the customer account for launch a customer report). Also, we declare other
\nvariables like dialog fields, auxiliar variables, etc. But, the most important feature here, is the\u00a0#localmacro.CurrentList<\/em>\u00a0declaration. This macro helps you to define which variables you want
\nto save for running the class in batch mode (when not user interaction is available).<\/p>\n

class<\/span> Tutorial_RunbaseBatch extends RunBaseBatch\r\n{\r\n    \/\/ Packed variables<\/span>\r\n    TransDate       transDate;\r\n    CustAccount     custAccount;\r\n\r\n    \/\/ Dialog fields<\/span>\r\n    DialogField     dlgCustAccount;\r\n    DialogField     dlgTransDate;\r\n\r\n    \/\/ Current version<\/span>\r\n    \/\/ We can have different versions for different purposes<\/span>\r\n    #define.CurrentVersion(1)\r\n    #define.Version1(1)\r\n    #localmacro.CurrentList  \/\/ Our current variable list for save user's selected values<\/span>\r\n        transDate,\r\n        custAccount\r\n    #endmacro\r\n}<\/pre>\n
 <\/p>\n
The macro\u00a0#define.CurrentVersion(1)<\/em>\u00a0and\u00a0#define.Version1(1)<\/em>\u00a0are useful for scaling our class
\nwhen we need to change\/upgrade it preserving compatibility.<\/p>\n
Now two methods:\u00a0pack<\/em>\u00a0and\u00a0unpack<\/em>. These methods are used for store and retrieve user’s
\npreferences and perform the batch operation when none user are available (in batch mode).
\nHere is the point where we use the macro defined previously:<\/p>\n
<\/div>\n
public<\/span> container<\/span> pack()\r\n{\r\n    return<\/span> [#CurrentVersion,#CurrentList];\r\n}\r\n\r\npublic<\/span> boolean unpack(container<\/span> packedClass)\r\n{\r\n    Version version = RunBase::getVersion(packedClass);\r\n;\r\n    switch<\/span> (version)\r\n    {\r\n        case<\/span> #CurrentVersion:\r\n            [version,#CurrentList] = packedClass;\r\n            break<\/span>;\r\n        \/\/case #otherVersion:<\/span>\r\n            \/\/[version,#CurrentList, #otherList] = packedClass;<\/span>\r\n            \/\/break;<\/span>\r\n        default<\/span>:\r\n            return<\/span> false<\/span>;\r\n    }\r\n\r\n    return<\/span> true<\/span>;\r\n}<\/pre>\n
<\/div>\n
<\/div>\n
Bacause we need to ask the user about preferences for run this object (report,<\/div>\n
\u00a0process, query, etc.), we must implement some methods:<\/div>\n
<\/div>\n
–\u00a0dialog<\/em>: for build the custom dialog for prompting user’s preferences.<\/div>\n
–\u00a0dialogPostRun<\/em>: after dialog was created, you can perform other UI tasks here.<\/div>\n
–\u00a0getFromDialog<\/em>: used for retrive user’s preferences (dialog values).<\/div>\n
–\u00a0validate<\/em>: here, you can perform a validation for any data entered by the user.<\/div>\n
<\/div>\n
public<\/span> Object dialog()\r\n{\r\n    DialogRunbase       dialog = super();\r\n    ;\r\n \r\n    \/\/ Creation of our custom dialog fields\/controls to ask user for preferences<\/span>\r\n    dlgTransDate = dialog.addFieldValue(typeid(TransDate),transDate);\r\n    dlgCustAccount = dialog.addFieldValue(typeid(CustAccount),custAccount);\r\n\r\n    return<\/span> dialog;\r\n}\r\n\r\npublic<\/span> void<\/span> dialogPostRun(DialogRunbase dialog)\r\n{\r\n;\r\n    super(dialog);\r\n}\r\n\r\npublic<\/span> boolean getFromDialog()\r\n{\r\n    ;\r\n\r\n    \/\/ Retrieving user's preferences<\/span>\r\n    transDate   = dlgTransDate.value<\/span>();\r\n    custAccount = dlgCustAccount.value<\/span>();\r\n\r\n    return<\/span> super();\r\n}\r\n\r\npublic<\/span> boolean validate()\r\n{\r\n    \/\/ We can perform some validations here<\/span>\r\n    if<\/span> (false<\/span>)\r\n        return<\/span> checkFailed(\"\"<\/span>);\r\n\r\n    return<\/span> true<\/span>;\r\n}\r\n<\/pre>\n
<\/div>\n
<\/div>\n
Finally, the\u00a0main<\/em>\u00a0method\u00a0constructs<\/em>\u00a0the object from this batch class, and after<\/div>\n
\u00a0prompting user and validation was successful, the\u00a0run<\/em>\u00a0method is called to perform<\/div>\n
some task (in batch mode if it was selected):<\/div>\n
<\/div>\n
server static<\/span> Tutorial_RunbaseBatch construct()\r\n{\r\n    return<\/span> new<\/span> Tutorial_RunbaseBatch();\r\n}\r\n\r\npublic<\/span> void<\/span> run()\r\n{\r\n    try<\/span>\r\n    {\r\n        \/\/ Obviously, this code is silly, why show something to nobody?<\/span>\r\n        \/\/ remember, this code is running in batch without user interaction<\/span>\r\n        info(strfmt(\"Parameters: %1 for %2\"<\/span>, transDate, custAccount));\r\n    }\r\n    catch<\/span>(Exception::Deadlock)\r\n    {\r\n        retry;\r\n    }\r\n    catch<\/span>(Exception::UpdateConflict)\r\n    {\r\n        throw<\/span> Exception::UpdateConflict;\r\n    }\r\n    catch<\/span>\r\n    {\r\n        throw<\/span> Exception::Error;\r\n    }\r\n}\r\n\r\nstatic<\/span> void<\/span> main(Args args)\r\n{\r\n    Tutorial_RunbaseBatch    tutorial_RunBase;\r\n    ;\r\n\r\n    \/\/ Instanciating this batch class<\/span>\r\n    tutorial_RunBase = Tutorial_RunbaseBatch::construct();\r\n\r\n    \/\/ Prompting user and run if all is ok<\/span>\r\n    if<\/span> (tutorial_RunBase.prompt())\r\n        tutorial_RunBase.run();\r\n}\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
For creating a batch class in Dynamics AX we can start from the Tutorial_RunbaseBatch class, but here is the explanation for understanding all its methods: In the\u00a0classDeclaration, we declare any variable that contains user’s selection or preferences (for example, the … Weiterlesen →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-16","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=\/wp\/v2\/posts\/16"}],"collection":[{"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=16"}],"version-history":[{"count":5,"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=\/wp\/v2\/posts\/16\/revisions"}],"predecessor-version":[{"id":23,"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=\/wp\/v2\/posts\/16\/revisions\/23"}],"wp:attachment":[{"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=16"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=16"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/kerms.hobby-site.org\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=16"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}