Microsoft Dynamics AX 2012 Services

Chapter 1. Getting Started with Microsoft Dynamics AX 2012 Services

Microsoft Dynamics AX 2012 introduces a lot of new features that are related to the Application Integration Framework (AIF) and services in general. Many of the existing concepts have been radically changed. This chapter unveils these new features and enhancements made to services in Microsoft Dynamics AX 2012.

At the end of this chapter, you will have a clear picture of what services are all about in the context of Microsoft Dynamics AX 2012. This should enable you to identify where and when to use services in your solution, and what type of service to use.

The following topics are covered in this chapter:

What are services and SOA?: We will start by defining what services are and what SOA has to offer, and derive from that the scenarios in which they can be used.
Architecture overview: We will look at an overview of the services and AIF architecture, and familiarize ourselves with the key components of the architecture.
What's new?: We will discuss the new features and enhancements that have been made compared to Microsoft Dynamics AX 2009. This is also an opportunity to find out why some of these changes were made.
Types of services and comparison: There are several types of services available to choose from when implementing your solution. Therefore it is important to be able to distinguish between these different types and choose the type that suits your needs best.

What are services and SOA?

So what is a service? The best way of understanding what a service is, is by understanding why you would need a service. Typically, there are a lot of different applications being used in an enterprise. Sometimes this is by design, for example, because a specialized functionality is needed that is not implemented in the ERP system. In other cases legacy systems are not replaced when implementing an ERP system, simply because they do their jobs well. Whatever the reasons, these or others, the result is the same: a growing number of different applications.

One of the problems with these applications is that they are likely to have been built using different technologies. Because they speak a different language, it makes them unable to communicate with each other. This is a problem that services address by providing a means by which applications can communicate, independent of their technology. They achieve this by adhering to standards and protocols so that in essence they start speaking the same language.

A service should have many of the same qualities as modern applications. Applications should be modular, components should be reusable, and everything should be loosely coupled. These principles also apply when developing services. Your services should have a well-defined functionality, and should be able to autonomously execute that functionality without interaction with other services.

Services should also be abstract. By this we mean that other applications should not have to know the inner workings of the provider in order to use the service.

A service is also self-describing, meaning it can provide other applications with metadata about itself. This metadata describes what operations can be used, and what the input and output is. In the case of Microsoft Dynamics AX, this information is published using the Web Service Description Language (WSDL).

All of these qualities make services usable in a Service-Oriented Architecture (SOA). In an SOA, services are published and made discoverable. Services are then composed to create loosely coupled applications.

Example implementations

To make the previous explanation about services more concrete, we will take a look at three very different scenarios in which services can be used.

Bing API

Microsoft provides an API for Bing Maps and Search that is available to developers in various ways, including a web service. Developers can use this service for things such as calculating a route between two addresses, locating an address on a map, getting search result for a certain query, and so on.

It's not hard to imagine this service being used in a logistics application, for example, to calculate the most efficient route for delivering goods to customers.

Mobile application

Let's look at a scenario where a mobile application has to be developed for Microsoft Dynamics AX 2012. Even if your mobile application contains business logic to work offline, data will have to be sent back to the Application Object Server (AOS) at some time. The mobile application could use services to execute business logic and send data to the AOS when a network is available.

A mobile application can also be built without containing business logic, in a way that it only renders a Graphical User Interface (GUI). In this scenario, the application will have to stay connected to the AOS over the network because the AOS will drive the application and tell it what to do using services.

Business Process Modeling (BPM)

You can use services in an SOA to model business processes. When all requirements for the business processes are available as services, it is possible to compose processes entirely using services. When done right, this is very powerful because of the great flexibility that the combination of BPM and SOA provides.

Architecture overview

Depending on the requirements of your projects, a different architectural approach will be needed. To make the right decisions when designing your solutions, it is important to understand the services and AIF architecture.

Compared to Microsoft Dynamics AX 2009, there have been a lot of improvements made to the service architecture in Microsoft Dynamics AX 2012. The biggest improvement is the native Windows Communications Foundation (WCF) support. As a result the proprietary Microsoft Message Queuing (MSMQ) and BizTalk adapters that were available in Microsoft Dynamics AX 2009 have been deprecated and replaced by adapters that use WCF. The file system adapter remains intact, and still allows you to import and export messages from and to the file system.

All services are WCF services and are hosted on the AOS. When an application wants to consume these services on the local network, no further deployment is needed, because it can connect directly to the AOS. Just like with Microsoft Dynamics AX 2009, deployment on Internet Information Services (IIS) is needed for consumers that are not on the intranet. However, the services themselves are no longer deployed on IIS; instead a WCF routing service on the IIS routes everything to the AOS.

If you want to modify messages before they are received or after they are sent, you can use pipelines and transformations . Pipelines only apply to the body of a message, and are handled by the request preprocessor and response postprocessor . You can use transformations to transform a complete message including the header. This allows you to exchange messages in non-XML format.

While not displayed in the diagram, there is now load balancing support for services using Windows Server Network Load Balancing (NLB). Combined with NLB for IIS that was already available, this enables high availability and load balancing for services.

What's new?

Services have been around for some time in Microsoft Dynamics AX. AIF was initially introduced with the release of Microsoft Dynamics AX 4.0 and Microsoft Dynamics AX 2009 continued to build on that. But now with the latest release of Microsoft Dynamics AX 2012, Microsoft has really succeeded in bringing the service functionality to a whole new level. Let us take a walk through the major changes that Microsoft Dynamics AX 2012 brings to the table.

AOS WCF service host

The first major feature that has been added to this release is that the AOS is now the host for the Microsoft Dynamics AX 2012 services. In previous releases, the exchange of messages was either through adapters such as the file system, BizTalk, and MSMQ adapter, or services that were exposed as WCF 3.5 services through IIS. With the latter, IIS was acting as the host for the WCF services.

With this new release of Microsoft Dynamics AX, services will be exposed as WCF 4.0 services hosted directly in the AOS Windows service. As long as intranet users and applications are consuming these services, no IIS is needed.

WCF adapters

Microsoft Dynamics AX 2012 provides a lot more support for WCF. Proprietary adapters such as the BizTalk adapter and the MSMQ adapter that were previously available, are now obsolete and no longer available. Instead, support for MSMQ and BizTalk is provided by a native WCF equivalent of these adapters.

This does not mean that creating custom adapters using the AIF adapter framework is not supported anymore. Custom adapters can still be added by implementing the AifIntegrationAdapter interface.

Out-of-the-box, Microsoft Dynamics AX 2012 comes with the following adapters:

NetTcp adapter: The NetTcp adapter is the default adapter used when creating a new integration port. This adapter type corresponds to the WCF NetTcpBinding. It provides synchronous message exchanges by using WS-* standards over the Transmission Control Protocol (TCP).
File system adapter: The file system adapter can be used for asynchronous exchange of XML messages stored in file system directories.
MSMQ adapter: The MSMQ adapter is used when support for queuing is needed. Message exchange is asynchronous and uses MSMQ. Note that choosing this adapter type actually uses the WCF NetMsmq binding.
HTTP adapter: The HTTP adapter supports synchronous message exchanges over the HTTP and HTTPS protocols. This was already available in Microsoft Dynamics AX 2009, but there is a difference in the deployment to the IIS. The business connector is no longer used for services hosted on the IIS; instead a WCF routing service is used. There is more about routing services later in this chapter.

Note

More information about the bindings that are used in these adapters can be found on MSDN at http://msdn.microsoft.com/en-us/library/ms733027.aspx. If you want to learn more about WS-* standards, check out the Web Services Specification Index Page at http://msdn.microsoft.com/en-us/library/ms951274.aspx.

Integration ports

In Microsoft Dynamics AX 2009, there was a lot of configuration required to get AIF up and running. This included configuration of the following:

Endpoints
Local endpoints
Channels
Endpoint users
Endpoint constraints

Now, integration ports have been added and they provide a simpler way of configuring services. There are two types of integration ports: inbound and outbound, depending on whether the message originates from outside or inside Microsoft Dynamics AX.

The inbound integration ports can be divided into two types: basic or enhanced. Out-of-the-box, Microsoft Dynamics AX 2012 already has some services that are associated with basic integration ports. These have been deployed and enabled by default. We will discuss how these basic ports differ from enhanced ports in later chapters.

Instead of having Microsoft Dynamics AX specific endpoints and channels, integration ports use native WCF to deploy services and therefore endpoints, security, behaviors, bindings, and so on. All of this is configured using the WCF Configuration utility. By default, integration ports are hosted on the AOS using the NetTcp binding.

IIS hosting without Business Connector

Previously, when services were deployed on IIS, they used the .NET Business Connector to communicate to the AOS. This has been replaced by a WCF routing service that implements the IRequestReplyRouter interface. Regardless of whether services are consumed from the intranet or the Internet, they are always processed by the AOS. So when services are deployed to be used on the Internet, they will be deployed both on the AOS and on the IIS. The AOS hosts the service using the NetTcp binding and the IIS has a WCF routing service that will forward service requests to the internal services hosted on the AOS.

Non-XML support

Using transformations, Microsoft Dynamics 2012 can transform inbound messages from a variety of formats into the format AIF can understand. Likewise, outbound messages can be transformed from the AIF format into the format required by external systems. There are two types of transformations that can be used: Extensible Stylesheet Language Transformations (XSLT) and .NET assemblies.

You can create XSLT transformations by using any text editor, but tools such as BizTalk MAPPER, Visual Studio, or Altova MapForce make it very easy. .NET assemblies are DLL files that can be compiled using Visual Studio and do transformations in code. This is especially convenient for transforming from or into a non-XML format. Some of the tools available can actually generate both the XSLT and the managed code needed to compile a .NET assembly.

AIF change tracking

In Microsoft Dynamics AX 2009, document services had a set of six operations available for use:

Create
Delete
Find
FindKeys
Read
Update

In Microsoft Dynamics AX 2012, there are two additional operations available for developers:

GetKeys: The GetKeys action can be used in combination with a document filter to only obtain the keys of the documents that were the result of the filter.
GetChangedKeys: The GetChangedKeys action does the same as the GetKeys operation with the addition of a date and time being passed to the action. This way only the keys of documents that have actually changed since that time are returned.

Custom services

One of the major changes in Microsoft Dynamics AX 2012 is the ease and flexibility by which you can create custom services. Instead of having to provide all the technical details on how the documents need to be serialized by implementing AifSerializable, you can now easily attribute class instance methods. These attributes are used to identify service operations and data contract members.

The SysOperation framework

Prior to Microsoft Dynamics AX 2012, the RunBase framework was used to provide a generic way of creating processes and batch jobs in the system.

In Microsoft Dynamics AX 2012, the SysOperation framework allows you to leverage the power of services to execute your business logic in Microsoft Dynamics AX. When you create a service, it encapsulates the business logic so other components within the system can use the service instead of accessing the business logic themselves.

The SysOperation framework makes use of the Model-View-Controller (MVC) pattern by using multiple components that each have their own responsibilities. These components separate the business logic from the code that is responsible for rendering the GUI and the classes that represent the data model. This is a great leap forward from Microsoft Dynamics AX 2009, where everything was written in one class that extended Runbase.

Also important to note is that when a service has been created for the SysOperation framework, it requires little effort to expose the same service to the outside world. You can simply expose it using an integration port.

So the advantages of the SysOperation framework can be summarized as follows:

It facilitates a service-oriented approach within Microsoft Dynamics AX
It implements the MVC pattern for more efficient client/server communication and separation of responsibilities
The GUI is automatically generated based on data contracts
Less extra effort in exposing business functionality externally using services

Types of services

Microsoft Dynamics AX 2012 already provides a number of services out-of-the-box. These services together with additional services that can be developed can be divided into three types. Each of the service types has its own characteristics and a different approach to create them.

Document services

Document services use documents to represent business objects such as purchase and sales orders, customers, vendors, and so on.

A document service is composed of the following components:

Document query: This is a query that is created in the Application Object Tree (AOT) and contains all the tables that are related to the business object that you want to expose. Based on this query, the Document Service Generation Wizard can be used to generate the other artifacts that make up the document service.
Table AxBC classes: An AxBC class is a wrapper for a table and contains business logic that is needed for Create, Read, Update, Delete (CRUD) operations.
Document class: The purpose of the document class is to contain business logic that is associated with the creation and modification of the business entity itself. For example, the AxdCustomer class could contain logic to handle party information of a customer.
Document service class: This is the actual service implementation class and extends the AifDocumentService class. This class implements the service operations that are published through the service contract.

When creating document services, developers need to make sure that the business object is mapped correctly to the document query. The document services framework will handle all other things such as the serialization and deserialization of XML, date effectiveness, and so on.

Document services can be deployed using the integration ports and all available adapters can be used.

Custom services

Custom services were already available in Microsoft Dynamics AX 2009, but support for Extended Data Types (EDTs) was limited, which resulted in developers having to provide custom serialization and deserialization logic.

Microsoft Dynamics AX 2012 introduces the concept of attributes. Attributes provide a way to specify metadata about classes and methods. Two of these attributes are used when creating data contracts: the DataContractAttribute and DataMemberAttribute attributes.

The DataContractAttribute attribute is used to define that a class is a data contract. The DataMemberAttribute attribute is added to methods of data contracts that represent data members that have to be exposed. This way of defining data contracts is very similar to other programming languages such as C#.

Support for more complex data types such as collections and tables has been added so that these types can be serialized and deserialized without developers having to provide the logic themselves.

In a typical custom service you will find the following components:

Service contract: A service contract is an X++ class that contains methods with the SysEntryPointAttribute attribute. This identifies methods that will result in a service operation contract when the service is exposed.
Data contracts: A data contract is an X++ class that is attributed with the DataContractAttribute attribute. It contains parameter methods that will be attributed as data members for each member variable that needs to be part of the data contract.

Custom services can be deployed using the integration ports and any available adapter can be used.

System services

These services are new since the release of Microsoft Dynamics AX 2012. The main difference between these services and the previous two types is that they are not customizable and are not mapped to a query or X++ code. They are not customizable because they are written by Microsoft in managed code. One exception is the user session service, which is written in X++ code but is generally considered as a system service.

There are three system services available for use in Microsoft Dynamics AX 2012: the query service, the metadata service, and the user session service.

Query service

The query service provides the means to run queries of the following three types:

Static queries defined in the AOT.
User-defined queries by using the QueryMetaData class in the service.
Dynamic queries that are written in X++ classes. These classes need to extend the AIFQueryBuilder class.

When queries are called by a service, the AOS authorization ensures that the caller has the correct permissions to retrieve the information. This means that unpermitted fields will be omitted from the query result. Furthermore, when joined data sources are not allowed to be used, the query call will result in an error that can be caught by the calling application.

The resulting rows will be returned as an ADO.NET DataSet object. This can be very useful when you make use of controls in your application that can be bound to a DataSet object.

The query service can be found at the following address: net.tcp://<hostname:port>/DynamicsAX/Services/QueryService

Metadata service

This system service can be used to retrieve metadata information about the AOT. Consumers of this service can get information such as which tables, classes, forms, and menu items are available in the system. An example usage of this service could be retrieving information about the AOT and using it in a dashboard application running on the Microsoft .NET Framework. We will create an example dashboard application in Chapter 7, System Services.

The metadata service can be found at the following address: net.tcp://<hostname:port>/DynamicsAX/Services/MetaDataService

User session service

The third system service is the user session service. With this service you can retrieve information about the caller's user session. This information includes the user's default company, language, preferred calendar, time zone, and currency.

The user session service can be found at the following address: net.tcp://<hostname:port>/DynamicsAX/Services/UserSessionService

The right service for the right job

Now that it is clear what types of services Microsoft Dynamics AX 2012 has to offer, the question arises as to when each type of service should be used. There is no simple answer for this due to the fact that every type has its strengths and weaknesses. Let us take a look at two factors that may help you make the right decision.

Complexity

Both document services and custom services can handle any business entity complexity. The document services framework parses the incoming XML and validates it against an XML Schema Definition (XSD) document. After validation, the framework calls the appropriate service action. Custom services on the other hand use the .NET XML Serializer and no validation of data is done. This means that any validations of the data in the data contract need to be written in code. Another advantage of document services over custom services is that the AxBC classes already contain a lot of the logic that is needed for CRUD operations.

Flexibility

Document services have service contracts that are tightly coupled with the AOT Query object. This means that when the query changes, the schema also changes. Data policies allow you to control which fields are exposed. When using custom services, this cannot be done by setup, but has to be done by attributing at design time.

Custom services have the flexibility towards the service contract that the document services are lacking. Here the developer is in full control about what is in the contract and what is not. The operations, input parameters, and return types are all the responsibility of the developer.

Another benefit in using custom services is the ability to use shared data contracts as parameters for your operations. Think of a company-wide software solution that involves the use of Microsoft Dynamics AX 2012 together with SharePoint and .NET applications that are all linked through BizTalk. You could opt to share data contracts to make sure that entities are the same for all of the components in the architecture.

In that scenario, you're able to create a data contract in managed code and reference it in Microsoft Dynamics AX 2012. Then you can use that .NET data contract in your service operations as a parameter.

There will probably be more factors that you will take into consideration to choose between the service types. But we can come to the following conclusion about when to use what type of service:

Custom services: Custom services should be used when exposing entities that have a low complexity or data contracts that need to be shared between other applications.
They are also ideal when custom logic needs to be exposed that may have nothing to do with data structures within Microsoft Dynamics AX.
Document services: Document services should be used when exposing entities that have a high complexity and when validation of the data and structure would require a lot of work for developers to implement on their own.
Query service: The query service should be used when only read operations are needed and there is no need for updates, inserts, or delete actions.
It can be used when writing .NET Framework applications that leverage the data from Microsoft Dynamics AX returned as an ADO.NET DataSet.
Metadata service: Use the metadata service when metadata information about objects in the AOT is required.
User session service: The user session service should be used when user session-related information is required.

Filter reviews by

All

Amazon verified reviews

Michael Fruergaard Pontoppidan Jan 22, 2013

A new development book has been published by Packt.If you are developing with Dynamics AX 2012, you'll need this book. For two reasons. Firstly, as you'll need to deal with services. Secondly, because it is a great book.The book is 200 pages, and it does a great job of explaining how to build and how to consume services.I think the book is great for several reasons:*It is technical. The level of contents and technical depth is comparable to Inside Dynamics AX 2012.*It is unique. The contents is written for this book. You will not find it anywhere else.*It is self-contained. Whenever a concept is used, it will be explained - even when it is not directly related to services. So be prepared for excursions to the lands of CIL, WCF, Runbase, AX Security, Visual Studio, UI builders etc.*It is actionable. Each chapter shows step-by-step, line-by-line what to do in various scenarios. Urging you to try it out yourselves.*It is opinionated. I'm not sure how they managed, but the book somehow captures the atmosphere we had when building AX 2012 - we knew we were on to something special. The book deals out appraisals where due, and explains why AX 2012 is a huge leap forward for services.*It is jovial. The tone in the book is welcoming and direct - I think the most used word is "you". This is quite refreshing for a technical book.A big "Thank You!" to the team behind the book for increasing the AX community's knowledge: Klaas Deforche, Kenny Saelen, Palle Agermark, José Antonio Estevan and Tom Van Dyck.

Amazon Verified review

Pedro Rodriguez Parra Feb 25, 2013

Services development ist each day more important and Microsoft Dynamics Ax 2012 offers between a lot of new technological improvement a quite good services framework which you should learn and master.This book is quite good for that because is quite short but just deliver what you need to know about Dynamics Ax 2012 Services. After reading it you will know all the possibilities that Ax offers you to develop and use services.After reading this book I would consider to read also the official trainning manuals 80416 for Application Integration Framework and you will be the services boss! :-)

Jose Antonio Estevan Estevan Feb 25, 2013

This is a small book but full of useful information. Services are a very important part of the standard framework of Microsoft Dynamics AX and it will become mandatory to make use of them for ampliation and comunication of developments over the standard.This books cover all the perspectives around services, including examples of using standard services to publish information out of AX and internally consuming external services from AX and making full use of the new standard SysOperationFramework, including theoric basis of services, full setup of the whole process, using the standard wizards to easilly setup the first versions, full examples of X++ and .NET code, etc.The book easily but fully covers an important feature of this new AX 2012 version that is not covered on other books at the moment. So, it's well worth to make it part of your technical library.

Amazon customer Feb 24, 2013

I read this book on the plane flying to my AX consulting gigs. I previously read Microsoft's materials about AIF and should say that this book is a great supplement to them. The book is written much better, gives great examples and covers most of the real-world scenarios of AIF usage. I highly recommend it to all AX developers.

Kindle Customer Feb 25, 2013

I'm an AX Developer, and I find Packt publishing's Dynamics AX books are great for some extra study while on the weekly commute to/from London. Have just started this book, but so far have enjoyed reading a good overview about the services in this new release of the product - not to fluffy and theoretical, but not necessarily complicated or techie either - just right!

Microsoft Dynamics AX 2012 Services: Everything you need to know about implementing services with Microsoft Dynamics AX 2012 is contained in this hands-on guide. Easy to follow and totally practical, it's a must for both new and experienced AX Dynamics developers.

What do you get with Print?

Contact Details

Shipping Address

Billing Address

Example implementations

Bing API

Mobile application

Business Process Modeling (BPM)

Architecture overview

Query service

Metadata service

User session service

Complexity

Flexibility

Key benefits

Description

Who is this book for?

What you will learn

Product Details

What do you get with Print?

Contact Details

Shipping Address

Billing Address

Product Details

Packt Subscriptions

Frequently bought together

Table of Contents

Recommendations for you

Customer reviews

Filter reviews by

People who bought this also bought

About the authors

FAQs