Creating New Services

In Application Integration Framework (AIF), an exchange starts with a document (also called a document class) that contains business logic. The document is serialized into XML, and header information is added to create a message that can then be transferred into or out of Microsoft Dynamics AX through the AIF transport layer. AIF includes out-of-the-box support for sending and receiving commonly used documents. When you create a new service you also create a new document. For more information about the documents that ship with Microsoft Dynamics AX, see Standard Axd Documents. For an example of creating a service, see Walkthrough: Creating a Service Using the AIF Document Service Wizard.

In some cases, there may be a business need to exchange information with Microsoft Dynamics AX for which there is not an existing document. In this case, the extensible nature of AIF enables you to create a custom document to send and receive data.

Consider the scenario in which a company needs to send data to an external system for reporting. They also need to be able to receive data through AIF from an external accounting system.

If there is no existing document to transfer data, a new document must be created in Microsoft Dynamics AX. The tool used to create a new document is the AIF Document Service Wizard. This wizard creates all the necessary service and document components and alerts you to any best practices issues. Use the following steps to create a new document using the AIF Document Service Wizard:

  1. Create the document query.

  2. Run the AIF Document Service Wizard.

  3. Add any custom business logic to the document class.

  4. Deploy the service.

    1. If the document can be sent outbound (the service has read, find, or findKeys service operations), deploy the document for an outbound exchange.

    2. If the document can be received inbound (the service has create, update, or delete service operations), deploy the document for an inbound exchange deploy the document for an inbound exchange.

ImportantImportant

Adding a custom service requires in-depth knowledge of AIF and documents. Before creating a custom document in AIF, it is recommended that you configure an exchange with an existing document in order to become familiar with how the transport layer and the XML framework interact within AIF.


Community Additions

ADD
Show: