Application Integration Framework (AIF) services are used to communicate with external systems or applications. Microsoft Dynamics AX 2012 has the following types of services:
- Document services
- Custom services
- System services
An AIF service can be Inbound or Outbound. An Inbound service is used when you want to send data to an external system and Outbound services are used when you want to retrieve data. This tutorial will guide you in creating Custom Inbound AIF services in Microsoft Dynamics AX 2012. Custom services are used when:
- The complexity of the entities is relatively low.
- When you want to have full control of the service contract.
- When data contracts needs to be shared with different entities.
- Microsoft Dynamics AX 2012
- AIF services must be installed and configured on IIS
Service operations are class methods that expose any business logic in a service. To define a service operation, add the SysEntryPointAttribute attribute at the top of a method. Any existing method can be converted to a service operation by adding this attribute at the beginning of the method.
Note: The service operation name cannot include Create, Find, Update or Delete. These names are reserved to be used by AIF Document services. AX will make an exception when they are called from a client.
SysEntryPointAttribute defines the authorization checks that will be performed when a method is called from the server. This attribute must be set on all the service operations. If the value is “true”, it means that authorization checks will be performed for all the tables accessed in the method and if set to “false”, no authorization checks will be performed.
AifCollectionTypeAttribute is used when you want to use a collection as a return type or in a parameter of a service operation. This attribute defines the type of data a collection contains.
As part of this tutorial the service will return the list of customer names in Dynamics AX.
- First we will create a new class which will contain Service operations.
- Open AOT. Go to Classes and create a new class. Let’s name it CustomerServiceDemo.
- Set the RunOn property of the class to Server. This will make sure the class always executes on the server.
- Add a new method and name it as getCustomerNameList. This method will query customers’ names and return a Type list string. Write the following code in the method:
- The SysEntryPointAttribute tells AX that this method is a service operation method.
- Now we will create a new service and add the above created service operation to it.
- Go to Services, right click and select New Service.
- Name it as CustomerServiceDemo.
- Open the properties of the newly created service and select the CustomerServiceDemo class in the Class field.
- Now expand the CustomerServiceDemo service node and add a new Operation by right clicking on Operations and selecting Add Operation.
- All service operations present in the class will be listed. Select the getCustomerNameList service operation by checking the Add field in the grid and press OK.
- The next step is to create a service group and deploy the service to the Inbound Port.
- Go to Service Groups, right click and select New Service group.
- Name it as CustomerServiceDemoGroup.
- Set the AutoDeploy to Yes (Service will start automatically when AOS is started) and set the Description as Customer name service.
- Right click the newly created service group and select New Service Node Reference.
- In the newly created service node, set the Service property to CustomerServiceDemo. The Name property will automatically default to the Service name.
- Now right click the service group and select Deploy Service Group.
- A success message will appear if the service group is successfully deployed.
- To verify it, go to System administration à Setup à Services and Application Integration Framework à Inbound ports.
- The Service group name CustomerServiceDemoGroup will appear here as Port name with a green check mark. This shows that service group is deployed and active. If a red ‘x’ is appearing, select Activate from the action pane to activate the port.
- The WSDL URI is the URL of the service which can be used by external systems to access the service.
- To test whether the service is running properly, open the Visual Studio Command Prompt by going to All Programs à Microsoft Visual Studio 2010 à Visual Studio Tools à Visual Studio Command Prompt.
- Write wcftestclient and press enter. WCF Test Client will open.
- Now, go to File àAdd Service.
- In the Add Service dialog box, paste the WSDL URI of the port and press OK.
- The WCF Test Client will open the service with the list of operations available.
- Double click the getCustomerNameList. It will open the operation details in the right hand side pane.
- Click the Invoke button. The result of the service will appear in the Response pane.
- Pat yourself on the back. You are finished!
//return denotes the parameter type and String specifies the type of data the collection will hold
public List getCustomerNameList()
List list = new List(Types::String);
//select all customers
while select * from custTable
//add customer name in the list