Creating New Documents
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. For more information about the documents that ship with Microsoft Dynamics AX, see Standard Axd Documents.
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 Contoso needs to send general journal entries to an external system for reporting. They also need to be able to receive data through AIF from an external accounting system and then create a journal entry and its associated lines. In the UI, entries are created in the general journal by navigating to the General ledger > Journals > General journal form.
Because there is no existing document to transfer journal entries a new document must be created in Microsoft Dynamics AX. The tool used to create a new document is the Axd Wizard. This wizard creates all the necessary document components and alerts you to any best practices issues. Use the following steps to create a new document using the Axd Wizard:
-
Deploy the document class.
-
If the document can be sent outbound (the document class exposes read or find methods), deploy the document for an outbound exchange.
-
If the document can be received inbound (the document class exposes create methods), deploy the document for an inbound exchange deploy the document for an inbound exchange.
-
Important |
|---|
|
Adding a custom document requires in-depth knowledge of AIF and documents. Before creating a custom document in AIF, it's 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. |
Important