Generating the outbound xml file for all records using File system adapater in ax 2012 AIF

  1. Generating the outbound xml file for selected record or single record – using document service(file system adapter).
  2. Generating the outbound xml file for all records( i.e. specified criteria on the query) – using document service(file system adapter).

    Example: Generating the outbound xml file for selected record or single record.
    Below is the code to generate the outbound xml file for the selected record.
    static void GenerateXmlSelectedRecord(Args _args)
    AxdSendContext      axdSendContext  = AxdSendContext::construct();
    AifEntityKey        aifEntityKey    = AifEntityKey::construct();
    AifEntityKeyList    aifEntityKeyList = AifEntityKeyList::construct();
    Map                 keyData;
    AifConstraintList   aifConstraintList   = new AifConstraintList();
    AifConstraint       aifConstraint       = new AifConstraint();
    CustTable           custTable;
    int i,j;
    CustCustomerService CustCustomerService = CustCustomerService::construct();
    custTable = CustTable::find(‘Cust001’);

    keyData = SysDictTable::getKeyData(custTable);



    aifConstraint.parmType(AifConstraintType::NoConstraint) ;
    aifConstraintList.addConstraint(aifConstraint) ;

    AifSendService::SubmitDefault(  classnum(CustCustomerService),

    Example: Generating the outbound xml file for all records( i.e. specified criteria on the query).
    Below is the code to generate the outbound xml for all the records or specified criteria.

    static void GenerateMutiplerecords(Args _args)
    CustTable           custTable;
    AxdSendContext      axdSendContext      = AxdSendContext::construct();
    AifEntityKey        aifEntityKey        = AifEntityKey::construct();
    AifConstraintList   aifConstraintList   = new AifConstraintList();
    AifConstraint       aifConstraint       = new AifConstraint();
    AifEndpointList     endpointList;
    AifActionId         actionId;
    Query               query;
    QueryBuildDataSource    qbds;

    query               = new Query(queryStr(AxdCustomer));

    actionId            = AifSendService::getDefaultSendAction(classnum(CustCustomerService), AifSendActionType::SendByQuery);
    aifConstraintList.addConstraint(aifConstraint) ;
    endpointList        = AifSendService::getEligibleEndpoints(actionId, aifConstraintList);


AIF Service Common Usage Scenarios in ax 2012

Custom Services: Use to expose very simple business entities as a service, or to expose custom logic from Microsoft Dynamics AX.

This Service enables developers to expose any logic written in x++ through a service interface. The support for Custom Services was introduced in Dynamics AX 2009, but it was limited to some specific data types. In Microsoft Dynamics AX 2012 with the integration of Windows Communication Foundation (WCF), attributes can be set on the Data Contract class to make them serialize and De-serialize across the network connection.

  • To expose a custom x++ logic.
  • Say, you have a custom module and you want to expose some logic/code to your custom application.

Document Services: – Use to expose business entitles with varying degrees of complexity, or to support medium-to-complex integration scenario involving business entities.

This was introduced in Microsoft Dynamics AX 4.0. It enables the user to exchange data between internal and external systems via XML documents. Document Services are generated from a query that models the business entity. For example, a customer query will run the Document Service Generation Wizard to create the Service artifacts.

Document Services include logic to handle the details of how a query will be serialized or De-serialized from the XML that is sent across a network. For synchronization of Document Services, there are two new entities introduced in Dynamics AX.

  • getKey
  • getChangedKey

Developers need to extend these functions to enable their own scenario.

  • Document services are services which expose a business entity. For example, Customer, Vendor, Employee, Sales Order.
  • You can Map the business entity using Query and run through Document Service Wizard to build the web service and perform CRUD operations.

System Service: System services are Windows Communication Foundation (WCF) services that are included with Microsoft Dynamics AX. These services enable clients to interact with and retrieve system information.

This is a new Service category introduced in Microsoft Dynamics AX 2012. This type of Service is not customizable and not mapped to any X++ code. There are three types of Services that come under System Services:

  • Query Service
  • Metadata Service
  • User Session Service

All these Services have unique functionality that will be discussed in my next post.

  • System services are kind of utility services.
  • Up and running when AOS starts.
  • Can be used for interactive clients
  • Build Ad-hoc query

System Service: Query Service: – Use to implement read operations for any Microsoft Dynamics AX, ad-hoc, or existing AOT query.

  • Enables you to issue a query for data without using an Application Integration Framework (AIF) document service or creating a custom service. The query service returns data in a dataset and implements a paging mechanism so that you can manage queries that return large amounts of data.

When you call the query service, you can specify the query to run in one of three different ways:

    • Static query – A query that is already defined in the AOT under the Queries node.
    • User-defined query – A query that is defined by using the QueryMetadata class which is found in the metadata service.
    • Dynamic query – A query that is defined in an X++ class that extends the AifQueryBuilder class. All query logic resides in the query builder class

System Service: Metadata Service: – Use to retrieve information about the structures in Microsoft Dynamics AX for a client application. For example, if you want to return information about a table such as what indexes exist on that table, you can use the metadata service.

Enables you to retrieve information about elements in the AOT. You can retrieve metadata for labels, menus, menu items, tables, extended data types, data types, enums, queries, web menus, web menu items, info parts, cues, dimensions, form parts, web controls, service groups, and services. The metadata service should be used when you want to return information about the structures in Microsoft Dynamics AX to a client application. For example, if you want to return information about a table such as what indexes exist on that table, you can use the metadata service.

System Service: User Session Service: – Use to retrieve information about the user session.

Enables you to return information about the current Windows user. You can return information such as the user’s default language, Default Company, default company time zone, permissions to access-controlled items, and so on

AX Data Export in XML file

static void XMLExport(Args _args)
    XmlDocument doc;
    XmlElement  nodeXml;
    XmlElement  nodeTable;
    XmlElement  nodeAccount;
    XmlElement  nodeName;
     XmlElement  nodeItemName;
    XmlElement  nodeModelGroup;
    XmlElement  nodeDimGroup;
    InventTable inventTable;
    doc     = XmlDocument::newBlank();
    nodeXml = doc.createElement(‘xml’);
    while select inventTable
        nodeTable = doc.createElement(tablestr(InventTable));
            fieldstr(InventTable, RecId),
        nodeAccount = doc.createElement(
            fieldstr(InventTable, ItemId));
        nodeName = doc.createElement(
            fieldstr(InventTable, ItemGroupId));
         nodeItemName = doc.createElement(
            fieldstr(InventTable, ItemName));
        nodeModelGroup = doc.createElement(
            fieldstr(InventTable, ModelGroupId));
        nodeDimGroup = doc.createElement(
            fieldstr(InventTable, DimGroupId));