Architecture of the Microsoft Dynamics AX Retail online store [AX 2012]

Updated: April 29, 2014

Applies To: Microsoft Dynamics AX 2012 R3

The Microsoft Dynamics AX Retail online store enables you to deploy, manage, and customize an online sales channel that is fully integrated with Microsoft Dynamics AX. The online store is built on the Microsoft SharePoint Server 2013 cross-site publishing platform. Cross-site publishing uses one or more authoring site collections to author and store content, and one or more publishing site collections to control the design of the site and to show content. The authoring site collection can contain catalogs such as Pages libraries, and lists of items that are tagged with metadata. These catalogs are indexed by the search system and made available to the Publishing Portal. The Publishing Portal displays previously indexed data on web pages by using search-driven Web Parts.

This topic describes the architecture, features, and components of the Retail online store. Before you continue, we suggest that you learn about the features and architecture of SharePoint cross-site publishing. For more information, see Plan for cross-site publishing in SharePoint Server 2013 and Plan the logical architecture for cross-site publishing in SharePoint Server 2013.

This section describes the features and components of the Retail online store. Figure 1 shows the logical architecture and the flow of information between some of the features and components discussed in this section.

Online store

Figure 1 High-level architecture of the Retail online store

Dn194016.collapse_all(en-us,AX.60).gifReal-time Service

The Commerce Data Exchange: Real-time Service is a Windows Communication Foundation (WCF) service that uses .NET Business Connector to facilitate communication between Microsoft Dynamics AX Retail headquarters and the Microsoft Dynamics AX commerce runtime (CRT). In previous releases, this service was called the Retail Transaction Service. This service is installed by using Microsoft Dynamics AX Setup. For more information about this service, see Install Commerce Data Exchange: Real-time Service (Retail Transaction Service).

Dn194016.collapse_all(en-us,AX.60).gifCommerce Data Exchange: Async Server

Commerce Data Exchange: Async Server is part of the system for asynchronous data exchange between Microsoft Dynamics AX and retail channels such as the Retail online store. Async Server is installed at headquarters and communicates with Microsoft Dynamics AX. For more information, see Commerce Data Exchange: Async Server.

Dn194016.collapse_all(en-us,AX.60).gifCommerce Data Exchange: Async Client

Commerce Data Exchange: Async Client is part of the system for asynchronous data exchange between Microsoft Dynamics AX and retail channels such as the Retail online store. Async Client is installed at the channel, and communicates with the channel database. Typically, you will install one instance of Async Client for each channel. For more information, see Commerce Data Exchange: Async Client.

Dn194016.collapse_all(en-us,AX.60).gifCommerce runtime

The Microsoft Dynamics AX commerce runtime is a set of .dlls that perform business logic and data processing for an online store. The CRT has four layers (data access, services, workflow, API) and a database. For more information about the CRT, see Commerce Runtime.

Dn194016.collapse_all(en-us,AX.60).gifSearch

The Microsoft SharePoint Server 2013 cross-site publishing platform uses Microsoft FAST Search and search-driven pages to dynamically display content for customers. For more information about FAST Search in cross-site publishing, see Plan search for cross-site publishing sites in SharePoint Server 2013

Dn194016.collapse_all(en-us,AX.60).gifTerm sets

You use term sets to tag catalog content such as pages or list items on the authoring site. By doing this, terms help categorize the content into a hierarchy. These same terms are later used on the publishing site to issue queries, show information about category and catalog item pages, create friendly URLs, and for managed navigation. For more information, see Plan terms and term sets in SharePoint Server 2013.

Dn194016.collapse_all(en-us,AX.60).gifRetail online store databases

When you deploy the online store, the system creates the following databases in Microsoft SQL Server.

  • Channel database(s): The online store uses this database as a data store before pushing data into SharePoint. By default, the database is named AxRetailSP. Settings for this database are stored in the oob-topology.xml file under Settings/Channel.

  • Identity Provider database: This database stores user credentials for forms-based authentication. By default, the database is named SPFBA. Settings for this database are stored in the oob-topology.xml file under Settings/IdentityProvider.

  • Custom Claims Provider database: This database stores the mapping between a user’s identify and their Microsoft Dynamics AX customer number when the user has created an account. By default, the database is named SPAuthZ. Settings for this database are stored in the oob-topology.xml file under Settings/CustomClaimsProvider.

Figure 2 provides a detailed view of the Microsoft Dynamics AX Retail online store and SharePoint features and components.

Expanded architecture of the Retail online store

Figure 2 Detailed view of the Retail online store architecture

Microsoft Dynamics AX 2012 for Retail includes two Retail online “starter” stores. The Contoso store is modeled after a fictitious online electronics retailer. The Fabrikam store is modeled after a fictitious online clothing store. When you install the Retail online store by using Setup.exe or PowerShell, you specify which starter store to deploy in your environment. You can then customize and rebrand the starter store to meet your needs. The starter stores consist of the following site collections and controls.

Dn194016.collapse_all(en-us,AX.60).gifSite collections

The product catalog and publishing portal site collections are located in separate web applications. The product catalog content web application uses AD DS to authenticate content authors. The publishing portal web application uses AD DS authentication for designers and forms-based authentication for web users. This web application is configured to allow anonymous access for web users. The product catalog site collection contains a list of product data, including the Microsoft Dynamics AX navigational hierarchy which is stored in the SharePoint Term Store. Those lists created by the online store publishing process are shared.

Internal users such as designers and other content authors have Contribute permission level to add, update, and delete items in the asset library. The asset library is added to the Suggested Content Browser Locations list for the authoring and product catalog site collections so that content authors can use those assets in their content.The search system indexes content from the authoring site and the product catalog site collection. When a user views a page on one of the publishing sites, queries from Search Web Parts on that page are sent to the search index. Results are returned from the search index, and shown in the Search Web Parts on the page.

Figure 3 provides a detailed view of the web applications and site collections that are created on the SharePoint server when you deploy the Retail online store. Figure 3 also lists the associated classes for the applications and site collections.

Architecture of the online store site collections

Figure 3 Detailed view of the Retail online store web applications and site collections

The Microsoft Dynamics AX Connector (also named the Channel Connector) is a SharePoint service publishing job that runs in the context of the OWSTimer.exe service, which is standard SharePoint Timer Windows service. The publishing job retrieves updated product, product schema, category hierarchy information from the channel database and pushes it into the product catalog database. The information is then crawled by Search.

The Secure Token Service is a SharePoint service that is used for validating forms-based authentication users.

Dn194016.collapse_all(en-us,AX.60).gifControls

The starter online store includes the following customizable controls.

Control type

Available in starter store

Page layouts

Address edit

Associate customer

Change password

Checkout confirm

Facebook logon

Issue gift card

Logon

Loyalty

My account

Order review

Order confirm

Order history

Product details

Product gallery

Product quick view

Display templates

Contoso_Default_Item_ProductDetails

Contoso_Default_Item_ProductGallery

Contoso_Default_Item_ProductQuickView

Control_KitRetailListWithPaging

Control_ProductVariants

Control_RetailListWithCarouselPaging

Control_RetailListWithPaging

Control_RetailListWithPagingNoCrt

Fabrikam_Default_Item_ProductDetails

Fabrikam_Default_Item_ProductGallery

Fabrikam_Default_Item_ProductQuickView

Filter_RetailMultiValue

Filter_RetailMultiValue_Body

GiftCard_Item_ProductDetails

GiftCard_ProductVariants

Item_KitComponentDetails_Contoso_Default

Item_Recommended

Item_SelectComponentSubstitutesQuickView_Contoso_Default

Controls/Web parts

Shopping Cart

Mini shopping cart

Order history

Address – display, edit

Customer – display, edit

Wish List

Category landing

Welcome bar

Store product availability


Announcements: To see known issues and recent fixes, use Issue search in Microsoft Dynamics Lifecycle Services (LCS).

Community Additions

ADD
Show: