Services and AIF Walkthroughs
Important
This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.
Applies To: Microsoft Dynamics AX 2012 R2
This topic lists and describes documentation that contains walkthroughs of various features of services and Application Integration Framework (AIF) in Microsoft Dynamics AX. You can browse walkthroughs by the type of service, such as system service or document service. Subsections of each service type let you browse walkthroughs in other ways, such as by the type of adapter or the type of document service.
Document Services
The following sections list walkthroughs for document services.
By Document Service
The following table lists walkthroughs by the type of document service.
Document type |
Topic |
Description |
BudgetTransactionService |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
CatImpService |
Walkthrough: Configuring an inbound integration port for catalog import |
This topic provides specific information about how to configure an integration port to receive catalog maintenance request (CMR) files. |
CustCustomerService |
This walkthrough shows you how to create a .NET transform assembly that can be called from an AIF pipeline in Microsoft Dynamics AX. In this scenario, the component takes the contents of a comma-separated values (CSV) file that contains customer leads and converts it into XML. |
|
CustCustomerService |
This walkthrough contains code for sending a read request from a C# console application that displays the customer fields that are returned. |
|
CustCustomerService |
Walkthrough: Reading a Customer by Using the File System Adapter |
This walkthrough illustrates sending a read request using an AIF message and contains an example customer record returned as an XML file. |
CustPaymentsService |
Walkthrough: Configuring an outbound integration port for payments |
This topic describes how to set up an outbound integration port for payments that use AIF and Single Euro Payments Area (SEPA) Credit Transfer. |
EMSMeterReadingFlowService |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
EMSSubstanceFlowService |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
LedgerGeneralJournalService |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
LedgerGeneralJournalService |
Walkthrough: Creating a Service by Using the AIF Document Service Wizard |
This walkthrough covers how to create a document query, a new service, and a document schema when you want to create a document service that is not included with AIF. |
LedgerGeneralJournalService |
Walkthrough: Deploying the Document Service in an Outbound Exchange |
This walkthrough illustrates the following tasks
|
ProdProdPickingListService |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
ProjectHourJournalS |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
SalesSalesOrderService |
Walkthrough: Exchanging documents by using the file system adapter |
The file system adapter enables asynchronous communication by using file system directories. This topic demonstrates how to perform an asynchronous document exchange. In this scenario, a new sales order request is sent to AIF by using the file system adapter. |
SalesSalesOrderService |
The HTTP adapter enables synchronous communication through a website. This walkthrough demonstrates how to use an inbound integration port together with the HTTP adapter to read a sales order from Microsoft Dynamics AX. In this walkthrough, you create an inbound integration port, and then use C# code to create a command-line program that reads a specific sales order. |
|
SalesSalesOrderService |
The MSMQ adapter enables asynchronous communication by using the Message Queuing transport. This walkthrough demonstrates how to use an inbound port together with the MSMQ adapter to create a sales order in Microsoft Dynamics AX. In this walkthrough, you create an inbound integration port, and then use C# code to create a command-line program that sends an XML document to a message queue. |
|
SalesSalesOrderService |
Walkthrough: Exchanging documents by using the NetTcp adapter |
The NetTcp adapter provides for synchronous communication by using the Transmission Control Protocol (TCP) transport. This walkthrough demonstrates how to use an inbound port with the NetTCP adapter to read a sales order from Microsoft Dynamics AX. In this walkthrough, you will create an inbound integration port and then use C# code to create a command-line program that reads a particular sales order. |
SalesSalesOrderService |
AIF enables you to integrate a Microsoft Dynamics AX installation with external systems. This framework supports the ability to create, read, update, and delete data. In this walkthrough, you will update a sales order using the file system transport. |
|
SysImportBusSector |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
VendGroup |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
VendPaymentsService |
Walkthrough: Configuring an outbound integration port for payments |
This topic describes how to set up an outbound integration port for payments that use AIF and Single Euro Payments Area (SEPA) Credit Transfer. |
VendRequestSignup |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
By Adapter
The following table lists walkthroughs by the type of adapter.
Adapter type |
Topic |
Description |
All |
This walkthrough shows you how to create a .NET transform assembly that can be called from an AIF pipeline in Microsoft Dynamics AX. In this scenario, the component takes the contents of a comma-separated values (CSV) file that contains customer leads and converts it into XML. |
|
Excel add-in |
Walkthrough: Configuring an inbound integration port for Office Excel import |
This topic describes how to use the Excel add-in. |
File system |
Walkthrough: Configuring an inbound integration port for catalog import |
This topic provides specific information about how to configure an integration port to receive catalog maintenance request (CMR) files. |
File system |
Walkthrough: Exchanging documents by using the file system adapter |
The file system adapter enables asynchronous communication by using file system directories. This topic demonstrates how to perform an asynchronous document exchange. In this scenario, a new sales order request is sent to AIF by using the file system adapter. |
File system |
AIF enables you to integrate a Microsoft Dynamics AX installation with external systems. This framework supports the ability to create, read, update, and delete data. In this walkthrough, you will update a sales order using the file system transport. |
|
HTTP |
The HTTP adapter enables synchronous communication through a website. This walkthrough demonstrates how to use an inbound integration port together with the HTTP adapter to read a sales order from Microsoft Dynamics AX. In this walkthrough, you create an inbound integration port, and then use C# code to create a command-line program that reads a specific sales order. |
|
MSMQ |
The MSMQ adapter enables asynchronous communication by using the Message Queuing transport. This walkthrough demonstrates how to use an inbound port together with the MSMQ adapter to create a sales order in Microsoft Dynamics AX. In this walkthrough, you create an inbound integration port, and then use C# code to create a command-line program that sends an XML document to a message queue. |
|
NetTCP |
Walkthrough: Exchanging documents by using the NetTcp adapter |
The NetTcp adapter provides for synchronous communication by using the Transmission Control Protocol (TCP) transport. This walkthrough demonstrates how to use an inbound port with the NetTCP adapter to read a sales order from Microsoft Dynamics AX. In this walkthrough, you will create an inbound integration port and then use C# code to create a command-line program that reads a particular sales order. |
Custom Services
The following topic contains a walkthrough for custom services:
External Web Services
The following topic contains a walkthrough for how to consume an external web service:
System Services
System services are Windows Communication Foundation (WCF) services that are included with Microsoft Dynamics AX that enable clients to interact with and retrieve system information. This section lists walkthroughs for the three types of system services: the metadata service, the query service, and the user session service.
Metadata Service
The metadata service returns information about AOT objects in Microsoft Dynamics AX such as tables, services, extended data types (EDTs), enums, and queries. The following table lists walkthroughs that show how to use the metadata service.
Type of system service |
Topic |
Description |
Metadata Service |
This walkthrough illustrates how to call the metadata service from a C# program and return metadata for a specific query. |
|
Metadata Service |
Walkthrough: Using the Metadata Service to Get Table Field Labels |
This walkthrough illustrates how to call the metadata service from a C# program and return field names and field labels for all the fields in a particular table as specified by the table ID. |
Query Service
The query service enables you to issue a query for data without using an AIF document service or creating a custom service. The following table lists walkthroughs that show how to use the query service.
Type of system service |
Topic |
Description |
Query Service |
Walkthrough: Using the Query Service to Query Tables in a Hierarchy |
This walkthrough shows you how to call the query service and retrieve data from tables that implement table inheritance in Microsoft Dynamics AX. |
Query Service |
Walkthrough: Using the Query Service to Query Date Effective Tables |
This walkthrough shows you how to call the query service and retrieve data from tables that contain date effective fields. |
Query Service |
Walkthrough: Using the Query Service to Return a Flattened Dataset |
This walkthrough shows you how to call the query service and retrieve data from tables that implement table inheritance in Microsoft Dynamics AX in a flattened data table. |
User Session Service
The user session service returns information about the calling user such as the user’s default language, default company, default company time zone. The following walkthrough illustrates how to call the user session service from a C# console application and display the user’s information: