You are on page 1of 330

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Corporation
Published: May 2014

Note:
Some of the information in this guide applies only to Microsoft Dynamics AX 2012 R3
installations, and some information applies only to AX 2012 R2, AX 2012 Feature Pack or AX 2012.
Unless otherwise noted in this guide, all other content applies to AX 2012 R3, AX 2012 R2, AX
2012 Feature Pack, and AX 2012.

Microsoft Dynamics AX
Microsoft Dynamics is a line of integrated, adaptable business management solutions that enables you
and your people to make business decisions with greater confidence. Microsoft Dynamics works like and
with familiar Microsoft software, automating and streamlining financial, customer relationship, and supply
chain processes in a way that helps you drive business success.
U.S. and Canada Toll Free 1-888-477-7989
Worldwide +1-701-281-6500
www.microsoft.com/dynamics
This document is provided "as-is." Information and views expressed in this document, including URL and
other Internet Web site references, may change without notice. You bear the risk of using it.
Some examples are for illustration only and are fictitious. No real association is intended or inferred.
This document does not provide you with any legal rights to any intellectual property in any Microsoft
product. You may copy and use this document for your internal, reference purposes.
Copyright 2014 Microsoft. All rights reserved.
Microsoft, Microsoft Dynamics, the Microsoft Dynamics logo, Active Directory, Excel, MSDN, SharePoint,
SQL Server, Visual Studio, Windows, Windows PowerShell, Windows Server, and Windows Vista are
trademarks of the Microsoft group of companies. All other trademarks are property of their respective
owners.

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX

Table of Contents
Plan the base topology of Microsoft Dynamics AX ................................................................................................................ 7
Servers in the Microsoft Dynamics AX environment ......................................................................................................... 7
Sample deployment scenarios .................................................................................................................................................... 9
Single-server deployment ........................................................................................................................................................ 9
Small-scale deployment ............................................................................................................................................................ 9
Large-scale deployment ......................................................................................................................................................... 11
AOS topology ................................................................................................................................................................................. 13
AOS clusters without a dedicated load balancer ......................................................................................................... 13
AOS clusters with a dedicated load balancer ................................................................................................................ 14
SQL Server topology recommendations for availability and performance ............................................................ 16
Overview of the installation........................................................................................................................................................... 19
Microsoft Dynamics AX components .................................................................................................................................... 19
Installation types ........................................................................................................................................................................... 28
Before you begin ............................................................................................................................................................................... 29
Pre-installation checklist ............................................................................................................................................................ 29
Create service accounts .............................................................................................................................................................. 30
Create a shared directory for installation ............................................................................................................................ 37
Include cumulative updates and hotfixes in a new installation (slipstreaming) .................................................. 38
Verify that you have the required permissions for installation ................................................................................... 40
Check prerequisites ...................................................................................................................................................................... 43
Install the databases ......................................................................................................................................................................... 45
Configure SQL Server and storage settings ....................................................................................................................... 45
Install the Microsoft Dynamics AX databases .................................................................................................................... 52
Install server and web server components .............................................................................................................................. 60
Install an Application Object Server (AOS) instance ....................................................................................................... 60
Install an AOS instance ........................................................................................................................................................... 60
Install multiple AOS instances ............................................................................................................................................. 64
Install Enterprise Portal ............................................................................................................................................................... 65
Checklists for deploying Enterprise Portal sites............................................................................................................ 65
Checklist: Deploy an internal Enterprise Portal site that has Role Centers.................................................... 65
Checklist: Deploy an employee self-service portal ................................................................................................. 66
Checklist: Deploy an unsolicited vendor portal ........................................................................................................ 67
Checklist: Deploy a vendor registration portal ......................................................................................................... 68
Install Enterprise Portal on a single server ...................................................................................................................... 69
Deploy Enterprise Portal in a server farm ....................................................................................................................... 73
Install and configure Windows AppFabric for Enterprise Portal ........................................................................ 73
Install Enterprise Portal in a Web farm ............................................................................................................................. 85

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX
Deploy a claims-mode Enterprise Portal site ................................................................................................................. 92
Deploy an Enterprise Portal site that uses forms-based authentication ........................................................ 92
Deploy an Enterprise Portal site that uses AD FS authentication ................................................................... 106
Deploy Enterprise Portal for vendor registration with Windows Azure Active Directory Access
Control ................................................................................................................................................................................ 121
Install Enterprise Portal in a traditional perimeter network ................................................................................... 137
Install Enterprise Portal Help content ............................................................................................................................. 148
Install multiple Enterprise Portals on the same server ............................................................................................. 149
Set up Enterprise Portal and Role Centers.................................................................................................................... 151
Deploy Microsoft Dynamics AX Web parts to a SharePoint site ......................................................................... 151
Install Search ................................................................................................................................................................................. 153
Checklist: Deploy Microsoft Dynamics AX Enterprise Search ............................................................................... 153
Install and configure Search prerequisites ................................................................................................................... 154
Configure the Search Crawler account ........................................................................................................................... 156
Configure SharePoint Services logging ......................................................................................................................... 156
Install Microsoft Dynamics AX Enterprise Search ...................................................................................................... 157
Install Enterprise Search on FAST Search Server ........................................................................................................ 160
Configure Enterprise Search by using the Search Configuration wizard .......................................................... 165
Install help server ........................................................................................................................................................................ 167
Before you install the help server ..................................................................................................................................... 167
Install the help server ............................................................................................................................................................ 168
Install Help content at an alternative location ............................................................................................................ 170
Install business intelligence components .............................................................................................................................. 172
Install Reporting Services extensions for Microsoft Dynamics AX .......................................................................... 172
Checklist: Install the Reporting Services extensions and deploy reports ......................................................... 172
Before you install the Reporting Services extensions .............................................................................................. 173
Install the Reporting Services extensions ...................................................................................................................... 178
Complete the Reporting Services integration ............................................................................................................. 180
Create a document library to store reports ............................................................................................................. 180
Deploy the default reports ............................................................................................................................................. 182
Grant users access to reports ........................................................................................................................................ 184
Configure Analysis Services .................................................................................................................................................... 186
Checklist: Configure Analysis Services and deploy cubes ...................................................................................... 186
Before you configure Analysis Services ......................................................................................................................... 187
Configure Analysis Services by running Setup ............................................................................................................ 188
Complete the Analysis Services integration process ................................................................................................ 190
Install Management Reporter components .......................................................................................................................... 191
Install Management Reporter server components ........................................................................................................ 191
Install Report Designer for Management Reporter ....................................................................................................... 193
Install client components ............................................................................................................................................................. 195
Install the Microsoft Dynamics AX client ........................................................................................................................... 195
Install a client ............................................................................................................................................................................ 195
Configure clients to use a shared configuration ........................................................................................................ 197
Configure clients to access data in a partition ............................................................................................................ 199

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX
Install Office Add-ins ................................................................................................................................................................. 201
Install Remote Desktop Services integration ................................................................................................................... 203
Install developer tools ................................................................................................................................................................... 204
Install the debugger ................................................................................................................................................................... 204
Install Visual Studio Tools ........................................................................................................................................................ 205
Install the Trace Parser .............................................................................................................................................................. 207
Install integration components .................................................................................................................................................. 209
Install web services on IIS ........................................................................................................................................................ 209
Install the .NET Business Connector .................................................................................................................................... 213
Install the synchronization proxy for Microsoft Project Server ................................................................................. 215
Install the synchronization service for Microsoft Project Server .............................................................................. 217
Install management utilities ........................................................................................................................................................ 219
Install retail components .............................................................................................................................................................. 221
Deployment topologies for Retail ........................................................................................................................................ 222
Install Retail headquarters ....................................................................................................................................................... 227
Install Commerce Data Exchange: Real-time Service (Retail Transaction Service) ............................................ 228
Install Retail POS (point of sale) ............................................................................................................................................ 238
Install Modern POS..................................................................................................................................................................... 240
Install a retail channel database ............................................................................................................................................ 242
Install Commerce Data Exchange: Synch Service (Retail Store Connect) ............................................................. 245
Install Commerce Data Exchange: Async Server ............................................................................................................. 247
Install Commerce Data Exchange: Async Client .............................................................................................................. 253
Install the Retail Channel Configuration Utility (Retail Store Database Utility) .................................................. 259
Install Retail Server ..................................................................................................................................................................... 261
Install Retail Hardware Station............................................................................................................................................... 267
Install a Microsoft Dynamics AX Retail online store (e-commerce) ........................................................................ 272
Install retail mass deployment toolkit ................................................................................................................................. 295
Install Retail SDK (Retail POS Plug-ins) .............................................................................................................................. 297
Install Retail Essentials at headquarters ............................................................................................................................. 298
Install Retail Essentials at the store or at the point of sale ......................................................................................... 304
Install the RapidStart Connector ............................................................................................................................................... 307
Install Warehouse Mobile Devices Portal .............................................................................................................................. 309
Install the VSS writer for Microsoft Dynamics AX ............................................................................................................... 312
Install Connector for Microsoft Dynamics ............................................................................................................................. 315
Install the Data import/export framework (DIXF, DMF) ................................................................................................... 317
Perform a single-computer installation of Microsoft Dynamics AX ............................................................................ 320
Perform a single-computer installation ............................................................................................................................. 320
Considerations for installing multiple instances on a computer.............................................................................. 321
Install Microsoft Dynamics AX in silent mode ..................................................................................................................... 323

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX
Run Setup in silent mode ......................................................................................................................................................... 323
Firewall settings for Microsoft Dynamics AX components ............................................................................................. 325
Troubleshoot the installation...................................................................................................................................................... 330

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX

Plan the base topology of Microsoft Dynamics AX


Before you install Microsoft Dynamics AX, you should determine the arrangement of computers, or the
topology, that you will use in your implementation. This part of the documentation describes the types of
servers that are required in a Microsoft Dynamics AX implementation. It also describes typical singleserver, small-scale, and large-scale Microsoft Dynamics AX deployment scenarios. This documentation
also explains topology options for the availability and performance of the core components of Microsoft
Dynamics AX: Application Object Server (AOS) and Microsoft SQL Server.
The following topics are included in this section:

Servers in the Microsoft Dynamics AX environment

Sample deployment scenarios

AOS topology

SQL Server topology recommendations for availability and performance

Servers in the Microsoft Dynamics AX environment


A production deployment of Microsoft Dynamics AX requires multiple servers. This topic describes the
types of server that may be required in your implementation.

Servers in a minimum installation of Microsoft Dynamics AX


A minimum installation of Microsoft Dynamics AX consists of a business database, a model store, an
instance of Application Object Server (AOS), and at least one client. These components can be installed on
computers that are arranged in various topologies, but the system does not run unless all elements are
installed.

Application Object Server


An AOS server is a computer that runs the AOS Windows service. The AOS service controls
communications among Microsoft Dynamics AX clients, databases, and applications. You can install the
AOS on a single computer, or you can create a server cluster for load balancing.

Database server
A Microsoft SQL Server database server hosts the database that stores Microsoft Dynamics AX transaction
data. The database server also hosts the model store, which is the database that stores application
elements. These application elements include customizations.
Note:
In Microsoft Dynamics AX 2012 R3 and AX 2012 R2, the model store and the business data are
stored in separate databases. In earlier versions of AX 2012, the model store and business data
are stored in a single database.

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX

Servers in a complete installation of Microsoft Dynamics AX


For some Microsoft Dynamics AX functionality, you must have one or more of the following additional
servers.

Report server
A report server is a server that runs Microsoft SQL Server Reporting Services. Reporting Services is a
server-based solution that lets users create and publish both traditional, paper-based reports and
interactive, web-based reports.
For more information about how to set up a report server, see Install Reporting Services extensions for
Microsoft Dynamics AX.

Analysis server
An analysis server enhances the reporting functionality in Microsoft Dynamics AX by linking to Microsoft
SQL Server Analysis Services. An analysis server provides enhanced support for online analytical
processing (OLAP).
For more information about how to set up an analysis server, see Configure Analysis Services.

Web server
A web server hosts the websites that are required for some Microsoft Dynamics AX features. These
features include Enterprise Portal for Microsoft Dynamics AX, Help server, Enterprise Search, Warehouse
Mobile Devices Portal, web services on IIS, and the Retail online store.

Other servers in the environment


The following servers are typically found in infrastructures that run Microsoft Dynamics AX. This
documentation provides information about how to use Microsoft Dynamics AX together with these
servers. For information about how to install and set up these servers, see the documentation for each
server.

Domain controller
A domain controller in an Active Directory network manages user logons and access to network and
shared resources.

Messaging server
A messaging server enables email messages and instant messages to be sent and received. Microsoft
Dynamics AX can use email to send alerts to users. Microsoft Dynamics AX requires that the messaging
server support SMTP.

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX

Sample deployment scenarios


This section describes sample deployment scenarios for Microsoft Dynamics AX. The scenarios range from
a single-server deployment to a large-scale, distributed deployment. The scenarios are provided to help
you understand requirements for the infrastructure and servers. These scenarios do not provide any
guidelines for infrastructure sizing.
The following topics are included in this section:

Single-server deployment

Small-scale deployment

Large-scale deployment

Single-server deployment
A single-server deployment occurs when you deploy all the Microsoft Dynamics AX components on a
single computer. We recommend that you consider a single-server deployment only for development or
demonstration environments.
You must make sure that the single-server deployment fits in with your overall strategy for IT
infrastructure and development. Carefully consider the hardware and software that are required for the
single-server deployment to guarantee appropriate response times for your developers. For the current
hardware and software requirements for Microsoft Dynamics AX, download Microsoft Dynamics AX 2012
System Requirements from the Microsoft Download Center
(http://go.microsoft.com/fwlink/?LinkID=195222).

Small-scale deployment
The topology for a small-scale deployment of Microsoft Dynamics AX expands on the topology for a
single-server deployment that is described in Single-server deployment.
This topology does not offer scalability or high availability. Scalability and high availability are introduced
in the large-scale topology that is described in the Large-scale deployment topic. This topology is suitable
as a test environment and for training purposes.

Microsoft Dynamics AX 2012 Installation Guide

Microsoft Dynamics AX
The following diagram shows a sample topology for a small-scale deployment.
Small-scale deployment topology

The following list describes how the computers in this sample topology are used:

An Active Directory domain controller is required to deploy Microsoft Dynamics AX components.

Windows clients for Microsoft Dynamics AX that connect over a wide area network (WAN) are
configured to use Terminal Services to communicate with Application Object Server (AOS). Windows
clients on the local area network (LAN) are configured to communicate with AOS directly.

AOS is deployed on a single-server computer. AOS can host the following components:

Workflow

Services and Application Integration Framework (AIF)

External applications use services and AIF to exchange data with Microsoft Dynamics AX.

A web server can host the following components:

Search server

Enterprise Portal for Microsoft Dynamics AX

Web services on IIS

Microsoft Project Server

The server that runs Microsoft SQL Server can host the following components:

Microsoft Dynamics AX online transaction processing (OLTP) database

Model files in the OLTP database

Microsoft SQL Server Analysis Services (SSAS)

Microsoft Dynamics AX 2012 Installation Guide

10

Microsoft Dynamics AX

Microsoft SQL Server Reporting Services (SSRS)

Large-scale deployment
The sample topology for a large-scale deployment of Microsoft Dynamics AX focuses on high availability.
To achieve high availability, the topology includes load-balancing server clusters for the application
servers and failover server clusters for the database server.

Topology diagram
The following diagram shows the sample topology for a large-scale deployment.
Large-scale deployment

This diagram shows a layered topology that helps provide security through the strategic placement of
firewalls and the use of a perimeter network. A perimeter network, which is also known as a demilitarized
zone (DMZ) or a screened subnet, prevents external users from directly accessing the corporate intranet.
Inside the corporate intranet, servers are divided among the following layers:

An applications layer, which contains servers that specialize in serving information to clients.

Microsoft Dynamics AX 2012 Installation Guide

11

Microsoft Dynamics AX

A database and platform layer, which contains servers that specialize in storing information that can
be retrieved by servers in the applications layer. This layer also contains servers that provide
company-wide administrative and security functions, such as directory servers and mail servers.

Microsoft Dynamics AX Windows clients that connect over a wide area network (WAN) are configured to
use Terminal Services to communicate with Application Object Server (AOS). Microsoft Dynamics
AX Windows clients on the local area network (LAN) are configured to communicate with AOS directly.

Perimeter network
The perimeter network provides external users access to Microsoft Dynamics AX functionality through the
following types of server clusters:

A Terminal Services cluster provides virtual private network (VPN) access to authorized users.

An Internet Information Services (IIS) cluster provides access to services through the Web services on
IIS feature for Microsoft Dynamics AX.

An IIS cluster is dedicated to Enterprise Portal for Microsoft Dynamics AX (EP).

Applications layer
The applications layer contains servers that provide information both to internal clients and to external
clients that access Microsoft Dynamics AX through the perimeter network. This layer contains the
following servers:
1.

A single AOS cluster supports clients and application components. You can configure one or more
AOS instances in the cluster to act as batch servers. The AOS cluster natively provides functionality for
services and Application Integration Framework (AIF), Workflow, and batch processing tasks. This
cluster typically uses Network Load Balancing (NLB) to distribute the workload among the AOS
instances.

2.

A cluster of integration servers connects to pre-existing systems.

3.

Dedicated servers provide internal clients access to Enterprise Portal, Microsoft Dynamics AX Help
Server, Search Server, and Microsoft Project Server.

Database and platform layer


The database and platform layer contains the following servers:

A Microsoft SQL Server failover cluster contains the Microsoft Dynamics AX database. This cluster may
support additional database requirements. For example, the cluster may host the database that is
required for Microsoft SharePoint 2010 products.
Note:
You must determine whether additional database clusters are required, based on the
expected workload.

A second SQL Server failover cluster is dedicated to Microsoft SQL Server Analysis Services and
Microsoft SQL Server Reporting Services.

All data is backed up through a storage area network (SAN).

System Center Operations Manager (SCOM) enables monitoring for the whole system.

An Active Directory domain controller is required to deploy Microsoft Dynamics AX components.

Microsoft Dynamics AX 2012 Installation Guide

12

Microsoft Dynamics AX

AOS topology
An Application Object Server (AOS) instance is a core component of your Microsoft Dynamics AX
installation and is installed by using Setup. An AOS instance enforces security, manages connections
between clients and the database, and provides the foundation where Microsoft Dynamics AX business
logic runs. The topics in this section describe the various roles in which AOS can function.

AOS clusters without a dedicated load balancer

AOS clusters with a dedicated load balancer

AOS clusters without a dedicated load balancer


You can configure Microsoft Dynamics AX Application Object Server (AOS) clusters that include a
dedicated load balancer. You can also configure clusters that do not include a dedicated load balancer.
This topic describes planning considerations for an AOS cluster that does not include a dedicated load
balancer.

Overview
The following figure shows how a client establishes a connection with an AOS instance in a cluster when a
dedicated load balancer is not present.
1.

When a Microsoft Dynamics AX client starts, the client reads the list of AOS instances that is specified
in the Microsoft Dynamics AX 2012 Configuration utility. The client initiates a handshake with the first
AOS instance in the list. If the first AOS instance does not respond, the client initiates a handshake
with the next AOS instance in the list. The client continues in this manner until the handshake occurs.

2.

The AOS instance that received the client request queries the database and all active AOS instances in
the cluster. The AOS instance returns to the client a list of all active AOS instances in the cluster,
sorted by workload. The server that has the smallest workload is at the top of the list. The workload is
based on the number of connected clients, divided by the maximum number of clients that are
allowed on the server.

3.

The client attempts to connect to each AOS instance in the sorted list until a successful connection is
established. The client then uses the AOS instance that it connected to for the whole session.

Microsoft Dynamics AX 2012 Installation Guide

13

Microsoft Dynamics AX

Considerations for using an AOS instance in a cluster that does not include a
dedicated load balancer

If a dedicated load balancer is not present, each AOS instance in the cluster functions as both an
active AOS instance and a load balancer.

An active AOS instance has higher hardware requirements than an AOS instance that functions as
a dedicated load balancer.

For information about how to configure load balancing clusters, see Create a load balancing cluster
(http://technet.microsoft.com/library/b070501d-cf46-49fb-8168-785259178d27(AX.60).aspx).

AOS clusters with a dedicated load balancer


You can configure Microsoft Dynamics AX Application Object Server (AOS) clusters that include a
dedicated load balancer. You can also configure clusters that do not include a dedicated load balancer.
This topic describes planning considerations for an AOS cluster that includes a dedicated load balancer.

Overview
The following figure shows how a client establishes a connection with an AOS instance in a cluster when a
dedicated load balancer is present.
1.

When a Microsoft Dynamics AX client starts, the client reads the list of active AOS instances that is
specified in the Microsoft Dynamics AX 2012 Configuration utility. The client initiates a handshake

Microsoft Dynamics AX 2012 Installation Guide

14

Microsoft Dynamics AX
with the first AOS instance in the list. In this scenario, the administrator has configured the first AOS
instance as a dedicated load balancer.
2.

The load balancing AOS instance that received the client request queries the database and all active
AOS instances in the cluster. The AOS instance returns to the client a list of all active AOS instances in
the cluster, sorted by workload. The server that has the smallest workload is at the top of the list. The
workload is based on the number of connected clients, divided by the maximum number of clients
that are allowed on the server.

3.

The client attempts to connect to each AOS instance in the sorted list until a successful connection is
established. The client then uses the AOS instance that it connected to for the whole session.

Considerations for using an AOS instance as a dedicated load balancer

An AOS instance that is configured as a load balancer does not accept any client connections as either
an application server or a batch server. This AOS instance functions only as a load balancer.

A dedicated load balancer can be used only for remote procedure call (RPC) connections. To balance
the load of connections for Application Integration Framework (AIF) and services, you must use
Microsoft Network Load Balancing (NLB). For more information, see Configuring network load
balancing for services (http://technet.microsoft.com/library/9ecde78e-7da2-4677-b9a217f3e7fe16aa(AX.60).aspx).

An AOS instance that is configured as a load balancer does not require an AOS license, because the
server does not provide any application services to the clients.

Microsoft Dynamics AX 2012 Installation Guide

15

Microsoft Dynamics AX

If you configure an AOS instance as a dedicated load balancer, you do not have to update client
configurations when AOS instances are added to or removed from the cluster.

A dedicated load balancer has lower hardware requirements than an AOS instance that functions as
an application server, because the load balancer does not process application requests or business
logic.

You can configure multiple AOS instances to function as dedicated load balancers. However, you must
make sure that dedicated load balancers appear first in the list of active servers in the client
configuration.

For information about how to configure load balancing clusters, see Create a load balancing cluster
(http://technet.microsoft.com/library/b070501d-cf46-49fb-8168-785259178d27(AX.60).aspx).

SQL Server topology recommendations for availability


and performance
The choice topology of the Microsoft SQL Server environment that supports Microsoft Dynamics AX is
driven primarily by requirements for availability and performance.

General topology recommendations


We recommend the following guidelines as a baseline for your topology:

Follow the documented best practices for SQL Server.

Use a dedicated server that is running SQL Server 2012, SQL Server 2008 R2 or SQL Server 2008.

Use a single instance of SQL Server that is dedicated to running the Microsoft Dynamics AX
production database.

Store your test and development databases on a separate server from the production database.

Availability recommendations
SQL Server provides several options that can help you achieve high availability: Windows Server Failover
Clustering, SQL Server database mirroring, SQL Server log shipping, and SQL Server 2012 AlwaysOn
Availability Groups. Of these options, failover clustering and availability groups provide the least amount
of downtime. However, replication, database mirroring, log shipping, and availability groups can satisfy
other requirements. For example, some of these options can be used to provide a reporting environment
that can reduce the load on your production server. The high availability option that you select for your
implementation of Microsoft Dynamics AX depends on your availability requirements, a cost/benefit
analysis, and the risk tolerance of your organization.
Important:
Before you select a high availability option for SQL Server, we strongly recommend that you
contact your value-added reseller (VAR) or Microsoft Support to make sure that the option that
you want to use is supported.
Determine and document your availability needs carefully, and test the solution that you select to make
sure that it provides the expected availability. The following table lists supported high availability
configurations.

Microsoft Dynamics AX 2012 Installation Guide

16

Microsoft Dynamics AX

High availability configuration

Support status

Windows Server Failover Clustering (WSFC)

Supported

Log shipping

Supported

Transactional replication

Supported. Requires KB 2765281.

Snapshot replication

Supported

Database mirroring

Supported

Merge replication

Not supported, because complex resolution is required to


guarantee data integrity

SQL Server 2012 AlwaysOn Availability groups

Supported. Both synchronous and asynchronous secondary


configurations are supported.

If you are running SQL Server 2012, we recommend that you deploy AlwaysOn Availability Groups.
If you are running SQL Server 2008, we recommend that you deploy a Windows Server Failover Cluster
with one active node and one inactive node.
Availability groups and failover clusters do not require a restart of the Application Object Server (AOS)
service.
The following figure shows a SQL Server failover topology.

When you use SQL Server failover clustering, note the following behavior:

The failover is transparent to AOS, and the service typically does not require a restart.

In-process transactions are rolled back, and the user may have to reenter data that was being
entered at the time of failure.

Note:
We recommend that a failover cluster be configured so the active node will fail over to an inactive
node. If the active node fails over to another active node in the cluster, you must make sure there

Microsoft Dynamics AX 2012 Installation Guide

17

Microsoft Dynamics AX
is sufficient capacity to sustain the Microsoft Dynamics AX database workload, otherwise
performance may be degraded significantly.
Caution:
Microsoft SQL Server Reporting Services cannot be installed on a failover cluster, because you
cannot run the Reporting Services service as part of a failover cluster. However, you can install the
report server database on a computer that has a failover cluster installed.
For more information about availability options, see:

Getting started with SQL Server 2008 R2 Failover Clustering


(http://go.microsoft.com/fwlink/?LinkId=216763)

Windows Server Failover Clustering (WSFC) with SQL Server (http://technet.microsoft.com/enus/library/hh270278.aspx)

Database mirroring (http://go.microsoft.com/fwlink/?LinkId=216767)

Log shipping (http://go.microsoft.com/fwlink/?LinkId=216765)

Transactional replication (http://go.microsoft.com/fwlink/?LinkId=216768)

Snapshot replication (http://go.microsoft.com/fwlink/?LinkId=216769)

Host a Report Server Database in a SQL Server Failover Cluster (http://technet.microsoft.com/enus/library/bb630402.aspx)

Performance recommendations
The performance of the database can significantly affect overall Microsoft Dynamics AX performance.
To achieve the best performance, the SQL Server environment and storage subsystem must be correctly
configured. For more information, see Configure SQL Server and storage settings.

Microsoft Dynamics AX 2012 Installation Guide

18

Microsoft Dynamics AX

Overview of the installation


This section provides an overview of the components that you can install by using the Setup wizard. It also
describes the installation types that are available in Setup. The following topics are included:

Microsoft Dynamics AX components

Installation types

For information about new installation features in Microsoft Dynamics AX 2012, see What's new:
Installation (http://technet.microsoft.com/library/21756ba4-0bc4-44ee-8f95-686d9a5c158c(AX.60).aspx).

Microsoft Dynamics AX components


This topic describes the components of Microsoft Dynamics AX that you can install by using the Setup
wizard.

Databases
Databases include the Microsoft Dynamics AX database, the model store, and the baseline database. The
AOS connects to the Microsoft Dynamics AX database to process transactions. The AOS connects to the
model store to display application elements such as forms and reports. The baseline database contains a
model store that is used to upgrade X++ code to Microsoft Dynamics AX 2012. The baseline database is
used to analyze application updates before they are applied.
Note:
In Microsoft Dynamics AX 2012 R3 and Microsoft Dynamics AX 2012 R2, the model store and the
business data are stored in separate databases. In earlier versions of Microsoft Dynamics AX 2012,
the model store and business data are stored in a single database.
For information about how to install the databases, see Install the Microsoft Dynamics AX databases.
Other Microsoft Dynamics AX components, such as Enterprise Portal and Reporting Services extensions,
also include databases. The additional databases are created when you install those components and their
prerequisites. They are not installed as part of the Microsoft Dynamics AX databases component.

Server components
Server components include AOS and the Microsoft Dynamics AX components that run on Internet
Information Services (IIS). For information about how to install one of the server components, click the
corresponding link in the following table.
Component

Description

More information

Application Object Server (AOS)

The AOS service controls

Install an Application Object Server

communications among Microsoft

(AOS) instance

Dynamics AX clients, databases, and


applications.

Microsoft Dynamics AX 2012 Installation Guide

19

Microsoft Dynamics AX

Component

Description

More information

Enterprise Portal for Microsoft

Enterprise Portal is a SharePoint site

Install Enterprise Portal

Dynamics AX (web server)

that lets trusted users access Microsoft


Dynamics AX data and functionality.
Anonymous users can access only
limited functionality, such as catalog
information and questionnaires.

Enterprise Search (web server)

Enterprise Search lets client users and

Install Search

Enterprise Portal users search for data,


forms, and reports in Microsoft
Dynamics AX by entering simple search
terms. Enterprise Search uses Microsoft
Search Server Express or SharePoint
Server and the Business Data
Connectivity Service (BCS).
Help Server (web server)

Help server is an IIS web site that stores

Install help server

Help documentation that is used in


Microsoft Dynamics AX. Help server
simplifies the task of updating and
customizing Help.

Business intelligence components


Business intelligence components provide reporting and analytical functionality that you can use to view
and interpret business data. For information about how to install one of the business intelligence
components, click the corresponding link in the following table.
Component

Description

More information

Reporting Services extensions

Integration with Microsoft SQL Server

Install Reporting Services extensions

Reporting Services lets you create

for Microsoft Dynamics AX

reports by using Reporting Services.


Analysis Services configuration

Integration with Microsoft SQL Server

Configure Analysis Services by

Analysis Services lets you use cubes for

running Setup

business intelligence and analytical


reporting in Microsoft Dynamics AX.

Microsoft Dynamics AX 2012 Installation Guide

20

Microsoft Dynamics AX

Management Reporter components


Management Reporter for Microsoft Dynamics ERP is the recommended financial reporting solution for
Microsoft Dynamics AX 2012. For information about how to install one of the Management Reporter
components, click the corresponding link in the following table.
Note:
Management Reporter components are available in the Setup wizard in AX 2012 R3 and
cumulative update 7 for Microsoft Dynamics AX 2012 R2.
Component

Description

More information

Management Reporter for

Use Management Reporter to create,

Install Management Reporter server

Microsoft Dynamics ERP

distribute, and analyze financial

components

statements and other financial reports.


Report Designer for Management

Report Designer is a component of

Install Report Designer for

Reporter

Management Reporter that is used to

Management Reporter

create the building blocks that define a


report.

Client components
Client components give users access to Microsoft Dynamics AX data and functionality. For information
about how to install one of the client components, click the corresponding link in the following table.
Component

Description

More information

Microsoft Dynamics AX Windows

The Microsoft Dynamics AX client is an

Install the Microsoft Dynamics AX

client

interface to Microsoft Dynamics AX data

client

and functionality.
Microsoft Office Add-ins

Use the Office Add-ins to integrate the

Install Office Add-ins

Microsoft Dynamics AX client with


Microsoft Excel or Microsoft Word.
In Microsoft Dynamics AX 2012 R3 and
cumulative update 7 for Microsoft
Dynamics AX 2012 R2, the Microsoft
Project client add-in is included with the
Office Add-ins. With the Microsoft
Project client add-in, users can take
advantage of features in both Microsoft
Dynamics AX and Microsoft Project to
manage a project.

Microsoft Dynamics AX 2012 Installation Guide

21

Microsoft Dynamics AX

Component

Description

More information

Remote Desktop Services

The Remote Desktop Services

Install Remote Desktop Services

integration

integration components support

integration

integration with local applications, such


as Microsoft Word and Microsoft Excel,
when Microsoft Dynamics AX is hosted
on a Remote Desktop server.

Developer tools
Developer tools are used to customize Microsoft Dynamics AX. For example, you can create
customizations or extensions to Enterprise Portal, or you can create advanced production reports for
Microsoft Dynamics AX by using Reporting Services. For information about how to install one of the
developer tools, click the corresponding link in the following table.
Component

Description

More information

Debugger

The debugger tool provides debugging

Install the debugger

capabilities for X++ developers.


Visual Studio Tools

Visual Studio Tools integrate the development

Install Visual Studio Tools

of Microsoft Dynamics AX with Visual Studio.


Developers can use these tools to create
managed code that accesses X++ objects.
Trace Parser

The Trace Parser consolidates information from

Install the Trace Parser

multiple sources, such as RPC and SQL, to


provide an integrated view of the applications
performance at run time.

Integration components
Integration components enable integration between Microsoft Dynamics AX and external applications. For
information about how to install one of the integration components, click the corresponding link in the
following table.
Component

Description

More information

Web services on IIS

Web services on IIS are an optional

Install web services on IIS

component. Services that are hosted on AOS


are available to users and applications over
the intranet. However, to consume services
over the Internet, you must host services on
IIS.

Microsoft Dynamics AX 2012 Installation Guide

22

Microsoft Dynamics AX

Component

Description

More information

.NET Business Connector

The .NET Business Connector enables

Install the .NET Business

applications to interact with instances of

Connector

Application Object Server (AOS).

Note:
.NET Business
Connector is installed
automatically when
Microsoft Dynamics
AX components that
require it are installed.

Synchronization proxy and

The synchronization proxy and

Install the synchronization

synchronization service for

synchronization service for Microsoft Project

proxy for Microsoft Project

Microsoft Project Server

enable you to synchronize project data in

Server

Microsoft Dynamics AX with data in

Install the synchronization

Microsoft Project Server.

service for Microsoft Project


Server

Management utilities
Management utilities let you configure and manage Microsoft Dynamics AX components and artifacts,
such as reports and web controls, from the metadata store.
For information about how to install management utilities, see Install management utilities.

Retail components
Microsoft Dynamics AX for Retail provides mid-market and large retailers a complete head office and
point of sale (POS) solution. It can help retailers increase financial returns, improve service, manage
growth, and streamline efficiencies. Microsoft Dynamics AX for Retail consists of several components that
are typically distributed across multiple computers and locations.
For information about how to install one of the retail components, click the corresponding link in the
following table.
Component

Description

More information

Retail headquarters

Retail headquarters includes components

Install Retail headquarters

that are necessary to use Retail functionality


in Microsoft Dynamics AX.
Retail POS

Retail POS is the point of sale (POS) program

Install Retail POS (point of sale)

for Microsoft Dynamics AX.

Microsoft Dynamics AX 2012 Installation Guide

23

Microsoft Dynamics AX

Component

Description

More information

Retail Modern POS

Modern POS (point of sale) provides the

Install Modern POS

services that enable Windows 8.1 clients to


interface with Retail.
Note:
Modern POS is available only in AX
2012 R3.
Retail channel database

Channel databases hold Retail data for one

Install a retail channel database

or more retail channels, such as online stores


or brick-and-mortar stores.
Note:
Retail channel database is available
only in AX 2012 R3.
Commerce Data Exchange: Synch

Synch Service shares data among the head

Install Commerce Data

Service (Retail Store Connect)

office, stores, and individual point of sale

Exchange: Synch Service (Retail

(POS) terminals.

Store Connect)

Note:
In AX 2012 R3, deploy this
component only if you need to
support previous versions of Retail
POS while you upgrade (N-1).
Commerce Data Exchange: Real-

Real-time Service is an integrated service that Install Commerce Data

time Service (Retail Transaction

provides real-time communication between

Exchange: Real-time Service

Service)

Microsoft Dynamics AX and individual point

(Retail Transaction Service)

of sale (POS) devices.


Commerce Data Exchange: Async

Async Server is part of the asynchronous

Install Commerce Data

Server

system that shares data between the

Exchange: Async Server

Microsoft Dynamics AX database and


channel databases. Async Server is installed
at headquarters and communicates with the
Microsoft Dynamics AX database.
Note:
Async Server is available only in AX
2012 R3.

Microsoft Dynamics AX 2012 Installation Guide

24

Microsoft Dynamics AX

Component

Description

More information

Commerce Data Exchange: Async

Async Client is part of the asynchronous

Install Commerce Data

Client

system that shares data between the

Exchange: Async Client

Microsoft Dynamics AX database and


channel databases. Async Client is installed at
the channel and communicates with the
channel database.
Note:
Async Client is available only in AX
2012 R3.
Retail Channel Configuration Utility The Retail Channel Configuration Utility is

Install the Retail Channel

(Retail Store Database Utility)

used configure Retail databases and

Configuration Utility (Retail

database connections.

Store Database Utility)

Retail Server provides services and business

Install Retail Server

Retail Server

logic for Modern POS (point of sale) clients.


Note:
Retail Server is available only in AX
2012 R3.
Retail hardware station

Retail Hardware Station provides services for

Install Retail Hardware Station

Modern POS (point of sale) clients and


peripherals such as printers, cash drawers, or
payment devices that enable these devices to
communicate with Retail Server.
Note:
Hardware station is available only in
AX 2012 R3.
Retail Online Channel

Retail Online Channel includes components

Install a Microsoft Dynamics AX

that are needed to provision an online sales

Retail online store (e-

channel using SharePoint. This component

commerce)

allows you to integrate data from Microsoft


Dynamics AX into the SharePoint site.
Note:
Retail Online Channel is available
only in AX 2012 R3 and AX 2012 R2.

Microsoft Dynamics AX 2012 Installation Guide

25

Microsoft Dynamics AX

Component

Description

More information

Retail mass deployment toolkit

The Retail mass deployment toolkit enables

Install retail mass deployment

you to use System Center Configuration

toolkit

Manager (SCCM) to deploy retail


components.
Note:
Retail mass deployment toolkit is
available only in AX 2012 R3.
Retail SDK

The Retail Software Development Kit (SDK)

Install Retail SDK (Retail POS

includes sample code and templates that can

Plug-ins)

be used to customize Retail for Microsoft


Dynamics AX.
Retail essentials

Retail essentials is a retail-centric

Install Retail Essentials at

configuration option for Microsoft Dynamics

headquarters

AX. Retail essentials provides a simplified,

Install Retail Essentials at the

streamlined user experience that is optimized


for organizations that use only the retail

store or at the point of sale

management functions of Microsoft


Dynamics AX.

Connector for Microsoft Dynamics


Connector can be used to integrate data between Microsoft Dynamics CRM and Microsoft Dynamics AX.
For example, you can integrate Microsoft Dynamics AX customers with Microsoft Dynamics CRM
accounts. This gives you access to up-to-date customer and account information in both systems.
Note:
Connector is available through the Microsoft Dynamics AX Setup wizard in AX 2012 R3 and
cumulative update 7 for Microsoft Dynamics AX 2012.
For more information about how to install Connector, see Install Connector for Microsoft Dynamics.

RapidStart Connector
The Rapid Start Connector for Microsoft Dynamics AX enables RapidStart Services for Microsoft Dynamics
ERP to communicate with an on-premises Microsoft Dynamics AX implementation.
Note:
The RapidStart Connector is available through the Microsoft Dynamics AX Setup wizard in AX
2012 R3, AX 2012 R2, and Microsoft Dynamics AX 2012 Feature Pack.
For more information about how to install RapidStart Connector, see Install the RapidStart Connector.

Microsoft Dynamics AX 2012 Installation Guide

26

Microsoft Dynamics AX

VSS writer
The Volume Shadow Copy Service writer for Microsoft Dynamics AX, (AX VSS writer) can be used with
Microsoft System Center 2012 Data Protection Manager (DPM) to protect Microsoft Dynamics AX data
and servers. The AX VSS writer coordinates backup and restore operations.
Note:
The AX VSS writer is available through the Microsoft Dynamics AX Setup wizard in AX 2012 R3
and cumulative update 7 for Microsoft Dynamics AX 2012 R2.
For more information about how to install the VSS writer, see Install the VSS writer for Microsoft Dynamics
AX.

Warehouse Mobile Devices Portal


Warehouse Mobile Devices Portal enables users to complete tasks on mobile devices in the warehouse
facility. It includes a website that can be accessed by mobile devices. Warehouse Mobile Devices Portal
communicates with AOS by using Windows Communication Foundation (WCF) services.
Note:
The Warehouse Mobile Devices Portal is available through the Microsoft Dynamics AX Setup
wizard only in AX 2012 R3.
For more information about how to install the Warehouse Mobile Devices Portal, see Install Warehouse
Mobile Devices Portal.

Data Import/Export Framework


The Microsoft Dynamics AX 2012 Data Import/Export Framework is an extension that helps you export
data and import it into Microsoft Dynamics AX. Examples of the data that you can import include master
data, open stock, and balances.
Note:
The Data Import/Export Framework is available through the Microsoft Dynamics AX Setup wizard
only in AX 2012 R3.
For more information about how to install the Data Import/Export Framework, see Install the Data
import/export framework (DIXF, DMF).

Microsoft Dynamics AX 2012 Installation Guide

27

Microsoft Dynamics AX

Installation types
Two types of installation are available from the Setup wizard: Custom installation and Single-computer
installation.

Custom installation
Select Custom installation to install specific Microsoft Dynamics AX components on multiple computers.
Use this type of installation in a production environment.

Single-computer installation
Select Single-computer installation to install a complete Microsoft Dynamics AX system on one
computer. Setup uses default settings to configure all components, and new Microsoft Dynamics AX
databases are created. User names and passwords are the only input that is required.
If you want to connect to an existing database or specify other custom settings, you must perform a
custom installation.
Important:
Do not perform a single-computer installation in a production environment. Use this type of
installation only for development and testing.
A single-computer installation includes the following components:

Databases

Application Object Server (AOS)

Enterprise Portal

Help server

Reporting Services extensions

Analysis Services configuration

Client

Office add-ins

Remote Desktop Services integration

Debugger

Visual Studio Tools

Trace Parser

.NET Business Connector

Management utilities

For information about how to install a Microsoft Dynamics AX system on a single computer, see Perform a
single-computer installation.

Microsoft Dynamics AX 2012 Installation Guide

28

Microsoft Dynamics AX

Before you begin


The topics in this section provide the procedures that you must complete before you start to install
Microsoft Dynamics AX. The following topics are included:

Pre-installation checklist

Create service accounts

Create a shared directory for installation

Include cumulative updates and hotfixes in a new installation (slipstreaming)

Verify that you have the required permissions for installation

Check prerequisites

Pre-installation checklist
Before you install Microsoft Dynamics AX, you must plan the implementation and complete the preinstallation tasks that are listed in the following table.
Task

More information

1. Plan the deployment of Microsoft Dynamics AX.

Implementation Planning Guide


(http://go.microsoft.com/fwlink/?LinkID=163797) (PDF
download)

2. Look for updated installation documentation for

Installation Guide

Microsoft Dynamics AX 2012 on the web.

(http://go.microsoft.com/fwlink/?LinkID=163796) (PDF
download)

3. Review the system requirements.


Important:
If you plan to upgrade the operating system,

System requirements on the Web


(http://go.microsoft.com/fwlink/?LinkId=165377) (PDF
download)

you must perform the upgrade before you


install Microsoft Dynamics AX. If you upgrade
the operating system after Microsoft Dynamics
AX has been installed, you may experience
problems. For example, instances of
Application Object Server (AOS) may not start,
or registry entries may be deleted.
4. Create service accounts that Windows services can run

Create service accounts

as. For example, you must create accounts to run


Microsoft Dynamics AX services and Microsoft SQL
Server services.
5. Copy the DVD contents to a shared directory.

Microsoft Dynamics AX 2012 Installation Guide

Create a shared directory for installation

29

Microsoft Dynamics AX

Task

More information

6. Obtain product updates, and copy them to the

Include cumulative updates and hotfixes in a new

installation directory for Microsoft Dynamics AX.

installation (slipstreaming)

7. Make sure that your domain account has the

Verify that you have the required permissions for

appropriate permissions to perform the installation.

installation

8. Verify that prerequisites have been met.

Check prerequisites

Create service accounts


An implementation of Microsoft Dynamics AX requires many services to run. Set up accounts to run the
services. Each account that you set up must have the following characteristics:

Unless otherwise noted, it must be a dedicated account. A dedicated account is used only for a
specific service.

It must have a password that does not expire.

It must have minimal access to network resources.

It must be able to log on as a service.

If you are using Windows Server 2008 R2 or a later version of Windows Server, you can use managed
service accounts. For more information, see the Service Accounts Step-by-Step Guide
(http://go.microsoft.com/fwlink/?linkid=214033) on TechNet.
Note:
If an account must be a Microsoft Dynamics AX user, it cannot be a managed service account.
The accounts in this topic must be configured in order to install the components of Microsoft Dynamics
AX. For information about additional service accounts that are used when you configure Microsoft
Dynamics AX, see Configure system accounts (http://technet.microsoft.com/library/56e3522e-38a8-41bab95e-3ad3c7d53178(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

30

Microsoft Dynamics AX

Create accounts for Microsoft Dynamics AX services


Create the accounts in the following table to run Microsoft Dynamics AX services.
Account

Description

Configuration procedure

Application Object Server

The account that the Microsoft Dynamics AX

Enter this account when you

(AOS) service account

Object Server Windows service runs as. This account

run the Setup wizard to

is used to communicate with the database server.

install an AOS instance. For

Consider the following points when you select an

more information, see Install

account:

an AOS instance.

We strongly recommend that you use a domain


account or a managed service account in a
production environment. Use the Network
Service account only in development and testing
environments.

If you plan to use a managed service account,


you must first create that account as described in
the Service Accounts Step-by-Step guide
(http://go.microsoft.com/fwlink/?LinkId=254376).

If Microsoft SQL Server and the AOS are on


different computers, you must use a domain
account or a managed service account.

If you plan to install any Microsoft Dynamics AX


components on a domain controller, you must
use a domain account.

If you plan to use Message Queuing, which is


also known as MSMQ, for document exchange
with web services on Internet Information
Services (IIS), and you want to send signed
messages, you must use a domain account.
However, if you want to send unsigned
messages by using web services on IIS, the AOS
can run under the Network Service account.

Business Connector proxy

The account that the .NET Business Connector runs

Enter this account when you

account

as. This account is used to connect to the AOS on

run the Setup wizard or select

behalf of a Microsoft Dynamics AX user, but without

this account in the System

granting that user excessive privileges in the system.

service accounts form.

Note:
This account must not be a Microsoft
Dynamics AX user.

Microsoft Dynamics AX 2012 Installation Guide

31

Microsoft Dynamics AX

Account

Description

Configuration procedure

Search crawler account

The account that Enterprise Search runs as. This

Enter this account when you

account is used by the Microsoft SharePoint Indexing

run the Setup wizard to

Service to crawl Microsoft Dynamics AX data. This

install Enterprise Search. For

account must be assigned to the Search crawler

more information, see Install

security role in Microsoft Dynamics AX. We

Microsoft Dynamics AX

recommend that you configure this account so that it

Enterprise Search.

has no local logon rights.

Use the Assign users to


roles form to assign this
account to the Search
crawler security role.

Management Reporter

The account that is used to run integrations between

Enter this account when you

integration user account

Management Reporter and Microsoft Dynamics AX.

run the Setup wizard to

(optional)

This account must have read permission and view

install Management Reporter.

change tracking permission on the Microsoft


Dynamics AX transaction database and model
database.

For more information, see


Install Management Reporter
server components.

Setup will add the account as a user in Microsoft


Dynamics AX, and will assign the user to the System
administrator security role.
Management Reporter

The account that the Management Reporter

Enter this account when you

service account (optional)

Windows service runs as.

run the Setup wizard to

We recommend that you use the AOS service

install Management Reporter.

account to run the Management Reporter service.

For more information, see


Install Management Reporter
server components.

Synchronization service

The account that the Microsoft Project Server

Select this account in the

account (optional)

synchronization service runs as. We recommend that

System service accounts

you configure this account so that it has no local

form.

logon rights.

For more information, see


Install the synchronization
service for Microsoft Project
Server.

Connector integration user

The account that is used to connect to Microsoft

Enter this account when you

account (optional)

Dynamics AX.

run the Setup wizard to

Setup will add the account as a user in Microsoft

install Connector. For more

Dynamics AX, and will assign the user to the System


administrator security role.

Microsoft Dynamics AX 2012 Installation Guide

information, see Install


Connector for Microsoft
Dynamics.

32

Microsoft Dynamics AX

Account

Description

Configuration procedure

Connector service account

The account that is used to run integrations with

Enter this account when you

(optional)

Microsoft Dynamics AX.

run the Setup wizard to

This account is also used to send notification emails.

install Connector. For more

If the Simple Mail Transfer Protocol (SMTP) server


that you use to send notifications requires
authentication to submit emails, you must give this

information, see Install


Connector for Microsoft
Dynamics.

service account permission to authenticate and


submit emails.
RapidStart Connector

The account that the RapidStart Connector Windows

Enter this account when you

account (optional)

service runs as.

run the Setup wizard to


install the RapidStart
Connector. For more
information, see Install the
RapidStart Connector.
Use the Assign users to
roles form to assign this
account to the System
administrator security role.

VSS writer account

The account that the VSS writer Windows service runs

Enter this account when you

(optional)

as.

run the Setup wizard to

This account must be a local administrator, and must

install the VSS writer. For

have read/write access to the location where

more information, see Install

temporary backups are stored.

the VSS writer for Microsoft

Application pool identity for

The account that is used to run the application pool

Enter this account when you

Warehouse Mobile Devices

for the web application for Warehouse Mobile

run the Setup wizard to

Portal (optional)

Devices Portal.

install Warehouse Mobile

You must install an instance of Warehouse Mobile

Devices Portal. For more

Devices Portal for each company in Microsoft


Dynamics AX. Create a separate service account for

Dynamics AX.

information, see Install


Warehouse Mobile Devices

each instance.

Portal.

Service accounts must be assigned to the

Use the Assign users to

Warehouse mobile device user security role in


Microsoft Dynamics AX. The default company for the
user must be the legal entity in which the warehouse
operates. The language that you select for the user is
the default language for the portal.

Microsoft Dynamics AX 2012 Installation Guide

roles form to assign this


account to the Warehouse
mobile device user security
role. Use the Options form to
set the default company and
language for the user.

33

Microsoft Dynamics AX

Account

Description

Configuration procedure

Data Import/Export

The account that is used for the Data Import/Export

Enter this account when you

Framework (DIXF) service

Framework service.

run the Setup wizard to

account

The account must have dbdatareader and

install the Data Import/Export

dbdatawriter access to the business and model store

Framework service. For more

databases, as well as administrator rights to Microsoft information, see Install the


Data import/export
Dynamics AX.
We recommend that you use the AOS service

framework (DIXF, DMF).

account.

Create accounts for Retail services


Create the accounts in the following table to run the services that are used in Retail.
Account

Description

Configuration procedure

Application pool identity for

The account that is used to run the application

Enter this account when you run

Commerce Data Exchange:

pool for the web application for Real-time

the Setup wizard to install Real-

Real-time Service

Service.

time Service. For more

Note:

Note:

In Microsoft Dynamics

In Microsoft Dynamics AX 2012

AX 2012 Feature Pack,

Feature Pack, Real-time Service is a

Commerce Data

Windows service, and this account is

Exchange: Real-time

used as the service account.

Service is called Retail

information, see Install


Commerce Data Exchange: Realtime Service (Retail Transaction
Service).
Use the Assign users to roles
form to assign this account to
the BusinessConnector Role.

Transaction Service.
Service account for Commerce

The account that the Async Client Windows

Enter this account when you run

Data Exchange: Async Client

service runs as. The account is not required to

the Setup wizard to install Async

be a domain account. It can be a member of a

Client. For more information, see

workgroup on the local computer.

Install Commerce Data


Exchange: Async Client.

Application pool identity for

The account that is used to run the application

Enter this account when you run

Commerce Data Exchange:

pool for the web application for Async Server.

the Setup wizard to install Async

Async Server

Server. For more information,


see Install Commerce Data
Exchange: Async Server.

Microsoft Dynamics AX 2012 Installation Guide

34

Microsoft Dynamics AX

Account

Description

Configuration procedure

Service accounts for Commerce

The accounts that the Synch Service Windows

Enter this account when you run

Data Exchange: Synch Service

service runs as. These accounts are used to

the Setup wizard to install Synch

communicate with the database server.

Service. For more information,

Consider the following points when you select

see Install Commerce Data

Note:
In Microsoft Dynamics
AX 2012 Feature Pack,
Commerce Data

an account:

Store Connect).

supported.

Exchange: Synch
Service is called Retail

Guest or temporary user accounts are not

Exchange: Synch Service (Retail

The service user account on head-office


instances of Synch Service must be a

Store Connect.

Microsoft Dynamics AX user.

If you are installing a forwarder instance of


Synch Service at headquarters, the service
user account can be any valid domain
account.

If you are installing an instance of Synch


Service for a channel, you can use a valid
local user account on the computer where
the instance runs.

The account must be a member of the


db_datareader and db_datawriter
database roles in the message database.

This account must be created on POS


computers where offline databases are
located.

Application pool identity for

The account that is used to run the application

Enter this account when you run

Retail Server

pool for the web application for Retail Server.

the Setup wizard to install Retail

The account is not required to be a domain

Server. For more information,

account. It can be a member of a workgroup on see Install Retail Server.


the local computer.
Application pool identity for

The account that is used as the identity of the

Enter this account when you run

Retail hardware station

application pool for Retail hardware station.

the Setup wizard to install Retail

The account is not required to be a domain

hardware station. For more

account. It can be a member of a workgroup on information, see Install Retail


the local computer.

Hardware Station.

Service account for Offline Sync

The account that the Offline Sync Service

Add this account to the

Service

Windows service runs as.

RetailUsers local group.


Use the Services control panel to
manually set this account as the
identity for the Offline Sync
Service.

Microsoft Dynamics AX 2012 Installation Guide

35

Microsoft Dynamics AX

Account

Description

Retail online store service

accounts

Configuration procedure

Product catalog app pool user: The

Enter these accounts when you

account that is used as the identity of the

run the Setup wizard to install

application pool for the Retail online store

the Retail online store or when

product catalog web site. This account

you install the store by using

must be a member of the SharePoint Farm

Windows PowerShell. For more

Administrators group so that it can edit

information, see Install a

properties in the root web site.

Microsoft Dynamics AX Retail

Store front app pool user: The account

online store (e-commerce).

that is used as the identity of the


application pool for the Retail online store
site. This account must be a member of the
SharePoint Farm Administrators group so
that it can edit properties in the root web
site.

STS app pool user: The account that is


used to run the application pool for the
Security Token Service. This account must
be a member of the SharePoint Farm
Administrators group so that it can edit
properties in the root web site. This
account is specified when you install
SharePoint.

Retail job user: The account that is used


to run the SharePoint Timer Service. This
account is specified when you install
SharePoint.

Create accounts for SQL Server services


Create the accounts in the following table to run SQL Server services.
Account

Description

Configuration procedure

SQL Server Database Engine

The account that the SQL Server

Select this account when you

account

(MSSQLSERVER) Windows service runs as.

install the Database Engine.


For more information, see
the SQL Server
documentation.

Microsoft Dynamics AX 2012 Installation Guide

36

Microsoft Dynamics AX

Account

Description

Configuration procedure

Microsoft SQL Server

The account that the SQL Server Reporting Services

When you install Reporting

Reporting Services account

(MSSQLSERVER) Windows service runs as.

Services, specify that you


want the Reporting
Services Windows service to
run as the .NET Business
Connector account.

Microsoft SQL Server

The account that the SQL Server Analysis Services

Select this account when you

Analysis Services account

(MSSQLSERVER) Windows service runs as.

install Analysis Services.


Important:
The account that
you select must
have read access to
the online
transaction
processing (OLTP)
database for
Microsoft Dynamics
AX.

Create a shared directory for installation


Before you install Microsoft Dynamics AX and subsequent cumulative updates, we recommend that you
create a shared directory on a file server. Then copy the contents of the Microsoft Dynamics AX DVD and
the updates to this network location. Perform all installations from this network location instead of the
DVD.
By giving users a shared network location from which to install Microsoft Dynamics AX, you can make sure
that the same version of the software is installed on all computers.
Additionally, the installation program may later require access to files from the location where Setup was
run. For example, the installation program may require access to the files when you upgrade, when you
modify the installation, or when you uninstall a component or update. If Setup was run from a network
location, the installation program can retrieve the files silently from the network. However, if Setup was
run from a DVD, the user is prompted to insert the DVD when files are required.
Before you install Microsoft Dynamics AX, follow these steps to create a shared directory for the contents
of the DVD.
1.

Create a directory that is named DynamicsAX6.

2.

Share the DynamicsAX6 directory:

Give the Administrator group full control, or owner access.

Give the Everyone group read access.

As a security best practice, we recommend that you prevent users from making changes to this
directory. Only read access is required to perform an installation from the directory.

Microsoft Dynamics AX 2012 Installation Guide

37

Microsoft Dynamics AX
3.

Copy the contents of the Microsoft Dynamics AX DVD to the DynamicsAX6 directory.

4.

Copy the installation files for cumulative updates and hotfixes to the directory. For more information
about how to include updates, see Include cumulative updates and hotfixes in a new installation
(slipstreaming).

Include cumulative updates and hotfixes in a new


installation (slipstreaming)
If you are installing Microsoft Dynamics AX components for the first time, and cumulative updates, binary
hotfixes, or service packs for Microsoft Dynamics AX are available, you can incorporate the updates into
the installation by using a process that is known as slipstreaming. When updates are slipstreamed, Setup
automatically detects and applies them. In this way, the time that is required to install the whole Microsoft
Dynamics AX solution is reduced.
Note:
Components that were previously installed are not updated during a later slipstream installation.
For example, an instance of Application Object Server (AOS) is installed on a server. Later, you add
updates to the installation source, and you also install another Microsoft Dynamics AX
component on the same server. In this scenario, the existing AOS instance is not updated.
You can slipstream the following kinds of updates:

Cumulative updates

Binary hotfixes

Help content updates

Service packs

Application (database) hotfixes cannot be included in the slipstreaming process. They must be installed by
using AxUpdate.exe.

The Updates folder


Before you install Microsoft Dynamics AX, you copy the DVD to a network location. This lets you modify
the installation media to create a slipstream installation. Incorporate updates into the installation process
by copying files to the Updates folder in the shared network location.
Note:
For more information about how to install Microsoft Dynamics AX from a shared network folder,
see Create a shared directory for installation.
In the Updates folder, create a subfolder for each update package that you download. We recommend
that you use the Knowledge Base article numbers of the updates as the names of the subfolders. For
example, for the update that is associated with Knowledge Base article number 123456, create a subfolder
that is named KB123456.

Microsoft Dynamics AX 2012 Installation Guide

38

Microsoft Dynamics AX
Extract each update into the appropriate subfolder. The following illustration shows an example of the
recommended folder structure:

Any time that you apply a cumulative update package or a binary hotfix to your environment, we strongly
recommend that you add the installation package to the Updates folder. This practice ensures that you
can deploy new servers, clients, and other components of the correct version quickly. You should also
make a copy of the updated installation media per your system recovery strategy.

The slipstreaming process


The following is a high-level overview of the slipstreaming process:
1.

To find cumulative updates:

For AX 2012 R3, go to Microsoft Dynamics Lifecycle Services, and after selecting a project, click
Updates. In the Updates to include with new installations section, select the slipstreamable
update package that you want, and download it.

For AX 2012 R2 or earlier, visit the hotfix pages for Microsoft Dynamics AX 2012
(https://mbs.microsoft.com/customersource/downloads/hotfixes/ax2012hotfixes.htm) or
Microsoft Dynamics AX 2012 R2
(https://mbs.microsoft.com/customersource/support/downloads/hotfixes/ax2012r2hotfixes.htm)
on the CustomerSource web site. Logon is required.

2.

Create a shared network location from which to install Microsoft Dynamics AX.

3.

In the Updates folder, create a subfolder for each update package that you download. Then extract
each update into the appropriate subfolder.

4.

Run Setup and select the components that you want to install. Setup detects and installs the updates.
Follow the usual installation procedures to install Microsoft Dynamics AX components. For detailed
installation instructions for each Microsoft Dynamics AX 2012 component, see the procedures later in
this document.
To install updates for Help content, you must select the Help Server component, and then select the
updated content sets on the Language and content selection page.

Microsoft Dynamics AX 2012 Installation Guide

39

Microsoft Dynamics AX

Verify that you have the required permissions for


installation
Before you begin the installation of Microsoft Dynamics AX, work with a system administrator to make
sure that the account that you log on with at each server has appropriate permissions. The permissions in
the following table are recommended based on the principle of least privilege.
In all cases, you must be a member of the Administrators group on the local computer where you are
installing a component. The following table lists the permissions that are required in addition to
administrator access on the local computer.
Component

Additional permissions that are required to install the component

Databases

Membership in the dbcreator server role in Microsoft SQL Server

Membership in the securityadmin server role in SQL Server

Membership in the db_accessadmin database role in SQL Server


for the Microsoft Dynamics AX database

If you install the databases remotely from a computer other than the
database server, you must log on to the remote computer by using an
account that is an administrator on the SQL Server computer. Setup
requires access to SQL Server services.
Application Object Server (AOS)

Membership in the sysadmin role on the instance of SQL Server that


you want to connect to

Enterprise Portal for Microsoft Dynamics AX

Membership in the System administrator role in Microsoft


Dynamics AX

Membership in the Administrators group in Windows on the


Web server

Membership in the Farm Administrators group in Microsoft


SharePoint 2010 products

Membership in the dbcreator role on the instance of SQL Server


that is used for SharePoint 2010 products

Membership in the WSS_Content_Application_Pools database


role in the SharePoint_Config database

Enterprise Search

Membership in the System administrator role in Microsoft


Dynamics AX

Membership in the Administrator group in Microsoft SharePoint


Services

Membership in the dbcreator role on the instance of SQL Server


that is used for Microsoft SharePoint Services

Help server

Membership in the System administrator role in Microsoft Dynamics


AX

Microsoft Dynamics AX 2012 Installation Guide

40

Microsoft Dynamics AX

Component

Additional permissions that are required to install the component

Management Reporter (server components)

Membership in the sysadmin role on the instance of SQL Server


that you want to connect to.

To finish the initial configuration of Management Reporter,


membership is required in the Administrator role in
Management Reporter.

Microsoft SQL Server Reporting Services

Membership in the System administrator role in Microsoft Dynamics

extensions

AX

Microsoft SQL Server Analysis Services

configuration

Membership in the System administrator role in Microsoft


Dynamics AX

Membership in the SQL Server securityadmin server role

Membership in the SQL Server db_owner database role for the


Microsoft Dynamics AX database

Client

None

Microsoft Office add-ins

None

Remote Desktop Services integration

None

Report Designer for Management Reporter

None

(client component)
Debugger

None

Visual Studio Tools

None

Trace Parser

None

Web services on Internet Information

Membership in the System administrator role in Microsoft Dynamics

Services (IIS)

AX

.NET Business Connector

None

Synchronization proxy

Membership in the dbowner database role in the SQL Server


database for Microsoft Project Server

Membership in the System administrator role in Microsoft


Dynamics AX

Synchronization service

Membership in the System administrator role in Microsoft Dynamics


AX

Management utilities

None

Retail Headquarters

None

Retail POS

None

Commerce Data Exchange: Synch Service

To install Synch Service, no additional permissions are required. To

(Retail Store Connect)

configure Synch Service, membership is required in the sysadmin role


on the instance of SQL Server that you want to connect to.

Microsoft Dynamics AX 2012 Installation Guide

41

Microsoft Dynamics AX

Component

Additional permissions that are required to install the component

Commerce Data Exchange: Real-time

None

Service (Retail Transaction Service)


Commerce Data Exchange: Async Server

To install Async Server, no additional permissions are required. To


configure Async Server, membership is required in the sysadmin role
on the instance of SQL Server that you want to connect to.

Commerce Data Exchange: Async Client

To install Async Client, no additional permissions are required. To


configure Async Client, membership is required in the sysadmin role
on the instance of SQL Server that you want to connect to.

Retail Channel Configuration Utility (Retail

To install the utility, no additional permissions are required. To

Store Database Utility)

configure databases, membership is required in the sysadmin role on


the instance of SQL Server that you want to connect to.

Retail SDK (Retail POS Plug-ins)

None

Retail Online Channel

None

Retail Server

None

Retail mass deployment toolkit

None

Modern POS

None

Retail channel database

None

Retail hardware station

None

RapidStart Connector

None

Warehouse Mobile Devices Portal

None

Data Import/Export Framework

Membership in the dbdatareader and dbdatawriter roles on the


instance of SQL Server that you want to connect to

Membership in the System administrator role in Microsoft


Dynamics AX

VSS writer

Membership in the Administrators group on the computer where


Microsoft System Center 2012 Data Protection Manager (DPM) is
installed

Connector for Microsoft Dynamics

Permission to query for entries in Active Directory

Membership in the SQL Server dbcreator server role

Membership in the SQL Server securityadmin server role

Membership in the sysadmin database role on the SQL Server


instance that hosts the Microsoft Dynamics Integration (MSDI)
database

Microsoft Dynamics AX 2012 Installation Guide

42

Microsoft Dynamics AX

Check prerequisites
Run the prerequisite validation utility for Microsoft Dynamics AX to determine whether a computer meets
the requirements to install a Microsoft Dynamics AX component. You can run the utility before you install
any components in your environment. If requirements are not met, the utility helps you install or
configure most prerequisites. Additionally, you can view or print a report that shows the results of the
prerequisite validation.
Prerequisite validation is also built into Setup. Therefore, the same prerequisites are validated when you
install a component by using the Setup wizard.
Note:
The prerequisite validation utility validates the software prerequisites that Microsoft Dynamics AX
depends on. However, the utility does not verify whether Microsoft Dynamics AX components
that are also required are installed or configured. For example, the utility verifies whether a
supported version of Windows is installed, but does not verify whether an Application Object
Server (AOS) is running in the environment. Prerequisite Microsoft Dynamics AX components are
validated when you run Setup.
To review the hardware and software requirements for Microsoft Dynamics AX, see the system
requirements (http://go.microsoft.com/fwlink/?LinkId=165377).
Use the following procedure to run the prerequisite validation utility.
1.

Start Microsoft Dynamics AX Setup.

2.

Under Prepare, click Validate system requirements.


Note:
To avoid errors, run only one instance of the utility at a time.

3.

The Prerequisite validation page is displayed. Select the components that you plan to install on the
local computer, and then click Next.

4.

The Prerequisite validation results page is displayed. Each prerequisite is assigned one of the
following statuses.
Status

Description

Success

The local computer meets the prerequisite.

Error

The local computer does not meet the prerequisite. You cannot install the component
until this prerequisite is installed or configured.

Warning

The local computer does not meet the prerequisite, but you can still install the Microsoft
Dynamics AX component.

Microsoft Dynamics AX 2012 Installation Guide

43

Microsoft Dynamics AX
For more information about a prerequisite, click its status. For information about all the prerequisites
that were validated, click View report to display the Microsoft Dynamics AX Prerequisite check
report. Both options provide a description of the prerequisite, the validation status, and
recommendations for resolving any problems.
5.

Resolve prerequisite issues. For many errors and warnings, the prerequisite validation utility can
attempt to resolve the issue for you.

If a link is available in the Download column, click it to download and install the missing
prerequisite. Internet access is required to download some prerequisites that are not included on
the installation media. In some cases, the download starts immediately when you click the link. In
other cases, a download page is displayed when you click the link.
Note:
If network or computer security prevents a prerequisite from being downloaded from the
utility, you must download the prerequisite by using another method. Click the Error link
on the prerequisite validation page to obtain the download URL.

If a check box is available in the Configure column, select it, and then click the Configure button
to resolve the issue.

Some prerequisites depend on other prerequisites. In these cases, the prerequisites must be installed
or configured in a specific order. For example, the Windows Search Service must be installed before it
can be started.
6.

After you have resolved prerequisite issues, click Revalidate to run the prerequisite validation again.

7.

When you have finished validating prerequisites, click Close.


Important:
Prerequisite software that is installed or configured by the prerequisite validation utility may not
include the latest updates. We strongly recommend that you run Windows Update to identify and
install the latest updates before you continue with the installation of Microsoft Dynamics AX.

See Also
Troubleshoot prerequisite issues (http://technet.microsoft.com/library/e3771aed-bde7-4610-bff2aa64212a8352(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

44

Microsoft Dynamics AX

Install the databases


These topics describe how to configure Microsoft SQL Server and install the Microsoft Dynamics AX
databases. The following topics are included:

Configure SQL Server and storage settings

Install the Microsoft Dynamics AX databases

Configure SQL Server and storage settings


This topic provides information about how to configure Microsoft SQL Server to support the business and
model store databases for Microsoft Dynamics AX. To achieve optimal Microsoft Dynamics AX
performance, you must correctly configure the database infrastructure.
This topic does not describe how to configure the infrastructure for reporting and analytics databases. For
information about those features, see Reporting in Microsoft Dynamics AX
(http://technet.microsoft.com/library/6728b08f-6618-4719-a333-ec7f5bec25c2(AX.60).aspx) and Analytics
in Microsoft Dynamics AX (http://technet.microsoft.com/library/8f284ccb-628f-4e84-b82c3e0c032ad80f(AX.60).aspx).
This information is designed for Microsoft Dynamics AX administrators and Microsoft SQL Server database
administrators who are responsible for administration of the Microsoft Dynamics AX application.
To benefit from this topic, you must have knowledge in the following areas:

Windows Server administration.

SQL Server administration. Specific areas of knowledge include advanced configuration options,
memory management, performance management, and troubleshooting.

Microsoft Dynamics AX system administration.

Minimal SQL Server infrastructure


The configuration of Windows Server and SQL Server greatly affects the performance of the Microsoft
Dynamics AX business database. This section provides detailed recommendations for the configuration of
Windows Server and SQL Server.
The configuration recommendations are based on the following assumptions:

You are following the documented best practices for Windows Server and SQL Server.

You are using a dedicated server that runs SQL Server 2008 R2.

You are using a single instance of SQL Server that is dedicated to running the Microsoft Dynamics AX
production databases.
We recommend that you store your test and development databases on a separate server from the
production databases.

Microsoft Dynamics AX 2012 Installation Guide

45

Microsoft Dynamics AX

Configuring Windows Server


Verify that SQL Server is configured to run as a background service in Windows.
1.

In Windows Server 2008 R2, in Control Panel, click System and Security, and then click System.
In Windows Server 2008, in Control Panel, double-click System.

2.

Click Advanced system settings.

3.

On the Advanced tab, under Performance, click Settings.

4.

On the Advanced tab, under Processor scheduling, select Background services, and then click OK.

Configuring the server that runs SQL Server


In addition to the documented best practices for SQL Server, we recommend the following configuration
settings for the SQL Server service.

Run the SQL Server service under an Active Directory domain account that has the minimum
necessary privileges. For more information, see SQL Server 2008 Security Overview for Database
Administrators (http://go.microsoft.com/fwlink/?LinkId=213202).

Confirm that the account for the SQL Server service has been granted the Lock pages in memory
privilege. We recommend this setting, because it significantly affects whether other processes affect
SQL Server. For instructions, see How to: Enable the Lock Pages in Memory Option (Windows)
(http://go.microsoft.com/fwlink/?LinkId=213203). For more information, see the following Web pages:

The Microsoft Customer Service and Support (CSS) SQL Server Engineers blog
(http://go.microsoft.com/fwlink/?LinkId=213204)

Knowledge base article 981483, How to reduce paging of buffer pool memory in the 64-bit
version of SQL Server (http://go.microsoft.com/fwlink/?LinkId=213205)

Slava Oks's WebLog (http://go.microsoft.com/fwlink/?LinkId=213207)

Configure the account for the SQL Server service for instant file initialization. Instant file initialization is
only available if the account for the SQL Server service, MSSQLSERVER, has been granted the
SE_MANAGE_VOLUME_NAME right. Members of the Windows Administrator group have this right
and can grant it to other users by adding them to the Perform Volume Maintenance Tasks security
policy. For more information, see Database file initialization
(http://go.microsoft.com/fwlink/?LinkId=213208).

Enable the TCP/IP network protocol. Depending on the edition of SQL Server that you use, this
protocol may be automatically installed during installation. For instructions, see How to: Enable or
Disable a Server Network Protocol (SQL Server Configuration Manager)
(http://go.microsoft.com/fwlink/?LinkId=213210).

Disable hyperthreading. This step must be performed in the BIOS settings of the server. For
instructions, see the hardware documentation for your server.

Microsoft Dynamics AX 2012 Installation Guide

46

Microsoft Dynamics AX

Configuring the instance of SQL Server


In addition to the documented best practices for SQL Server, we recommend the following storage
settings for the instance of SQL Server.

Configuring max degree of parallelism


The max degree of parallelism option is a setting that affects the entire instance of SQL Server.
Microsoft Dynamics AX workloads generally perform better when intra-query parallelism is disabled.
However, the upgrade process benefits from parallelism, as do activities that are used exclusively for batch
jobs or maintenance. Use the following settings when the system performs maintenance activities or an
upgrade:

Before an upgrade to a new release of Microsoft Dynamics AX, or before a large number of
maintenance or batch activities, set max degree of parallelism to the smallest of the following
values:

The number of physical processor cores

The number of physical processor cores per non-uniform memory access (NUMA) node

When the Microsoft Dynamics AX database is used in a production environment, set max degree of
parallelism to 1.

Use the following statements to set the value of max degree of parallelism.
Examine the output from the second sp_configure 'max degree of parallelism' statement, and confirm that
the value has been changed. In the following query, the first sp_configure 'max degree of parallelism'
statement sets the value of max degree of parallelism to 1. The second sp_configure 'max degree of
parallelism' statement returns a value of 1.
EXEC sp_configure 'show advanced options', 1;
RECONFIGURE;
GO
EXEC sp_configure 'max degree of parallelism', 1;
RECONFIGURE;
GO
EXEC sp_configure;

For more information, see max degree of parallelism Option


(http://go.microsoft.com/fwlink/?LinkId=213211). For general guidelines, see Knowledge base article
329204, General guidelines to use to configure the MAXDOP option
(http://go.microsoft.com/fwlink/?LinkId=213212). For tips from the SQL Server team, visit the SQL Server
Relational Engine team's blog, SQL Server Engine Tips (http://go.microsoft.com/fwlink/?LinkId=213213).

Microsoft Dynamics AX 2012 Installation Guide

47

Microsoft Dynamics AX

Configuring max server memory


SQL Server dynamically acquires and frees memory as required. Typically, an administrator does not have
to specify how much memory is allocated to SQL Server. However, the max server memory option can
be useful in some environments. Make sure that sufficient memory is available for the operation of
Windows Server. For more information, see Monitoring available memory, later in this topic.
If you find that the dynamic allocation of memory adversely affects the operation of Windows Server,
adjust the value of max server memory based on the available random access memory (RAM). For more
information, see Effects of min and max server memory (http://go.microsoft.com/fwlink/?LinkId=213214).

Monitoring available memory


Make sure that sufficient memory is available for the operation of Windows Server. For example, make
sure that you run a dedicated instance of SQL Server on a server that has at least 4 gigabytes (GB) of
memory. If the available memory for the server drops below 500 megabytes (MB) for extended periods,
the performance of the server may degrade.
Use the Memory: Available Mbytes performance counter for the Windows Server operating system to
determine whether the available memory drops below 500 MB for extended periods. If the available
memory drops below 500 MB frequently or for extended periods, we recommend that you reduce the
max server memory setting for SQL Server or increase the physical memory of the server.
Detailed guidance about memory management is beyond the scope of this topic. For more information
about how to monitor memory and troubleshoot performance issues, see the Windows Server and SQL
Server documentation.

Allocating storage for tempdb


We recommend that you determine the total size of the data files and transaction log files that are
required for the tempdb database, and that you set a specific value. Do not use automatic growth, or
autogrow, setting for space management. Instead, use autogrow as a safety mechanism, so that tempdb
can grow if tempdb files use the space that was originally allocated to them. Follow this process to
determine the number and placement of data files.

Determine the number of processors that are available to SQL Server. Unless you are using an affinity
mask, this number is same as the total number of processors that you see on the Performance tab of
Windows Task Manager. When hyperthreading is not enabled, each processor corresponds to a
processor core. Affinity masks and processor cores are beyond the scope of this topic. For more
information, see the Windows Server and SQL Server documentation.

Based on performance testing of the OLTP workload for Microsoft Dynamics AX, we recommend that
you maintain one tempdb data file per processor. For more information, see the performance
benchmark reports on PartnerSource (http://go.microsoft.com/fwlink/?LinkId=143994) or
CustomerSource (http://go.microsoft.com/fwlink/?LinkId=213216).

Isolate tempdb on dedicated storage, if you can. We recommend that you move the primary data file
and log file for tempdb to high-speed storage, if high-speed storage is available. The Microsoft
Dynamics AX database runs in read committed snapshot isolation (RCSI) mode. In RCSI mode, row
versions are stored in tempdb. By creating multiple files for tempdb data, even if these files reside on
the same storage device, you can improve the performance of tempdb operations.

Microsoft Dynamics AX 2012 Installation Guide

48

Microsoft Dynamics AX

Determine the size of the tempdb data files and log files. You must create one primary data file and
one log file. Determine how many additional, secondary data files you require for the tempdb data.
For best results, create data files of equal size. The total number of data files must equal the total
number of processor cores. The aggregate size of the primary data file and all other data files must
equal the total data size that you determined for the tempdb database.
For more information, see Optimizing tempdb performance
(http://go.microsoft.com/fwlink/?LinkId=213217).

Resize the primary data file and log file for tempdb. Move the primary data file and log file to
dedicated storage, if dedicated storage is available. The primary tempdb data file cannot be moved
while the instance of SQL Server is running. To complete the move, you must use an ALTER DATABASE
statement and restart the instance of SQL Server. For more information, see ALTER DATABASE
(http://go.microsoft.com/fwlink/?LinkId=213218).
Note:
The data files and transaction log files for tempdb can reside on the same storage device.

If space is available on the drive where tempdb files are allocated, do not configure the autogrow
property for data files and log files as a percentage. Instead, configure the autogrow property as a
specific number of megabytes. If you can, configure the data files and log files to grow by 100 to 500
MB, depending on the available space. Monitor the data files, and when they grow, adjust the original
allocation to prevent automatic growth later. If the autogrow property is configured in megabytes
instead of as a percentage, the allocation of space is more predictable, and the chance of extremely
small or large growth increments is reduced.

Monitor the tempdb data files and log files to make sure that they are all sized correctly, and that all
data files are of equal size. Use SQL Server Management Studio or a transact-SQL query to view the
database properties. Verify that all the data files are of equal size, and that they have the same size as
the value that you originally provided. If one or more files have grown, adjust the initial size of all files.

Configuring the Microsoft Dynamics AX business database


We recommend the following settings for the Microsoft Dynamics AX business database. You can use SQL
Server Management Studio or the appropriate ALTER DATABASE statement to configure these settings.
For more information, see ALTER DATABASE (http://go.microsoft.com/fwlink/?LinkId=213218).

Set COMPATIBILITY_LEVEL to 110 for SQL Server 2012, or to 100 for SQL Server 2008 or SQL Server
2008 R2.

Set READ_COMMITTED_SNAPSHOT to on. Performance testing has shown that Microsoft Dynamics
AX performs better when the READ_COMMITTED_SNAPSHOT isolation option is set to on. You must
use an ALTER DATABASE statement to set this option. This option cannot be set by using SQL Server
Management Studio.
Run the following query, where <database name> is the name of the Microsoft Dynamics AX
database. There can be no other active connections in the database when you run this query.
ALTER DATABASE <database name>
SET READ_COMMITTED_SNAPSHOT ON;

Microsoft Dynamics AX 2012 Installation Guide

49

Microsoft Dynamics AX
Query the sys.databases catalog view, and verify that the Microsoft Dynamics AX database contains a
value of 1 in the is_read_committed_snapshot_on column. For more information, see the following
Web pages:

sys.databases (http://go.microsoft.com/fwlink/?LinkId=213219)

Choosing Row Versioning-based Isolation Levels (http://go.microsoft.com/fwlink/?LinkId=213220)

Set AUTO_CREATE_STATISTICS and AUTO_UPDATE_STATISTICS to on. Set


AUTO_UPDATE_STATISTICS_ASYNC to off. Performance testing has shown that Microsoft
Dynamics AX performs better when the options have these settings.

Make sure that the AUTO_SHRINK option is set to off. When database files are automatically
shrunk, performance of the database degrades. We recommend that the database administrator
manually shrink the database files on a predefined schedule. For more information, see Turn
AUTO_SHRINK OFF! (http://go.microsoft.com/fwlink/?LinkId=213221) on the SQL Server Storage
Engine Team's blog.

Important:
All Microsoft Dynamics AX databases must use the same SQL collation. These databases include
the business database, model store database, Microsoft SQL Server Reporting Services database,
and Microsoft SQL Server Analysis Services database.

Plan database storage


Designing a data storage solution involves multiple interrelated aspects. We recommend that you follow
this process when you must complete this task.
1.

Characterize the input/output (I/O) load of the application. The I/O characteristics depend on your
business requirements, and on the Microsoft Dynamics AX modules and components that you deploy.
To determine your I/O characteristics, answer the following questions:

What is the read ratio versus write ratio of the application?

What is the typical I/O volume, or I/O per second (IOPs)?

How much of the I/O is sequential, and how much is random?

2.

Determine the availability and performance requirements for the database system.

3.

Determine the hardware that is required to support the analysis that you performed made in steps 1
and 2.

4.

Configure SQL Server to take advantage of the hardware that you determined in step 3.

5.

Track the performance as the workload changes.

Step-by-step guidance about database architecture and storage is beyond the scope of this topic. For
more detailed recommendations from the SQL Server team, see Microsoft SQL Server Storage Top 10 Best
Practices (http://go.microsoft.com/fwlink/?LinkId=213199) and Physical Database Storage Design
(http://go.microsoft.com/fwlink/?LinkId=213201).

Configuring physical storage


This section provides general recommendations for physical storage. Determine the applicability of these
recommendations to your environment. Some storage area network (SAN) vendors may have alternative
recommendations that take precedence. Recommendations are listed in order of priority.

Microsoft Dynamics AX 2012 Installation Guide

50

Microsoft Dynamics AX

Many factors contribute to optimal I/O performance for a disk. By default, Windows Server 2008
aligns partitions. When you upgrade to Windows Server 2008, preexisting partitions are not
automatically aligned and must be manually rebuilt to guarantee optimal performance. Therefore,
until you rebuild the migrated partitions, alignment of disk partitions remains a relevant technology.
Check existing disks on the server, and be aware of the differences in the analysis of basic partitions
and dynamic volumes. Rebuild the partitions, if you can, and appropriate and create all new partitions
based on guidance from the SAN vendor. If the vendor does not provide recommendations, follow
the best practices for SQL Server. See Disk Partition Alignment Best Practices for SQL Server
(http://go.microsoft.com/fwlink/?LinkId=213222).
The partition offset value must be a multiple of the stripe size. In other words, the expression,
partition offset / stripe size, must resolve to an integer value.

Create the tempdb database files, data files for the Microsoft Dynamics AX database, and
Microsoft Dynamics AX log files on disk arrays of type RAID 1, RAID 0 + 1, or RAID 10. We
recommend RAID 10 for these files. Do not use RAID 5.

Store the data files for the Microsoft Dynamics AX database on separate physical stores from the
transaction log files.

Store the tempdb data files on a separate physical store from the data files and log files for the
Microsoft Dynamics AX database.

Store other database files on separate physical stores from the data files and log files for tempdb
and the Microsoft Dynamics AX database.

Summary
To help achieve optimal Microsoft Dynamics AX performance, you must correctly plan and configure and
the settings for SQL Server and storage. Additionally, you may have to adjust the database configuration
periodically.

Microsoft Dynamics AX 2012 Installation Guide

51

Microsoft Dynamics AX

Install the Microsoft Dynamics AX databases


This topic describes how to install the Microsoft Dynamics AX databases and model files.
There are three database components: the Microsoft Dynamics AX transaction database, the model store,
and the baseline model store. The Application Object Server (AOS) connects to the Microsoft Dynamics
AX database to process transactions. The AOS connects to the model store to display forms and reports.
The baseline model store is used to upgrade X++ code to Microsoft Dynamics AX 2012, and to analyze
application updates before they are applied.
In Microsoft Dynamics AX 2012 R3 and Microsoft Dynamics AX 2012 R2, the model store and the
transaction data are stored in separate databases. In earlier versions of Microsoft Dynamics AX 2012, the
model store and transaction data are stored in a single database.
Note:
If you are upgrading databases between AX 2012, AX 2012 Feature Pack, AX 2012 R2, and AX
2012 R3, you should review Scenario: Perform in-place upgrade to Microsoft Dynamics AX 2012
R2 or AX 2012 R3 (http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc92919f47afb8f(AX.60).aspx).
Model files contain metadata information about application objects and are stored in the model store. For
more information about model files, see Models, Layers, and the Model Store
(http://msdn.microsoft.com/library/cc7eb6ff-a5de-4a7e-a758-af783ce0ace0(AX.60).aspx).
Warning:
If you plan to enable database mirroring in Microsoft SQL Server, you must enable it after you
install the Microsoft Dynamics AX database and AOS. If you enable database mirroring before you
install Microsoft Dynamics AX components, warnings are generated when the AOS is installed.

Before you install the Microsoft Dynamics AX databases


Verify that the following steps are completed before you install the Microsoft Dynamics AX databases.

Configure SQL Server. For more information, see Configure SQL Server and storage settings.

On the computer where you plan to install the databases, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Make sure that you have the required permissions to install the database. For more information, see
Verify that you have the required permissions for installation.

Make sure that the appropriate firewall ports are open. For more information, see Firewall settings for
Microsoft Dynamics AX components.

Microsoft Dynamics AX 2012 Installation Guide

52

Microsoft Dynamics AX

Default models
The default models that are available in Setup vary based on the release of Microsoft Dynamics AX 2012
that you are installing.

Default models in AX 2012 R3 and Microsoft Dynamics AX 2012 R2


If you are installing AX 2012 R3 or AX 2012 R2, the following models are available in Setup by default.
Model

Description

Foundation

The base Microsoft Dynamics AX model, which contains the application


framework, the core application, extensions for industries, and localizations
for countries/regions. This model is required.

Foundation Upgrade

The model that is used to upgrade from Microsoft Dynamics AX 2009 or


Microsoft Dynamics AX 4.0.

Foundation Labels

Application labels for the foundation model. This model includes labels for
the following languages:

Arabic (Saudi Arabia)

Hungarian (Hungary)

Chinese (China)

Icelandic (Iceland)

Czech (Czech Republic)

Italian (Italy and Switzerland)

Danish (Denmark)

Japanese (Japan)

Dutch (Belgium and The

Latvian (Latvia)

Netherlands)

Lithuanian (Lithuania)

English (Australia, Canada, India,

Norwegian Bokmal (Norway)

Polish (Poland)

Kingdom, and United States)

Portuguese (Brazil)

Estonian (Estonia)

Russian (Russia)

Finnish (Finland)

Spanish (Mexico and Spain)

French (Belgium, Canada, France,

Swedish (Sweden)

and Switzerland)

Thai (Thailand)

Ireland, Malaysia, New Zealand,


Singapore, South Africa, United

German (Austria, Germany, and


Switzerland)

Microsoft Dynamics AX 2012 Installation Guide

53

Microsoft Dynamics AX

Default models in Microsoft Dynamics AX 2012 Feature Pack


If you are installing AX 2012 Feature Pack, the following models are available in Setup by default.
Model

Description

Foundation

The base Microsoft Dynamics AX model, which contains the


application framework and the application foundation. This
model also contains functionality for the discrete manufacturing
industry. This model is required.

Update for Foundation

Cumulative update for the Foundation model. If you selected to


install the Foundation model, this model is installed
automatically.

Foundation Upgrade

The model that is used to upgrade from Microsoft Dynamics AX


2009 or Microsoft Dynamics AX 4.0.

Update for Foundation Upgrade

Cumulative update for the Foundation Upgrade model. If you


selected to install the Foundation Upgrade model, this model is
installed automatically.

Foundation Labels

Application labels for the foundation model. This model includes


labels for the following languages:

Danish (Denmark)

Dutch (Belgium and The Netherlands)

English (Australia, Canada, India, Ireland, Malaysia, New


Zealand, Singapore, South Africa, United Kingdom, and
United States)

Foundation Labels II

French (Belgium, Canada, France, and Switzerland)

German (Austria, Germany, and Switzerland)

Italian (Italy and Switzerland)

Spanish (Mexico and Spain)

Application labels for the foundation model. These labels are for
languages that were released after Microsoft Dynamics AX 2012
was made generally available. This model includes labels for the
following languages:

Microsoft Dynamics AX 2012 Installation Guide

Arabic (Saudi Arabia)

Finnish (Finland)

Icelandic (Iceland)

Norwegian Bokmal (Norway)

Swedish (Sweden)

Thai (Thailand)

54

Microsoft Dynamics AX

Model

Description

SYP labels

Cumulative update of labels that were added by software


updates in the SYP layer.

Extensions

Microsoft Dynamics AX extensions for the following industries:

Process Manufacturing - Process manufacturing production


and logistics for Microsoft Dynamics AX. Allows you to
manage production, inventory, and costs in a processcontrolled environment, such as in the food, chemical, and
pharmaceutical industries.

Public Sector - Addresses the special controls, rules, and


regulations of Public Sector organizations.

Project Management Allows you to invoice customers for


various billing scenarios, such as billing per unit of delivery
and billing when a milestone is completed. You can also
create customer and vendor retentions, and manage
workers on projects.

Retail - Provides mid-market and large retailers a complete


head office and point of sale (POS) solution.
Important:
This model is required when you install AX 2012
Feature Pack. If the model includes functionality that
you do not plan to use, turn off the appropriate license
codes and configuration keys. Do not uninstall this
model to remove unwanted functionality. Uninstalling
models that are released by Microsoft will put the
system in an unsupported state. If you have uninstalled
this model, you must reinstall it using the instructions
found in How to: Export and Import a Model
(http://msdn.microsoft.com/library/c2449a03-75744b9d-8518-9005b560209f(AX.60).aspx).

Extensions Upgrade

The model that is used to upgrade Process Manufacturing,


Public Sector, Project Management, or Retail from Microsoft
Dynamics AX 2009 or Microsoft Dynamics AX 4.0.

Microsoft Dynamics AX 2012 Installation Guide

55

Microsoft Dynamics AX

Default models in Microsoft Dynamics AX 2012


If you are installing the original release of Microsoft Dynamics AX 2012, the following models are available
in Setup by default.
Model

Description

Foundation

The base Microsoft Dynamics AX model, which contains the


application framework and the application foundation. This
model also contains functionality for the discrete manufacturing
industry. This model is required.

Foundation Upgrade

The model that is used to upgrade from Microsoft Dynamics AX


2009 or Microsoft Dynamics AX 4.0.

Foundation Labels

Application labels for the foundation model. This model includes


labels for the following languages:

Danish (Denmark)

Dutch (Belgium and The Netherlands)

English (Australia, Canada, Ireland, Malaysia, New Zealand,


Singapore, South Africa, United Kingdom, and United
States)

Process Manufacturing

French (Belgium, Canada, France, and Switzerland)

German (Austria, Germany, and Switzerland)

Italian (Italy and Switzerland)

Spanish (Mexico and Spain)

The model that contains features for Process manufacturing


production and logistics for Microsoft Dynamics AX. You can use
these features to manage production, inventory, and costs in a
process-controlled environment, such as in the food, chemical,
and pharmaceutical industries.

Process Manufacturing Upgrade

The model that is used to upgrade Process manufacturing


production and logistics from Microsoft Dynamics AX 2009 or
Microsoft Dynamics AX 4.0.

Public Sector

The Public Sector model for Microsoft Dynamics AX. This model
addresses the special controls, rules, and regulations of Public
Sector organizations.

Project Management

The model that contains additional project-related features for


Microsoft Dynamics AX. You can use these features to invoice
customers for various billing scenarios, such as billing per unit of
delivery and billing when a milestone is completed. You can also
use these features to create customer and vendor retentions,
and to manage workers on projects.

Microsoft Dynamics AX 2012 Installation Guide

56

Microsoft Dynamics AX

Model

Description

Project Management Upgrade

The model that is used to upgrade Project Management from


Microsoft Dynamics AX 2009 or Microsoft Dynamics AX 4.0.

Include additional model files in the installation (optional)


When you install the databases, you must identify any additional model files that are required for your
environment.
During installation, Setup displays models from the CD\Models\ folder and all its subfolders. To import
additional layers or customizations, you can add other model files to this folder.
Follow these steps to include additional models in the installation:
1.

Browse to the directory where the files from the Microsoft Dynamics AX DVD are shared. For more
information, see Create a shared directory for installation.

2.

Create a subfolder in the CD\Models\ folder. We recommend that you create different folders to store
the models that are received from different sources. For example, create a folder for each
independent software vendor (ISV) or each value-added reseller (VAR).

3.

Copy the additional .axmodel files to the folders that you created.
Warning:
Do not copy your model files to the Standard folder. The Standard folder must be used only
for models that are mandatory, such as the Foundation model (Foundation.axmodel).

Install the Microsoft Dynamics AX databases


Use this procedure to install the Microsoft Dynamics AX databases and model files. If you install other
Microsoft Dynamics AX components at the same time, the installation pages vary, depending on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, on the Select an installation option page, click Microsoft Dynamics
AX, and then click Next.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Databases, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select databases page, select whether you want to create new databases by using Setup, or
whether you want to configure existing databases. If you are upgrading, you should select to
configure existing databases.

Microsoft Dynamics AX 2012 Installation Guide

57

Microsoft Dynamics AX
9.

If you want Setup to create the databases, on the Create new databases page, in the Server name
list, select the name of the computer that runs SQL Server. Provide database names or accept the
default database names. By default, the transaction database is named MicrosoftDynamicsAX. The
baseline database is optional. By default, the baseline database is named
MicrosoftDynamicsAX_baseline.
If you created the databases manually, or if you are upgrading a database, on the Configure existing
databases page, select the name of the computer that runs SQL Server, and then select the names of
the existing databases that you want to configure.
Important:
The database name must not include any spaces or any of the following characters:
backslashes (\), slashes (/), periods (.), commas (,), colons (:), brackets ([ ]), parentheses (( )), or
hyphens (-). For more information about characters that are allowed by SQL Server, see the
Identifiers (http://go.microsoft.com/fwlink/?LinkId=214698) topic on MSDN.
Click Next.

10. On the Select additional models page, select models in the Available Models list. Setup lists all the
models that are contained in the Models folder and its subfolders. Required models are selected by
default, and you cannot clear the selection.
Note:
You may have models, or .axmodel files, that are not electronically signed. The Setup program
cannot verify the publisher of an unsigned model file. If you import an unsigned model file
into the model store, you create a security risk. Setup displays an error message if a selected
model file does not have a digital signature. Before you decide whether you want to continue
or cancel the installation, carefully review the models that you have selected.
If you install models other than the Foundation models, you must complete the Compile application
task when you run the initialization checklist. If you do not complete the Compile application task,
you encounter errors when you run the Synchronize database task in the initialization checklist. For
more information about the initialization checklist, see Initialize Microsoft Dynamics AX
(http://technet.microsoft.com/library/ba7f64a8-c5c3-4a9a-927b-21afc16f92af(AX.60).aspx).
Click Next to continue.
11. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
12. On the Ready to install page, click Install.
13. After the installation is completed, click Finish to close the wizard.

Create a Microsoft Dynamics AX database manually


If you want to create databases manually for Microsoft Dynamics AX, you must first create databases
using Setup as a template.
1.

Follow the procedure above to create business and model store databases using Setup.

2.

Manually create a second business database using SQL Server Management Studio.

3.

Copy all objects, users, and user permissions from the template database to the new database.

Microsoft Dynamics AX 2012 Installation Guide

58

Microsoft Dynamics AX
4.

Manually create a second model database using SQL Server Management Studio. It must have the
same name as the new business database that you created in step 2, with _model at the end of the
name.

5.

Copy all objects, users, and user permissions from the template database to the new database.

6.

Configure an AOS instance to connect to the new business database. Installing an AOS instance sets
the appropriate rights for the AOS service account on the selected database server and creates stored
procedures used for session management.

7.

If you want an existing AOS instance to connect to the manually created database, you must set the
appropriate rights for the AOS account. Set the following permissions in the database:
a.

Make the account a login on the database server. (This login already exists if you are installing on
the same SQL Server computer as the first database.)

b. Assign the user to the db_ddladmin, db_datareader, and db_datawriter database roles.
c.

Grant the user execute rights on the createserversessions and createusersessions stored
procedures.

Microsoft Dynamics AX 2012 Installation Guide

59

Microsoft Dynamics AX

Install server and web server components


The topics in this section provide information about how to install the server and web server components
for Microsoft Dynamics AX. The following topics are included:

Install an Application Object Server (AOS) instance

Install Enterprise Portal

Install Search

Install help server

Install an Application Object Server (AOS) instance


The Application Object Server (AOS) is a Windows service that controls communications among Microsoft
Dynamics AX clients, databases, and applications.
Use the following topics to install an AOS instance:

Install an AOS instance

Install multiple AOS instances

Install an AOS instance


This topic describes how to install an Application Object Server (AOS) instance for Microsoft Dynamics AX
2012.
Note:
If you are upgrading AOS instances between AX 2012, AX 2012 Feature Pack, AX 2012 R2, and AX
2012 R3you should review Scenario: Perform in-place upgrade to Microsoft Dynamics AX 2012 R2
or AX 2012 R3 (http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc92919f47afb8f(AX.60).aspx).

Before you install the AOS instance

On the computer where you will install the AOS instance, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).
Note:
A 64-bit computer is not required to install an AOS instance. However, if you need to
complete a full Common Intermediate Language (CIL) generation, such as in a development
environment, a 64-bit computer is required.

Verify that you have the appropriate permissions to install the AOS instance. For more information,
see Verify that you have the required permissions for installation.

Microsoft Dynamics AX 2012 Installation Guide

60

Microsoft Dynamics AX

If you plan to enable database mirroring in SQL Server, you must do so after installing the Microsoft
Dynamics AX database and Application Object Server (AOS). If you enable database mirroring before
installing Microsoft Dynamics AX components, the AOS instance will install with warnings.

Select a service account for the AOS service. Before you install an AOS instance, you must determine
which account you want the AOS service to run as. The AOS service can run as a domain account, as a
managed service account, or as the Network Service account of the computer that you install the AOS
service on. For more information about how to set up an account for the AOS service, see Create
service accounts.

Choose a name for the AOS instance. We recommend that you use a uniform naming convention for
all aspects of the installation, such as the database name and the name of the AOS instance. Because
Microsoft Dynamics AX installations typically include one database and multiple AOS instances, make
sure that the name of each AOS instance is unique but consistent with the naming convention. For
example, you can use a name such as Fabrikam_DYNAX6_Live_AOS1, which includes a shortened form
of your business name, the Microsoft Dynamics AX version, a code that describes the purpose of the
installation, and an identifier for the AOS instance.
The instance name must not include any blank characters or any of the following characters:
ampersand (&), backslash (\), slash (/), colon (:), brackets ([]), parentheses (()), angle brackets (<>),
quotation marks (), question mark (?), exclamation point (!), asterisk (*), percent (%), caret (^), or
pipe (|).

You must install an initial AOS instance and complete the Initialization checklist on that instance
before you install additional AOS instances. If you install additional AOS instances before you have
completed the Initialization checklist those AOS instances will not start. For more information about
how to install additional AOS instances, see Install multiple AOS instances.

Install the first or only AOS instance


Use this procedure to install a single or first instance of AOS on a server. If you are installing other
Microsoft Dynamics AX components at the same time, the installation pages vary, based on the
components that you are installing.
Install an AOS instance
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the initial wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Application Object Server (AOS), and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location where you want 32-bit versions of Microsoft
Dynamics AX files to be installed, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

61

Microsoft Dynamics AX
9.

On the Connect to the databases page, in the Server name box, type or select the name of the
Microsoft SQL Server computer. In the Database name box, select the name of the Microsoft
Dynamics AX transaction database. Optionally, select the name of the baseline database.
If you are upgrading code or data from Microsoft Dynamics AX 4.0 or Microsoft Dynamics AX 2009,
you must select Register database for upgrade and select a baseline database. The Register
database for upgrade option is available when you install the first AOS in the computing
environment. If you install more AOSs, this option is not available. You can determine whether the
database was registered for upgrade by opening the Microsoft Dynamics AX client. If the database
was registered for upgrade, the Data upgrade checklist is displayed when you open the client. Click
Next.

10. On the Configure an Application Object Server (AOS) instance page, assign a name to the AOS
instance. Optionally, you can specify the ports that are listed in the following table.
Port

Purpose

Default

TCP/IP port

Used by other Microsoft Dynamics AX components to

2712

communicate with AOS.


Services WSDL port

Used by external applications to access the WSDL for AOS-

8101

based Microsoft Dynamics AX Web services.


Services endpoint port

Used by external applications to access AOS-based Microsoft

8201

Dynamics AX Web services.

11. On the Specify an AOS account page, select the Network Service account of the local computer
(recommended only for development environments), a managed service account, or a domain
account for the AOS service. If you select to use a managed service account, make sure to specify the
account in the format Domain\AccountName$.
Warning:
The process of manually changing the service account for an AOS is complicated and prone
to error. For this reason, if you must change the service account for an AOS, we recommend
that you uninstall and reinstall the AOS by using Setup.exe. For more information, see Change
the account used by AOS (http://technet.microsoft.com/library/87aaf2fa-1190-4036-9d39c1252c48da88(AX.60).aspx).
12. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
13. On the Ready to install page, click Install.
14. After the installation is complete, click Finish to close the wizard.
The AOS service can take several minutes to start the first time after it is installed. To determine
whether the AOS service has started, click Administrative tools > Services, and review the status of
the Microsoft Dynamics AX Object Server service.

Microsoft Dynamics AX 2012 Installation Guide

62

Microsoft Dynamics AX

Start the AOS Windows service


After you install an AOS instance, you must wait for the Microsoft Dynamics AX Object Server Windows
service to start.
By default, if a Windows service takes longer than 30 seconds to start, the system displays a message
informing you that the service did not respond to a start command. The AOS Windows service can take
longer than 30 seconds to start, and the lack of a response in 30 seconds can cause the service to stop.
Therefore, if an AOS instance repeatedly does not start, you may want to configure the registry to give
Windows services more time, such as 120 seconds, to start before the error message is displayed.
Warning:
This section describes how to modify the registry so that the AOS Windows service has enough
time to start before Windows displays an error message. Be aware that serious problems can
occur if you modify the registry incorrectly. We recommend that you back up the registry before
you modify it. If a problem occurs, you can restore it. For more information about how to back up
and restore the registry, see Backup and recovery
(http://go.microsoft.com/fwlink/?LinkId=214428).
1.

Click Start, click Run, type regedit, and then click OK.

2.

Locate and then click the following registry subkey:


\HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control

3.

Right-click Control, and then click New > DWORD (32-Bit) Value.

4.

Right-click the new key, and then click Rename. Enter the name ServicePipeTimeout.

5.

Right-click the key again, and then click Modify.

6.

In the Value data text box, enter 120000, and then click OK. The AOS Windows service now has 120
seconds to start before the system displays an error message.

If the AOS instance does not start after you implement this registry key, use the Microsoft Dynamics AX
Server Configuration utility to verify that the AOS instance is using a unique port. Port conflicts prevent
AOS instances from starting. For more information, see Change AOS ports
(http://technet.microsoft.com/library/2ba82a8b-bde4-4813-b231-5f025ff89927(AX.60).aspx).
Run the initialization checklist
After you install and start an AOS instance, and before you complete any other tasks in Microsoft
Dynamics AX, you must run the initialization checklist. For more information, see Initialize Microsoft
Dynamics AX (http://technet.microsoft.com/library/ba7f64a8-c5c3-4a9a-927b-21afc16f92af(AX.60).aspx).

See Also
Troubleshoot installation issues with AOS (http://technet.microsoft.com/library/e5b619c0-a99c-4841bfc4-5d78ac5e1975(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

63

Microsoft Dynamics AX

Install multiple AOS instances


This topic describes how to install multiple instances of Application Object Servers (AOS) for Microsoft
Dynamics AX 2012. You can install up to 99 AOS instances in your environment.
Important:
You must install an initial AOS instance and complete the Initialization checklist on that instance
before you install additional AOS instances. If you install additional AOS instances before you
have completed the Initialization checklist those AOS instances will not start. For more
information, see Install an AOS instance.

Install an AOS instance on multiple computers


In most production environments, you install multiple AOS instances, each on a different server. You can
use multiple AOS instances to support batch processing and load balancing. Install each AOS instance in
the way that is described in Install an AOS instance, and make sure that you point every AOS instance to
the same database. The first user who installs an AOS instance is automatically added to Microsoft
Dynamics AX as an administrator. If subsequent AOS instances are installed by different users, you must
manually add those users to the Microsoft Dynamics AX System administrator role to grant them
administrative rights in Microsoft Dynamics AX.
You can use a single domain account for all instances of the AOS service, or you can specify a different
account for each instance.

Install multiple AOS instances on one computer


In some testing and development scenarios, you may want to install multiple AOS instances on the same
computer. For example, if you are developing code for multiple versions of Microsoft Dynamics AX, you
can install different versions of AOS side by side.
Install each AOS instance in the way that is described in Install an AOS instance. If you install an AOS
instance on a server that already has an AOS instance, you must specify a unique port number for each
instance. By default, every time that you install an additional AOS instance on a computer, the TCP/IP,
WSDL, and NET-TCP port numbers are incremented by 1. If the same port number is used for more than
one AOS instance on a computer, one of the AOS instances that have conflicting port numbers does not
start.

See Also
Application Object Server security and protection (http://technet.microsoft.com/library/ec82b5b9-8fa04d9e-9ac2-6ffa985be9c5(AX.60).aspx)
Configure an AOS instance as a batch server (http://technet.microsoft.com/library/74687f8d-fd55-4a99bea9-835655905fb4(AX.60).aspx)
Manage an AOS configuration (http://technet.microsoft.com/library/4aab5e81-921d-4f7f-b379adffcb8febce(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

64

Microsoft Dynamics AX

Install Enterprise Portal


This section contains information about how to install Microsoft Dynamics AX 2012 Enterprise Portal. Use
the following topics to help you install Enterprise Portal.

Checklists for deploying Enterprise Portal sites

Install Enterprise Portal on a single server

Deploy Enterprise Portal in a server farm

Deploy a claims-mode Enterprise Portal site

Install Enterprise Portal in a traditional perimeter network

Install Enterprise Portal Help content

Install multiple Enterprise Portals on the same server

Set up Enterprise Portal and Role Centers

Deploy Microsoft Dynamics AX Web parts to a SharePoint site


Note:
If you are upgrading Enterprise Portal between AX 2012, AX 2012 Feature Pack, AX 2012 R2, and
AX 2012 R3, you should review Scenario: Perform in-place upgrade to Microsoft Dynamics AX
2012 R2 or AX 2012 R3 (http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc92919f47afb8f(AX.60).aspx).

Checklists for deploying Enterprise Portal sites


The topics in this section provide checklists that can help you deploy different types of sites in Enterprise
Portal for Microsoft Dynamics AX.

Checklist: Deploy an internal Enterprise Portal site that has Role Centers

Checklist: Deploy an employee self-service portal

Checklist: Deploy an unsolicited vendor portal

Checklist: Deploy a vendor registration portal

See Also
Enterprise Portal architecture (http://technet.microsoft.com/library/967d873d-5a15-4a6c-990c2831938731fb(AX.60).aspx)
Overview of Enterprise Portal for Microsoft Dynamics AX (http://technet.microsoft.com/library/5c731ae45882-41cc-9748-6b0e65a1664d(AX.60).aspx)

Checklist: Deploy an internal Enterprise Portal site that has Role Centers
This topic provides checklists that can help you deploy Enterprise Portal for Microsoft Dynamics AX and
Role Centers for an employee portal that is for internal use only. An employee portal for internal use only
provides access to the following modules sites in Enterprise Portal. If your business or organization
deploys Role Centers, users can also access their Role Center page on the Home site.

Home site/Role Center

Sales

Microsoft Dynamics AX 2012 Installation Guide

65

Microsoft Dynamics AX

Procurement

Employee services

Project

Compliance

Service Management

User access to modules sites is determined by Microsoft Dynamics AX security roles. For a description of
the features and reports that are available on each of these modules sites, see Overview of Enterprise
Portal for Microsoft Dynamics AX (http://technet.microsoft.com/library/5c731ae4-5882-41cc-97486b0e65a1664d(AX.60).aspx). If you want to deploy an employee self-service portal that gives employees
access to expense management, time and attendance, and other personal information, see Checklist:
Deploy an employee self-service portal.
The following table describes the tasks that you must complete to deploy Enterprise Portal and Role
Centers. After you complete the tasks in this checklist, internal users can access the employee portal in the
network.
Task

More information

Install Enterprise Portal

Install Enterprise Portal on a single server


-orInstall Enterprise Portal in a Web farm

Install Enterprise Portal Help content

Install Enterprise Portal Help content

Configure security and enable users to access the

Checklist: Configure Enterprise Portal security

Enterprise Portal site.

(http://technet.microsoft.com/library/fed77384-7e0c-446f-8f171fb3220a07c1(AX.60).aspx)

Configure parameters for Enterprise Portal.

Specify Enterprise Portal parameters


(http://technet.microsoft.com/library/cc5082d0-0c89-4553a21b-af076c9f830a(AX.60).aspx)

Configure Enterprise Portal for Role Centers.

Checklist: Configure Role Centers


(http://technet.microsoft.com/library/17abe92f-40df-4d5f-9f8d4842c0a1d001(AX.60).aspx)

Checklist: Deploy an employee self-service portal


This topic provides checklists that can help you deploy an employee self-service portal for Enterprise
Portal for Microsoft Dynamics AX. An employee self-service portal gives users access to expense
management, time and attendance, and other personal information. For a complete description of the
features and reports that are available on an employee self-service portal, see Overview of Enterprise
Portal for Microsoft Dynamics AX (http://technet.microsoft.com/library/5c731ae4-5882-41cc-97486b0e65a1664d(AX.60).aspx). If you want to deploy an employee portal that is for internal use only, and
that gives users access to Microsoft Dynamics AX module sites and Role Centers, see Checklist: Deploy an
internal Enterprise Portal site that has Role Centers.

Microsoft Dynamics AX 2012 Installation Guide

66

Microsoft Dynamics AX
The following table describes the tasks that you must complete to deploy Enterprise Portal. After you
complete the tasks in this checklist, internal users can access the employee self-service portal in the
network.
Task

More information

Install Enterprise Portal.

Install Enterprise Portal on a single server


-orInstall Enterprise Portal in a Web farm

Install Enterprise Portal Help content

Install Enterprise Portal Help content

Configure security and enable users to access the

Checklist: Configure Enterprise Portal security

Enterprise Portal site.

(http://technet.microsoft.com/library/fed77384-7e0c-446f8f17-1fb3220a07c1(AX.60).aspx)

Configure parameters for Enterprise Portal.

Specify Enterprise Portal parameters


(http://technet.microsoft.com/library/cc5082d0-0c89-4553a21b-af076c9f830a(AX.60).aspx)

Checklist: Deploy an unsolicited vendor portal


An unsolicited vendor portal enables vendor prospects to register with your company.
The following table describes tasks that you must complete to set up and configure an unsolicited vendor
portal.
Task

More information

Install Enterprise Portal.

Install Enterprise Portal on a single server


-orInstall Enterprise Portal in a Web farm

Install Enterprise Portal Help content.

Install Enterprise Portal Help content

Create an Enterprise Portal public site.

Create a public Enterprise Portal site


(http://technet.microsoft.com/library/5fe392a4-5683-469ebcfe-ecfaa6e24883(AX.60).aspx)

Enable guest users to access the public Enterprise

See the section titled Grant users access to a public site in

Portal site.

Enable users to access Enterprise Portal


(http://technet.microsoft.com/library/2adbf75e-a599-45caa849-765185bf7897(AX.60).aspx)

Configure user provisioning for vendor-add

Key tasks: Set up vendor add requests

requests.

(http://technet.microsoft.com/library/7cf92c10-76ff-4090b9d6-15b97ffa6521(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

67

Microsoft Dynamics AX

Task

More information

Configure security and enable users to access the

Checklist: Configure Enterprise Portal security

Enterprise Portal site.

(http://technet.microsoft.com/library/fed77384-7e0c-446f8f17-1fb3220a07c1(AX.60).aspx)

Checklist: Deploy a vendor registration portal


This topic provides checklists that can help you deploy Enterprise Portal for Microsoft Dynamics AX for
vendor access. Vendors who have registered with your business or organization can perform a variety of
tasks from a vendor self-service portal. Some of the common tasks include the following:

Update a profile

Update contacts

View purchase orders that have not yet been invoiced

Request to be added to additional procurement categories

Request to add users from your organization to the vendor self-service portal

Create invoices from purchase orders

For a complete description of the features and reports available on a vendor portal, see Overview of
Enterprise Portal for Microsoft Dynamics AX (http://technet.microsoft.com/library/5c731ae4-5882-41cc9748-6b0e65a1664d(AX.60).aspx). For information about how to deploy an unsolicited vendor portal, see
Checklist: Deploy an unsolicited vendor portal.
Checklist for a vendor portal deployment
The following table describes tasks that you must complete to deploy Enterprise Portal.
Task

For more information

Install Enterprise Portal

Install Enterprise Portal on a single server


-orInstall Enterprise Portal in a Web farm

Install Enterprise Portal Help content

Install Enterprise Portal Help content

Configure Enterprise Portal security.

Checklist: Configure Enterprise Portal security


(http://technet.microsoft.com/library/fed77384-7e0c446f-8f17-1fb3220a07c1(AX.60).aspx)

Configure Microsoft Dynamics AX to enable vendor user

Configuring Enterprise Portal for vendor requests

provisioning. Users are provisioned either as part of the

(http://technet.microsoft.com/library/fd6b06a0-6bb7-

user request process, or automatically through specific

49f5-9717-ae40a1f7d327(AX.60).aspx)

tasks in the user request workflow. User provisioning


automates the creation of Microsoft Dynamics AX user
accounts and user permission assignments. This ensures
proper control of users and their access to the Vendor
portal and simplifies the process of creating users.

Microsoft Dynamics AX 2012 Installation Guide

68

Microsoft Dynamics AX

Task

For more information

Specify vendor roles on the External roles form.

Click System administration > Setup > Security >


External roles.

Configure Enterprise Portal parameters

Specify Enterprise Portal parameters


(http://technet.microsoft.com/library/cc5082d0-0c894553-a21b-af076c9f830a(AX.60).aspx)

Next step
After you finished preparing the Enterprise Portal environment for vendor access, you must configure
vendor portal pages and vendor portal workflow templates in the Microsoft Dynamics AX client. For more
information, see Configuring Enterprise Portal for vendor requests
(http://technet.microsoft.com/library/fd6b06a0-6bb7-49f5-9717-ae40a1f7d327(AX.60).aspx) in the
Microsoft Dynamics AX online Help.

Install Enterprise Portal on a single server


This topic describes how to install Enterprise Portal for Microsoft Dynamics AX on a single server.
Businesses and organizations typically use a single-server deployment for development environments or
testing.
For information about scale-out deployments, see Install Enterprise Portal in a Web farm. For information
about how to install Enterprise Portal in an environment with two domain controllers and two firewalls for
extranet deployments, see Install Enterprise Portal in a traditional perimeter network.

Before you install Enterprise Portal


Complete the following tasks before you install Enterprise Portal and Role Centers:

If you installed a non-SYS layer model file in the Microsoft Dynamics AX environment, compile
Microsoft Dynamics AX before you install Enterprise Portal. If you do not compile Microsoft Dynamics
AX, the Enterprise Portal installation might fail.

Microsoft Dynamics AX 2012 Installation Guide

69

Microsoft Dynamics AX

If you want to deploy Enterprise Portal in multiple languages, you must download and deploy
SharePoint language packs onto the web server before you install Enterprise Portal. You can
download SharePoint language packs from Microsoft.com. Enterprise Portal is currently supported in
the following languages:
Arabic

English (South Africa)

Italian

Chinese (Simplified)

English (UK)

Italian (Switzerland)

Czech

English (US)

Japanese

Danish - 1030

Estonian

Latvian

Dutch (Netherlands)

Finnish

Lithuanian

Dutch (Belgium)

French (France)

Norwegian

English

French (Canada)

Polish

English (Australia)

French (Belgium)

Portuguese (Brazilian)

English (Canada)

French (Switzerland)

Russian

English (India)

German (Germany)

Spanish (international)

English (Ireland)

German (Austria)

Spanish (Mexico)

English (Malaysia)

German (Switzerland)

Swedish

English (New Zealand)

Hungarian

Thai

English (Singapore)

Icelandic

To deploy Enterprise Portal in one of the languages list here, you must create a Web application in
SharePoint and specify the new language. For more information, see Create an Enterprise Portal site
(http://technet.microsoft.com/library/da9149f8-9bb8-4d95-b392-4c6954a60b5f(AX.60).aspx).

Verify that the name of the server that will host Enterprise Portal does not include an underscore, for
example EPserver_1. If an Enterprise Portal server includes an underscore in the server name, lookups
and web pages might display errors.

On the computer where you will install Enterprise Portal, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Verify that you have the appropriate permissions to install Enterprise Portal. If you are installing
Enterprise Portal on a server that already hosts an Enterprise Portal deployment and you want to
overwrite that deployment, you must have Full Control permission in SharePoint for the existing
Enterprise Portal site collection. If you do not have Full Control permission, you will not be able to
delete the existing site collection by using Setup. For more information about permissions, see Verify
that you have the required permissions for installation.

If you intend to deploy multiple Enterprise Portals on the same server and those portals will connect
to different Application Object Servers, then you must update the web.config file. For more
information, see Install multiple Enterprise Portals on the same server.

Microsoft Dynamics AX 2012 Installation Guide

70

Microsoft Dynamics AX

For Secure Sockets Layer (SSL) encryption, you cannot install Enterprise Portal on a Web application
that is already configured to use HTTP and HTTPS bindings. You must remove the HTTP binding from
the site by using Internet Information Services (IIS) Manager before you install Enterprise Portal.

If you plan to use host headers, review the SharePoint documentation about host headers and Web
farms before you install Enterprise Portal.
Important:
If you attempt to install Enterprise Portal on an existing Internet Information Services (IIS) site
that is already configured to use a host header, the installation fails, unless you create a
BackConnectionHostNames (http://go.microsoft.com/fwlink/?LinkId=194948) registry entry.

Pre-installation tasks
Perform the following tasks to verify that you can deploy Enterprise Portal on the Web server.
1.

Verify that you can open SharePoint 2010 Central Administration on the Enterprise Portal server.

2.

Verify that you have the appropriate permissions to create sites by using SharePoint 2010 Central
Administration to create a SharePoint team site.

3.

Verify that you can browse the team site without prompts and resolve the URL without proxy errors or
other problems.

4.

If you intend to deploy or configure Enterprise Portal at a command prompt, verify that you can start
the SharePoint 2010 Management Shell.

Install Enterprise Portal


This section describes how to install Enterprise Portal by using Setup. If you are installing other Microsoft
Dynamics AX components at the same time, the installation pages vary, based on the components that
you are installing.
Tip:
By default, when you install SharePoint, the system creates a Web application on port 80.
Microsoft Dynamics AX Setup deploys an Enterprise Portal site on the port 80 Web application
unless you specify a different Web application. If you do not intend to deploy Enterprise Portal on
the default port-80 Web application, you must use SharePoint Central Administration to create a
new Web application before you install Enterprise Portal. Also note, if you intend to deploy
Enterprise Portal on a Web application that is already configured to use a host header, you must
use SharePoint Central Administration to create a new Web application using the host header
before you install Enterprise Portal. For any new Web application, you must specify the Business
Connector proxy account as the application pool account in the Configurable list.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

Microsoft Dynamics AX 2012 Installation Guide

71

Microsoft Dynamics AX
5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Enterprise Portal (EP), and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location where you want to install 32-bit versions of
Microsoft Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want Enterprise
Portal to access configuration information from the registry on the local computer or from a shared
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. You can optionally specify the
name of the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this screen is not displayed. Subsequent installations on
this computer reuse the existing AOS connection.
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by the .NET Business Connector. Click Next.
12. On the Configure a Web site for Enterprise Portal page, select a web site. If no web sites are
available in the list, you must cancel Setup, create a web site by using SharePoint Central
Administration, and then try the installation again.
We recommend that you select the Configure for Windows SharePoint Services option. If you
select this option, Setup verifies that the site is a SharePoint site. If the site is not a SharePoint site,
Setup extends the site in SharePoint. Setup also sets the application pool to run under the service
account and sets the authentication method to Windows NTLM.
Important:
Note the following important information about the Create Web site option:

Clear this option if you are installing Enterprise Portal for a public site, such as an unsolicited
vendor portal. For public sites, you must create the Enterprise Portal site by using the public
site template. For more information, see Create a public Enterprise Portal site
(http://technet.microsoft.com/library/5fe392a4-5683-469e-bcfe-ecfaa6e24883(AX.60).aspx).

If you are installing Enterprise Portal for a stand-alone installation select the Create Web site
option to create a site at the following URL: http://ServerName/sites/DynamicsAX. Setup
creates a new site that uses port 80.

Click Next.
Note:
If your business or organization purchased a developer license for Microsoft Dynamics AX,
you can change the URL for the web site, title, and description before you complete the
installation. Modify the EPSetupParams file in the Application Object Tree (AOT) (Web > Web
Files > Static Files > EPSetupParams).

Microsoft Dynamics AX 2012 Installation Guide

72

Microsoft Dynamics AX
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is complete, click Finish to close the wizard.

Next steps
Configure the firewall on the Enterprise Portal server: For information about the recommended
firewall settings on an Enterprise Portal server, see Firewall settings for Microsoft Dynamics AX
components.

Deploy Enterprise Portal in a server farm


The topics in this section provide information about how to install Enterprise Portal for Microsoft
Dynamics AX in a server farm.

Install and configure Windows AppFabric for Enterprise Portal

Install Enterprise Portal in a Web farm

Install and configure Windows AppFabric for Enterprise Portal


This topic provides sample configurations and settings for installing Windows Server AppFabric
(http://go.microsoft.com/fwlink/?LinkId=324716) with Enterprise Portal for Microsoft Dynamics AX.
AppFabric is required to run Enterprise Portal in a web farm with Microsoft Dynamics AX 2012 R2.
AppFabric is not required for single-server Enterprise Portal deployments.
Windows Server AppFabric is a set of integrated technologies that make it easier to build, scale and
manage Web and composite applications that run on Internet Information Services (IIS). AppFabric
extends Windows Server to provide enhanced hosting, management, and caching capabilities for Web
applications and middle-tier services. Enterprise Portal uses the AppFabric distributed, in-memory caching
services to improve the performance and scalability of the application.
Important:
This document includes sample settings and configurations to help you install AppFabric for
Enterprise Portal. Depending on your hardware, software, and computing environment, you might
select different settings and configurations from those specified in this document.
Note:
Previous versions of Windows Server AppFabric were called Velocity Server. This document
includes code blocks that make reference to Velocity.
Install and configure Windows Server AppFabric on a single server
Use the following procedures to install Windows Server AppFabric single server and then run the
configuration wizard. To install AppFabric in a cluster, see Install Windows Server AppFabric in a cluster
in this document. The installation program provides the following functionality:

Enables you to select specific features to install.

Validates the operating system to make sure that the product is not installed in an unsupported state,
and indicates which prerequisites have to be installed.

Installs AppFabric.

Microsoft Dynamics AX 2012 Installation Guide

73

Microsoft Dynamics AX

Enables you to remove specific AppFabric features or AppFabric as a whole. This makes sure that the
computer can be left in a state in which the features or AppFabric can be reinstalled.

Creates the AppFabric Caching Service. Sets the services to a startup type of manual and a status of
stopped.

The AppFabric Setup program sets configuration settings in the root (server level) Web.config file, the
machine.config file, and the applicationHost.config file. You can configure AppFabric either immediately
after installation, or in a separate process. Installing and configuring Windows Server AppFabric on a
single server requires that you:
1.

Run Setup

2.

Run the configuration wizard

3.

Configure cache settings with PowerShell

4.

Install and configure the cache client

5.

Validate deployment

Each of these processes is described in this topic.


Run Setup
1.

Run one of the following Setup applications on the Enterprise Portal server:
For AppFabric 1.0, download (http://go.microsoft.com/fwlink/?LinkId=324596) and run the
WindowsServerAppFabricSetup_x64_6.1.
For AppFabric 1.1, download (http://go.microsoft.com/fwlink/?LinkId=386334) and run the
WindowsServerAppFabricSetup_x64.

2.

On the Accept License Terms page, read the license terms, and then accept the terms and then click
Next to continue, or do not accept the terms and then exit the setup wizard.

3.

On the Customer Experience Improvement Program page, select Yes to participate in the
Customer Experience Improvement program, or No not to participate, and then click Next.

4.

Clear the Yes, download and install critical updates option.

5.

On the Feature Selection page, select Caching Services and Cache Administration, and then click
Next.
Caching Services

The distributed Caching Service and related components that enable you to
prepare this host as a Caching Service, turning the server into the node of a
cluster. You can create a new cluster or join this host to an existing cluster
by using the Caching Service.

Cache Administration

Components that enable you to administer a cache cluster. You can select
Cache Administration as an independent component, without other
features selected. In that instance, you could use administration tools to
administer the Caching Service installed on a separate computer.

Note:
If prerequisite software has to be installed, the setup wizard will display the Platform
Validation page after the Feature Selection page. You must install the missing prerequisites

Microsoft Dynamics AX 2012 Installation Guide

74

Microsoft Dynamics AX
manually. If all prerequisites have already been installed, the setup wizard will continue to the
Confirm Installation Selections page.
6.

On the Platform Validation page, review the information and download any prerequisite software.
Click the link for a component or a configuration issue for more information. After installing
components and resolving issues, click Refresh to verify that the problem has been fixed and then
click Next to continue with the setup wizard.

7.

The Confirm Installation Selections page will display a list of the features that were selected in the
Feature Selection page, and will be installed. It displays a list of the required Windows components
and the AppFabric features that will be installed. Verify that the lists are correct, and then click Install
to begin installation.
Note:
The Application Server role is required for AppFabric. This role will be included in the list of
the required Windows components even if it is already installed, and the installation wizard
will verify that it has been installed.

8.

On the Installation Progress page, you can monitor the progress of the installation.

9.

On the Installation Results page, verify that the installation has succeeded. To display a list of
recommended updates that you can install, click the Recommended Updates link. To run the
configuration wizard, select the Launch configuration tool check box, and then click Finish to
complete the installation wizard. Click Detailed Installation report to display a log of setup events.

Run the configuration wizard


This section describes recommended settings for Windows Server AppFabric with Enterprise Portal. The
following table lists settings as they appear in the Windows Server AppFabric Configuration Wizard. For
more information about the options or settings in the configuration wizard, see Configure Windows
Server AppFabric (http://go.microsoft.com/fwlink/?LinkId=324774).
Configuring Caching service parameters

Suggested settings

Set Caching Service configuration

Select this option

Caching Service configuration provider

XML

File share (UNC server share required:

Create a file share on the C drive of the Enterprise Portal server.

\\server\share)

Configure permissions for the share as follows:

Grant read access for the account under which the Enterprise
Portal application pool is running in IIS (This is also the .NET
Business Connector proxy account).

Grant read access for the application caching account.

New cluster

Select this option

Cluster size

Select Small (1-5 computers)

Click Next to view the next page of the wizard.

Microsoft Dynamics AX 2012 Installation Guide

75

Microsoft Dynamics AX

Configure AppFabric Cache Node

Suggested settings

Node ports

Retain default settings

Windows firewall exceptions

Select Windows Server AppFabric: AppFabric Caching Service

Click Finish. When prompted, click Yes.


Configure cache settings with PowerShell
The procedure in this section uses PowerShell Cmdlets to configure cache settings. For more information,
about these cmdlets, see AppFabric Caching PowerShell Cmdlts
(http://go.microsoft.com/fwlink/?LinkId=324842) on MSDN.
1.

Open the Caching Administration Windows PowerShell command prompt as an administrator.

2.

Execute the Use-CacheCluster (http://go.microsoft.com/fwlink/?LinkId=324847) command to set the


context of your PowerShell session to a particular cache cluster.

3.

Execute the New-Cache (http://go.microsoft.com/fwlink/?LinkId=324848) command to create a new


named cache. Make a note of the name you specified. You will enter this cache name in the next
procedure.

4.

Execute the Grant-CacheAllowedClientAccount (http://go.microsoft.com/fwlink/?LinkId=324849)


command and specify the .NET Business Connector proxy (the account that is used by the Enterprise
Portal application pool).

5.

Execute the Start-CacheCluster (http://go.microsoft.com/fwlink/?LinkId=324850) command to start


the cache.

Install and configure the cache client


1.

Run the WindowsServerAppFabricSetup_x64_6.1.exe file on the Enterprise Portal server.

2.

On the Feature Selection page, select Cache Client and clear all other options. Click Next.
Cache Client

The client libraries that enable you to use cache functionality in your applications
during development or run time. You can install this component even if you are
not installing the Caching Services.

3.

Complete the setup wizard.

4.

In Windows explorer, open the c:\inetpub\wwwroot\<Enterprise Portal web app> folder. Locate the
web.config file and create a backup of this file in a different location.

5.

Open the web.config file.

6.

Locate the <configSections>. Add the following section tag:


<section name="dataCacheClient"
type="Microsoft.ApplicationServer.Caching.DataCacheClientSection,
Microsoft.ApplicationServer.Caching.Core, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=31bf3856ad364e35" allowLocation="true" allowDefinition="Everywhere" />

7.

Add the following AppFabric cache client tags to the web.config file after the </configSections>.
Replace Host_server_name with the name of the name of the server where you installed Windows

Microsoft Dynamics AX 2012 Installation Guide

76

Microsoft Dynamics AX
Server AppFabric. Replace default with the name specified when you executed the New-Cache
command.
<!-- velocity -->
<dataCacheClient>
<localCache isEnabled="false" />
<hosts>
<!--List of hosts -->
<!-- Replace Host_server_name with velocity server name -->
<host name="Host_server_name" cachePort="22233" />
</hosts>
</dataCacheClient>
<Microsoft.Dynamics>
<AppFabricCaching CacheName="default" />
</Microsoft.Dynamics>
<!-- velocity -->

Required configurations for AppFabric 1.1


If you installed AppFabric 1.1, you must choose Option 1 or Option 2 in this section and perform the
procedures for that option. If you installed AppFabric 1.0, you can skip this section.
You must choose one of these options because AppFabric 1.1 DLLs are not stored in the Global Assembly
Cache (GAC). If you run Enterprise Portal in an AppFabric 1.1 environment without performing the
procedures for Option 1 or Option 2, Enterprise Portal returns an error.
Option 1: Add AppFabric codeBase tags to the web.config file This option is more complex than
Option 2, but it reduces overall administration time and troubleshooting because you only have to
perform the procedure one time.
Option 2: Copy AppFabric DLLs to the bin folder This option is a simple copy/paste, but if the
AppFabric DLLs are ever updated, you must repeat this procedure with the updated AppFabric DLLs.
Updated DLLs can include AppFabric hotfixes, updates, or version releases. If you do not repeat this
procedure whenever AppFabric DLLs are updated, you might receive errors in Enterprise Portal.
Option 1: Add AppFabric codeBase tags to the web.config file
Use the procedures in this section to add tags to the Enterprise Portal web.config file.
1.

Open the web.config file in Microsoft Visual Studio or a text editor, such as Notepad. By default, the
file is located in the following directory on the Enterprise Portal server:
C:\inetpub\wwwroot\wss\VirtualDirectories\80\web.config

2.

Add the codebase tag for the following AppFabric DLLs:


Microsoft.ApplicationServer.Caching.Core.dll
Microsoft.ApplicationServer.Caching.Client.dll
Microsoft.WindowsFabric.Common.dll
Microsoft.WindowsFabric.Data.Common.dll

Microsoft Dynamics AX 2012 Installation Guide

77

Microsoft Dynamics AX

Important:
The href attribute for the codeBase tag must specify the location of the AppFabric DLLs. By
default, the DLLs are located in the following directory: C:\Program Files\AppFabric 1.1 for
Windows Server\.
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">

<!-- velocity -->


<dependentAssembly>
<assemblyIdentity name="Microsoft.ApplicationServer.Caching.Core"
publicKeyToken="31bf3856ad364e35" culture="neutral" />
<codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows
Server\Microsoft.ApplicationServer.Caching.Core.dll"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.ApplicationServer.Caching.Client"
publicKeyToken="31bf3856ad364e35" culture="neutral" />
<codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows
Server\Microsoft.ApplicationServer.Caching.Client.dll"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.WindowsFabric.Common"
publicKeyToken="31bf3856ad364e35" culture="neutral" />
<codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows
Server\Microsoft.WindowsFabric.Common.dll"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="Microsoft.WindowsFabric.Data.Common"
publicKeyToken="31bf3856ad364e35" culture="neutral" />
<codeBase version="1.0.0.0" href="C:\Program Files\AppFabric 1.1 for Windows
Server\Microsoft.WindowsFabric.Data.Common.dll"/>
</dependentAssembly>
<!-- velocity -->

</assemblyBinding>
</runtime>

Microsoft Dynamics AX 2012 Installation Guide

78

Microsoft Dynamics AX
3.

Search the web.config file for the following tag:


<system.web>
<securityPolicy>
<trustLevel name="WSS_Medium" policyFile="C:\Program Files\Common Files\Microsoft
Shared\Web Server Extensions\14\config\wss_mediumtrust.config" />

4.

Open the directory specified in the trustLevel > policyFile section of this tag. For example: C:\Program
Files\Common Files\Microsoft Shared\Web Server Extensions\14\config\

5.

Make a copy of the wss_mediumtrust.config file in this directory. Rename the copy as
wss_mediumtrust_appfabric.config.

6.

Open the wss_mediumtrust_appfabric.config file.

7.

Search the file for the following tag: class="FirstMatchCodeGroup"

8.

Add the UnionCodeGroup section in a new <CodeGroup section beneath the FirstMatchCodeGroup
section. Be sure to add it down to the first closing </CodeGroup> tag. The closing tag is not included
in the following example:
<CodeGroup
class="FirstMatchCodeGroup"
version="1"
PermissionSetName="Nothing">
<IMembershipCondition
class="AllMembershipCondition"
version="1"
/>
<CodeGroup
class="UnionCodeGroup"
version="1"
PermissionSetName="FullTrust">
<IMembershipCondition
class="UrlMembershipCondition"
version="1"
Url="file:///C:/Program Files/AppFabric 1.1 for Windows Server/*"
/>

9.

In the web.config file, search for the <system.web> tag.

10. Add the following tag in the <securityPolicy> section:


<trustLevel name="WSS_Medium_Custom" policyFile="C:\Program Files\Common Files\Microsoft
Shared\Web Server Extensions\14\config\wss_mediumtrust_appfabric.config" />

11. Search the file for the <trust originUrl="" level="WSS_Medium" /> tag.

Microsoft Dynamics AX 2012 Installation Guide

79

Microsoft Dynamics AX
12. Change the trust level to WSS_Medium_Custom. For example:
<trust originUrl="" level="WSS_Medium_Custom" />

13. Save your changes in the file.


14. From the Run dialog, type iisreset to restart the web service.
Option 2: Copy AppFabric DLLs to the bin folder
1.

Copy the following files from the C:\Program Files\AppFabric 1.1 for Windows Server directory:
a.

Microsoft.ApplicationServer.Caching.Core.dll

b. Microsoft.ApplicationServer.Caching.Client.dll
c.

Microsoft.WindowsFabric.Common.dll

d. Microsoft.WindowsFabric.Data.Common.dll
2.

Paste these files into the following directory: C:\inetpub\wwwroot\wss\VirtualDirectories\80\_app_bin

3.

From the Run dialog, type iisreset and press Enter.


Warning:
If the AppFabric 1.1 DLLs are ever updated, for example if AppFabric 1.2 or 2.0 is released, then
you must repeat this procedure with the updated DLLs.

Validate deployment
Use the following procedure to verify that the AppFabric cache stores Enterprise Portal session on the
server.
1.

On the AppFabric server, verify in the Windows Services console that AppFabricCachingService is
running.

2.

Open a Windows PowerShell command prompt as an administrator.

3.

Execute the Get-CacheStatistics (http://go.microsoft.com/fwlink/?LinkId=324868) default command.


The results should display all zeros.

4.

Open Enterprise Portal and submit an Expense report.

5.

Execute the Get-CacheStatistics (http://go.microsoft.com/fwlink/?LinkId=324868) default command


again and verify that the cache displays values. This indicates that cache distribution is working.

Install and configure Windows Server AppFabric in a cluster


Use the following procedures to install Windows Server AppFabric in a cluster and then run the
configuration wizard. The installation program provides the following functionality:

Enables you to select specific features to install.

Validates the operating system to make sure that the product is not installed in an unsupported state,
and indicates which prerequisites must be installed.

Installs AppFabric.

Enables you to remove specific AppFabric features or AppFabric as a whole, making sure that the
computer can be left in a state in which the features or AppFabric can be reinstalled.

Microsoft Dynamics AX 2012 Installation Guide

80

Microsoft Dynamics AX

Creates the AppFabric Caching Service. Sets the services to a startup type of manual and a status of
stopped.

The AppFabric Setup program sets configuration settings in the root (server level) Web.config file, the
machine.config file, and the applicationHost.config file. You can configure AppFabric either immediately
after installation, or in a separate process. Installing and configuring Windows Server AppFabric on a
single server requires that you:
1.

Run Setup

2.

Run the configuration wizard

3.

Configure additional servers in the AppFabric cluster

4.

Configure the cluster cache settings with PowerShell

5.

Install and configure the cache client

6.

Validate deployment

Each of these processes is described in this topic.


Run Setup
1.

Download (http://go.microsoft.com/fwlink/?LinkId=324596) and run the


WindowsServerAppFabricSetup_x64_6.1.exe file on the host server in the cluster.

2.

On the Accept License Terms page, read the license terms, and then accept the terms and then click
Next to continue, or do not accept the terms and then exit the setup wizard.

3.

On the Customer Experience Improvement Program page, select Yes to participate in the
Customer Experience Improvement program, or No not to participate, and then click Next.

4.

Clear the Yes, download and install critical updates option.

5.

On the Feature Selection page, select Caching Services and Cache Administration, and then click
Next.
Caching Services

The distributed Caching Service and related components that enable you to
prepare this host as a Caching Service, turning the server into the node of a
cluster. You can create a new cluster or join this host to an existing cluster by
using the Caching Service.

Cache Administration

Components that enable you to administer a cache cluster. You can select Cache
Administration as an independent component, without other features selected.
In that instance, you could use administration tools to administer the Caching
Service installed on a separate computer.

Note:
If prerequisite software must be installed, the setup wizard will display the Platform
Validation page after the Feature Selection page. You must install the missing prerequisites
manually. If all prerequisites have already been installed, the setup wizard will continue to the
Confirm Installation Selections page.
6.

On the Platform Validation page, review the information and download any prerequisite software.
Click the link for a component or a configuration issue for more information. After installing

Microsoft Dynamics AX 2012 Installation Guide

81

Microsoft Dynamics AX
components and resolving issues, click Refresh to verify that the problem has been fixed and then
click Next to continue with the setup wizard.
7.

The Confirm Installation Selections page will display a list of the features that were selected in the
Feature Selection page, and will be installed. It displays a list of the required Windows components
and the AppFabric features that will be installed. Verify that the lists are correct, and then click Install
to begin installation.
Note:
The Application Server role is required for AppFabric. This role will be included in the list of
the required Windows components even if it is already installed, and the installation wizard
will verify that it has been installed.

8.

On the Installation Progress page, you can monitor the progress of the installation.

9.

On the Installation Results page, verify that the installation has succeeded. To display a list of
recommended updates that you can install, click the Recommended Updates link. To run the
configuration wizard, select the Launch configuration tool check box, and then click Finish to
complete the installation wizard. Click Detailed Installation report to display a log of setup events.

Run the configuration wizard


This section describes recommended settings for Windows Server AppFabric with Enterprise Portal. The
following table lists settings as they appear in the Windows Server AppFabric Configuration Wizard. For
more information about the options or settings in the configuration wizard, see Configure Windows
Server AppFabric (http://go.microsoft.com/fwlink/?LinkId=324774).
Configuring Caching service parameters

Suggested settings

Set Caching Service configuration

Select this option

Caching Service configuration provider

SQL Server AppFabric Caching Service Configuration Store


Provider

New cluster

Select this option

Cluster size

Select an option

Click Next to view the next page of the wizard.


Specify settings to create and register an AppFabric Caching Service

Suggested settings

configuration database that uses the Microsoft SQL Server provider


Register AppFabric Caching Service configuration database

Select this option

Create AppFabric Caching Service configuration database

Select this option

Microsoft Dynamics AX 2012 Installation Guide

82

Microsoft Dynamics AX
Enter required information in the Server and Database fields and then click OK.
Configure AppFabric Cache Node

Suggested settings

Node ports

Retain default settings

Windows firewall exceptions

Select Windows Server AppFabric: AppFabric Caching Service

When prompted, click Yes.


Configure additional servers in the AppFabric cluster
On each server in the cluster, repeat the procedures that are described in this section for running Setup
and running the configuration wizard. In the configuration wizard, you must select the following options
Configuring Caching service parameters

Suggested settings

Set Caching Service configuration

Select this option

Caching Service configuration provider

SQL Server AppFabric Caching Service Configuration Store Provider

Join cluster

Select this option

Click Next to view the next page of the wizard.


Specify settings to create and register an AppFabric Caching Service

Suggested settings

configuration database that uses the Microsoft SQL Server provider


Register AppFabric Caching Service configuration database

Select this option

Create AppFabric Caching Service configuration database

Clear this option

Enter the same information that you previously specified in the Server and Database fields and then click
OK.
Configure the cluster cache settings with PowerShell
The procedure in this section uses PowerShell Cmdlts to complete the process of configuring the cache.
For more information, about these cmdlts, see AppFabric Caching PowerShell Cmdlts
(http://go.microsoft.com/fwlink/?LinkId=324842) on MSDN.
1.

Open a Windows PowerShell command prompt as an administrator.

2.

Execute the Use-CacheCluster (http://go.microsoft.com/fwlink/?LinkId=324847) command to set the


context of your PowerShell session to a particular cache cluster.

3.

Execute the New-Cache (http://go.microsoft.com/fwlink/?LinkId=324848) command to create a new


named cache. Make a note of the name you specified. You will enter this cache name in the next
procedure.

4.

Execute the Grant-CacheAllowedClientAccount (http://go.microsoft.com/fwlink/?LinkId=324849)


command and specify the .NET Business Connector proxy (the account that is used by the Enterprise
Portal application pool).

Microsoft Dynamics AX 2012 Installation Guide

83

Microsoft Dynamics AX
5.

Execute the Set-CacheConfig (http://go.microsoft.com/fwlink/?LinkId=324878) command and specify


Secondaries parameter

6.

Export the configuration with this command: Export-CacheClusterConfig and specify a name for the
file.

7.

Open the file that you just created and add the following configuration to the <advancedProperties>
section:
<transportProperties maxBufferSize="1000000000" />

8.

Import the configuration with this command: Import-CacheClusterConfig

9.

Execute the Start-CacheCluster (http://go.microsoft.com/fwlink/?LinkId=324850) command to start


the cache.

Install and configure the cache client


1.

Run the WindowsServerAppFabricSetup_x64_6.1.exe file on the Enterprise Portal server.

2.

On the Feature Selection page, select Cache Client and clear all other options. Click Next.
Cache Client

The client libraries that enable you to use cache functionality in your applications
during development or run time. You can install this component even if you are not
installing the Caching Services.

3.

Complete the setup wizard.

4.

In Windows explorer, open the $\inetpub\wwwroot\ folder. Locate the web.config file and create a
backup of this file in a different location.

5.

Open the web.config file.

6.

Locate the <configSections>. Add the following section tag:


<configSections>
<!-- velocity -->
<section name="dataCacheClient"
type="Microsoft.ApplicationServer.Caching.DataCacheClientSection;
Microsoft.ApplicationServer.Caching.Core, Version=1.0.0.0; Culture=neutral,
PublicKeyToken=31bf3856ad364e35" allowLocation="true" allowDefinition="Everywhere" />
<sectionGroup name="Microsoft.Dynamics">
<section name="Session" type="System.Configuration.SingleTagSectionHandler, System,
Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
<section name="ServerState" type="System.Configuration.SingleTagSectionHandler, System,
Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
<section name="AppFabricCaching" type="System.Configuration.SingleTagSectionHandler,
System, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
</sectionGroup>
<!-- velocity -->

Microsoft Dynamics AX 2012 Installation Guide

84

Microsoft Dynamics AX
7.

Add the following dataCacheClient tag to the web.config file after the </configSections>. Replace
each instance of Host_server_name with the name of a server. Replace default with the name
specified when you executed the New-Cache command.
<!-- velocity -->
<dataCacheClient>
<localCache isEnabled="false" />
<hosts>
<!--List of hosts -->
<!-- Replace Host_server_name with velocity server name -->
<host name="Host_server_name1" cachePort="22233" />
<host name="Host_server_name2" cachePort="22233" />
<host name="Host_server_name3" cachePort="22233" />
</hosts>
</dataCacheClient>
<Microsoft.Dynamics>
<AppFabricCaching CacheName="default" />
</Microsoft.Dynamics>
<!-- velocity -->

Validate deployment
Use the following procedure to verify that the AppFabric cache stores Enterprise Portal session on the
server.
1.

On the AppFabric server, verify in the Windows Services console that AppFabricCachingService is
running.

2.

Open a Windows PowerShell command prompt as an administrator.

3.

Execute the Get-CacheStatistics (http://go.microsoft.com/fwlink/?LinkId=324868) default command.


The results should display all zeros.

4.

Restart the web service on the Enterprise Portal server.

5.

Open Enterprise Portal and submit an Expense report.

6.

Execute the Get-CacheStatistics (http://go.microsoft.com/fwlink/?LinkId=324868) default command


again and verify that the cache displays values. This indicates that cache distribution is working.

Install Enterprise Portal in a Web farm


This topic describes how to install and configure Enterprise Portal for Microsoft Dynamics AX in a Web
farm. A Web farm distributes Enterprise Portal requests and processing across multiple servers, which can
improve performance and availability.
For information about how to install Enterprise Portal in an environment with two domain controllers and
two firewalls for extranet deployments, see Install Enterprise Portal in a traditional perimeter network.
Note:

Microsoft Dynamics AX 2012 Installation Guide

85

Microsoft Dynamics AX
If you are upgrading Enterprise Portal between Microsoft Dynamics AX 2012, Microsoft Dynamics
AX 2012 Feature Pack, and Microsoft Dynamics AX 2012 R2, you should review Scenario: Perform
in-place upgrade to Microsoft Dynamics AX 2012 R2 or R3
(http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc9-2919f47afb8f(AX.60).aspx).

Before you begin


Complete the following tasks before you install Enterprise Portal in a Web farm:

Install and configure Windows Server AppFabric in your server farm. For more information, see Install
and configure Windows AppFabric for Enterprise Portal.

If you installed a non-SYS layer model file in the Microsoft Dynamics AX environment, compile
Microsoft Dynamics AX before you install Enterprise Portal. If you do not compile Microsoft Dynamics
AX, the Enterprise Portal installation might fail.

Verify that the name of each server in the Enterprise Portal Web farm does not include an underscore,
for example EPserver_1. If an Enterprise Portal server includes an underscore in the server name,
lookups and Web pages might display errors.

On each computer where you will install Enterprise Portal, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Verify that you have the appropriate permissions to install Enterprise Portal.

Member of the Administrator group in Windows on each server in the farm.

Member of the dbcreator and securityadmin roles in the Microsoft Dynamics AX SQL Server
instance.

Member of the System administrator role in Microsoft Dynamics AX.

Member of the SharePoint farm administrators group (if SharePoint is already installed on each
server)
If you are installing Enterprise Portal on a server that already hosts an Enterprise Portal
deployment and you want to overwrite that deployment, you must have Full Control permission
in SharePoint for the existing Enterprise Portal site collection. If you do not have Full Control
permission, you will not be able to delete the existing site collection by using Setup.

For Secure Sockets Layer (SSL) encryption, you cannot install Enterprise Portal on a Web application
that is already configured to use HTTP and HTTPS bindings. You must remove the HTTP binding from
the site by using IIS Manager before you install Enterprise Portal.

If you plan to deploy multiple Enterprise Portals on the same server and those portals will connect to
different Application Object Servers, you must update the web.config file. For more information, see
Install multiple Enterprise Portals on the same server.

Microsoft Dynamics AX 2012 Installation Guide

86

Microsoft Dynamics AX

If you plan to use host headers, review the SharePoint documentation about host headers and Web
farms before you install Enterprise Portal.
Important:
If you attempt to install Enterprise Portal on an existing Internet Information Services (IIS) site
that is already configured to use a host header, the installation fails, unless you create a
BackConnectionHostNames (http://go.microsoft.com/fwlink/?LinkId=194948) registry entry.

Topology overview
This topic uses the following Web server topology. The database, Application Object Server (AOS), and
report server are not included in this list. Your Web server topology might differ.
Server

Description

Notes

Administration Server

The following components and services

are installed and running:

Internet Information Services (IIS)

Microsoft SharePoint Server

SharePoint Central Administration

administration server.

Microsoft SharePoint Foundation

running. You must configure this service


in SharePoint Central Administration.

Microsoft Dynamics AX Enterprise


Portal

You must install Enterprise Portal on


each front-end Web server before you

Web Application service

The Microsoft SharePoint Foundation


Web Application service must be

Service

This server is the SharePoint farm

install Enterprise Portal on this server.

When you install Enterprise Portal on


this server by using Microsoft Dynamics
AX Setup, you can select the Create
Web site option or you can create the
site later using SharePoint Central
Administration. You must not select the
Create Web site option on any frontend Web server.

Web front-end servers

IIS

SharePoint Server

Microsoft SharePoint Foundation

a Web front-end.

You must install Enterprise Portal on


each front-end Web server before you

Web Application service

SharePoint is installed on each server as

install Enterprise Portal on the

Microsoft Dynamics AX Enterprise

SharePoint farm administration server.

Portal

When you install Enterprise Portal on


each Web front-end server by using
Microsoft Dynamics AX Setup, you must
clear the Create Web site option.

Microsoft Dynamics AX 2012 Installation Guide

87

Microsoft Dynamics AX

Install and configure SharePoint


Install and configure SharePoint on each farm in the server. Note the following requirements for the
SharePoint installation.
1.

If you are using a load balancer, specify a site name in the Load Balanced URL field on the Web
application that will host the Enterprise Portal site.

2.

The Microsoft SharePoint Foundation Web Application service must be running on the farm
administration server. You must configure this service in SharePoint Central Administration.

3.

Configure the Web application to use the Business Connector proxy account. This means you must
select the Configurable option and then enter the proxy credentials.

Supported languages
If you want to deploy Enterprise Portal in multiple languages, you must download and deploy SharePoint
language packs onto the web server before you install Enterprise Portal. You can download SharePoint
language packs from Microsoft.com. Enterprise Portal is currently supported in the following languages:
Arabic

English (South Africa)

Italian

Chinese (Simplified)

English (UK)

Italian (Switzerland)

Czech

English (US)

Japanese

Danish - 1030

Estonian

Latvian

Dutch (Netherlands)

Finnish

Lithuanian

Dutch (Belgium)

French (France)

Norwegian

English

French (Canada)

Polish

English (Australia)

French (Belgium)

Portuguese (Brazilian)

English (Canada)

French (Switzerland)

Russian

English (India)

German (Germany)

Spanish (international)

English (Ireland)

German (Austria)

Spanish (Mexico)

English (Malaysia)

German (Switzerland)

Swedish

English (New Zealand)

Hungarian

Thai

English (Singapore)

Icelandic

To deploy Enterprise Portal in one of the languages list here, you must create a Web application in
SharePoint and specify the new language. For more information, see Create an Enterprise Portal site
(http://technet.microsoft.com/library/da9149f8-9bb8-4d95-b392-4c6954a60b5f(AX.60).aspx).
You do not have to create portals for specific languages. You just have to install SharePoint language
packs, and then create a site as described in Create an Enterprise Portal site
(http://technet.microsoft.com/library/da9149f8-9bb8-4d95-b392-4c6954a60b5f(AX.60).aspx). Portals are
then displayed in the language that is specified for each user in the Options form in Microsoft Dynamics
AX.

Microsoft Dynamics AX 2012 Installation Guide

88

Microsoft Dynamics AX

Before you install Enterprise Portal


Perform the following tasks to verify that you can deploy Enterprise Portal in the SharePoint server farm.

Verify that you can open SharePoint Central Administration on the Enterprise Portal administration
server.

Verify that you have the appropriate permissions to create sites by using SharePoint Central
Administration to create a SharePoint team site.

Verify that you can browse the team site without prompts and resolve the URL without proxy errors or
other problems.

Install Enterprise Portal


This section describes how to install Enterprise Portal by using Setup. You must install Enterprise Portal on
each Web front-end server before you install on the farm administration server. When you install
Enterprise Portal on the Web front-end servers, you clear the option to create a site. This means that when
you install Enterprise Portal on the Web front-end servers, Setup deploys files and configures settings on
the server, but no site is created. When you install Enterprise Portal on the farm administration server, you
select the option to create a site.
Tip:
By default, when you install SharePoint, the system creates a Web application on port 80.
Microsoft Dynamics AX Setup deploys an Enterprise Portal site on the port 80 Web application
unless you specify a different Web application. If you do not intend to deploy Enterprise Portal on
the default port-80 Web application, you must use SharePoint Central Administration to create a
new Web application before you install Enterprise Portal. Also note, if you intend to deploy
Enterprise Portal on a Web application that is already configured to use a host header, you must
use SharePoint Central Administration to create a new Web application using the host header
before you install Enterprise Portal. For any new Web application, you must specify the Business
Connector proxy account as the application pool account in the Configurable list.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Enterprise Portal (EP), and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location where you want to install 32-bit versions of
Microsoft Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want Enterprise
Portal to access configuration information from the registry on the local computer or from a shared

Microsoft Dynamics AX 2012 Installation Guide

89

Microsoft Dynamics AX
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.
10. On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. You can optionally specify the
name of the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this screen is not displayed. Subsequent installations on
this computer reuse the existing AOS connection.
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by the .NET Business Connector. Click Next.
12. On the Configure a Web site for Enterprise Portal page, select a web site. If no Web sites are
available in the list, you must cancel Setup, create a web site by using SharePoint Central
Administration, and then try the installation again.
We recommend that you select the Configure for Windows SharePoint Services option. If you
select this option, Setup verifies that the site is a SharePoint site. If the site is not a SharePoint site,
Setup extends the site in SharePoint. Setup also sets the application pool to run under the service
account and sets the authentication method to Windows NTLM.
Important:
Note the following important information about the Create Web site option:

When you install Enterprise Portal on Web front-end servers in a server farm, you must clear
this option. The site must be created only on the administration server for the Web farm.

If you are installing Enterprise Portal on an administration server for a Web farm, select the
Create Web site option to create a site at the following URL:
http://ServerName/sites/DynamicsAX. Setup creates a new site that uses port 80.

Clear this option if you are installing Enterprise Portal for a public site, such as an unsolicited
vendor portal. For public sites, you must create the Enterprise Portal site by using the public
site template. For more information, see Create a public Enterprise Portal site
(http://technet.microsoft.com/library/5fe392a4-5683-469e-bcfe-ecfaa6e24883(AX.60).aspx).

Click Next.
Note:
If your business or organization purchased a developer license for Microsoft Dynamics AX,
you can change the URL for the web site, title, and description before you complete the
installation. Modify the EPSetupParams file in the Application Object Tree (AOT) (Web > Web
Files > Static Files > EPSetupParams).
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is complete, click Finish to close the wizard.
16. Repeat this procedure on every Web server in the server farm.

Microsoft Dynamics AX 2012 Installation Guide

90

Microsoft Dynamics AX

Optional: Specify machineKey values in web.config files for sites in a Web farm
If Enterprise Portal pages display authentication and access errors after you installed Enterprise Portal on
each server in the Web farm, you might have to specify values for machineKey properties in the
web.config file of each server in the Web farm. MachineKey properties, validationKey and decryptionKey, are
used to hash and decrypt authentication tickets and cookies. Values for machineKey properties must be
the same on all servers in the Web farm.
1.

On the administration server for the Web farm, open the web.config file in a text editor such as
Notepad. By default, the file is located in the following directory:
C:\Inetpub\wwwroot\wss\VirtualDirectories\PortNumber.

2.

Locate the machineKey section, and copy the validationKey and decryptionKey values to a separate
text file. The following is an example of a machineKey section:
<machineKey validationKey="4785A9C8F5FA32B47E5245AC48671291F1CE55735A475EB7"
decryptionKey="D961976E181646326D64E01AB2052F5D076F0ABDE2C702FB" validation="SHA1" />

3.

Edit the web.config files on the other servers in the Web farm. Replace the existing machineKey values
with the values that you copied from the administration server for the Web farm.

For more information about how to configure machineKey properties, see How to: Configure MachineKey
in ASP.Net 2.0 (http://go.microsoft.com/fwlink/?LinkId=117441), especially the "Web Farm Deployment
Considerations" section.

Configure firewall settings on Enterprise Portal servers


For information about the recommended firewall settings on an Enterprise Portal server, see Firewall
settings for Microsoft Dynamics AX components.

Next steps
After you deploy Enterprise Portal in the Web farm, you must enable users to access the Enterprise Portal
site. For more information, see Enable users to access Enterprise Portal
(http://technet.microsoft.com/library/2adbf75e-a599-45ca-a849-765185bf7897(AX.60).aspx). For
information about other Enterprise Portal deployment and configuration tasks, see Checklists for
deploying Enterprise Portal sites.

See Also
Install and configure Windows AppFabric for Enterprise Portal
Troubleshoot installation issues with Enterprise Portal and Role Centers
(http://technet.microsoft.com/library/e0cee771-4fcb-42e3-9213-5b297c8f6fe5(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

91

Microsoft Dynamics AX

Deploy a claims-mode Enterprise Portal site


The topics in this section provide information about how to install Enterprise Portal for Microsoft
Dynamics AX with claims-based authentication. Enterprise Portal supports forms-based authentication or
Active Directory Federations Services authentication.

Deploy an Enterprise Portal site that uses forms-based authentication

Deploy an Enterprise Portal site that uses AD FS authentication

Deploy Enterprise Portal for vendor registration with Windows Azure Active Directory Access Control

Deploy an Enterprise Portal site that uses forms-based authentication


This topic describes how to deploy an Enterprise Portal for Microsoft Dynamics AX site that uses the
claims-mode authentication that is provided by SharePoint. In the context of Microsoft Dynamics AX, this
kind of authentication is called flexible authentication. Flexible authentication enables businesses and
organizations to authenticate Enterprise Portal users without having to store user accounts in Active
Directory Domain Services. By using flexible authentication, you can configure a claims-aware Enterprise
Portal site to authenticate users by using one of the following services: forms-based authentication or
Microsoft Active Directory Federation Services (AD FS). This topic describes how to deploy an Enterprise
Portal site that uses forms-based authentication. Forms-based authentication validates credentials that are
entered in a logon form and stored in an ASP.NET database.
Note:
Active Directory Domain Services (AD DS) is still required for Enterprise Portal administration
tasks.
Before you create a forms-based Enterprise Portal site, we recommend that you learn about the concepts
of claims-based authentication. The procedures in this topic assume that you are familiar with the
concepts in the following documents.
Forms Authentication Provider (http://go.microsoft.com/fwlink/?LinkId=235460)
A Guide to Claims-Based Identity and Access Control (2nd Edition)
(http://go.microsoft.com/fwlink/?LinkId=234145)
Implementing Claims-Based Authentication with SharePoint Server 2010
(http://go.microsoft.com/fwlink/?LinkId=234146)
This topic includes the following sections.

Before you begin

Pre-installation tasks

Install Enterprise Portal binaries

Configure certificates

Enable SharePoint Claims to Windows Token Service

Create a claims-aware Enterprise Portal site

Install the ASP.NET database

Create a signing certificate to establish trust between the Enterprise Portal site and the forms-based
site

Microsoft Dynamics AX 2012 Installation Guide

92

Microsoft Dynamics AX

Grant the .NET Business Connector proxy access to the signing certificate

Create a forms-based Security Token Service site

Force new users to change their password at first logon

Create a new user for forms-based authentication

Logon to the site using forms-based authentication

Before you begin


Complete the following tasks before you install Enterprise Portal.
Task

Details

Install Microsoft Dynamics AX hotfixes for claims-mode

1.

Download

authentication (required for Microsoft Dynamics AX

(http://go.microsoft.com/fwlink/?LinkId=294944) and

2012 R2 or earlier; not required for Microsoft Dynamics

install the Microsoft Dynamics AX 2012 claims-mode

AX 2012 R3).

authentication hotfix (KB 2823664).


2.

Download
(http://go.microsoft.com/fwlink/?LinkID=294677) and
install the Microsoft Dynamics AX 2012 R2 claimsmode authentication hotfix (KB 2824690).

Create a domain account

Create a domain account for the Microsoft Dynamics AX


.NET Business Connector proxy.
Warning:
The account should not be a member of the
Microsoft Dynamics AX system administrator
group or a member of the Windows
administrator group on the Enterprise Portal
server. The login should not be used for
standard logon purposes. Only those individuals
who are responsible for deploying and
configuring Microsoft Dynamics AX should know
the credentials for this login. If a malicious user
gained access to the credentials for this login,
that person could potentially impersonate any
Microsoft Dynamics AX user.
Enter the account in the Microsoft Dynamics AX client on
the System administration > System > System service
accounts form.

Install SharePoint

After you install SharePoint on the web server, run the


SharePoint configuration wizard. Specify the Microsoft
Dynamics AX .NET Business Connector proxy account on
the Specify Configuration Database Settings > Specify
Database Access Account page of the SharePoint
configuration wizard.

Microsoft Dynamics AX 2012 Installation Guide

93

Microsoft Dynamics AX

Task

Details

Compile Microsoft Dynamics AX if you installed any

If you installed a non-SYS layer model file in the

non-SYS layer mode files

Microsoft Dynamics AX environment, compile Microsoft


Dynamics AX before you install Enterprise Portal. If you
do not compile Microsoft Dynamics AX, the Enterprise
Portal installation might fail.

Download and deploy language packs

If you want to deploy Enterprise Portal in multiple


languages, download and deploy the SharePoint
language packs on the Web server before you install
Enterprise Portal. You must create a unique Web
application in SharePoint for each language. You can
download language packs from Microsoft.com.

Verify the server name

Verify that the name of the server that will host Enterprise
Portal does not include an underscore, for example
EPserver_1. If an Enterprise Portal server includes an
underscore in the server name, lookups and web pages
might display errors.

Verify prerequisites and system requirements

On the computer where you will install Enterprise Portal,


run the prerequisite validation utility to verify that system
requirements have been met. For information about how
to run the prerequisite validation utility, see Check
prerequisites.
For more information about the hardware and software
requirements for Microsoft Dynamics AX, see the system
requirements
(http://go.microsoft.com/fwlink/?LinkId=165377).

Verify permissions

Verify that you have the appropriate permissions to install


Enterprise Portal. If you are installing Enterprise Portal on
a server that already hosts an Enterprise Portal
deployment and you want to overwrite that deployment,
you must have Full Control permission in SharePoint for
the existing Enterprise Portal site collection. If you do not
have Full Control permission, you will not be able to
delete the existing site collection by using Setup. For
more information about permissions, see Verify that you
have the required permissions for installation.

Verify SSL settings

For Secure Sockets Layer (SSL) encryption, you cannot


install Enterprise Portal on a web application that is
already configured to use HTTP and HTTPS bindings. You
must remove the HTTP binding from the site by using
Internet Information Services (IIS) Manager before you
install Enterprise Portal.

Microsoft Dynamics AX 2012 Installation Guide

94

Microsoft Dynamics AX
Pre-installation tasks
Perform the following tasks to verify that you can deploy Enterprise Portal on the web server.
1.

Verify that you can open SharePoint Central Administration on the Enterprise Portal server.

2.

Verify that you have the appropriate permissions to create sites by using SharePoint Central
Administration to create a SharePoint team site.

3.

Verify that you can browse the team site without prompts and resolve the URL without proxy errors or
other problems.

4.

If you intend to deploy or configure Enterprise Portal at a command prompt, verify that you can start
the SharePoint Management Shell.

Install Enterprise Portal binaries


This section describes how to install Enterprise Portal binaries by using Setup. During this initial install,
you will not install create an Enterprise Portal site. You will create the site later in this document.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Enterprise Portal (EP) and .NET Business Connector, and
then click Next.

7.

On the Prerequisite validation results page, resolve any warnings or errors. For more information
about how to resolve prerequisite errors, see Check prerequisites. When no warnings or errors remain,
click Next.

8.

On the Select a file location page, select the location where you want to install 32-bit versions of
Microsoft Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want Enterprise
Portal to access configuration information from the registry on the local computer or from a shared
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. If necessary, verify name of the
AOS instance, the TCP/IP port number, and the WSDL port for services before you click Next. If the
AOS details are correct, click Next.
11. On the Specify Business Connector proxy account information page, enter the user name and
password for the proxy account that is used by the .NET Business Connector. Click Next.

Microsoft Dynamics AX 2012 Installation Guide

95

Microsoft Dynamics AX
12. On the Configure a Web site for Enterprise Portal page, select the SharePoint 80 (SharePoint Web
application). If no web applications are available in the list, you must cancel Setup, create a web
application by using SharePoint Central Administration, and then try the installation again.
Warning:
Do not select any other options on this page. Verify that you specified the SharePoint 80
web application and that all other options are cleared before you click Next.

Click Next.
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is complete, click Finish to close the wizard.
Important:
Before you proceed to the next section, verify that the .NET Business connector proxy account was
added to the WSS_WPG group on the web server computer: From a command prompt type net
localgroup wss_wpg and press Enter.

Microsoft Dynamics AX 2012 Installation Guide

96

Microsoft Dynamics AX
Configure certificates
The procedures in this section require secure sockets layer (SSL) and security token service (STS)
certificates. These certificates help ensure that a users claim is not changed in transit. The following
certificates are required.
Certificate

Details

SSL certificate for the Enterprise Portal site

Referred to as SSLCert1 in this document

SSL certificate for the STS site

Referred to as SSLCert2 in this document

STS signing certificate for the token service

Referred to as STScertSigningCert

For test environments, you can create self-signed certificates


(http://go.microsoft.com/fwlink/?LinkId=235235) by using Internet Information Services (IIS) manager.
However, for production environments you must acquire certificates from a valid certificate authority.
Before you proceed in this topic, install SSLCert1 and SSLCert2 into the Personal node in the certificate
store on the web server. You will configure the STScertSigningCert later in this document. For information
about how to work with certificates see Certificate Overview
(http://go.microsoft.com/fwlink/?LinkId=282620).
1.

On the Windows server that will host the forms-based Enterprise Portal site, click Start > Run, type
mmc, and then click OK.

2.

Click File > Add/remove snap-in.

3.

Click Certificates, and then click Add.

4.

When the system prompts you to specify which type of account to manage certificates for, click
Computer Account, and then click Next.

5.

Click Local computer, and then click Finish.

6.

In the Add or Remove Snap-ins dialog box, click.

7.

In the MMC snap-in, click the Certificates (Local Computer) node.

8.

Right-click Personal, and then click All tasks > Import. The Certificate Import Wizard opens. Click
Next.

9.

Browse to the certificate, and then click Next.

10. Enter the password for the certificate, and then click Next.
11. Select the Mark this key as exportable option, and then click Next. The Certificate Store dialog box
appears. Click Next.
Enable SharePoint Claims to Windows Token Service
You must enable the SharePoint claims to Windows token service (C2WTS) for claims-based
authentication. Use the following procedure to start this service.
1.

In SharePoint Central Administration, under System Settings, click Manage services on server.

2.

Locate the Claims to Windows Token Service.

3.

In the Action column, click Start.

4.

In Windows, click Start > Run, type services.msc and press Enter.

Microsoft Dynamics AX 2012 Installation Guide

97

Microsoft Dynamics AX
5.

In the Services console, verify that the Claims to Windows Token Service is running.
Note:
Do not use the services.msc to start the C2WTS because the service will be automatically disabled
after a period of time. You must use SharePoint Central Administration to start this service.

Create a claims-aware Enterprise Portal site


This section describes how to create a claims-aware Enterprise Portal site by using a Microsoft Windows
PowerShell cmdlet. The cmdlet in this section first creates a claims-aware web application in SharePoint,
and then deploys an Enterprise Portal site on that web application. If you are not familiar with Windows
PowerShell cmdlets for Microsoft Dynamics AX, see Administering Microsoft Dynamics AX by using
Windows PowerShell (http://go.microsoft.com/fwlink/?LinkId=235298) for more information. You can also
create a claims-aware Enterprise Portal site on an existing SharePoint web application. Complete one of
the following procedures.

Create a claims-aware site on a new SharePoint web application

Create a claims-aware site on an existing SharePoint web application

Create a claims-aware site on a new SharePoint web application


Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.
1.

Open the Microsoft Dynamics AX 2012 Management Shell with administrator privileges. Click Start >
Administrative Tools > right-click Microsoft Dynamics AX 2012 Management Shell and click Run
as administrator.

2.

Enter the following command and press Enter.


$Cred=Get-Credential

3.

When prompted, enter the credentials for the .NET Business Connector proxy account. The credentials
must be the .NET Business Connector proxy account and password that were specified when
Enterprise Portal binaries were installed earlier in this document. If you specify an account other than
the .NET Business Connector proxy account, then the cmdlet overwrites the existing .NET Business
Connector account, which can cause existing Enterprise Portal installations to stop working. Also note,
this cmdlet designates the .NET Business Connector proxy account as the Enterprise Portal site
administrator.

4.

Execute the following command, replacing PathToSSLCert1 with the path to SSLCert1, which you
imported earlier in this document.
$SSLCert = Get-PfxCertificate "PathToSSLCert1"

When prompted, enter the password that you specified when you exported the SSL certificate.
5.

On the Enterprise Portal server, execute the New-AXClaimsAwareEnterprisePortalServer cmdlet.


For descriptions of the required parameters and syntax, see NewAXClaimsAwareEnterprisePortalServer (http://go.microsoft.com/fwlink/?LinkID=217573) on TechNet.

Microsoft Dynamics AX 2012 Installation Guide

98

Microsoft Dynamics AX
The following example shows the cmdlet with the required parameters. Note that the port value of
8000 is a user-defined value. You can specify any available port number. If you specify port 443, then
you do not need to specify the port number when you type the web site URL.
new-AXClaimsAwareEnterprisePortalServer -Credential $Cred -Port 8000 -SSLCertificate $SSLCert

This cmdlet can take several minutes to be completed. After the cmdlet is completed, you can access
a new instance of Enterprise Portal at the following URL:
https://ServerName:PortNumber/sites/DynamicsAx.
Browse this site to verify that the command was executed properly. If you viewed the site, then you skip to
the section titled Install the ASP.NET database in this topic. If you were not able to view the site, see the
section titled Troubleshooting issues with a claims-aware site.
Create a claims-aware site on an existing SharePoint web application
If you want to create a new claims-aware site on an existing SharePoint web application, note the
following requirements.

The web application must be configured for Integrated Windows/NTLM authentication in SharePoint
Central Administration. This is required even if the web application is already configured as a claimsmode web application.

You must be a member of the site collection administrator group in SharePoint to perform the
following procedures.
Important:
We recommend that the web application be configured with SSL to enhance data security.

Verify that the existing web application uses the Windows authentication provider
Use the following procedure to verify that the existing web application uses the Windows authentication
provider.
1.

In SharePoint Central Administration, click Application Management.

2.

Under Web applications, click Manage web applications.

3.

Click the application and then click Authentication Providers.

4.

Verify that the Zone lists Default and the Membership Provider Name lists Windows.

5.

Click the Zone link.

6.

In either the IIS Authentication Settings section or the Claims Authentication Types section, verify
that Integrated Windows and NTLM are selected.

7.

Save your changes.

Create an Enterprise Portal site on the web application


Choose one of the following options to create an Enterprise Portal site on the existing web application.

Use Microsoft Dynamics AX Setup

Use Microsoft Dynamics AX 2012 Management Shell

Use Microsoft Dynamics AX Setup


To create an Enterprise Portal site on the existing web application by using Microsoft Dynamics AX Setup,
complete the procedure described earlier in this topic under Install Enterprise Portal binaries. However,

Microsoft Dynamics AX 2012 Installation Guide

99

Microsoft Dynamics AX
when you perform that procedure, you must select the existing web application and select the following
options: Configure for Windows SharePoint Services, Create Web site, and Restart IIS after
installation is completed.

Use the Microsoft Dynamics AX 2012 Management Shell


You can create an Enterprise Portal site on the existing web application by using the Microsoft Dynamics
AX 2012 Management Shell.
1.

Determine the name of the web application where you want to create the site. In SharePoint Central
Administration, click Manage web applications. Find the name of the application. For example,
SharePoint 443.

2.

On the Enterprise Portal server, execute the New-AXClaimsAwareEnterprisePortalServer cmdlet by


using the following parameters.
new-AXClaimsAwareEnterprisePortalServer -Credential $Cred WebApplication
ExistingWebApplicationName

For example: new-AXClaimsAwareEnterprisePortalServer -Credential $Cred WebApplication


SharePoint - 443

This cmdlet can take several minutes to be completed. After the cmdlet is completed, you can access
a new instance of Enterprise Portal at the following URL:
https://ServerName:PortNumber/sites/DynamicsAx. Browse this site to verify that the command was

Microsoft Dynamics AX 2012 Installation Guide

100

Microsoft Dynamics AX
executed properly. If you viewed the site, then you skip to the section titled Install the ASP.NET
database in this topic. If you were not able to view the site, see the section titled Troubleshooting
issues with a claims-aware site.
Troubleshooting issues with a claims-aware site
Error: A specified logon session does not exist.
This error is caused by incorrect certificate information. Verify that you selected Mark this key as
exportable when you imported the certificate.
Error: Setup could not find the IIS virtual server by using the name you specified.
This error occurs when the web application and Enterprise Portal site already exist on the server, so that
the Windows PowerShell cmdlet detects a conflict.
To resolve this issue:
1.

Click Start > Administrative Tools > Internet Information Services (IIS) Manager.

2.

Expand the server node, and then expand the Web sites node.

3.

Click the Enterprise Portal site.

4.

In the center pane, under IIS, double-click Authentication.

5.

Click ASP.NET Impersonation, and then, in the Actions pane, click Disable.

6.

Use Microsoft Dynamics AX Setup to install Enterprise Portal on the web application created by the
New-AXClaimsAwareEnterprisePortalServer cmdlet. For more information, see Install Enterprise
Portal on TechNet.
Note:
On the Configure a Web site for Enterprise Portal page of the Setup Wizard, clear all
options. You will configure SharePoint and create the website later in this procedure.

7.

After you install Enterprise Portal on the web application, click Start > SharePoint Central
Administration.

8.

Click Application Management.

9.

Under Site Collections, click Create site collections.

10. Under Select a template, click the Custom tab.


11. Select the Microsoft Dynamics Enterprise Portal template.
12. After SharePoint creates the site collection, select the Enterprise Portal site in IIS Manager.In the
center pane, under IIS, double-click Authentication.
13. Enable ASP.NET Impersonation authentication.
Install the ASP.NET database
Enterprise Portal users who are external to your business or organization will enter their credentials during
sign-up, and those credentials will be stored in an ASP.NET database. Use the following procedure to
create the ASP.NET database.
Note:

Microsoft Dynamics AX 2012 Installation Guide

101

Microsoft Dynamics AX
You can install the ASP.NET database on a separate server. If you do install this database on a
separate server, then you must specify a SQL connection string that will permit access to the
database. You can specify the connection string by using the -ConnectionString parameter when
you execute the Add-AXSharepointClaimsAuthenticationProvider PowerShell cmdlet later in this
document.
Open a Command Prompt window by using an administrator account on the server. Execute the following
command.
1.

%windir%\Microsoft.NET\Framework64\v4.0.30319\aspnet_regsql.exe

2.

The ASP.NET SQL Server Setup Wizard opens.

3.

Accept all default values, and complete the wizard. The wizard creates a new database in Microsoft
SQL Server called aspnetdb.

Grant the Business Connector proxy access to the ASP.NET database


Complete the following procedure to add the .NET Business Connector proxy to the ASP.NET database.
1.

Open SQL Server Manager on the server where you installed the ASP.NET database.

2.

Expand then ASP.NET database in the left column, and then expand the Security node.

3.

Right-click the Users node and select New User.

4.

Enter the domain/user_name of the .NET Business Connector proxy.

5.

In the Database Role Membership section, click db_owner.

6.

Save your changes.

Create a signing certificate to establish trust between the Enterprise Portal site and the formsbased site
This section describes how to create a signing certificate that is used to establish trust between the
claims-aware Enterprise Portal site and the forms-based site. The makecert.exe command in the following
procedures creates a self-signed certificate and registers that certificate with the local computer. For the
following procedures, refer to Option A if Visual Studio is installed on the Enterprise Portal server, or refer
to Option B if Visual Studio is installed on a separate server and you need to export the certificate after
you create it.
Option A: Visual Studio is installed on the Enterprise Portal server
Use this procedure to create a signing certificate. You must use Visual Studio to create the certificate. This
procedure describes how to create the certificate when Visual Studio is installed on the Enterprise Portal
server. If Visual Studio is not installed on the Enterprise Portal server, go to Option B.
1.

On the Enterprise Portal server, click Start > All Programs.

2.

Click Microsoft Visual Studio 2010.

3.

Click Visual Studio Tools > Visual Studio Command Prompt.

4.

Execute following command, replacing <string> with a name for your certificate. For example:
FORMS-CERT. Make a note of the name of this string because you will specify it again in the next
procedure.
makecert.exe -r -pe -a sha1 -n "CN=<string>" -ss My -sr LocalMachine -sky exchange -len 2048
-sp "Microsoft Enhanced RSA and AES Cryptographic Provider" -sy 24 c:\certs\<string>.cer

Microsoft Dynamics AX 2012 Installation Guide

102

Microsoft Dynamics AX
After the command completes go to the section titled Grant the .NET Business Connector proxy access to
the signing certificate.
Option B: Visual Studio is not installed on the Enterprise Portal server
Use this procedure to create a signing certificate. You must use Visual Studio to create the certificate. This
procedure describes how to create the certificate with Visual Studio and then import the certificate to the
Enterprise Portal server.
1.

On the Visual Studio server, click Start > All Programs.

2.

Click Microsoft Visual Studio 2010.

3.

Click Visual Studio Tools > Visual Studio Command Prompt.

4.

Execute following command, replacing <string> with a name for your certificate. For example:
FORMS-CERT. Make a note of the name of this string because you will specify it again in the next
procedure.
makecert.exe -r -pe -a sha1 -n "CN=<string>" -ss My -sr LocalMachine -sky exchange -len 2048
-sp "Microsoft Enhanced RSA and AES Cryptographic Provider" -sy 24 c:\certs\<string>.cer

5.

Click Start > Run, type mmc and press Enter.

6.

In the Microsoft Management Console, click File > Add/Remove snap-in.

7.

Add the Certificates snap-in and click OK.

8.

Click Computer account and then click Next.

9.

Click Local computer and then click Finish.

10. Click OK to close the Add or Remove Snap-ins dialog box.


11. Expand the Certificates (Local Computer) node.
12. Expand the Trusted Root Certification Authorities > Certificates node.
13. Right-click the certificate that you created in Step 4 of this procedure and click All Tasks/Export.
14. Click Next, and then click Yes, Export the private key.
15. Click Next, and then enter a password for the certificate. Make a note of the password because you
will need to specify it when you import the certificate in the next procedure.
16. Click Next, and then specify a location and name for the certificate.
17. Click Finish.
18. Copy the certificate file (.PFX file) to a location that is accessible by the Enterprise Portal server. You
can now import the certificate to the Enterprise Portal server.
Import the certificate to the Enterprise Portal server
Use this procedure to import the signing certificate that you created in the previous procedure to the
Enterprise Portal server.
1.

On the Enterprise Portal server, click Start > Run, type mmc and press Enter.

2.

In the Microsoft Management Console, click File > Add/Remove snap-in.

3.

Add the Certificates snap-in and click OK.

4.

Click Computer account, and then click Next.

5.

Click Local computer, and then click Finish.

Microsoft Dynamics AX 2012 Installation Guide

103

Microsoft Dynamics AX
6.

Click OK to close the Add or Remove Snap-ins dialog box.

7.

Expand the Certificates (Local Computer) node.

8.

Right-click Trusted Root Certification Authorities, and then click All tasks\Import.

9.

Click Next, and then specify the file location.

10. Click Next, and then enter the password for the pfx certificate.
11. Select the Mark this key as exportable option, and then click Next.
12. Click Next, and then click Finish.
13. You are now ready to grant the .NET Business Connector proxy access to the signing certificate.
Grant the .NET Business Connector proxy access to the signing certificate
Use the following procedure to grant the .NET Business Connector proxy access to the signing certificate
you created in the previous section.
1.

On the Enterprise Portal server, click Start > Run, type mmc and press Enter.

2.

In the Microsoft Management Console, click File > Add/Remove snap-in.

3.

Add the Certificates snap-in and click OK.

4.

Click Computer account, and then click Next.

5.

Click Local computer, and then click Finish.

6.

Click OK to close the Add or Remove Snap-ins dialog box.

7.

Expand the Certificates (Local Computer) > Personal > Certificates node.

8.

Right-click the certificate you created in the previous section and select All Tasks > Manage Private
Keys.

9.

Add the .NET Business Connector as a user and grant Full control permissions.

10. Save your changes.


Create a forms-based Security Token Service site
An Enterprise Portal site can support multiple identity providers. When a user selects the forms
authentication provider, they are redirected to the Security Token Service (STS) site that you will create in
this section. The user can then login to Enterprise Portal using their forms-based credentials.
1.

Click Start > Administrative Tools.

2.

Click Microsoft Dynamics Ax 2012 Management Shell.

3.

Execute the following command, replacing PathToSSLCert2 with the path of the SSL certificate that
you registered earlier in this document.
$SSLCert = Get-PfxCertificate "PathToSSLCert2"

4.

Execute the following command. Note that the value of <string>.cer is the same value you specified
for the Create a signing certificate to establish trust between the Enterprise Portal site and the formsbased site procedure.
$SigningCert = Get-PfxCertificate c:\certs\<string>.cer

5.

On the Enterprise Portal server, execute the Add-AXSharepointClaimsAuthenticationProvider


cmdlet. For descriptions of the required parameters and syntax, see Add-

Microsoft Dynamics AX 2012 Installation Guide

104

Microsoft Dynamics AX
AXSharepointClaimsAuthenticationProvider (http://go.microsoft.com/fwlink/?LinkID=217572) on
TechNet.
The following example shows the cmdlet with the required parameters. Note that the name
FormsAuth and the port value 8088 are user-specified values. You can specify any name and available
port.
Add-AXSharepointClaimsAuthenticationProvider -Type Forms -Name FormsAuth -SigningCertificate
$SigningCert -Credential $Cred -Port 8088 -SSLCertificate $SSLCert

Notes:
The command assumes that the ASP.NET database is installed on the Enterprise Portal server.
If the ASP.NET database is installed on a separate server, you must also specify the
ConnectionString parameter.
-ConnectionString "Data Source=<AspNetDbMachineName>;Initial
Catalog=aspnetdb;Trusted_Connection=true"

6.

On the Enterprise Portal server, execute the Add-AXEnterprisePortalClaimsAuthenticationProvider


cmdlet. For descriptions of the required parameters and syntax, see AddAXEnterprisePortalClaimsAuthenticationProvider (http://go.microsoft.com/fwlink/?LinkID=217571) on
TechNet.
The following example shows the cmdlet with the required parameters.
Add-AXEnterprisePortalClaimsAuthenticationProvider -URL "https://ServerName:PortNumber" -Name
FormsAuth

This cmdlet adds the forms-based authentication trusted identity provider to the claims-aware
Enterprise Portal site. The URL must be the URL of the Enterprise Portal site that you created earlier in
this document: https://ServerName:PortNumber. Users should now see this provider in the providers
list when they navigate to the site (https://ServerName:PortNumber/sites/DynamicsAx).
Force new users to change their password at first logon
By default, the forms-based authentication provider does not require new users to change the default
password that was specified when the user account was enabled. As a security best practice, we
recommend that you force new users to change their password at first logon.
1.

Open the forms-based authentication provider web.config file. By default, the file path is:
C:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\14\template\layouts\FormsAuth\web.config

2.

Locate the enableForceChangePasswordOnce key.

3.

Change the key setting to true. For example:


<add key="enableForceChangePasswordOnce" value="true" />

4.

Save your changes in the file.

5.

Restart the web service.


Important:
By default, the maxinvalidPasswordAttempts property in the web.config file is configured to allow
unlimited logon attempts. We recommend that you configure the property to limit the number of

Microsoft Dynamics AX 2012 Installation Guide

105

Microsoft Dynamics AX
logon attempts. For more information, see SqlMembershipProvider.MaxInvalidPasswordAttempts
(http://msdn.microsoft.com/enus/library/system.web.security.sqlmembershipprovider.maxinvalidpasswordattempts.aspx)
Property.
Create a new user for forms-based authentication
The New-AXUser cmdlet creates a new user in the System user role in Microsoft Dynamics AX. After you
create the new user using the following command, add the user to other roles, if needed. For more
information about adding users to Microsoft Dynamics AX or configuring user roles, see Set up user
security in Microsoft Dynamics AX (http://technet.microsoft.com/library/a9eea83b-60bf-4690-8442a459de3c2001(AX.60).aspx).
If you are creating a claims user, specify the name of the claims provider in the UserDomain parameter. If
you are using forms-based claims authentication, you can also create a new user in the provider.
1.

Click Start > Administrative Tools.

2.

Click Microsoft Dynamics Ax 2012 Management Shell.

3.

On the Enterprise Portal server, execute the New-AXUser cmdlet. For descriptions of the required
parameters and syntax, see New-AXUser (http://go.microsofft.com/fwlink/?LinkID=217580) on
TechNet.
The following example shows the cmdlet with the required parameters. The AXUserId, UserName,
UserDomain, and Password are user-specified values. The UserDomain is the same value specified for
Name in Step 7 of the previous procedure.
New-AXUser -AccountType ClaimsUser -AXUserId jdd -UserName johndoe -UserDomain FormsAuth CreateInProvider -ClearTextPassword "Yukon!!90"

4.

Assign security roles for the user by using the Add-AXSecurityRoleMember


(http://technet.microsoft.com/EN-US/library/jj720265.aspx) cmdlet or by using the Users form in the
Microsoft Dynamics AX client.

Logon to the site using forms-based authentication


If you browse the Enterprise Portal site by using the following URL:
https://ServerName:PortNumber/sites/DynamicsAx, the Sign In page prompts you to select a logon option
from the drop-down list. If you select FormsAuth, you are redirected to the forms-based authentication
logon site, such as https://ServerName.contoso.com:PortNumber/_Layouts/Login.aspx. Verify that you can
logon to the site using forms-based authentication.

Deploy an Enterprise Portal site that uses AD FS authentication


This topic describes how to deploy Enterprise Portal for Microsoft Dynamics AX in an Active Directory
Federation Services (AD FS) environment. AD FS simplifies access to systems and applications by using a
claims-based authorization mechanism to help maintain application security. AD FS supports web single
sign-on technologies that help IT organizations collaborate across organizational boundaries. AD FS is a
server role in Windows Server 2008 R2 and Windows Server 2012. For more information about AD FS, see
Active Directory Federation Services (http://go.microsoft.com/fwlink/?LinkId=389356).

Microsoft Dynamics AX 2012 Installation Guide

106

Microsoft Dynamics AX
This topic includes the following sections.

Before you begin

Pre-installation tasks

Install Enterprise Portal binaries

Enable SharePoint Claims to Windows Token Service

Create a claims-aware Enterprise Portal site

Register an SSL certificate on the AD FS server

Install Active Directory Federation Services 2.0

Add a trusted relying party

Manage the AD FS token-signing certificate

Specify the claims provider in SharePoint

Register the AD FS signing certificate as a trusted root authority with SharePoint

Create a new user for AD FS authentication

Assign security roles for users

Validate AD FS configurations

Troubleshooting AD FS issues

Specify which trusted identity provider is available for users at logon

Before you begin


Complete the following tasks before you install Enterprise Portal.
Task

Details

Install Microsoft Dynamics AX hotfixes for

1.

Download (http://go.microsoft.com/fwlink/?LinkId=294944)

claims-mode authentication (required for

and install the Microsoft Dynamics AX 2012 claims-mode

Microsoft Dynamics AX 2012 R2 or earlier; not

authentication hotfix (KB 2823664).

required for Microsoft Dynamics AX 2012 R3).

2.

Download (http://go.microsoft.com/fwlink/?LinkID=294677)
and install the Microsoft Dynamics AX 2012 R2 claims-mode
authentication hotfix (KB 2824690).

Microsoft Dynamics AX 2012 Installation Guide

107

Microsoft Dynamics AX

Task

Details

Create a domain account

Create a domain account for the Microsoft Dynamics AX .NET


Business Connector proxy.
Warning:
The account should not be a member of the Microsoft
Dynamics AX system administrator group or a member of
the Windows administrator group on the Enterprise Portal
server. The login should not be used for standard logon
purposes. Only those individuals who are responsible for
deploying and configuring Microsoft Dynamics AX should
know the credentials for this login. If a malicious user
gained access to the credentials for this login, that person
could potentially impersonate any Microsoft Dynamics AX
user.
Enter the account in the Microsoft Dynamics AX client on the
System administration > System > System service accounts
form.

Install SharePoint

After you install SharePoint on the web server, run the SharePoint
configuration wizard. Specify the Microsoft Dynamics AX .NET
Business Connector proxy account on the Specify Configuration
Database Settings > Specify Database Access Account page of
the SharePoint configuration wizard.

Compile Microsoft Dynamics AX if you

If you installed a non-SYS layer model file in the Microsoft

installed any non-SYS layer mode files

Dynamics AX environment, compile Microsoft Dynamics AX before


you install Enterprise Portal. If you do not compile Microsoft
Dynamics AX, the Enterprise Portal installation might fail.

Download and deploy language packs

If you want to deploy Enterprise Portal in multiple languages,


download and deploy the SharePoint language packs on the Web
server before you install Enterprise Portal. You must create a unique
Web application in SharePoint for each language. You can
download language packs from Microsoft.com.

Verify the server name

Verify that the name of the server that will host Enterprise Portal
does not include an underscore, for example EPserver_1. If an
Enterprise Portal server includes an underscore in the server name,
lookups and web pages might display errors.

Microsoft Dynamics AX 2012 Installation Guide

108

Microsoft Dynamics AX

Task

Details

Verify prerequisites and system requirements

On the computer where you will install Enterprise Portal, run the
prerequisite validation utility to verify that system requirements
have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software
requirements for Microsoft Dynamics AX, see the system
requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Verify permissions

Verify that you have the appropriate permissions to install


Enterprise Portal. If you are installing Enterprise Portal on a server
that already hosts an Enterprise Portal deployment and you want to
overwrite that deployment, you must have Full Control permission
in SharePoint for the existing Enterprise Portal site collection. If you
do not have Full Control permission, you will not be able to delete
the existing site collection by using Setup. For more information
about permissions, see Verify that you have the required
permissions for installation.

Verify SSL settings

For Secure Sockets Layer (SSL) encryption, you cannot install


Enterprise Portal on a web application that is already configured to
use HTTP and HTTPS bindings. You must remove the HTTP binding
from the site by using Internet Information Services (IIS) Manager
before you install Enterprise Portal.

Pre-installation tasks
Perform the following tasks to verify that you can deploy Enterprise Portal on the web server.
1.

Verify that you can open SharePoint Central Administration on the Enterprise Portal server.

2.

Verify that you have the appropriate permissions to create sites by using SharePoint Central
Administration to create a SharePoint team site.

3.

Verify that you can browse the team site without prompts and resolve the URL without proxy errors or
other problems.

4.

If you intend to deploy or configure Enterprise Portal at a command prompt, verify that you can start
the SharePoint Management Shell.

Install Enterprise Portal binaries


This section describes how to install Enterprise Portal binaries by using Setup. During this initial install,
you will not install create an Enterprise Portal site. You will create the site later in this document.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

Microsoft Dynamics AX 2012 Installation Guide

109

Microsoft Dynamics AX
4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Enterprise Portal (EP) and .NET Business Connector, and
then click Next.

7.

On the Prerequisite validation results page, resolve any warnings or errors. For more information
about how to resolve prerequisite errors, see Check prerequisites. When no warnings or errors remain,
click Next.

8.

On the Select a file location page, select the location where you want to install 32-bit versions of
Microsoft Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want Enterprise
Portal to access configuration information from the registry on the local computer or from a shared
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. If necessary, verify name of the
AOS instance, the TCP/IP port number, and the WSDL port for services before you click Next. If the
AOS details are correct, click Next.
11. On the Specify Business Connector proxy account information page, enter the user name and
password for the proxy account that is used by the .NET Business Connector. Click Next.
12. On the Configure a Web site for Enterprise Portal page, select the SharePoint 80 (SharePoint Web
application). If no web applications are available in the list, you must cancel Setup, create a web
application by using SharePoint Central Administration, and then try the installation again.
Warning:
Do not select any other options on this page. Verify that you specified the SharePoint 80
web application and that all other options are cleared before you click Next.

Microsoft Dynamics AX 2012 Installation Guide

110

Microsoft Dynamics AX

Click Next.
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is complete, click Finish to close the wizard.
Important:
Before you proceed to the next section, verify that the .NET Business connector proxy account was
added to the WSS_WPG group on the web server computer: From a command prompt type net
localgroup wss_wpg and press Enter.
Register an SSL certificate on the AD FS server
For testing, you can create a self-signed SSL certificate. If you create self-signed certificates, we
recommend that you have one self-signed SSL certificate for the Enterprise Portal server (SSLCert1) and
one self-signed SSL certificate for the AD FS server (SSLCert2). For more information, see Create a SelfSigned Server Certificate in IIS 7.0 (http://go.microsoft.com/fwlink/?LinkId=235235). For production
servers, you must register an SSL certificate from a certification authority on the AD FS server. The
certificate will help make sure that the users claim was not changed in transit. We recommend that you
register separate SSL certificates for the AD FS and Enterprise Portal servers. After you have created selfsigned certificates or acquired certificates, complete the following procedure.

Microsoft Dynamics AX 2012 Installation Guide

111

Microsoft Dynamics AX
1.

On the Windows Server that will host the claims-based Enterprise Portal site, click Start > Run, type
mmc, and then click OK.

2.

Click File > Add/remove snap-in.

3.

Click Certificates, and then click Add.

4.

When the system prompts you to specify which type of account to manage certificates for, click
Computer Account, and then click Next.

5.

Click Local computer, and then click Finish.

6.

In the Add or Remove Snap-ins dialog box, click OK.

7.

In MMC snap-in, click the Certificates (Local Computer) node.

8.

Right-click Personal, and then click All tasks > Import. The Certificate Import Wizard opens. Click
Next.

9.

Browse to the certificate, and then click Next.

10. Enter the password for the certificate, and then click Next.
11. Select the Mark this key as exportable option, and then click Next. The Certificate Store dialog box
appears.
12. Click Next.
13. Click Finish.
Enable SharePoint Claims to Windows Token Service
You must enable the SharePoint claims to Windows token service (C2WTS) for claims-based
authentication. Use the following procedure to start this service.
1.

In SharePoint Central Administration, under System Settings, click Manage services on server.

2.

Locate the Claims to Windows Token Service.

3.

In the Action column, click Start.

4.

In Windows, click Start > Run, type services.msc and press Enter.

5.

In the Services console, verify that the Claims to Windows Token Service is running.
Note:
Do not use the services.msc to start the C2WTS because the service will be automatically disabled
after a period of time. You must use SharePoint Central Administration to start this service.

Create a claims-aware Enterprise Portal site


This section describes how to create a claims-aware Enterprise Portal site by using a Microsoft Windows
PowerShell cmdlet. The cmdlet in this section first creates a claims-aware web application in SharePoint,
and then deploys an Enterprise Portal site on that web application. If you are not familiar with Windows
PowerShell cmdlets for Microsoft Dynamics AX, see Administering Microsoft Dynamics AX by using
Windows PowerShell (http://go.microsoft.com/fwlink/?LinkId=235298) for more information. You can also
create a claims-aware Enterprise Portal site on an existing SharePoint web application. Complete one of
the following procedures.

Create a claims-aware site on a new SharePoint web application

Create a claims-aware site on an existing SharePoint web application

Microsoft Dynamics AX 2012 Installation Guide

112

Microsoft Dynamics AX
Create a claims-aware site on a new SharePoint web application
Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.
1.

Open the Microsoft Dynamics AX 2012 Management Shell with administrator privileges. Click Start >
Administrative Tools > right-click Microsoft Dynamics AX 2012 Management Shell and click Run
as administrator.

2.

Enter the following command and press Enter.


$Cred=Get-Credential

3.

When prompted, enter the credentials for the .NET Business Connector proxy account. The credentials
must be the .NET Business Connector proxy account and password that were specified when
Enterprise Portal binaries were installed earlier in this document. If you specify an account other than
the .NET Business Connector proxy account, then the cmdlet overwrites the existing .NET Business
Connector account, which can cause existing Enterprise Portal installations to stop working. Also note,
this cmdlet designates the .NET Business Connector proxy account as the Enterprise Portal site
administrator.

4.

Execute the following command, replacing PathToSSLCert1 with the path to SSLCert1, which you
imported earlier in this document.
$SSLCert = Get-PfxCertificate "PathToSSLCert1"

When prompted, enter the password that you specified when you exported the SSL certificate.
5.

On the Enterprise Portal server, execute the New-AXClaimsAwareEnterprisePortalServer cmdlet.


For descriptions of the required parameters and syntax, see NewAXClaimsAwareEnterprisePortalServer (http://go.microsoft.com/fwlink/?LinkID=217573) on TechNet.
The following example shows the cmdlet with the required parameters. Note that the port value of
8000 is a user-defined value. You can specify any available port number. If you specify port 443, then
you do not need to specify the port number when you type the web site URL.
new-AXClaimsAwareEnterprisePortalServer -Credential $Cred -Port 8000 -SSLCertificate
$SSLCert

This cmdlet can take several minutes to be completed. After the cmdlet is completed, you can access
a new instance of Enterprise Portal at the following URL:
https://ServerName:PortNumber/sites/DynamicsAx.
Browse this site to verify that the command was executed properly. If you viewed the site, then you skip to
the section titled Install Active Directory Federation Services 2.0 in this topic. If you were not able to view
the site, see the section titled Troubleshooting issues with a claims-aware site.
Create a claims-aware site on an existing SharePoint web application
If you want to create a new claims-aware site on an existing SharePoint web application, note the
following requirements.

Microsoft Dynamics AX 2012 Installation Guide

113

Microsoft Dynamics AX

The web application must be configured for Integrated Windows/NTLM authentication in SharePoint
Central Administration. This is required even if the web application is already configured as a claimsmode web application.

You must be a member of the site collection administrator group in SharePoint to perform the
following procedures.
Important:
We recommend that the web application be configured with SSL to enhance data security.

Verify that the existing web application uses the Windows authentication provider
Use the following procedure to verify that the existing web application uses the Windows authentication
provider.
1.

In SharePoint Central Administration, click Application Management.

2.

Under Web applications, click Manage web applications.

3.

Click the application and then click Authentication Providers.

4.

Verify that the Zone lists Default and the Membership Provider Name lists Windows.

5.

Click the Zone link.

6.

In either the IIS Authentication Settings section or the Claims Authentication Types section, verify
that Integrated Windows and NTLM are selected.

7.

Save your changes.

Create an Enterprise Portal site on the web application


Choose one of the following options to create an Enterprise Portal site on the existing web application.

Use Microsoft Dynamics AX Setup

Use Microsoft Dynamics AX 2012 Management Shell

Use Microsoft Dynamics AX Setup


To create an Enterprise Portal site on the existing web application by using Microsoft Dynamics AX Setup,
complete the procedure described earlier in this topic under Install Enterprise Portal binaries. However,
when you perform that procedure, you must select the existing web application and select the following
options: Configure for Windows SharePoint Services, Create Web site, and Restart IIS after
installation is completed.

Microsoft Dynamics AX 2012 Installation Guide

114

Microsoft Dynamics AX

Use the Microsoft Dynamics AX 2012 Management Shell


You can create an Enterprise Portal site on the existing web application by using the Microsoft Dynamics
AX 2012 Management Shell.
1.

Determine the name of the web application where you want to create the site. In SharePoint Central
Administration, click Manage web applications. Find the name of the application. For example,
SharePoint 443.

2.

On the Enterprise Portal server, execute the New-AXClaimsAwareEnterprisePortalServer cmdlet by


using the following parameters.
new-AXClaimsAwareEnterprisePortalServer -Credential $Cred WebApplication
ExistingWebApplicationName

For example: new-AXClaimsAwareEnterprisePortalServer -Credential $Cred WebApplication


SharePoint - 443

This cmdlet can take several minutes to be completed. After the cmdlet is completed, you can access
a new instance of Enterprise Portal at the following URL:
https://ServerName:PortNumber/sites/DynamicsAx. Browse this site to verify that the command was
executed properly. If you viewed the site, then you skip to the section titled Install Active Directory
Federation Services 2.0 in this topic. If you were not able to view the site, see the section titled
Troubleshooting issues with a claims-aware site.

Microsoft Dynamics AX 2012 Installation Guide

115

Microsoft Dynamics AX
Troubleshooting issues with a claims-aware site
Error: A specified logon session does not exist.
This error is caused by incorrect certificate information. Verify that you selected Mark this key as
exportable when you imported the certificate.
Error: Setup could not find the IIS virtual server by using the name you specified.
This error occurs when the web application and Enterprise Portal site already exist on the server, so that
the Windows PowerShell cmdlet detects a conflict.
To resolve this issue:
1.

Click Start > Administrative Tools > Internet Information Services (IIS) Manager.

2.

Expand the server node, and then expand the Web sites node.

3.

Click the Enterprise Portal site.

4.

In the center pane, under IIS, double-click Authentication.

5.

Click ASP.NET Impersonation, and then, in the Actions pane, click Disable.

6.

Use Microsoft Dynamics AX Setup to install Enterprise Portal on the web application created by the
New-AXClaimsAwareEnterprisePortalServer cmdlet. For more information, see Install Enterprise
Portal on TechNet.
Note:
On the Configure a Web site for Enterprise Portal page of the Setup Wizard, clear all
options. You will configure SharePoint and create the website later in this procedure.

7.

After you install Enterprise Portal on the web application, click Start > SharePoint Central
Administration.

8.

Click Application Management.

9.

Under Site Collections, click Create site collections.

10. Under Select a template, click the Custom tab.


11. Select the Microsoft Dynamics Enterprise Portal template.
12. After SharePoint creates the site collection, select the Enterprise Portal site in IIS Manager.In the
center pane, under IIS, double-click Authentication.
13. Enable ASP.NET Impersonation authentication.
Install Active Directory Federation Services 2.0
This section describes how to install AD FS on an Enterprise Portal server.
1.

Download (http://go.microsoft.com/fwlink/?LinkId=235894) AD FS, and run Setup.

2.

When prompted to select a server role, click Federation server.

3.

After the installation is completed, restart the server as recommended by Setup, and then run the
AD FS 2.0 Management tool. In Windows, click Start > Administrative Tools > AD FS 2.0
Management.

4.

Under Configure This Federation Server, click AD FS 2.0 Federation Server Configuration Wizard.

5.

Click Create a new Federation Service, and then click Next.

6.

Click Stand-alone federation server, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

116

Microsoft Dynamics AX
7.

Specify the SSL certificate that you created earlier in this document, and then click Next.

8.

Complete the wizard. AD FS creates a new application named adfs on the Default Web Site in IIS.

Add a trusted relying party


A relying party trust is a trust object that is created to maintain the relationship with a Federation Service
or an application that consumes claims from the Federation Service. This section describes how to
configure a trusted relying party in AD FS 2.0 Management.
1.

In AD FS 2.0 Management, click Require: Add a trusted relying party. The Add Relying Party Trust
Wizard opens.

2.

Click Start.

3.

Click Enter data about the relying party manually, and then click Next.

4.

In the Display Name field, enter a name, such as ADFS Sign-on, and then click Next.

5.

Click ADFS 1.0 and 1.1 profile, and then click Next.

6.

In the WS-Federation Passive URL field, enter the URL of the claims-aware Enterprise Portal site. The
URL must use the following format: https://ServerName:portnumber/_trust/. The server name and port
must be the values that you specified earlier in this document when you created the claims-aware
Enterprise Portal site.
For example: https://TestServer:8000/_trust/

7.

Type an identifier in the format urn:ServerName:ProviderName, and then click Add.


For example: urn:TestServer:ADFSProvider

8.

Remove the following entry from the list of providers: https://ServerName:PortNumber/_trust/

9.

Click Next.

10. Click Permit all users to access this relying party, and then click Next.
11. On the Ready to Add Trust page, click Next.
12. On the Finish page, click Open the Edit Claim Rules for the relying party trust.
13. Click Add Rule.
14. Select the Send LDAP Attributes as Claims claim rule template, and then click Next.
15. Enter a claims rule name, such as ADFS sign-on.
16. In the Select an attribute store section, click Active Directory.
17. Click LDAP Attribute, and then click SAM-Account-Name.
18. In the Outgoing claim type section, click E-mail address.
19. Click Finish.
Manage the AD FS token-signing certificate
1.

In AD FS 2.0 Management, expand Service, and then click Certificates.

2.

In the center pane, in the Token-signing section, right-click the CN=ADFS Signing certificate, and
then click View Certificate.

3.

Click Details, and then click Copy to file.

Microsoft Dynamics AX 2012 Installation Guide

117

Microsoft Dynamics AX
4.

Save the file as Name.cer by using the DER Encoded Binary X.509 option and then copy it to a
directory on the Enterprise Portal server. For example, you could save the certificate as adfsTokenSigningCert.cer and save it in a cert directory on the C:\ drive of the Enterprise Portal server.
Note:
Users must specify a valid email address for their account logon.

Specify the claims provider in SharePoint


1.

In Windows, click Start > Administrative Tools.

2.

Click Microsoft Dynamics AX 2012 Management Shell.

3.

Execute the following command, replacing path-to-token signing certificate from the AD FS
server with the path of the Name.cer file that you configured in step 4 of the previous procedure.
$SigningCert

= Get-PfxCertificate "path-to-token signing certificate from the AD FS

server"

4.

On the Enterprise Portal server, execute the Add-AXSharepointClaimsAuthenticationProvider


cmdlet. For descriptions of the required parameters and syntax, see AddAXSharepointClaimsAuthenticationProvider (http://go.microsoft.com/fwlink/?LinkID=217572) on
TechNet.
The following example shows the cmdlet with the required parameters.
Add-AXSharepointClaimsAuthenticationProvider -Type ADFS -Name ADFSProvider SigningCertificate $SigningCert ServerUrl "https://ServerName/adfs/ls/"

You can specify any name for the provider. In this example, the name is ADFSProvider. The server URL
must be the FQDN of the server that runs AD FS, followed by /adfs/ls/.
5.

On the Enterprise Portal server, execute the Add-AXEnterprisePortalClaimsAuthenticationProvider


cmdlet. For descriptions of the required parameters and syntax, see AddAXEnterprisePortalClaimsAuthenticationProvider (http://go.microsoft.com/fwlink/?LinkID=217571) on
TechNet.
The following example shows the cmdlet with the required parameters.
Add-AXEnterprisePortalClaimsAuthenticationProvider -URL "https://ServerName:PortNumber" Name ADFSPROVIDER

This cmdlet adds the AD FS-based authentication trusted identity provider to the claims-aware
Enterprise Portal site. The URL must be the URL of the Enterprise Portal site that you created earlier in
this document: https://ServerName:PortNumber. The name of the provider must be the name that was
used to create the provider in the previous procedure. Users should now see this provider in the
providers list when they browse the site (https://ServerName:PortNumber/sites/DynamicsAx).
Register the AD FS signing certificate as a trusted root authority with SharePoint
1.

Click Start > All Programs > Microsoft SharePoint Products > SharePoint Management Shell.

2.

Execute the following commands, replacing <Path-to-certificate>\Name.cer with the path and name
of the AD FS signing certificate.
$cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2("<Pathto-certificate>\Name.cer")

Microsoft Dynamics AX 2012 Installation Guide

118

Microsoft Dynamics AX

$spcert = New-SPTrustedRootAuthority -Certificate $cert -Name "ADFSSigningCert"

Note:
ADFSSigningCert is a user-specified value.
Create a new user for AD FS authentication
The New-AXUser cmdlet creates a new user in Microsoft Dynamics AX. You can specify the type of user
to add. If you are creating a claims user, specify the name of the claims provider in the UserDomain
parameter, as described in the following procedure.
1.

In Windows, click Start > Administrative Tools.

2.

Click Microsoft Dynamics AX 2012 Management Shell.

3.

On the Enterprise Portal server, execute the New-AXUser cmdlet. For descriptions of the required
parameters and syntax, see New-AXUser (http://go.microsoft.com/fwlink/?LinkID=217580) on
TechNet.
The following example shows the cmdlet with the required parameters. AXUser, UserName, and
UserDomain are user-specified values. The value of UserDomain is the same value that you specified
in Step 4 of the Specify the Claims Provider in SharePoint procedure earlier in this document.
New-AXUser -AccountType ClaimsUser -AXUserId april -UserName aprilbuckley -UserDomain
ADFSProvider

Assign security roles for users


You must assign security roles for each user who was created by using the New-AXUser cmdlet. For
information about how to assign security roles in the Microsoft Dynamics AX client, see Assign users to
security roles (http://technet.microsoft.com/library/214ee45b-5b99-4ea8-9454-f4297f68e38c(AX.60).aspx).
For information about how to assign security roles by using PowerShell, see the AddAXSecurityRoleMember (http://technet.microsoft.com/EN-US/library/jj720265.aspx) cmdlet Help on
TechNet.
Validate AD FS configurations
1.

Open a web browser, and browse the Enterprise Portal site:


https://ServerName:PortNumber/sites/DynamicsAx

2.

In the list of providers, select the AD FS provider. For example, ADFSProvider.

3.

Log on to Enterprise Portal by using the credentials that you created in the previous procedure. You
should be able to log on to Microsoft Dynamics AX as a system user.

Troubleshooting AD FS issues
Error: Users see a blank page after logging on to Enterprise Portal by using the AD FS provider.
This error occurs when the logon URL for the AD FS provider (for example,
https://TestServer.contoso.com/adfs/ls/) cannot be opened in a web browser. To resolve this issue, you
must update the hosts file on the server.
1.

Open the hosts file. By default, the file is located in the following directory:
C:\Windows\System32\drivers\etc folder

Microsoft Dynamics AX 2012 Installation Guide

119

Microsoft Dynamics AX
2.

Add an entry for the AD FS provider in the form <IP address of AD FS server> <AD FS Server Name>
<FQDN of AD FS server>
For example: 10.10.50.215 TestServer TestServer.contoso.com

3.

In Internet Explorer, open Internet options.

4.

Click the Connections tab, and then click LAN settings.

5.

Clear the Automatically detect settings option. You might have to instruct all Enterprise Portal users
to change this setting in their web browser.

Error: Users select the AD FS provider on the logon page, and then receive a 404: Page not found
error.
To resolve this issue, use IIS Manager to verify that Default Web Site or the site that hosts the AD FS
provider is running.
Error: There was a problem accessing the site.
To learn more about this error, view the details in the AD FS 2.0 Admin event log. If you need more details
about this issue, you can enable the AD FS debug log, as described in the following procedure.
1.

In Event Viewer, click View > Show Analytic and Debug Logs.

2.

To view events in the debug log, click AD FS 2.0 Tracing > Debug.

3.

Right-click the Debug log, and then click Enable Log.

Error in the AD FS Admin log: An error was encountered during a federation passive request.
Exception details:
Microsoft.IdentityServer.Web.InvalidScopeException: MSIS7007: The requested relying party trust
'urn:ServerName:Provider' is unspecified or unsupported. If a relying party trust was specified, it is
possible that you do not have permission to access the trust relying party. Contact your administrator for
details at:
Microsoft.IdentityServer.Web.FederationPassiveAuthentication.SubmitRequest(MSISRequestSecurityToken
request
To resolve this issue:
1.

In AD FS 2.0 Management, click Trust Relationships > Relying Party.

2.

Double click ADFS Sign-on.

3.

Click the Identifiers tab.

4.

In the Relying party identifiers field, verify that the address matches the address shown in the error
message. Addresses are case sensitive.

Specify which trusted identity provider is available for users at logon


You can select which flexible authentication provider is available in the Sign-in list when a user accesses
the Enterprise Portal site.
1.

In SharePoint Central Administration on the Enterprise Portal server, click Manage web applications.

2.

Click the claims-aware Enterprise Portal site.

3.

Click Authentication providers.

4.

Click Default.

Microsoft Dynamics AX 2012 Installation Guide

120

Microsoft Dynamics AX
5.

In the Claims Authentication Types section, select the providers that you want to appear in the
Sign-in list.

6.

Click OK.

See Also
Deploy an Enterprise Portal site that uses forms-based authentication

Deploy Enterprise Portal for vendor registration with Windows Azure Active
Directory Access Control
This topic describes how to create a claims-aware Enterprise Portal site for vendor registration. The vendor
registration process begins when a potential vendor requests registration by using a public Enterprise
Portal site that is configured for anonymous authentication. After completing a series of steps in the
registration workflow, the registered vendor can access Enterprise Portal outside of your Active Directory
domain by using one of the following types of accounts: Microsoft Account, Google, Yahoo, or Facebook.
The claims-aware Enterprise Portal site uses Windows Azure Active Directory Access Control (also known
as Access Control Service or ACS). ACS is a cloud-based service that provides user authentication and
authorization to web applications and services. Instead of implementing an authentication system with
user accounts that are specific to your application, ACS manages user authentication and authorization on
the web.
This topic describes how to deploy and configure Enterprise Portal with ACS for a vendor registration
portal.
Before you begin
Complete the following tasks before you deploy Enterprise Portal for vendor registration.
Task

Details

Learn about Windows Azure Active Directory

Access Control Services 2.0

Access Control (ACS)

(http://go.microsoft.com/fwlink/?LinkId=390990) on MSDN.

Purchase an Azure subscription so that you can

Windows Azure sign-up

use ACS

(http://go.microsoft.com/fwlink/?LinkId=390991) on the web.

Process flow: Enterprise Portal vendor registration with Access Control Services
The diagrams in this section describe how users complete the vendor on-boarding process by using an
Enterprise Portal site that is configured for claims-based authentication with ACS. After you configure
Enterprise Portal with ACS, as described in this topic, unsolicited vendors use this process to register with
your company for consideration as vendors.
Unsolicited vendor sign up with an Enterprise Portal public site and ACS
This section describes the process by which an unsolicited vendor authenticates with ACS to use the
Enterprise Portal sign up page.

Microsoft Dynamics AX 2012 Installation Guide

121

Microsoft Dynamics AX
Figure 1: Unsolicited vendor sign up process flow with an Enterprise Portal public site and ACS

1.

A vendor wants to register with your company and locates the public site. The user is regarded as a
Guest user with the security role Vendor anonymous (external).

2.

The vendor clicks the sign-up button. This button is visible when a guest user has the Vendor
anonymous (external) security role in Microsoft Dynamics AX. The site redirects the request to ACS.

3.

ACS provides the user with a list of links to registered identity providers. The user enters credentials
for a third-party provider such as one of the following: Microsoft Account, Google, Yahoo, or
Facebook. The provider authenticates the credentials.

4.

After the user is authenticated, ACS redirects the users browser to the URL for the sign up form and
includes an identity token.

5.

Enterprise Portal determines that the users identity has been verified. Enterprise Portal displays the
sign up form. The user completes the form and submits their information.

After the user submits their information in the Sign up form, Microsoft Dynamics AX stores the request as
an unsolicited vendor requests with a user alias derived from the identity token. This information is used
to create a Microsoft Dynamics AX user account. The new user account is assigned to the Prospective
vendor security role in Microsoft Dynamics AX. The user creation is handled by the Microsoft Dynamics
AX New User request workflow. The user is now considered to be a Prospective Vendor by the system.
The system sends the user a private URL for more information, as described by the next process flow.
Prospective vendor registration with an Enterprise Portal private site and ACS
This section describes the process by which a prospective vendor (a user who has completed the sign up
form described in the previous process flow) authenticates with ACS to use the Enterprise Portal vendor
registration page.

Microsoft Dynamics AX 2012 Installation Guide

122

Microsoft Dynamics AX
Figure 2: Vendor prospect registration process flow with an Enterprise Portal private site and ACS

1.

A prospective vendor (a user) who wants to complete the registration process with your company to
become a vendor locates the URL sent to their email after they completed the Sign up form.

2.

The site determines that the user is not authenticated and redirects to ACS.

3.

ACS provides the user with a list of links to registered identity providers. The user enters credentials
for a third-party provider such as one of the following: Microsoft Account, Google, Yahoo, or
Facebook. The provider authenticates the credentials.

4.

After the user is authenticated, ACS redirects the users browser to the private Enterprise Portal URL
and includes an identity token.

5.

SharePoint determines that the user has been authenticated. Microsoft Dynamics AX authorizes the
user to access the Prospective vendor registration form. The user completes the form and submits
their information.

After the prospective vendor completes the registration form, the request is processed for approval by
Microsoft Dynamics AX workflow. If the prospective vendor is accepted as a vendor, they are assigned a
vendor security role. The vendor can then access the vendor portal pages.
Deploy Enterprise Portal sites
A vendor registration portal requires an internal Enterprise Portal site in your Active Directory domain and
a public Enterprise Portal site configured for anonymous access. See the following procedures to install
these sites:

Internal site: Install Enterprise Portal on a single server or Deploy Enterprise Portal in server farm

Public site: Create a public Enterprise Portal site (http://technet.microsoft.com/library/5fe392a45683-469e-bcfe-ecfaa6e24883(AX.60).aspx)

After you have deployed the internal site in your Active Directory domain and the public site with
anonymous access, you can continue with the procedures in this topic.
Register a site with Access Control Services (ACS)
This section includes multiple procedures to help you register a site with ACS and then configure the
claims-aware site. You must complete each procedure in this section.

Microsoft Dynamics AX 2012 Installation Guide

123

Microsoft Dynamics AX
Create an ACS site on the Azure management portal
To perform the following procedure you must have an Azure subscription. For more information, see
Windows Azure sign-up (http://go.microsoft.com/fwlink/?LinkId=390991) on the web.
1.

Open the Azure control panel (http://go.microsoft.com/fwlink/?LinkId=390995) on the web.

2.

In the left pane, click Active Directory and then click Access control namespace in the main header.

3.

Create a new namespace. Click New at the bottom of the Azure web page and complete the steps for
App Services > Active Directory > Access Control > quick create. When the wizard is completed,
you see an ACS URI in this format: https://<acs_namespace>.accesscontrol.windows.net
Note:
Only the administrator of the Azure subscription can access the ACS Management Portal. This
person must configure access for other administrators who need access to the ACS Access
Control page. For more information, see Portal Administrators
(http://go.microsoft.com/fwlink/?LinkId=391018).

4.

After the namespace is created, select it in the Access Control Namespaces list and click Manage at
the bottom of the page.

5.

In the Access Control Service management portal, click Identity Providers. Select the providers that
you want to enable for your claims-aware Enterprise Portal site. If you select Microsoft Account,

Microsoft Dynamics AX 2012 Installation Guide

124

Microsoft Dynamics AX
Google, or Yahoo, you can continue with the procedure to Add a relying party. If you want to enable
Facebook as an identity provider, you must complete the steps in the Configure Facebook as an ACS
identity provider procedure.
Configure Facebook as an ACS identity provider
Complete the following procedure to configure Facebook as an ACS identity provider for your claimsaware Enterprise Portal site.
1.

Complete the configuration steps in the following article on MSDN: Facebook as an ACS Identity
Provider (http://go.microsoft.com/fwlink/?LinkId=391020). After you complete these steps in the
article, continue with this procedure.

2.

In the Access Control Service management portal, on the Basic page for the Facebook app, enter
windows.net in the App Domains field.

3.

In the Canvas URL field, enter the namespace URL in the format:
http://ServerName.accesscontrol.windows.net/

Create relying party application #1


An application in a relying party role acts as a Web service that can request a set of claims from a trusted
claims provider. The application also consumes the claims that it receives from its configured claims
provider. Use the following procedure to create one of two relying party applications. You will create
relaying party application #2 later in this document.
1.

In the left pane of the ACS Management Portal, click Relying party applications.

2.

Click Add.

Microsoft Dynamics AX 2012 Installation Guide

125

Microsoft Dynamics AX
3.

Enter a name for the relying party. For example: Your_company_name Enterprise Portal. This name is
used only in the ACS Management Portal.

4.

Enter the name of a realm. A realm specifies where the authentication request will originate. This
name can also be, for example, Your_company_name Enterprise Portal.

5.

Enter a return URL. ACS redirects to this URL after successful authentication. For this web site, the URL
should be in the following format:
https://<host_name>:<acs_port>/_trust
You can specify any available port. Make a note of this port number because you will specify it again
when you create the secure site on the host machine.

6.

(Optional): Enter an error URL. If a user experiences an error, the web browser is redirected to this URL

7.

In the Token format field, specify SAML1.1.

8.

In the Token encryption policy field, specify None.

9.

In the Token lifetime (secs) field, enter a large number so that the token does not expire too
frequently. For example, specify 86,400 seconds (24 hours).

10. Select the identify providers for this application.


11. In the Rule group section, create a new rule group.
12. Click Save.
Configure the group
Use this procedure to configure the new rule group that you created in the previous procedure.
1.

Click Add.

2.

Select the Identity providers to configure. You can select one provider or all of the providers.

3.

In the Input claim type field, leave the default value of Any.

4.

In the Input claim field, leave the default value of Any.

5.

In the Output claim type field, click Pass through first input claim type.

6.

In the Output claim value field, click Pass through first input claim value.

7.

Click Save.

Create a custom token signing certificate for the ACS site


This procedure describes how to create a custom token signing certificate by using Internet Information
Services (IIS) manager. The signing certificate is used to encrypt communications between the ACS
application and the claims-aware Enterprise Portal site. This procedure creates a self-signed certificate for
a developer or test environment. When you deploy a claims-aware Enterprise Portal vendor registration
site in a production environment, you must acquire a valid certificate from a certificate authority. In
commands throughout this document, this certificate is referred to as the <ACS_signing_cert>.
1.

In IIS manager, in the center pane, click Server Certificates.

2.

In the right pane, click Create Self-Signed Certificate.

3.

Specify a friendly name for the certificate and click OK.

4.

In the middle pane, right-click the certificate you just created and click Export.

5.

Enter a path where you want to export the file and specify a password.

Microsoft Dynamics AX 2012 Installation Guide

126

Microsoft Dynamics AX
6.

From the Windows Run dialog box, type MMC.exe and press Enter.

7.

In Microsoft Management Console, click File > Add/Remove Snap-ins. Add the Certificates snap-in.

8.

Click Computer account and then click Local Computer.

9.

Click Finish.

10. In Microsoft Management Console, expand Certificates (Local Computer) > Trusted Root
Certification Authorities > Certificates and locate the certificate you just created.
11. Right-click the certificate and click All Tasks\Export.
12. In the Certificate Export Wizard, select No, do not export the private key and retain all default
settings. The wizard exports the certificate as a .cer file. Make a note of the path to this file because
you will enter this information later in this topic.
13. Verify that with this procedure you have successfully created both the <acs_signing_cert>.pfx file and
the <acs_signing_cert>.cer file.
14. In the ACS Management Portal, in the left pane, click Certificate and keys.
15. Above the Token Signing section, click the Add link.

16. In the Used for section, click Relying Party Application and select the relying party application that
you created in the previous procedure.
17. In the Type section, verify that X.509 Certificate is selected.
18. In the Certificate section, browse to the <acs_signing_cert>.pfx file, enter in the password, and click
Save.
19. In the Primary section, verify that Make Primary is selected.
20. Click Save.

Microsoft Dynamics AX 2012 Installation Guide

127

Microsoft Dynamics AX
Create the claims-aware Enterprise Portal site
Use the procedures in this section to create a new SSL certificate for the claims-aware Enterprise Portal
site and then create the site on a new SharePoint web application.
Create an SSL certificate for the claims-aware site
You created a custom token signing certificate by using IIS manager in the previous section. You must
now create a second SSL certificate for the claims-aware Enterprise Portal site. This procedure creates a
self-signed certificate for a developer or test environment. When you deploy a claims-aware Enterprise
Portal vendor registration site in a production environment, you must acquire a valid certificate from a
certificate authority.
Important:
You cannot use the custom token signing certificate that you created earlier. That certificate is
specific to ACS. You must create a second SSL certificate, as described below.
1.

In IIS manager, in the center pane, click Server Certificates.

2.

In the right pane, click Create Self-Signed Certificate.

3.

Specify a friendly name for the certificate and click OK.

4.

In the middle pane, right-click the certificate you just created and click Export.

5.

Enter a path where you want to export the file and specify a password.

6.

From the Windows Run dialog box, type MMC.exe and press Enter.

7.

In Microsoft Management Console, click File > Add/Remove Snap-ins. Add the Certificates snap-in.

8.

Click Computer account and then click Local Computer.

9.

Click Finish.

10. In Microsoft Management Console, expand Certificates (Local Computer) > Trusted Root
Certification Authorities > Certificates and locate the certificate you just created.
11. Right-click the certificate and click All Tasks\Export.
12. In the Certificate Export Wizard, select No, do not export the private key and retain all default
settings. The wizard exports the certificate as a .cer file. Make a note of the path to this file because
you will enter this information later in this topic.
Create a claims-aware site on a new SharePoint web application
This section describes how to create a claims-aware Enterprise Portal site by using a Microsoft Windows
PowerShell cmdlet. The cmdlet in this section first creates a claims-aware web application in SharePoint,
and then deploys an Enterprise Portal site on that web application. If you are not familiar with Windows
PowerShell cmdlets for Microsoft Dynamics AX, see Administering Microsoft Dynamics AX by using
Windows PowerShell (http://go.microsoft.com/fwlink/?LinkId=235298) for more information.
Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.

Microsoft Dynamics AX 2012 Installation Guide

128

Microsoft Dynamics AX
1.

Open the Microsoft Dynamics AX 2012 Management Shell with administrator privileges. Click Start >
Administrative Tools > right-click Microsoft Dynamics AX 2012 Management Shell and click Run
as administrator.

2.

Enter the following command and press Enter.


$Cred=Get-Credential

3.

When prompted, enter the credentials for the .NET Business Connector proxy account. The credentials
must be the .NET Business Connector proxy account and password that were specified when
Enterprise Portal binaries were installed earlier in this document. If you specify an account other than
the .NET Business Connector proxy account, then the cmdlet overwrites the existing .NET Business
Connector account, which can cause existing Enterprise Portal installations to stop working. Also note,
this cmdlet designates the .NET Business Connector proxy account as the Enterprise Portal site
administrator.

4.

Execute the following command, replacing PathToSSLCert.pfx with the path to the .PFX certificate
file that you created in the previous procedure.
$SSLCert = Get-PfxCertificate "PathToSSLCert.pfx"

When prompted, enter the password that you specified when you created the SSL certificate.
5.

On the Enterprise Portal server, execute the New-AXClaimsAwareEnterprisePortalServer cmdlet.


For descriptions of the required parameters and syntax, see NewAXClaimsAwareEnterprisePortalServer (http://go.microsoft.com/fwlink/?LinkID=217573) on TechNet.
Important:
The following example shows the cmdlet with the required parameters. For the port value,
you must specify the port value of the Relying Party Application.
new-AXClaimsAwareEnterprisePortalServer -Credential $Cred -Port 8000 -SSLCertificate
$SSLCert

This cmdlet can take several minutes to be completed. After the cmdlet is completed, you can access
a new instance of Enterprise Portal at the following URL:
https://ServerName:RelyingPartyAppPortNumber/sites/DynamicsAx.
The site is also listed on the System administration > Enterprise Portal > Web sites form.
Browse this site to verify that the command was executed properly. The site displays a certificate warning.
You will not see this warning when you acquire a valid certificate from a certificate authority. You can
ignore this warning for now and proceed to the site.
Establish claims mapping
Use the following PowerShell commands to map three different claims to the ACS service.
1.

From the SharePoint Management Shell, execute the following three commands:
a.

$claim1 = New-SPClaimTypeMapping -IncomingClaimType


"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" IncomingClaimTypeDisplayName "ACS Name Identifier Claim" -LocalClaimType
"http://schemas.microsoft.com/custom/claim/type/2013/07/acs-nameidentifier"

b. $claim2 = New-SPClaimTypeMapping -IncomingClaimType


"http://schemas.microsoft.com/accesscontrolservice/2010/07/claims/identityprovider" -

Microsoft Dynamics AX 2012 Installation Guide

129

Microsoft Dynamics AX

IncomingClaimTypeDisplayName "ACS Identity Provider" -LocalClaimType


"http://schemas.microsoft.com/custom/claim/type/2013/07/acs-identityprovider"

c.

$claim3 = New-SPClaimTypeMapping -IncomingClaimType


"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" IncomingClaimTypeDisplayName "ACS username" -LocalClaimType
"http://schemas.microsoft.com/custom/claim/type/2013/07/acs-username"

2.

Execute the following commands from the SharePoint Management Shell to register a token:
a.

$acscert = Get-PfxCertificate <ACS_signing_cert>

b. New-SPTrustedIdentityTokenIssuer -Name <name_of_your_SP_Trusted_Identity_Provider> Description <description_of_your_SP_Trusted_Identity_Provider> -Realm


<realm_of_your_SP_trusted_identity_provider> -ImportTrustCertificate $acscert -SignInUrl
"https://<acs_namespace>.accesscontrol.windows.net/v2/wsfederation" -ClaimsMappings
$claim1,$claim2,$claim3 -IdentifierClaim $claim1.InputClaimType

The following example shows parameters for Contoso Corporations test environment
New-SPTrustedIdentityTokenIssuer -Name AzureACS -Description Azure ACS -Realm
urn:Contoso:AzureACS -ImportTrustCertificate $acscert -SignInUrl
"https://ContosoTestServer1.accesscontrol.windows.net/v2/wsfederation" -ClaimsMappings
$claim1,$claim2,$claim3 -IdentifierClaim $claim1.InputClaimType

c.

Execute the following commands in the SharePoint Management Shell to import the
<ACS_signing_cert> as trusted root certificate in SharePoint:
a.

$cert = New-Object
System.Security.Cryptography.X509Certificates.X509Certificate2($acscert)

b. $spcert = New-SPTrustedRootAuthority -Certificate $cert -Name "ACSTokenSigningCert"


Configure the authentication provider in SharePoint Central Administration
Use the following procedure to configure the Azure ACS identity provider for your claims-aware
Enterprise Portal site.
1.

In SharePoint Central Administration, click Manage web applications and then click the claims-aware
Enterprise Portal site you created earlier in this topic.

2.

Click Authentication providers and then click Default.

Microsoft Dynamics AX 2012 Installation Guide

130

Microsoft Dynamics AX
3.

In the Trusted Identity provider list, verify that AzureACS is selected.

4.

From the SharePoint Central Administration home page, click Security.

5.

Under Users click Specify web application user policy.

6.

Click Add Users.

7.

In the Zones list, click Default, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

131

Microsoft Dynamics AX
8.

In the Users text box, enter: All Users\All Users (AzureACS).

9.

Select Full Read permissions and then click Finish.

Microsoft Dynamics AX 2012 Installation Guide

132

Microsoft Dynamics AX

Verify sign in
1.

Enter the ACS URL for your Enterprise Portal site in a web browser. For example:
https://ContosoTestServer1:8000/Sites/DynamicsAx.

2.

In the Sign In list, select AzureACS.

3.

When prompted, specify valid credentials for one of the identity providers listed.

Create relying party application #2


Use the following procedure to create a relying party application for the public Enterprise Portal site.
1.

In the left pane of the ACS Management Portal, click Relying party applications.

2.

Click Add.

3.

Enter a name for the relying party. For example: Your_company_name Unsolicited Vendor Sign-up.
This name is used only in the ACS Management Portal.

4.

Enter the name of a realm. A realm specifies where the authentication request will originate. This
name can also be, for example, Your_company_name Unsolicited Vendor Sign-up.

Microsoft Dynamics AX 2012 Installation Guide

133

Microsoft Dynamics AX
5.

Enter a return URL. ACS redirects to this URL after successful authentication. For a public web site, the
URL should be in the following format:
http://ServerName:Port/sites/Public/Enterprise%20Portal/VendRequestSignUp.aspx
Specify the port where you deployed the public Enterprise Portal site.

6.

(Optional): Enter an error URL. If a user experiences an error, the web browser is redirected to this URL

7.

In the Token format field, specify SAML1.1.

8.

In the Token encryption policy field, specify None.

9.

In the Token lifetime (secs) field, enter a large number so that the token does not expire too
frequently. For example, specify 86,400 seconds (24 hours).

10. Select the identify providers for this application.


11. In the Rule group section, create a new rule group.
12. Click Save.
Configure a rule group for the public site
Use this procedure to configure a rule group for the public Enterprise Portal site.
1.

Click Add.

2.

Select the Identity providers to configure. You can select one provider or all of the providers.

3.

In the Input claim type field, leave the default value of Any.

4.

In the Input claim field, leave the default value of Any.

5.

In the Output claim type field, click Pass through first input claim type.

6.

In the Output claim value field, click Pass through first input claim value.

7.

Click Save.

Configure the login page for the public Enterprise Portal site
1.

On the Azure ACS management portal, click Development > Application Integration > Login
pages.

2.

Select relaying party application #1. (The first relaying party application you created in this
documented.)

3.

Copy the link in the Option 1: Link to an ACS-hosted login page field.

4.

In IIS Manager, select the Enterprise Portal public site web application.

5.

In the center pane under ASP.NET, click Application Settings.

6.

Click Add and specify the following:


Name: STSSignInURL
Value: The link that you copied in step 2 of this procedure.

7.

Click OK.

8.

On the Enterprise Portal server, open the C:\inetpub\wwwroot\wss\VirtualDirectories\ directory.

9.

Open the directory for the Enterprise Portal public site. For example, directory 80.

10. Open the web.config file in Visual Studio or in a text editor like Notepad.

Microsoft Dynamics AX 2012 Installation Guide

134

Microsoft Dynamics AX
11. Choose one of the following options:
a.

For SharePoint 2010, add the following to the <configSections> node:


<section name="microsoft.identityModel"
type="Microsoft.IdentityModel.Configuration.MicrosoftIdentityModelSection,
Microsoft.IdentityModel, Version=3.5.0.0, Culture=neutral,
PublicKeyToken=31bf3856ad364e35" />
Add the following to the <configuration> node:
<microsoft.identityModel>
<service>
<securityTokenHandlers>
<securityTokenHandlerConfiguration >
<audienceUris>
<add value="http://<host_name>/" />
</audienceUris>
<issuerNameRegistry
type="Microsoft.IdentityModel.Tokens.ConfigurationBasedIssuerNameRegistry,
Microsoft.IdentityModel, Version=3.5.0.0, Culture=neutral,
PublicKeyToken=31bf3856ad364e35">
<trustedIssuers>
<add thumbprint="<Thumbprint>" name="<Any nonempty string>" />
</trustedIssuers>
</issuerNameRegistry>
</securityTokenHandlerConfiguration>
</securityTokenHandlers>
</service>
</microsoft.identityModel>

b. For SharePoint 2013, replace the following parameter:


<issuerNameRegistry type="Microsoft.SharePoint.IdentityModel.SPPassiveIssuerNameRegistry,
Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"
/>

With this parameter:


<issuerNameRegistry
type="Microsoft.IdentityModel.Tokens.ConfigurationBasedIssuerNameRegistry,
Microsoft.IdentityModel, Version=3.5.0.0, Culture=neutral,
PublicKeyToken=31bf3856ad364e35">
<trustedIssuers>

Microsoft Dynamics AX 2012 Installation Guide

135

Microsoft Dynamics AX

<add thumbprint="<thumbprint>" name="Unsolicited Vendor Request Token Signing


Certificate" />
</trustedIssuers>
</issuerNameRegistry>

Replace <Thumbprint> with the thumbprint of the token signing certificate for the Azure ACS
relying party application. To locate the thumbprint, click the certificate at the bottom of the
relying party application. Copy the thumbprint.

12. Enter the URL of your public Enterprise Portal site a web browser. For example:
http://ServerName:Port/sites/Public/Enterprise%20Portal/VendRequestSignUp.aspx. The web browser
redirects you to the ACS sign in page where you can select an identity provider and log in.
Configure Enterprise Portal parameters
You must configure the following parameters in the Microsoft Dynamics AX client.
1.

Click System administration > Setup > Enterprise Portal > Enterprise Portal parameters.

2.

Click the User provisioning page.

3.

In the Unsolicited vendor authentication list, select Azure ACS.

4.

In the Unsolicited Vendor Domain field, enter AzureACS.

5.

In the Vendor authentication method list, select Azure ACS.

Next steps
You must configure the vendor on-boarding workflow process in the Microsoft Dynamics AX client. The
process is described in detail in the following blog Step-by-step walkthrough of the vendor on-boarding
process (http://go.microsoft.com/fwlink/?LinkId=392074).

Microsoft Dynamics AX 2012 Installation Guide

136

Microsoft Dynamics AX
See Also
Configuring Enterprise Portal for vendor requests (http://technet.microsoft.com/library/fd6b06a0-6bb749f5-9717-ae40a1f7d327(AX.60).aspx)
Deploy a claims-mode Enterprise Portal site

Install Enterprise Portal in a traditional perimeter network


This topic describes how to set up a traditional perimeter network to support Enterprise Portal for
Microsoft Dynamics AX. A traditional perimeter network uses two firewalls and two domain controllers to
restrict access to Microsoft Dynamics AX data, forms, and business processes. More specifically, a
traditional perimeter network enables internal users of your corporate network (CORP users) to access
Enterprise Portal in the perimeter network from either the intranet or the Internet. External users can
access Enterprise Portal in the perimeter network from the Internet, but are not permitted to access files
or information in the intranet. This restricted access is accomplished by using firewalls and a separate
Active Directory forest with 1-way, outgoing, transitive, forest-level trust with the Active Directory forest in
the intranet.
Caution:
If you do not have experience setting up and configuring network security, contact a Microsoft
Certified Partner for help. If you do not set up the perimeter network correctly, the system might
be vulnerable to security threats.
This topic includes information about the following.

About traditional perimeter networks

Before you begin

Configure the traditional perimeter network

Name resolution

Enterprise Portal pre-installation tasks

Install Enterprise Portal

Enable users to access the Enterprise Portal site


Note:
If you are upgrading Enterprise Portal between Microsoft Dynamics AX 2012, Microsoft Dynamics
AX 2012 Feature Pack, and Microsoft Dynamics AX 2012 R2, you should review Scenario: Perform
in-place upgrade to Microsoft Dynamics AX 2012 R2 or R3
(http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc9-2919f47afb8f(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

137

Microsoft Dynamics AX

About traditional perimeter networks


A traditional perimeter network contains two Microsoft Active Directory domain controllers separated by
firewall devices in two distinct networks, as shown in Figure 1.
Figure 1: A traditional perimeter network

The perimeter network contains the Enterprise Portal Web server that is running IIS, SharePoint, and an
Active Directory domain controller. The perimeter domain controller hosts accounts for those users who
are external to the organization and who require Enterprise Portal access. These user accounts are set up
on the perimeter domain controller as follows:
1.

External users have no rights on the internal domain.

2.

External users cannot access the internal network

3.

The internal network contains a complete installation of Microsoft Dynamics AX. This includes the
following components:
a.

An Active Directory domain controller that contains the accounts for all internal Microsoft
Dynamics AX users

b. A database that stores Microsoft Dynamics AX data


c.

A Microsoft Dynamics AX AOS

The internal forest has a one-way, incoming, transitive, forest-level trust with the perimeter forest. In the
following description, the intranet/internal network is referred to as CORP. This configuration enables the
following access scenarios.

CORP users can access the AOS by using the Microsoft Dynamics AX Win32 client or the browserbased Enterprise Portal on an internal computer

CORP users can access the AOS by using the Microsoft Dynamics AX Win32 client or browser-based
Enterprise Portal from an external computer

External users can access the AOS by using the browser-based Enterprise Portal from an external
computer

Microsoft Dynamics AX 2012 Installation Guide

138

Microsoft Dynamics AX
The configurations in this document are only one example of how to configure internal and external users
to access the AOS by using Enterprise Portal.

Before you begin


Complete the following tasks before you install Enterprise Portal in a traditional perimeter network.

Verify that you have the appropriate permissions to install Enterprise Portal. For more information
about permissions, see Verify that you have the required permissions for installation.

Install and configure Microsoft Dynamics AX required components in your internal network. If you
already installed Microsoft Dynamics AX required components, you must verify that the AOS service
runs as a domain user account that is a member of your internal network. The AOS service cannot run
as NT Authority\Network Service for a traditional perimeter network deployment that hosts Enterprise
Portal. Verify that the unqualified AOS DNS hostname is not greater than 15 characters. At a
minimum, you must install the Microsoft Dynamics AX client, the Application Object Server (AOS), and
the database. You must be a local administrator on the server(s) were you want to deploy these
components. For more information, see Install Microsoft Dynamics AX 2012
(http://technet.microsoft.com/library/fbe52b68-1294-4398-b233-f8ec37c6d531(AX.60).aspx).

If you installed a non-SYS layer model file in the Microsoft Dynamics AX environment, compile
Microsoft Dynamics AX before you install Enterprise Portal. If you do not compile Microsoft Dynamics
AX, the Enterprise Portal installation might fail.

While logged in as a CORP user who is a local administrator on the server, install SharePoint on the
perimeter-network server that will host Enterprise Portal. Verify that you are an administrator on the
server and in the Microsoft SQL Server instance that will host SharePoint. When SharePoint prompts
you to specify credentials for a service, specify a domain user account that is a member of the internal
network. You will specify this same account as the .NET Business Connector proxy account when you
install Enterprise Portal. The account does not have to be a member of the administrators group on
the server.

Microsoft Dynamics AX 2012 Installation Guide

139

Microsoft Dynamics AX

If you want to deploy Enterprise Portal in multiple languages, you must download and deploy
SharePoint language packs onto the web server before you install Enterprise Portal. You can
download SharePoint language packs from Microsoft.com. Enterprise Portal is currently supported in
the following languages:
Arabic

English (South Africa)

Italian

Chinese (Simplified)

English (UK)

Italian (Switzerland)

Czech

English (US)

Japanese

Danish - 1030

Estonian

Latvian

Dutch (Netherlands)

Finnish

Lithuanian

Dutch (Belgium)

French (France)

Norwegian

English

French (Canada)French (Belgium)

Polish

English (Australia)

French (Switzerland)

Portuguese (Brazilian)

English (Canada)

German (Germany)

Russian

English (India)

German (Austria)

Spanish (international)

English (Ireland)

German (Switzerland)

Spanish (Mexico)

English (Malaysia)

Hungarian

Swedish

English (New Zealand)

Icelandic

Thai

English (Singapore)

To deploy Enterprise Portal in one of the languages list here, you must create a Web application in
SharePoint and specify the new language. For more information, see Create an Enterprise Portal site
(http://technet.microsoft.com/library/da9149f8-9bb8-4d95-b392-4c6954a60b5f(AX.60).aspx).

Verify that the name of the server that will host Enterprise Portal does not include an underscore,
for example EPserver_1. If an Enterprise Portal server includes an underscore in the server name,
lookups and web pages might display errors.

On the computer where you will install Enterprise Portal, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the
prerequisite validation utility, see Check prerequisites.

For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

If you are installing Enterprise Portal on a server that already hosts an Enterprise Portal
deployment and you want to overwrite that deployment, you must have Full Control permission
in SharePoint for the existing Enterprise Portal site collection. If you do not have Full Control
permission, you will not be able to delete the existing site collection by using Setup.

Important:
If you attempt to install Enterprise Portal on an existing Internet Information Services (IIS) site that
is already configured to use a host header, the installation fails, unless you create a
BackConnectionHostNames (http://go.microsoft.com/fwlink/?LinkId=194948) registry entry.

Microsoft Dynamics AX 2012 Installation Guide

140

Microsoft Dynamics AX

Configure the traditional perimeter network


This section describes how to configure ports and a one-way trust for a traditional perimeter network that
supports Enterprise Portal.
Configure ports
This section describes how to configure ports in the perimeter network and the internal network so that
users can access the appropriate Microsoft Dynamics AX information by using Enterprise Portal. Table 1 at
the end of this section provides a complete list of ports and the associated direction, connection, and
connection type information.
Figure 2: A request for an Enterprise Portal page

A request is processed as follows:


1.

By default, the Enterprise Portal Web server receives the request from the firewall on TCP port 80 (or
443, if the Web server is configured for Secure Sockets Layer [SSL] encryption). The firewall therefore
must have port 80 or 443 open for incoming Internet requests.

2.

After the Web server receives the request, it sends the request to the perimeter domain controller on
UDP port 53 to verify whether the user is an external or internal user.

3.

The perimeter domain controller and the internal domain controller communicate by using various
ports, as shown in Table 1 at the end of this section.

4.

The perimeter domain controller identifies the user and then returns the request to the Web server on
UDP port 53.

5.

The Web server authenticates the user and then sends the request to the AOS using TCP. The default
port is 2712. The Web server and the AOS communicate by using the Business Connector proxy
account.

6.

The AOS communicates with the Microsoft Dynamics AX SQL Server database on port 1433, by
default.

7.

After the AOS retrieves the necessary data from the database, it returns the response to the Web
server.

8.

The Web server responds back to the client (browser).

Microsoft Dynamics AX 2012 Installation Guide

141

Microsoft Dynamics AX
Table 1: Ports for a traditional perimeter network to support Enterprise Portal
Port

Direction

Connection

Type

Notes

80 or 443 (by default)

Inbound/ Outbound

Perimeter firewall to the

TCP

Verify which ports are used

Enterprise Portal Web

in your environment

server
2712 (by default)

Inbound/ Outbound

Enterprise Portal server to

TCP

Microsoft Dynamics AX

Verify which port is used in


your environment

AOS
8201

Inbound/ Outbound

Enterprise Portal server to

TCP

For WCF service interface

Microsoft Dynamics AX
AOS
53

Inbound/ Outbound

DNS

UDP

None

135

Outbound

Internal domain controller

TCP

None

TCP

None

TCP

None

TCP

None

TCP

None

TCP

None

UDP

None

UDP

None

to perimeter domain
controller
135

Inbound

Perimeter domain
controller to internal
domain controller

445

Outbound

Internal domain controller


to perimeter domain
controller

445

Inbound

Perimeter domain
controller to internal
domain controller

1638

Outbound

Internal domain controller


to perimeter domain
controller

1638

Inbound

Perimeter domain
controller to internal
domain controller

389

Outbound

Internal domain controller


to perimeter domain
controller

389

Inbound

Perimeter domain
controller to internal
domain controller

Microsoft Dynamics AX 2012 Installation Guide

142

Microsoft Dynamics AX
If necessary, use Telnet or Netmon to verify these ports. For more information about how to configure
firewall ports, see How to configure a firewall for domains and trusts
(http://support.microsoft.com/kb/179442).
Configure DNS
The following procedures describe how to configure your Domain Name System (DNS) to create a oneway trust between the domain controllers in your network. For Enterprise Portal, the perimeter network
domain controller should trust the internal domain controller, but the internal domain controller should
not trust the perimeter domain controller.
To create the one-way trust, complete the following procedures:

Configure zone transfers on both domain controllers

Create a secondary zone on both domain controllers

Create trust from the internal domain controller to the perimeter domain controller

Configure zone transfers on both domain controllers


Complete this procedure to make sure that the domain controllers can communicate with each other.
1.

Log on to the internal domain controller by using an account that is a member of the domain
administrators group.

2.

Open DNS (Start > Programs > Administrative Tools).

3.

In the DNS console, expand the local name server.

4.

Expand Forward Lookup Zones, right-click the domain name, and then click Properties.

5.

Click the Zone Transfers tab.

6.

Select Allow Zone Transfers, and then select Only to the Following Servers.

7.

Enter the IP address for the perimeter network domain controller, and then click Add.

8.

Click OK, and then restart the DNS server.

9.

Repeat this procedure for the perimeter domain controller.

Create a secondary zone on both domain controllers


Complete this procedure to make sure that the domain controllers know each other's fully qualified
domain names.
1.

Log on to the internal domain controller by using an account that is a member of the Domain
Administrators group.

2.

Open DNS(Start > Programs > Administrative Tools).

3.

In the DNS console, expand the local name server.

4.

Right-click Forward Lookup Zones, click New Zone, and then click Next.

5.

On the Zone type page, select Secondary zone, and then click Next.

6.

On the Zone Name page, enter the fully qualified domain name of the perimeter network, and then
click Next.

7.

Enter the IP address for the perimeter domain controller, and then click Next.

8.

Click Finish to complete the wizard, and then restart the DNS server.

9.

Repeat this procedure for the perimeter domain controller.

Microsoft Dynamics AX 2012 Installation Guide

143

Microsoft Dynamics AX
Create a one-way trust between the domain controllers
Complete this procedure to set up the one-way trust between the internal domain controller and the
perimeter domain controller.
1.

Log on to the perimeter domain controller by using an account that is a member of the Domain
Administrators group.

2.

Open Active Directory Domains and Trusts (Start > Programs > Administrative Tools).

3.

In the console tree, right-click the domain name for the domain that you want to administer, and then
click Properties.

4.

Click the Trust tab.

5.

Click New Trust, and then click Next.

6.

On the Trust Name page, enter the fully qualified domain name for the internal domain, and then
click Next.

7.

Select One Way: Outgoing, and then click Next.

8.

Select Both this domain and the specified domain, and then click Next.

9.

Enter the domain administrator credentials for the internal domain, select Domain Wide
Authentication, and then click Next.

10. Click Next two times, and then click Yes to confirm outgoing trust.
11. Click Finish.

Name resolution
The Enterprise Portal server, which is located in the perimeter network, must resolve the host name of the
AOS, which is located on the internal or corporate network (CORP). If the AOS does not use a fully
qualified domain name (FQDN) such as EP1.corp.contoso.com, then you must manually resolve
hostnames. You can resolve hostnames by using one of the following options.
1.

For environments that use a dynamic host configuration protocol (DHCP) server, add the CORP DNS
suffix (for example, EP1.corp.contoso.com) to the DNS suffix search list on the DHCP server. Then
verify that the perimeter network server resolves hostnames by using the DNS suffix list on the DHCP
server.

2.

Edit the hosts file on the Enterprise Portal server (%windir%\system32\drivers\etc\hosts). Add the
non-FQDN AOS computer name to IP mapping. Be aware that making this change in the host file
might change the IP address of the AOS server and result in name resolution failures.

3.

For environments that do not use a DHCP server, add the CORP DNS suffix (for example,
EP1.corp.contoso.com) to the DNS suffix search list on the Enterprise Portal server, as described in the
following procedure.

Configure the DNS suffix


1.

On the server that will host Enterprise Portal, click Start > Control Panel, and then click Network and
Sharing Center.

2.

Click Change adapter settings.

3.

Right-click Local Area Connection and then click Properties.

4.

Click Internet Protocol Version 6 (TCP/IPv6) and then click Properties.

Microsoft Dynamics AX 2012 Installation Guide

144

Microsoft Dynamics AX
5.

Click Advanced.

6.

In the Advanced TCP/IP settings dialog box, click the DNS tab.

7.

Click Append these DNS suffixes (in order) and then click the Add button.

8.

Enter the domain to append, for example, corp.contoso.com.

9.

Click OK until you are returned to the Local Area Connection Properties page.

10. Click Internet Protocol Version 4 (TCP/IPv4) and then click Properties.
11. Repeat steps 5 8 of this procedure to append a DNS suffix for IPv4.
12. When you are finished, click OK.

Enterprise Portal pre-installation tasks


Perform the following tasks to verify that you can deploy Enterprise Portal on the Web server.
1.

A member of the CORP network that has local administrator rights on the server must install
SharePoint. If you did not install SharePoint on the server, then you must also verify the following
points.

2.

Verify that you are member of the CORP network.

3.

Verify that you can open SharePoint Central Administration on the Enterprise Portal server.

4.

Verify that you have the appropriate permissions to create sites by using SharePoint Central
Administration to create a SharePoint team site.

5.

Verify that you can browse the team site without prompts and resolve the URL without proxy errors or
other problems.

6.

If you intend to deploy or configure Enterprise Portal at a command prompt, verify that you can start
the SharePoint Management Shell.

Install Enterprise Portal


This section describes how to install Enterprise Portal by using Setup. If you are installing other Microsoft
Dynamics AX components at the same time, the installation pages vary, based on the components that
you are installing.
Tip:
By default, when you install SharePoint, the system creates a Web application on port 80.
Microsoft Dynamics AX Setup deploys an Enterprise Portal site on the port 80 Web application
unless you specify a different Web application. If you do not intend to deploy Enterprise Portal on
the default port-80 Web application, you must use SharePoint Central Administration to create a
new Web application before you install Enterprise Portal. Also note, if you intend to deploy
Enterprise Portal on a Web application that is already configured to use a host header, you must
use SharePoint Central Administration to create a new Web application using the host header
before you install Enterprise Portal. For any new Web application, you must specify the Business
Connector proxy account as the application pool account in the Configurable list.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

Microsoft Dynamics AX 2012 Installation Guide

145

Microsoft Dynamics AX
3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Enterprise Portal (EP), and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location where you want to install 32-bit versions of
Microsoft Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want Enterprise
Portal to access configuration information from the registry on the local computer or from a shared
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.

10. On the Connect to an AOS instance page, enter the fully qualified domain name (FQDN) of the
computer that is running the Application Object Server (AOS) instance that you want to connect to.
You can optionally specify the TCP/IP port number and the WSDL port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this screen is not displayed. Subsequent installations on
this computer reuse the existing AOS connection. For all Microsoft Dynamics AX installations
that use a traditional perimeter network, you must specify the FQDN for the AOS when you
are prompted.
11. On the Specify Business Connector proxy account information page, if the .NET Business
Connector (BC) proxy account has not been configured in Microsoft Dynamics AX, then you must
specify a username and password. The proxy must be a domain account from the CORP domain. If the
BC proxy was previously configured, then you must enter the password. Click Next.
12. On the Configure a Web site for Enterprise Portal page, select a web site. If no web sites are
available in the list, you must cancel Setup, create a web site by using SharePoint Central
Administration, and then try the installation again.
We recommend that you select the Configure for Windows SharePoint Services option. If you
select this option, Setup verifies that the site is a SharePoint site. If the site is not a SharePoint site,
Setup extends the site in SharePoint. Setup also sets the application pool to run under the service
account and sets the authentication method to Windows NTLM.
Important:
Note the following important information about the Create Web site option:

Clear this option if you are installing Enterprise Portal for a public site, such as an unsolicited
vendor portal. For public sites, you must create the Enterprise Portal site by using the public
site template. For more information, see Create a public Enterprise Portal site
(http://technet.microsoft.com/library/5fe392a4-5683-469e-bcfe-ecfaa6e24883(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

146

Microsoft Dynamics AX

If you are installing Enterprise Portal for a stand-alone installation select the Create Web site
option to create a site at the following URL: http://ServerName/sites/DynamicsAX. Setup
creates a new site in the SharPoint web application that uses port 80.

Click Next.
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is complete, click Finish to close the wizard.

Enable users to access the Enterprise Portal site


Users must be listed in the Microsoft Dynamics AX Users form and be assigned to, at the very least, the
System user role before they can access Enterprise Portal. You cannot provision users in Microsoft
Dynamics AX by using Enterprise Portal. You must provision user by using the Microsoft Dynamics AX 32bit client. For more information, see Manage users (http://technet.microsoft.com/library/0f168598-54e64fb6-be09-b1160e2f3ab7(AX.60).aspx). After you have verified that all users are listed in Microsoft
Dynamics AX, you must enable users or groups to access the Enterprise Portal site in SharePoint as
described in the following procedure.
1.

Open the Enterprise Portal site in a Web browser. By default, the URL is
http://server_name/sites/DynamicsAX.

2.

On the menu bar, click Site Actions > Site Permissions.

3.

Click Grant Permissions.

4.

In the Users/Groups text box, enter the name of each user or group, and then click Check Names.

5.

Under Grant permissions, click the permission level that you want to set. At a minimum, users and
groups must have Read permissions.

6.

If you do not want users to be able to personalize their Role Center pages or modify the shared
view of a Web part, assign Read permissions.

If you want users to be able to personalize their Role Center pages and modify the shared view of
a Web part, assign Contribute permissions.

If you want users to be able to personalize their Role Center pages, but you do not want them to
be able to modify the shared view of a Web part, assign Read permissions, and then configure the
set of Read permissions in SharePoint. From the Enterprise Portal site, click Site Actions > Site
Permissions > Permission Levels. Click the Read permission link. Under Personal Permissions,
select the options that you want.

If you want users to be able to filter reports using a custom parameter value, assign Design
permissions.

If you want users to be able to add and modify financial indicators and key performance
indicators (KPIs), assign Design permissions.

Click OK.

Internal users can now view Enterprise Portal in a Web browser. If you granted users access to an
Enterprise Portal with Role Centers, then those users can now view content in their Role Centers. Page
access and the content that is displayed in Enterprise Portal and Role Centers are automatically trimmed
according to both the user's security role in Microsoft Dynamics AX and the permissions that you
specified in SharePoint.

Microsoft Dynamics AX 2012 Installation Guide

147

Microsoft Dynamics AX

Note:
If users are prompted to enter their credentials when they view the Enterprise Portal site, they can
automate authentication by adding the site to the list of local intranet sites. In Internet Explorer,
click Tools > Internet Options > Security > Local intranet > Sites.

See Also
Deploy an Enterprise Portal site that uses forms-based authentication
Checklists for deploying Enterprise Portal sites

Install Enterprise Portal Help content


The MS.EP.HC-LanguageCode.cab file contains Help topics for Enterprise Portal pages. The .cab file is
automatically deployed and configured on the Web server when you install Enterprise Portal. If the Help
does not display, use the procedure in this topic to manually install Enterprise Portal Help.

Before you begin

Deploy SharePoint language packs on the Enterprise Portal server. Note the SharePoint Language IDs
for each language pack you deploy.

Verify that the SharePoint Timer service is running. Enterprise Portal Help is installed as a job by the
SharePoint Timer service.

Install Enterprise Portal Help


1.

Locate the MS.EP.HC-LanguageCode.cab files on the Installation DVD. By default, the files are located
in the \Support\EPHelp directory.

2.

Copy each of the .cab files into its corresponding language ID directory on the Web server at the
following location. This path applies to SharePoint 2010 servers. For SharePoint 2013 servers, replace
14 with 15:
Drive:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\14\HCCab\LanguageCode\
For example, download the Arabic version of the MS.EP.HC-1025.cab file to this directory: C:\Program
Files\Common Files\Microsoft Shared\Web Server Extensions\14\HCCab\1025\ on a SharePoint 2010
server.

3.

Open the SharePoint Management Shell on the Enterprise Portal Web server. Click Start, click All
Programs, click SharePoint Products, and then click SharePoint Management Shell.

4.

In the management shell, run the following command. Remember to change the 14 to 15 for
SharePoint 2013 servers:
Install-SPHelpCollection -LiteralPath "Drive:\Program Files\Common Files\Microsoft Shared\Web
Server Extensions\14\HCCab\<language_code>\MS.EP.HC-LanguageCode.cab"
For example, to install Enterprise Portal Help for Spanish on a SharePoint 2013 server, run the
following command:
Install-SPHelpCollection -LiteralPath "Drive:\Program Files\Common Files\Microsoft Shared\Web
Server Extensions\15\HCCab\3082\MS.EP.HC-3082.cab"

Microsoft Dynamics AX 2012 Installation Guide

148

Microsoft Dynamics AX
5.

Repeat the command for each language that you want to install. After SharePoint finishes the Timer
job, you can open Enterprise Portal Help by clicking the Help icon on any Enterprise Portal page.

Install multiple Enterprise Portals on the same server


This topic describes how to install and configure multiple Enterprise Portals on the same server. Portals
can be configured to access the same or different Microsoft Dynamics AX Application Object Server (AOS)
instances, as described in this topic.
Warning:
Before you continue, consider the following.

If you install multiple portals on the same server, you create a single point of failure for all portals
if SharePoint or IIS are not available on the server.

Scheduled downtime for maintenance affects all portals on the server which might limit how often
you can perform maintenance.

If you plan to install portals for development, testing, and production on the same server (not
recommended) you could unintentionally deploy development changes to production which
could cause data-integrity problems.

Multiple portals consume more resources on the server than a single portal. Plan your topology
accordingly.

You can deploy multiple portals on the same server as long as the user controls are the same. This
means the controls must use the same AX model. Multiple portals on the same server are not
supported if the codebase is different.

Enterprise Portal and the AOS


Enterprise Portal determines which AOS instance to connect to by reading a Microsoft Dynamics AX client
configuration. If you install Enterprise Portal on a server that hosts an AOS instance, the client
configuration is stored, by default, in the registry on the AOS. If you install Enterprise Portal on a server
that does not host an AOS or if Setup cannot locate a client configuration on the Web server, you are
prompted to specify the location of the client configuration. If you create additional Enterprise Portals on
the server, those portals use the AOS that is specified in the client configuration unless you specify a
different client configuration, as described in this topic.

Multiple portals on the same server that use the same AOS
By default, when you install Enterprise Portal, Setup creates an Enterprise Portal site on the SharePoint-80
Web application. You can create additional sites on the port 80 Web application by using SharePoint
Central Administration. All sites created in this manner use the same AOS. For more information about
how to create an Enterprise Portal site, see Create an Enterprise Portal site
(http://technet.microsoft.com/library/da9149f8-9bb8-4d95-b392-4c6954a60b5f(AX.60).aspx).
If you create additional web applications by using SharePoint Central Administration, you must deploy
Enterprise Portal on the new web applications by using Microsoft Dynamics AX Setup. You can then create
additional sites on the new web application by using SharePoint Central Administration. All sites created
in this manner use the same AOS.

Microsoft Dynamics AX 2012 Installation Guide

149

Microsoft Dynamics AX

Multiple portals on the same server that use different AOSs


To install multiple portals on the same server and have those portals connect to different AOS instances,
you must follow these steps.
Before you begin
Enterprise Portal determines which AOS to connect to by reading a Microsoft Dynamics AX client
configuration. To install multiple portals on the same server and have those portals connect to different
AOS instances, the portals must read separate Microsoft Dynamics AX client configurations. Create one or
more Microsoft Dynamics AX client configuration files by using the Microsoft Dynamics AX 2012
Configuration utility and store the configuration files on a network share. For more information about how
to create a configuration file, see Manage a client configuration
(http://technet.microsoft.com/library/813ed1c9-aec5-47f5-9c1f-94e934fda5d3(AX.60).aspx).
1.

Use Microsoft Dynamics AX Setup to install Enterprise Portal on the server. By default, Setup creates
an Enterprise Portal intranet site on the SharePoint-80 Web application. For the purpose of this
procedure, this portal is called Portal1 and it is connected to AOS1. For more information about how
to install Enterprise Portal, see Install Enterprise Portal on a single server.

2.

Create a new web application on the Enterprise Portal server by using SharePoint Central
Administration. For more information about how to create a new web application, see the SharePoint
online Help.

3.

Install Enterprise Portal on the new web application by using Microsoft Dynamics AX Setup. By
default, a second portal is created on the port that is specified in SharePoint Central Administration.
For the purpose of this procedure, this portal is called Portal2. Copy the URL of Portal2. You will need
the URL later in this procedure when you register the portal. Portal2 is currently connected to AOS1.

4.

Specify the new Microsoft Dynamics AX client configuration file for Portal2 by editing the web.config
file. By default the web.config file is located in the following directory:
C:\inetpub\wwwroot\wss\VirtualDirectories\<port number>

5.

Add the following Microsoft.Dynamics element under </system.web>. Replace <server_name>,


<path>, and <configuration_file>.axc with the information specific to your computing environment.
For example: <Session Configuration="C:\inetpub\wwwroot\dynamicsax.axc" />
<Microsoft.Dynamics>
<Session Configuration="\\<server_name>\<path>\<configuration_file>.axc" />
</Microsoft.Dynamics>

6.

Save your changes in the web.config file.

7.

Verify that the Business Connector Proxy account for AOS2 is the same as AOS1. Click System
administration > Setup > System > System service accounts.

8.

Use the Microsoft Dynamics AX client to register Portal2 on AOS2. Click System administration >
Setup > Enterprise Portal > Web sites. Enter the URL in the Internal URL and External URL fields.

9.

In the Type field, click Full (Web parts and site templates). Portal2 is now connected to AOS2.

10. Delete Portal2 from the Web sites form on AOS1.


11. On the Enterprise Portal server, open a command prompt and run the following command. This
command closes stale Business Connector connections: iisreset /noforce

Microsoft Dynamics AX 2012 Installation Guide

150

Microsoft Dynamics AX

Next steps
After you create the portals you must configure security, user access, and portal-wide settings. For more
information, see Checklists for deploying Enterprise Portal sites.

Set up Enterprise Portal and Role Centers


By default, only the administrator who installed Enterprise Portal for Microsoft Dynamics AX can access
the site and view content. For more information about configuring Enterprise Portal for different kinds of
sites, see Checklists for deploying Enterprise Portal sites.

Deploy Microsoft Dynamics AX Web parts to a SharePoint site


This topic describes how to deploy Web parts for Enterprise Portal for Microsoft Dynamics AX to sites for
SharePoint. For example, if your organization uses a standard SharePoint team site, you can use the
procedure in this topic to deploy an Enterprise Portal Web part to that team site.

Before you begin


Install Enterprise Portal on the web application that hosts the site, such as SharePoint 80. In Microsoft
Dynamics AX Setup, clear the Create Web site option. By clearing the Create Web site option, you install
the required files on the web application, but you do not create a new website that uses the Enterprise
Portal template. For more information about how to install Enterprise Portal, see Install Enterprise Portal
on a single server.

Deploy a Microsoft Dynamics AX Web part to a SharePoint site


1.

Click System administration > Setup > Enterprise Portal > Web sites.

2.

Click New to add the SharePoint site to the list of sites. In the Internal URL field, enter the address of
the SharePoint site.

3.

In the Type list, click Web parts only.

4.

Click the General tab.

5.

If this site can be viewed only by users in a specific partition or company, configure the Partition
independent and Company independent options.

6.

Close the form to save your changes.

7.

Open the SharePoint v4.master style sheet from the following location. This path applies to Microsoft
SharePoint 2010 products. For Microsoft SharePoint 2013 Products, change 14 in the file path to 15:
C:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\GLOBAL\v4.master

Microsoft Dynamics AX 2012 Installation Guide

151

Microsoft Dynamics AX
8.

Add the following element to the v4.master style sheet:


<SharePoint:CSSRegistration name= "/_LAYOUTS/1033/STYLES/Themable/AXEP.css"
runat="server"/>

Important:
To enable a Microsoft Dynamics AX unified work list Web part in a standard SharePoint site,
you also must add the following Java script elements to the v4.master style sheet:
<script type="text/javascript" src="/_layouts/ep/scripts/jquery-min.js"> </script>
<script type="text/javascript"> var $jQ = jQuery.noConflict();</script>
9.

Save your changes, and close the file.

10. On the SharePoint site, create a new Web part page or edit an existing page, and then click Add a
Web part.
11. Beneath the Categories list, click Upload a Web part.
12. Browse to the following location, and then click the Web part to add. For SharePoint 2013, change 14
in the file path to 15:
C:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\FEATURES\DynamicsAxWebParts\WebParts
13. Click Upload. The site automatically updates the list. Click Add a Web part again, and then locate the
Imported Web parts folder in the Categories list.
14. In the Web Parts list, click the Web part to add, and then click Add.

Microsoft Dynamics AX 2012 Installation Guide

152

Microsoft Dynamics AX

Install Search
This section contains information about installing Microsoft Dynamics AX 2012 Enterprise Search. Use the
following topics to help you install Search.

Checklist: Deploy Microsoft Dynamics AX Enterprise Search

Install and configure Search prerequisites

Configure the Search Crawler account

Configure SharePoint Services logging

Install Microsoft Dynamics AX Enterprise Search

Install Enterprise Search on FAST Search Server

Configure Enterprise Search by using the Search Configuration wizard

Checklist: Deploy Microsoft Dynamics AX Enterprise Search


The following checklist can help you deploy Enterprise Search.
Task

More information

Install and configure Search prerequisites.

Install and configure Search prerequisites

Install the Microsoft Dynamics AX client, database, and

Install Microsoft Dynamics AX 2012

Application Object Server (AOS) in the environment

(http://technet.microsoft.com/library/fbe52b68-1294-

before you install Enterprise Search, and then complete

4398-b233-f8ec37c6d531(AX.60).aspx)

the initialization checklist. If you attempt to install


Enterprise Search before you complete these other
tasks, the installation fails.
Configure the domain account that is used to crawl

Configure the Search Crawler account

search data.
Configure logging to conserve disk space.

Configure SharePoint Services logging

Specify which queries (and the underlying database

Add AOT queries to the Search configuration

tables) are crawled and indexed for Search. Or, if Search (http://technet.microsoft.com/library/1d4707eb-72d0is already configured on a different AOS, you can

4d91-8432-eb5e5a4bbfb9(AX.60).aspx)

import Search configurations to a new AOS.

or
Import Search configurations to an AOS
(http://technet.microsoft.com/library/e44a9235-9a03446b-9bee-494abf6631ff(AX.60).aspx)

Deploy Search in the environment by using Setup. By

Install Search

default, Setup publishes queries that are configured for

or

Search to the SharePoint Business Data Connectivity


Service (BDS). The BDS then crawls and indexes Search

Install Enterprise Search on FAST Search Server

data for Microsoft Dynamics AX.

Microsoft Dynamics AX 2012 Installation Guide

153

Microsoft Dynamics AX

Task

More information

Publish searchable queries to the Business Data

Configure Enterprise Search by using the Search

Connectivity Service, so that the queries can be crawled

Configuration wizard

by Microsoft SharePoint Services. This option is


necessary if you configured additional AOT queries for
Search after you installed Search. If you did not
configure additional AOT queries for Search after you
installed Search, you can skip this step.
Verify that Search is installed and data is discoverable

Open the Microsoft Dynamics AX client, enter a word such

in Search results.

as a customer name in the Search box, and press Enter.

Install and configure Search prerequisites


This topic describes how to configure prerequisite software and services for Microsoft Dynamics AX
Enterprise Search. If the Microsoft Dynamics AX Prerequisite Checker displayed an error when you tried to
install Enterprise Search, then this topic might help you troubleshoot the error.

Services required for Search


Microsoft Dynamics AX Enterprise Search uses the following services.
Service

Details

Microsoft Search Server service

The Microsoft Search Server service crawls, indexes, and retrieves


Microsoft Dynamics AX data and metadata for Enterprise Search. This
service is available in the following products.

SharePoint Server 2010

Microsoft Search Server 2010

Microsoft Search Server Express 2010, which is a free download


(http://go.microsoft.com/fwlink/?LinkID=180385)

Microsoft FAST Search Server 2010

Microsoft SharePoint Foundation 2013 or Microsoft SharePoint


Server 2013

One of these products must be available in the computing environment


before you can install Enterprise Search.
Warning:
If you intend to deploy Microsoft Dynamics AX Enterprise
Search on Microsoft Fast Search Server 2010 know that FAST
Search Server requires additional configurations beyond what is
described in this topic. For more information, see Install
Enterprise Search on FAST Search Server.

Microsoft Dynamics AX 2012 Installation Guide

154

Microsoft Dynamics AX

Service

Details

SharePoint Server Search service

The SharePoint Server Search service crawls and indexes content for a
SharePoint system. This service also provides a user interface for running
queries against the catalog of crawled content. SharePoint Search is
installed with Microsoft SharePoint Server and all Microsoft Search Server
products.
Verify that the SharePoint Server Search service is available in the
Services Control Panel. Click Start > Administrative Tools, and then
click Services. If the service is not listed, install a supported version of
Microsoft SharePoint Server or Microsoft Search Server. If the service
exists, but is disabled then you must setup and configured the Search
service in SharePoint Central Administration. Verify that the BDC service
application is deployed by using the Manage Service Applications page
in SharePoint Central Administration. Click Start > All Programs >
Microsoft SharePoint Products, and then click SharePoint Central
Administration.

Business Data Connectivity (BDC) service

SharePoint uses the BDC service to display business data from back-end
server applications, web services, and databases. Verify that the BDC
service application is deployed by using the Manage Service
Applications page in SharePoint Central Administration. Click Start > All
Programs > Microsoft SharePoint Products, and then click SharePoint
Central Administration. For more information about the BDC service,
see the SharePoint documentation.

Verify SharePoint components before you install Enterprise Search


Use the following procedure to verify that SharePoint Search is configured correctly. We recommend that
you perform these checks before you attempt to install Microsoft Dynamics AX Enterprise Search.
1.

Click Start > All Programs > Microsoft SharePoint Products, and then click SharePoint Central
Administration.

2.

Click System Settings, and then click Manage Services on Server.

3.

Verify that the SharePoint Server Search service is running. Also verify that the SharePoint
Foundation Search service is stopped. SharePoint Foundation Search is not required for Enterprise
Search.
Warning:
If SharePoint Server Search does not appear in the list, you might be using SharePoint
Foundation, which requires additional configuration. See the section titled SharePoint Search
or SharePoint Server Search 14 service does not pass the prerequisite check in Troubleshoot
installation issues with Enterprise Search (http://technet.microsoft.com/library/7d38c40f3ae5-4a10-b159-9519c6ed9150(AX.60).aspx).

4.

From SharePoint Central Administration, click Manage Service Applications.

5.

Click the Business Data Connectivity Service link and verify that the page loads without errors.

Microsoft Dynamics AX 2012 Installation Guide

155

Microsoft Dynamics AX
6.

On the Manage Service Applications page, click the Search Service Application link and verify that
the page loads without errors.

7.

On the Search Administration page, click the Content Sources link and verify that the page loads
without errors.

If all pages loaded without errors, you can install Microsoft Dynamics AX Enterprise Search in the
environment. For more information, see Install Microsoft Dynamics AX Enterprise Search.

Configure the Search Crawler account


This topic describes how to configure the Enterprise Search crawler account so that the Microsoft
SharePoint indexing service can crawl Microsoft Dynamics AX data for Enterprise Search. Before you can
configure the account, you must create a domain account for the search crawler. For more information,
see Create service accounts.
1.

Add the domain account as a user in Microsoft Dynamics AX. For more information, see Create new
users in Microsoft Dynamics AX (http://technet.microsoft.com/library/4b742341-9d6e-4629-bbe5620086b7fee8(AX.60).aspx).

2.

Assign the user to the Search crawler role in Microsoft Dynamics AX. For more information, see Assign
users to security roles (http://technet.microsoft.com/library/214ee45b-5b99-4ea8-9454f4297f68e38c(AX.60).aspx).

3.

Repeat this procedure for each data partition. If you do not add the Search crawler account to a data
partition, users will not see search results for that partition. For more information about data
partitions, see Data partitioning architecture (http://technet.microsoft.com/library/27ba6c51-7ea74403-867a-46ccc1ee053a(AX.60).aspx).

Configure SharePoint Services logging


By default, there is no limit on the disk space that diagnostic logging for SharePoint can use. If you do not
specify a limit, diagnostic logging can use all of the space on the hard disk of the Enterprise Search server.

Configure logging
Use the following procedure to specify limits for diagnostic logging.
1.

In SharePoint Central Administration, click Monitoring.

2.

Under Reporting, click Configure diagnostic logging.

3.

In the Number of days to store log files section, enter a number.

4.

Select the Restrict Trace Log disk space usage option.

5.

In the Maximum storage space for Trace Logs (GB) field, enter a number.

6.

Click OK.

7.

Under Reporting, click Configure usage and health data collection.

8.

In the Maximum log file size field, enter a number.

9.

Click OK.

Microsoft Dynamics AX 2012 Installation Guide

156

Microsoft Dynamics AX

See Also
SharePoint documentation: Configure diagnostic logging
(http://go.microsoft.com/fwlink/?LinkId=194152)

Install Microsoft Dynamics AX Enterprise Search


This topic describes how to install Microsoft Dynamics AX Enterprise Search. You install and deploy the
files that are required to run searches for Microsoft Dynamics AX clients and Enterprise Portal for
Microsoft Dynamics AX. You must complete the installation procedure on each search server.

Before you install Enterprise Search

Read about Microsoft Dynamics AX Enterprise Search architecture and security before you deploy
Search. For more information, see Enterprise Search architecture
(http://technet.microsoft.com/library/1bc490b8-fa42-4910-b3b7-6728e05d1dc0(AX.60).aspx) and
Enterprise Search security and protection (http://technet.microsoft.com/library/53d56eec-e274-4ac1b89f-35ef10326145(AX.60).aspx).

Install the Microsoft Dynamics AX client, database, and Application Object Server (AOS) in the
environment before you install Enterprise Search, and then complete the initialization checklist. If you
attempt to install Enterprise Search before you complete these other tasks, the installation fails. For
more information, see Install Microsoft Dynamics AX 2012
(http://technet.microsoft.com/library/fbe52b68-1294-4398-b233-f8ec37c6d531(AX.60).aspx).

Create a domain account for Enterprise Search. This account must be configured as a Microsoft
Dynamics AX user. The user account must be assigned to the Search crawler role before you install
search. For more information, see Configure the Search Crawler account.

Verify that the SharePoint Web application used for Microsoft Dynamics AX Enterprise Search is
configured for NTLM authentication. Also verify that the Web application is not configured for
anonymous authentication.

On the computer where you will install Enterprise Search, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

If you are setting up Enterprise Search in a SharePoint server farm, verify that the Business Data
Connectivity service (BDC) is only running on the Enterprise Search server. You must stop this service
an all Web front-end servers in the farm. If you do not stop the service on all Web front-end servers,
Enterprise Search fails to install.

If you are installing Enterprise Search on Microsoft Search Server 2010 Express, you must install the
SharePoint Server 2010 hotfix package dated August 31, 2010. If you do not install the hotfix, you
receive the following error message when you install Enterprise Search: The trial period for this
product has expired. For more information and to download the hotfix package, see Microsoft
Knowledge Base article number 2276336 (http://support.microsoft.com/kb/2276336).

Search is not supported in an environment with multiple AOS servers on the same server, unless all
AOS servers point to the same database. Limitations in the Search server configuration

Microsoft Dynamics AX 2012 Installation Guide

157

Microsoft Dynamics AX
(mssdmn.exe.config) and the Microsoft Dynamics AX client configuration prevent support for a
topology with multiple AOS servers on the same server.

Install Enterprise Search


Use this procedure to install Enterprise Search. If you are installing other Microsoft Dynamics AX
components at the same time, the installation pages vary, based on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Enterprise Search, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location where you want to install 32-bit versions of
Microsoft Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want Enterprise
Search to access configuration information from the registry on the local computer or from a shared
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. You can optionally specify the
name of the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this screen is not displayed. Subsequent installations on
this computer reuse the existing AOS connection.
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by the .NET Business Connector. Click Next.
12. On the Specify the search crawler account page, enter the account information, and then click
Next.
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is complete, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

158

Microsoft Dynamics AX

Post-install configuration
If you installed Enterprise Search on a computer separate from the AOS, you must specify the Search
server url in the Enterprise Portal parameters form. If you do not specify the URL, Search does not
retrieve data.
1.

Click System administration > Setup > Enterprise Portal > Enterprise Portal parameters.

2.

Click Search.

3.

In the Search server url field, enter the URL to the SharePoint Search service where you just installed
Search. Replace server_name with the name of the server where you installed Search: http://
server_name/sites/DynamicsAXClientSearch/_vti_bin/search.asmx

4.

Click Close to save changes.

Verify membership in the SQL db_owner role


After you install Enterprise Search by using Setup, use SQL Server Management Studio to verify that the
Business Connector proxy account and the search service application pool account (if different than the
Business Connector proxy account) are members of the db_owner role for the following databases:
Search Service_Application_CrawlStoreDB_<GUID>, Search_Service_Application_DB_<GUID>,
Search_Service_Application_PropertyStoreDB_<GUID>.
Important:
If you installed FAST Search Server 2010 for SharePoint each role is prefaced with the word FAST.
For example, FAST_Search Service_Application_CrawlStoreDB_<GUID>

Post-install validation
Data, metadata, and documents can only be crawled and indexed for search if the database table is
included in a Microsoft Dynamics AX AOT query. After the table is specified in a query, the query must be
configured for Search. You configure a query for Search by setting the Searchable property to True in the
AOT. By default, only the following queries are configured for Search. These queries are automatically
published and indexed after you install Enterprise Search:

BdcDocuRef

CustTableListPage

EcoResProductPerCompanySearch

HcmWorkerListPage

SecurityRoleAllTasks

smmBusinessRelations_NoFilter

VendorEnterpriseSearch

Use SharePoint Central Administration to verify that the crawl for these queries has finished running.
1.

In SharePoint Central Administration, click Manage service applications > Search Service
Application.

2.

Under Content Source, verify that Microsoft Dynamics AX and Microsoft Dynamics AX Metadata
show a crawl end time and no errors.

Microsoft Dynamics AX 2012 Installation Guide

159

Microsoft Dynamics AX
3.

After the crawl complete, open an Microsoft Dynamics AX client and verify that the Search box
appears in the upper-right corner. Also search on a term such as Sales and verify that the system
returns results that are shown in both the middle pane (the data, metadata, and documents pane) and
the Help Topics pane.

For information about how to make data, metadata, and documents available in Search, see Add AOT
queries to the Search configuration (http://technet.microsoft.com/library/1d4707eb-72d0-4d91-8432eb5e5a4bbfb9(AX.60).aspx). After you have specified which queries should be available in Search, you
must publish the queries to SharePoint. For more information, see Configure Enterprise Search by using
the Search Configuration wizard.

SharePoint Search stops working after you install Enterprise Portal


If you install Enterprise Portal on a server that hosts a SharePoint Team site, the default Search settings for
the team site can change. SharePoint Search returns errors. To restore Search for the SharePoint team site,
reset the SharePoint Search settings to their default values.
1.

Open the Search Settings page. By default, the URL is: http://<
server_name>/_layouts/enhancedSearch.aspx

2.

Under Site Collection Search Center, click Do not use custom scopes.

3.

Under Site Collection Search Dropdown Mode, click Do not show scopes dropdown, and default
to contextual scope.

4.

Under Site Collection Search Results Page, click /_layouts/OSSSearchResults.aspx, and then click
OK.

See Also
Checklist: Deploy Microsoft Dynamics AX Enterprise Search

Install Enterprise Search on FAST Search Server


This topic describes how to deploy Microsoft Dynamics AX Enterprise Search on FAST Search Server 2010
for SharePoint.

Prerequisites
The following list includes links to documents that describe how to configure the prerequisites for
Microsoft Dynamics AX Enterprise Search. The list also includes links to documents that describe how to
install and configure FAST Search Server 2010 for SharePoint. You must complete all of the tasks in order
before you install Microsoft Dynamics AX Enterprise Search on FAST Search Server 2010. If you do not
complete every task, Enterprise Search on FAST Search Server 2010 is not installed correctly.
1.

Configure the Search Crawler account

2.

Add AOT queries to the Search configuration (http://technet.microsoft.com/library/1d4707eb-72d04d91-8432-eb5e5a4bbfb9(AX.60).aspx)

3.

Install SharePoint 2012 Products and Technologies (http://go.microsoft.com/fwlink/?LinkId=241980)

4.

Install FAST Search Server 2010 for SharePoint (http://go.microsoft.com/fwlink/?LinkId=241974)

Microsoft Dynamics AX 2012 Installation Guide

160

Microsoft Dynamics AX
5.

Configure a stand-alone deployment or a multiple server deployment (FAST Search Server 2010 for
SharePoint) (http://go.microsoft.com/fwlink/?LinkId=241975)

6.

Create and set up the Content Search Service Application (FAST Search Server 2010 for SharePoint)
(http://go.microsoft.com/fwlink/?LinkId=241976)

7.

Create and set up the Query Search Service Application (FAST Search Server 2010 for SharePoint)
(http://go.microsoft.com/fwlink/?LinkId=241977)

8.

Enable queries from Microsoft SharePoint Server (FAST Search Server 2010 for SharePoint)
(http://go.microsoft.com/fwlink/?LinkId=241978)

9.

Install Hotfix 2276339 on the SharePoint server (http://go.microsoft.com/fwlink/?LinkId=241979)

Configure the Business Connector proxy account for membership in the db_owner
role
The Business Connector proxy account must be a member of the db_owner role for each FAST Search
database. Use Microsoft SQL Server Management Studio to verify that the Business Connector proxy
account is listed as a user for each database, and that the user account is a member of the db_owner role.

Increase the time-out for Farm Search Administration


After you install Microsoft Dynamics AX Enterprise Search as described later in this topic, Setup starts a
full crawl of the content sources for Microsoft Dynamics AX and Microsoft Dynamics AX metadata. The
crawl must be completed without errors before you can configure managed properties as described later
in this topic. By default, the time-out for the filter daemon in SharePoint is too short. Therefore, you
receive the following error message when the content source for Microsoft Dynamics AX metadata is
crawled: The filter daemon did not respond within the time-out limit. Use the following procedure to
increase the Farm Search Administration timeout.
1.

In SharePoint Central Administration, click Manage Service Applications.

2.

Select the search service application for the FAST Search connector.

3.

In the left navigation pane, click Farm Search Administration.

4.

Under Farm-Level Search Settings, change the default value of Time-out (seconds), 60,60, to larger
numbers, such as 120,120.

5.

Click OK to save your changes.

Install Enterprise Search


If FAST Search is present on the server when you install Enterprise Search by using Microsoft Dynamics AX
Setup, the system configures only the default FAST Search Server application, as specified in SharePoint.
All other search service applications are ignored. After the installation is completed, the system performs a
full crawl of the Microsoft Dynamics AX content sources. The full crawl of the content sources must be
completed without errors before you can continue with the remaining procedures in this topic.
After the full crawl of the content sources is completed without errors, install Microsoft Dynamics AX
Enterprise Search on the server. For more information, see Install Microsoft Dynamics AX Enterprise
Search.

Microsoft Dynamics AX 2012 Installation Guide

161

Microsoft Dynamics AX

Create managed properties


FAST Search Server 2010 creates properties for crawled data. Microsoft Dynamics AX Enterprise Search
enables a rich advanced search experience if these properties are mapped to Microsoft Dynamics AX
managed properties. The following Windows PowerShell script creates managed properties for Microsoft
Dynamics AX Enterprise Search and registers these properties so that they can be used by FAST Search
Server 2010 at crawl time. The script also maps the crawled properties to managed properties to enable a
rich advanced search experience.
1.

On the FAST Search Server, create a new *.ps1 file. Copy and paste the following code into the *.ps1
file.
function MapManagedPropertyToCrawledProperty()
{
Param
(
[string]$managedProperty = $null,
[string]$crawledProperty = $null,
[int32]$managedPropertyType = 1
)

$EntityManagedProperty = New-FASTSearchMetadataManagedProperty -Name $managedProperty Type $managedPropertyType


$EntityCrawledProperty = Get-FASTSearchMetadataCrawledProperty -Name $crawledProperty
$FullTextIndex = Get-FASTSearchMetadataFullTextIndex -Name Content
$PropertyMapping = New-FASTSearchMetadataCrawledPropertyMapping -CrawledProperty
$EntityCrawledProperty -ManagedProperty $EntityManagedProperty
if ($managedPropertyType -eq 1)
{
New-FASTSearchMetadataFullTextIndexMapping -ManagedProperty $EntityManagedProperty FullTextIndex $FullTextIndex -Level 1
}

Write-Host $managedProperty " mapped to " $crawledProperty


}

function MapManagedPropertyToCrawledProperties()
{
Param
(
[string]$managedProperty = $null,

Microsoft Dynamics AX 2012 Installation Guide

162

Microsoft Dynamics AX

[string]$crawledProperties = $null,
[int32]$managedPropertyType = 2
)

$EntityManagedProperty = New-FASTSearchMetadataManagedProperty -Name $managedProperty Type $managedPropertyType

$crawledProperties.split(",") | ForEach-Object
{
$crawledProperty = $_;
$EntityCrawledProperty = Get-FASTSearchMetadataCrawledProperty -Name $crawledProperty
$PropertyMapping = New-FASTSearchMetadataCrawledPropertyMapping -CrawledProperty
$EntityCrawledProperty -ManagedProperty $EntityManagedProperty
}

$FullTextIndex = Get-FASTSearchMetadataFullTextIndex -Name Content


if ($managedPropertyType -eq 1)
{
New-FASTSearchMetadataFullTextIndexMapping -ManagedProperty $EntityManagedProperty FullTextIndex $FullTextIndex -Level 1
}

Write-Host $managedProperty " mapped to " $crawledProperty


}

# Map predefined values


MapManagedPropertyToCrawledProperty -managedProperty Entity -crawledProperty EntityName managedPropertyType 1
MapManagedPropertyToCrawledProperty -managedProperty EntityPath -crawledProperty
EntityKey.Path -managedPropertyType 1
MapManagedPropertyToCrawledProperty -managedProperty EntityHelpText -crawledProperty
EntityKey.HelpText -managedPropertyType 1
MapManagedPropertyToCrawledProperty -managedProperty EntityType -crawledProperty
EntityKey.Type -managedPropertyType 2
MapManagedPropertyToCrawledProperties -managedProperty PartitionKey -crawledProperty
"CustTable,DocuRef,InventTable,EmployeeTable,HcmWorker,smmBusRelTable,VendTable" managedPropertyType 2

Microsoft Dynamics AX 2012 Installation Guide

163

Microsoft Dynamics AX

# Create empty properties required by client search query


New-FASTSearchMetadataManagedProperty -Name Title1 -Type 1
New-FASTSearchMetadataManagedProperty -Name Title2 -Type 1

2.

Run the *.ps1 file from the FAST Search Server 2010 PowerShell command window. Figure 1 shows the
results of the command.

Figure 1: Output of the FAST Search Server 2010 PowerShell command for managed properties

Microsoft Dynamics AX 2012 Installation Guide

164

Microsoft Dynamics AX
The following list describes the actions of the script and the corresponding results in the output:
a.

MapManagedPropertyToCrawledProperty -managedProperty Entity -crawledProperty EntityName managedPropertyType 1

The crawled property Entity was mapped to the managed property EntityName. The managed
property is of type 1. Full-text index mapping was added to the property.
b. MapManagedPropertyToCrawledProperty -managedProperty EntityPath -crawledProperty
EntityKey.Path -managedPropertyType 1

The crawled property EntityPath was mapped to the managed property EntityKey.Path. The
managed property is of type 1. Full-text index mapping was added to the property.
c.

MapManagedPropertyToCrawledProperty -managedProperty EntityHelpText -crawledProperty


EntityKey.HelpText -managedPropertyType 1

The crawled property EntityHelpText was mapped to the managed property EntityKey.HelpText.
The managed property is of type 1. Full-text index mapping was added to the property.
d. MapManagedPropertyToCrawledProperty -managedProperty EntityType -crawledProperty
EntityKey.Type -managedPropertyType 2

The crawled property EntityType was mapped to the managed property EntityKey.Type.
e.

New-FASTSearchMetadataManagedProperty -Name Title1 -Type 1

The managed property Title1 was registered.


f.

New-FASTSearchMetadataManagedProperty -Name Title2 -Type 1

The managed property Title2 was registered.


3.

After the managed properties are created, use SharePoint Central Administration to start a full crawl
of the Microsoft Dynamics AX and Microsoft Dynamics AX metadata content sources.

Configure Enterprise Search by using the Search Configuration wizard


This topic describes how to configure Microsoft Dynamics AX Enterprise Search by using the Search
Configuration Wizard.

Before you configure Enterprise Search


You must complete the following tasks before you can configure Enterprise Search by using the Search
Configuration Wizard:
1.

Deploy Enterprise Search. For more information, see Install Microsoft Dynamics AX Enterprise Search.

2.

In the Queries node of the Application Object Tree (AOT), designate the queries that are available in
search results by setting the Searchable property to True. For more information, see Add AOT queries
to the Search configuration (http://technet.microsoft.com/library/1d4707eb-72d0-4d91-8432eb5e5a4bbfb9(AX.60).aspx)

Configure Enterprise Search


The Search Configuration Wizard helps you publish Microsoft Dynamics AX queries to the Microsoft
SharePoint Business Data Connectivity Service (BCS). The wizard lists the queries that passed all checks for
best practices, and for which the Searchable property is set to True. You can select which queries and

Microsoft Dynamics AX 2012 Installation Guide

165

Microsoft Dynamics AX
table fields you want to publish to the BCS. After you complete the wizard, the queries are published to
the BCS, so that SharePoint can crawl the selected tables in the Microsoft Dynamics AX database. After the
crawl is completed, users can view search results either in the Microsoft Dynamics AX 32-bit client or in
Enterprise Portal.
Note:
You can run the Search Configuration Wizard on a server where Enterprise Search is installed from
the Microsoft Dynamics AX client or by double-clicking AXSearchSetup.exe in the following
directory: %systemdrive%\Program Files\Microsoft Dynamics AX\60\SetupSupport.
1.

Click System administration > Setup > Search > Search configuration.

2.

Complete the wizard. Microsoft Dynamics AX informs you that the queries were successfully published
to the BCS.

If one or more queries were not published to the BCS, an error message is displayed. Review the log file at
the following location: %systemdrive%\ProgramData\Microsoft\Dynamics AX\Dynamics AX Setup Logs\.
After the queries are published to the BCS, you can view the list of queries and the status of the database
crawl in SharePoint Central Administration.
1.

Click Start, and then click SharePoint Central Administration.

2.

Under Application Management, click Manage service applications, and then click Search Service
Application.

3.

In the left pane, under Crawling, click Content Sources.

4.

To view the details, click either the content source for Microsoft Dynamics AX or the content source
for Microsoft Dynamics AX metadata.
Important:
By default, SharePoint schedules incremental crawls of the Microsoft Dynamics AX database. The
incremental crawl only updates records if a parent table is modified. To ensure that the crawler
updates records from joined tables, you should periodically perform a full crawl of the database.

Microsoft Dynamics AX 2012 Installation Guide

166

Microsoft Dynamics AX

Install help server


The following topics explain how to install the Microsoft Dynamics AX Help server.

Before you install the help server

Install the help server

Install Help content at an alternative location


Note:
If you are upgrading the Help server between AX 2012, AX 2012 Feature Pack, AX 2012 R2, and
AX 2012 R3, you should review Scenario: Perform in-place upgrade to Microsoft Dynamics AX
2012 R2 or AX 2012 R3 (http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc92919f47afb8f(AX.60).aspx).

Before you install the help server


This topic describes the tasks that you must complete before you can install the Microsoft Dynamics AX
Help server.

Check for required permissions


Verify that you have the permissions that are required to install the Help server. For more information, see
Verify that you have the required permissions for installation.

Install prerequisites
On the computer where you will install the Help server, run the prerequisite validation utility to verify that
system requirements have been met. For information about how to run the prerequisite validation utility,
see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
Microsoft Dynamics AX 2012 System Requirements (http://go.microsoft.com/fwlink/?LinkId=165377)
guide.

Select a web site for the Help server


The Help server must be installed on a web site in Internet Information Services (IIS). You can create a new
web site for the Help server, or you can use an existing site. The following sections describe these options.
Create a new web site
If you want to create a new web site for the Help server, see the IIS documentation for information about
how to create a web site.
Use an existing web site
You can install the Help server on an existing web site that is used by other applications. However, you
must verify that neither Microsoft SharePoint Foundation 2010 nor Microsoft SharePoint Server 2010 is
running on the same site.

Microsoft Dynamics AX 2012 Installation Guide

167

Microsoft Dynamics AX
If you install the Help server on the default web site in IIS, and you later install Microsoft SharePoint
Foundation or Microsoft SharePoint Server on the server, the SharePoint installation program stops the
default web site and creates a new site for SharePoint. This new site runs on port 80. You must then open
Internet Information Services (IIS) Manager and follow these steps:
1.

Configure the default web site to run on a different port.

2.

Restart the default web site.

Install help content updates


If updates for the Microsoft Dynamics AX help content are available, you can incorporate the updates into
the installation.
Use the following steps to include help updates in the installation:
1.

Locate and download help content updates from the CustomerSource


(http://go.microsoft.com/fwlink/?LinkID=210925) web site (logon required).

2.

Browse to the directory where the files from the Microsoft Dynamics AX DVD are shared. For more
information, see Create a shared directory for installation.

3.

Navigate to the \Msi\HelpContent folder.

4.

Copy the new or updated help .msi files to the appropriate language folder.

5.

When you run Setup and select the Help Server component, the new content will be displayed as an
option. Select the content sets that you want to install. Any content that was previously installed will
be replaced. If you clear the check box for a content set that was previously installed, it will be
removed.

Install the help server


Use this procedure to install the Help server and Help files. If you are installing other Microsoft Dynamics
AX components at the same time, the installation pages will vary based on the components that you are
installing.
Note:
If you are upgrading Help server between Microsoft Dynamics AX 2012, Microsoft Dynamics AX
2012 Feature Pack, and Microsoft Dynamics AX 2012 R2, you should review Scenario: Perform inplace upgrade to Microsoft Dynamics AX 2012 R2 or AX 2012 R3
(http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc9-2919f47afb8f(AX.60).aspx).
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the initial wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Provide a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Help Server, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

168

Microsoft Dynamics AX
7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites.
Note:
Validation errors can be resolved through the Prerequisite validation results page only if
you are installing the Help server on a supported server operating system. If you are installing
on an unsupported client operating system for demonstration or development purposes, you
must supply missing prerequisites manually.
When no errors remain, click Next.

8.

On the Specify a location for configuration settings page, specify whether you want the help server
to access configuration information from the registry on the local computer or from a shared
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.

9.

On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. You can optionally specify the
name of the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this screen is not displayed. Subsequent installations on
this computer reuse the existing AOS connection.

10. The Help Server must be installed on a 64-bit operating system. When you install Microsoft Dynamics
AX components on a 64-bit system, the Select a file location page is displayed. Use this page to
select the location where 32-bit versions of Microsoft Dynamics AX files should be installed, and then
click Next.
11. On the Select a display language page, select a language and click Next.
12. On the Specify a location for configuration settings page, indicate whether client and server
configuration settings should be stored locally or in a shared configuration file on the network. If you
select the shared configuration, enter the network location of the file. Click Next.
13. On the Connect to AOS instance page, provide the name of the AOS server that the Help server will
be using. You can optionally specify the AOS instance name, the AOS TCP/IP port number, and the
services WSDL port. Click Next.
14. On the Configure a Web site for Help Server page, select the web site that you have chosen to host
the Help server. Verify that the location of the physical directory for the web site is displayed. Click
Next.
15. On the Specify the Help Server account page, enter a domain user account and password. This
account must be the same as the .NET Business Connector proxy account for the AOS, and it must be
a user in Microsoft Dynamics AX. This should be a service account that does not expire. Click Next.
16. On the Language and content selection page, select the Help languages and content types to
install. EN-US must be installed, and is checked by default. Click Next.
Tip:
To add additional languages or content later, obtain the necessary MSI files and run Setup
again.

Microsoft Dynamics AX 2012 Installation Guide

169

Microsoft Dynamics AX
17. On the Prerequisite Validation page, resolve any errors. When no errors remain, click Next.
18. On the Ready to install page, click Install.
19. After the installation is complete, click Finish to close the wizard.
After the Microsoft Dynamics AX Help files are installed, they must be indexed by Windows Search Service
before you can view them. Depending on system load and the number of files, it may take up to an hour
for indexing to finish.

Install Help content at an alternative location


The Help server folder on the file system contains both system files and content files. The location of this
folder is a fixed parameter in Microsoft Dynamics AX. However, you can store the content at a different
location by using the virtual directory feature in Internet Information Services (IIS).
The Microsoft Dynamics AX setup utility installs Help server files at
C:\inetpub\wwwroot\DynamicsAX6HelpServer. Help content files are located in the Content folder under
this directory. The following procedure shows how to move the Content folder to another location on the
file system, so that Microsoft Dynamics AX can continue to access the folder.
1.

On the Help server computer, create a content folder that is not located under the default directory
for the Help server, C:\inetpub\wwwroot\DynamicsAX6HelpServer. In this example, the new folder is
D:\content.

2.

Move the Help files that are currently under C:\inetpub\wwwroot\DynamicsAX6HelpServer\Content so


that they are under D:\content. Delete the original Content folder after it is empty.
Important:
Do not put any configuration files in the new folder. This folder should contain only
subfolders and content-related files, such as HTML, JavaScript, or image files.

3.

Give the domain account for the Microsoft Dynamics AX administrative user Read & execute, List
folder contents, Read, and Write permissions to the new folder. Additionally, give the local IIS user
group, IIS_IUSRS, Read & execute, List folder contents, and Read permissions to the folder.

4.

Click Start > Control Panel > Indexing Options > Modify, and add the new folder as an indexed
location.

5.

Click Start > Administrative Tools > Internet Information Services (IIS) Manager to open IIS
Manager.

6.

In the navigation pane, expand the nodes to display C:\inetpub\wwwroot\DynamicsAX6HelpServer.

7.

Right-click DynamicsAX6HelpServer, and then select Add Virtual Directory.

8.

In the Add Virtual Directory window, in the Alias field, type Content. The directory tree that the
Help server accesses when it retrieves content is restored, in virtual form.

9.

In the Physical path field, type the path of the new folder, D:\content. Alternatively, you can navigate
to the folder. Then click OK, and close IIS Manager.

10. Under C:\inetpub\wwwroot\DynamicsAX6HelpServer, locate the web.config file, and configure this file
for the new content location. Open web.config in a text editor, and locate the basePath attribute.
After the basePath attribute, add a new contentPath attribute that has the same format, and that
contains the new content folder. In this example, the XML element begins as follows.
<dynamicsHelpConfig basePath="C:\inetpub\wwwroot\DynamicsAX6HelpServer" contentPath="D:\content"....

Microsoft Dynamics AX 2012 Installation Guide

170

Microsoft Dynamics AX
11. To trigger indexing of the new folder, click Start > Administrative Tools > Services, and then restart
the Windows Search Service. The Help system should work correctly after indexing is completed.

Microsoft Dynamics AX 2012 Installation Guide

171

Microsoft Dynamics AX

Install business intelligence components


The business intelligence components for Microsoft Dynamics AX provide reporting and analytical
functionality that enables you to view and interpret business data. You can use these components to
create and use Microsoft SQL Server Reporting Services reports and Microsoft SQL Server Analysis
Services cubes.
Use the following topics to install and configure the business intelligence components:

Install Reporting Services extensions for Microsoft Dynamics AX

Configure Analysis Services

Install Reporting Services extensions for Microsoft


Dynamics AX
Microsoft SQL Server Reporting Services is the primary reporting platform for Microsoft Dynamics AX. The
reports that are included with Microsoft Dynamics AX run on the Reporting Services platform.
To integrate Microsoft Dynamics AX and Reporting Services, you must complete several procedures. You
must first install the Reporting Services extensions by running the Microsoft Dynamics AX Setup Wizard
and selecting the Reporting Services extensions option. This option installs the extensions and enables
you to deploy the reports that are included with Microsoft Dynamics AX.
The following topics provide step-by-step instructions.

Checklist: Install the Reporting Services extensions and deploy reports

Before you install the Reporting Services extensions

Install the Reporting Services extensions

Complete the Reporting Services integration

Checklist: Install the Reporting Services extensions and deploy reports


To install the Microsoft SQL Server Reporting Services extensions and deploy reports, complete the tasks
in the following checklist.
Task

More information

Complete the pre-installation tasks:

Before you install the Reporting Services extensions

1.

Verify that you have the permissions that are


required to install the Reporting Services
extensions.

2.

Install prerequisites.

3.

Configure the Reporting Services instance.

Install the Reporting Services extensions.

Microsoft Dynamics AX 2012 Installation Guide

Install the Reporting Services extensions

172

Microsoft Dynamics AX

Task

More information

Complete the Reporting Services integration. The

Complete the Reporting Services integration

directions vary, depending on whether you are


running Reporting Services in native mode or
SharePoint integrated mode.
Note:
SharePoint integrated mode is supported if
you are using Microsoft Dynamics AX 2012
R2 or later.
If you are running Reporting Services in native mode,
complete the following procedures:
1.

Deploy the default reports that are included with


Microsoft Dynamics AX, if you did not already
deploy the reports when you installed the
Reporting Services extensions.

2.

Assign users to the DynamicsAXBrowser role on


the Report Manager site.

If you are running Reporting Services in SharePoint


integrated mode, complete the following procedures:
1.

Create a document library to store reports.

2.

Deploy the default reports that are included with


Microsoft Dynamics AX.

3.

Grant users permission to view reports in


SharePoint.

Before you install the Reporting Services extensions


Before you install the Microsoft SQL Server Reporting Services extensions, you must complete the
following procedures.

Verify that you have the required permissions to install the Reporting Services
extensions
To install the Reporting Services extensions, you must have the required permissions. For more
information, see Verify that you have the required permissions for installation.

Assign system service accounts to the appropriate Active Directory groups


Identify which accounts are used for the following purposes:

The account used to run the Microsoft Dynamics AX Application Object Server (AOS)

The account used as the Business Connector proxy

Microsoft Dynamics AX 2012 Installation Guide

173

Microsoft Dynamics AX
Assign the accounts listed above to the following Active Directory groups on the domain server:

Windows Authorization Access group

Pre-Windows 2000 Compatibility Access group

Install prerequisites
On the computer where Reporting Services is installed, or where you plan to install Reporting Services,
run the prerequisite validation utility to verify that system requirements have been met. For information
about how to run the prerequisite validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Configure Reporting Services in native mode


If you installed Reporting Services in native mode, you must complete the following procedures to
configure the Reporting Services instance.
Configure the Reporting Services instance by using the Reporting Services Configuration Manager
tool
Use the following procedure to configure the Reporting Services instance.
Note:
If you installed the Reporting Services instance in its default configuration, Reporting Services is
already configured for you. However, we recommend that you complete this procedure to verify
that the options are configured correctly.
1.

Click Start > All Programs > Microsoft SQL Server > Configuration Tools > Reporting Services
Configuration Manager to open Reporting Services Configuration Manager.

2.

Connect to your Reporting Services instance.

3.

Configure the options that are described in the following table. For detailed information about each
option, see the SQL Server documentation.

Microsoft Dynamics AX 2012 Installation Guide

174

Microsoft Dynamics AX

Click this option

To do this

[ServerName]\[InstanceName]

Verify that the Reporting Services instance is running. If it is not


running, click Start.

Service Account

The action that you should take depends on the configuration


mode that you selected when you installed the Reporting
Services instance.

If you installed the default configuration for native mode,


no action is required. The service account is set to the
account that you specified when you installed the Reporting
Services instance.

If you installed but did not configure the report server,


select the Network Service built-in account.
Note:
When you install the Reporting Services extensions, the
Business Connector proxy account is automatically
assigned as the service account for the Reporting
Services instance.

Web Service URL

Create a virtual directory for the Reporting Services web service.


By default, the virtual directory is named ReportServer, and the
URL is http://[SSRSServerName]:80/ReportServer.

Database

Create a database for the Reporting Services instance. By


default, the database is named ReportServer.

Report Manager URL

Create a virtual directory for Report Manager. Report Manager is


the website that reports are published to. By default, the virtual
directory is named Reports, and the URL is
http://[SSRSServerName]:80/Reports.

E-mail Settings

This option is not required. For more information, see the SQL
Server documentation.

Execution Account

Take no action.
Note:
When you install the Reporting Services extensions, the
Business Connector proxy account is automatically
assigned as the execution account for the Reporting
Services instance.

Encryption Keys

This option is not required. For more information, see the SQL
Server documentation.

Scale-out Deployment

This option is not required. For more information, see the SQL
Server documentation.

Microsoft Dynamics AX 2012 Installation Guide

175

Microsoft Dynamics AX
4.

Click Exit to close Reporting Services Configuration Manager.

Configure the Reporting Services instance for local administration


To administer an instance of the report server locally, you must complete additional configuration steps
when you deploy Reporting Services on Windows Server 2008. Windows Server 2008 limits the overuse of
elevated permissions by removing administrator permissions when you access applications. If you are a
member of the local Administrators group, you run most applications as if you are using the Standard
User account because the operating system removes permissions.
Although this practice improves the overall security of your system, it prevents you from using the
predefined, built-in role assignments that Reporting Services creates for local administrators. However, by
completing additional configuration steps, you can manage the report server's content and operations by
using standard user permissions. For instructions, see How to: Configure a Report Server for Local
Administration on Windows Vista and Windows Server 2008 (http://technet.microsoft.com/enus/library/bb630430.aspx) on TechNet.
After you have configured the Reporting Services instance for local administration, verify that you can
access the websites that are listed in the following table.
Website

Default URL

Reporting Services web service

http://[SSRSServerName]:80/ReportServer

Report Manager

http://[SSRSServerName]:80/Reports

Configure Reporting Services in SharePoint integrated mode


If you installed Reporting Services in SharePoint integrated mode, use one of the following procedures to
configure the Reporting Services instance. The procedure that you should use depends on the version of
SQL Server that you are using.
Note:
SharePoint integrated mode is supported if you are using Microsoft Dynamics AX 2012 R2 or
later.
Configure Reporting Services 2008 in SharePoint integrated mode
If you are using Reporting Services 2008 or Reporting Services 2008 R2, follow these steps to configure
Reporting Services in SharePoint integrated mode.
1.

Configure Reporting Services by using the following topics in the SQL Server documentation:

How to: Install and Configure SharePoint Integration on a Stand-alone Server


(http://technet.microsoft.com/en-us/library/bb677368(SQL.105).aspx)

How to: Install and Configure SharePoint Integration on Multiple Servers


(http://technet.microsoft.com/en-us/library/bb677365(SQL.105).aspx)
Note:
When you configure Reporting Services, set the Reporting Services service account and
execution account to the Business Connector proxy account.

Microsoft Dynamics AX 2012 Installation Guide

176

Microsoft Dynamics AX
2.

Configure the Reporting Services integration in SharePoint Central Administration. For more
information, see How to: Configure Report Server Integration in SharePoint Central Administration
(http://technet.microsoft.com/en-us/library/bb326213(SQL.105).aspx) in the SQL Server
documentation.

3.

Verify that you can access the websites that are listed in the following table.
Website

Default URL

Reporting Services web service

http://[SSRSServerName]:80/ReportServer

SharePoint site

The URL of the SharePoint site varies based on the URL that you
provided when you created the site collection. The URL of the
SharePoint site may be:
http://[SharePointServerName]:[PortNumber]
-orhttp://[SharePointServerName]:[PortNumber]/sites/[SiteName]

Configure Reporting Services 2012 in SharePoint integrated mode


If you are using Reporting Services 2012, follow these steps to configure Reporting Services in SharePoint
integrated mode.
1.

Configure Reporting Services by using the following topics in the SQL Server documentation:

Install Reporting Services SharePoint Mode as a Single Server Farm


(http://technet.microsoft.com/en-us/library/gg492276.aspx)
Important:
When installing Reporting Services 2012 in SharePoint integrated mode, be sure that you
do not mark the Reporting Services Native option on the Feature Selection page of
the SQL Server Setup Wizard.

2.

Add an Additional Report Server to a Farm (SSRS Scale-out) (http://technet.microsoft.com/enus/library/hh479774.aspx)

Add an Additional Reporting Services Web Front-end to a Farm (http://technet.microsoft.com/enus/library/hh479775.aspx)

If you did not create a site collection when installing and configuring SharePoint, create one now by
following the instructions in Create a site collection in SharePoint (http://technet.microsoft.com/enus/library/cc263094.aspx).

Microsoft Dynamics AX 2012 Installation Guide

177

Microsoft Dynamics AX
3.

Verify that you can access the websites that are listed in the following table.
Website

Default URL

Reporting Services web service

The URL of the Reporting Services web service varies based on the URL that
you provided when you created the site collection. The URL of the Reporting
Services web service may be:
http://[SharePointServerName]:[PortNumber]/_vti_bin/ReportServer
-orhttp://[SharePointServerName]:[PortNumber]/sites/[SiteName]/_vti_bin/Repo
rtServer

SharePoint site

The URL of the SharePoint site varies based on the URL that you provided
when you created the site collection. The URL of the SharePoint site may be:
http://[SharePointServerName]:[PortNumber]
-orhttp://[SharePointServerName]:[PortNumber]/sites/[SiteName]

For more information about how to verify that the integration is configured correctly, see Verify a
Reporting Services Installation (http://technet.microsoft.com/en-us/library/ms143773.aspx) in the SQL
Server documentation.

Install the Reporting Services extensions


Use this procedure to install the Microsoft SQL Server Reporting Services extensions. You must complete
this procedure on the computer that is running Reporting Services.
This procedure assumes that you are installing the Reporting Services extensions on a dedicated server
where no other Microsoft Dynamics AX components are installed. If you are installing other Microsoft
Dynamics AX components at the same time, the installation pages vary, depending on the components
that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the initial wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, select Custom installation. Click Next.

6.

On the Select components page, follow these steps:


a.

Select the Reporting Services extensions check box.


When you select the option to install the Reporting Services extensions, the management utilities
are automatically selected for installation, also.

Microsoft Dynamics AX 2012 Installation Guide

178

Microsoft Dynamics AX
b. A message is displayed that states that you must complete the code upgrade checklist if you are
upgrading. Click OK.
c.

Click Next.

7.

On the Prerequisite Validation page, resolve any errors. For more information about how to resolve
prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location in which to install 32-bit versions of Microsoft
Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want the Reporting
Services extensions to access configuration information from the registry on the local computer or
from a shared configuration file. If you select to use a shared configuration file, you must enter the
network location of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. You can optionally specify the
name of the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
You can connect to an AOS instance that is part of an AOS cluster. However, do not connect
to an AOS instance that serves as the dedicated load balancer for a cluster. For more
information about how to integrate Reporting Services with an AOS scale-out deployment,
see Planning for reporting in Microsoft Dynamics AX
(http://technet.microsoft.com/library/05dd329c-ba8a-41e6-a2d5-1d534c34b10a(AX.60).aspx).
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by Business Connector. Click Next.
12. On the Specify a Reporting Services instance page, complete the action listed in the following table.
Field

Action you should take

Notes

Instance name

Select the name of the Reporting

SharePoint integrated mode is supported if

Services instance.

you are using Microsoft Dynamics AX 2012 R2

If you are using Reporting Services 2012

or later.

in SharePoint integrated mode, select


@Sharepoint.
Site URL

Deploy reports

Select the URL of the SharePoint site

This field is displayed only when Reporting

that has been integrated with Reporting

Services 2012 is running in SharePoint

Services.

integrated mode.

Select the check box to deploy the

This check box is displayed only when

default reports that are included with

Reporting Services is running in native mode.

Microsoft Dynamics AX.

If Reporting Services is running in SharePoint

If you do not deploy the reports now,

integrated mode, you must deploy the reports

you can deploy them later by using

after you complete this wizard. Deploy the

Windows PowerShell commands. For

reports by using Windows PowerShell

more information, see Deploy the

commands. For more information, see Deploy

default reports.

the default reports.

Microsoft Dynamics AX 2012 Installation Guide

179

Microsoft Dynamics AX
Click Next.
13. On the Prerequisite Validation page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
If you selected to deploy the reports in step 11, a Windows PowerShell window is displayed. This
window shows the progress of the deployment, which may take several minutes. Do not close this
window. When the reports are deployed, the window closes automatically.
15. Click Finish to close the Setup wizard.
If you selected to deploy the reports in step 11, you can close the Setup wizard before the reports
have finished being deployed. The deployment of the reports is not affected.
16. The Microsoft Dynamics AX 2012 Setup Summary Report is displayed. This report lists additional
procedures that you must complete to integrate Microsoft Dynamics AX and Reporting Services. For
more information about the procedures, see Complete the Reporting Services integration.

Complete the Reporting Services integration


To fully integrate Microsoft Dynamics AX and Microsoft SQL Server Reporting Services, you must
complete additional configuration procedures. The procedures vary, depending on whether you are
running Reporting Services in native mode or SharePoint integrated mode.
Note:
SharePoint integrated mode is supported if you are using Microsoft Dynamics AX 2012 R2 or
later.
If you are running Reporting Services in native mode, complete the following procedures:
1.

Deploy the default reports

2.

Grant users access to reports

If you are running Reporting Services in SharePoint integrated mode, complete the following procedures:
1.

Create a document library to store reports

2.

Deploy the default reports

3.

Grant users access to reports

Create a document library to store reports


If you are using Microsoft Dynamics AX 2012 R2 or later, and if Microsoft SQL Server Reporting Services is
running in SharePoint integrated mode, create a document library in SharePoint to store your reports.
Complete this procedure before you deploy the default reports that are included with Microsoft Dynamics
AX.
Note:
This procedure does not apply to you if you are running Reporting Services in native mode.
Create a document library
Create a document library on your SharePoint site to store reports. For information about how to create a
document library, see the SharePoint documentation.

Microsoft Dynamics AX 2012 Installation Guide

180

Microsoft Dynamics AX
After you create the document library, add Reporting Services content types to the library. For more
information, see Add Report Server Content Types to a Library (Reporting Services in SharePoint
Integrated Mode) (http://technet.microsoft.com/en-us/library/bb326289(v=sql.110).aspx) in the SQL
Server documentation.
Specify the URL of the document library
After you have created the document library, complete the following procedure to specify the URL of the
document library in the Report servers form in Microsoft Dynamics AX.
1.

Open Microsoft Dynamics AX.

2.

Click System administration > Setup > Business intelligence > Reporting Services > Report
servers.

3.

In the Configuration ID field, enter a name that identifies the Reporting Services instance and the
Application Object Server (AOS) instance that you are connecting.

4.

In the Description field, enter a brief description to help you identify the Reporting Services instance
and the AOS instance that you are connecting.

5.

Select the Default configuration check box to make the Reporting Services and AOS instances that
are specified in this record the active connection.

6.

On the Reporting Server information tab, enter the following information:


a.

In the Server name field, enter the name of the server that is running Reporting Services.

b. In the Server instance name field, enter the name of the Reporting Services instance.
Note:
If you are using Reporting Services 2012, enter @Sharepoint.
c.

Leave the Report Manager URL field blank. This field becomes unavailable when you select the
SharePoint integrated mode check box in a later step.

d. In the Web service URL field, enter the URL of the Reporting Services web service.

If you are using Reporting Services 2008, the URL is typically


http://[SSRSServerName]/ReportServer.

If you are using Reporting Services 2012, the URL is typically


http://[SharePointServerName]/_vti_bin/ReportServer or
http:[SharePointServerName]/sites/[SiteName]/_vti_bin/ReportServer.

e.

Select the SharePoint integrated mode check box.

f.

In the Microsoft Dynamics AX report folder field, enter the URL of the document library that
you created to store reports.
For example, suppose that you have created a document library that is named Reports on a
SharePoint site that is named Contoso. In this example, the URL is as follows:
http://[SharePointServerName]/sites/Contoso/Reports

7.

On the Application Object Server information tab, select the name of the AOS instance.

Microsoft Dynamics AX 2012 Installation Guide

181

Microsoft Dynamics AX

Deploy the default reports


Microsoft Dynamics AX includes many default reports that you must deploy. If you did not deploy the
reports when you installed the Microsoft SQL Server Reporting Services extensions, you can deploy them
by using Windows PowerShell. The following procedures can help you deploy the reports.
Before you begin
Before you can deploy the reports by using Windows PowerShell, you must complete the following tasks:

Verify that Windows PowerShell 2.0 is installed on the computer that you are using.

Verify that your Windows domain account is a member of the Administrators group on the server that
is running Reporting Services.
Note:
If your Windows domain account is assigned to a group that is a member of the
Administrators group, it may take some time to validate that you are a member of the
Administrators group. If you experience a delay when you deploy reports, consider adding
your Windows domain account directly to the Administrators group.

If Reporting Services is running in native mode, verify that you are assigned to the System
Administrator role on the Report Manager website.

If Reporting Services is running in SharePoint integrated mode, verify that you have been granted
Contribute permission to the document library where you plan to deploy the reports.
Note:
SharePoint integrated mode is supported if you are using Microsoft Dynamics AX 2012 R2 or
later.

Open Windows PowerShell and view a list of reports


Complete the following procedure to open Windows PowerShell and view a list of the reports that are
included with Microsoft Dynamics AX.
1.

Open Windows PowerShell as an administrator by following these steps:


a.

Click Start > Administrative Tools.

b. Right-click the Microsoft Dynamics AX 2012 Management Shell option.


c.
2.

Click Run as administrator.

Retrieve a list of the reports that are included with Microsoft Dynamics AX, and store the list in a local
variable by entering the following command:
$reports = Get-AXReport -ReportName *

For more information about the Get-AXReport command, see Get-AXReport


(http://go.microsoft.com/fwlink/?LinkID=217546).
3.

View the list of reports by entering the following command:


$reports

Microsoft Dynamics AX 2012 Installation Guide

182

Microsoft Dynamics AX

Filter the list of reports


In the previous procedure, you displayed a list of all the reports that are included with Microsoft Dynamics
AX. To modify and filter the list, you can use the following commands:

To modify the list so that only the Name and ChangedDate fields are displayed, enter the following
command:
$reports | Select-Object Name,ChangedDate

To filter the list so that only specific reports are listed, enter keywords or report names. For example,
to filter the list so that only reports that contain the word CustTrans are listed, enter the following
command:
$reports | Select-Object Name,ChangedDate | Where { $_.Name -like "CustTrans*" }

Deploy the reports


After you have retrieved a list of reports, you can deploy the reports. The Publish-AXReport command is
used to deploy the reports. The following examples show how to use this command. For more
information, see Publish-AXReport (http://go.microsoft.com/fwlink/?LinkID=217550).

To deploy a specific report, enter the name of the report. For example, to deploy the CustTransList
report, enter the following command:
Publish-AXReport -ReportName CustTransList

To deploy two or more specific reports, enter the names of the reports. For example, to deploy the
CustTransList and CustTransOpenPerDate reports, enter the following command:
Publish-AXReport -ReportName CustTransList, CustTransOpenPerDate

To deploy all reports, enter the following command:


Publish-AXReport ReportName *

Redeploy the reports


If you have modified a reports data source or parameters, you must redeploy the report in order for the
changes to take effect. To redeploy a report, follow the previous procedures in this topic.
After you redeploy a report, complete the following tasks.
Restart the Reporting Services service
If youre running Reporting Services 2008 (in either native or SharePoint integrated mode) or Reporting
Services 2012 in native mode, restart the service by following these steps:
1.

Click Start > Administrative Tools > Services to open the Services management console.

2.

Right-click the SQL Server Reporting Services service and choose Restart.

If youre running Reporting Services 2012 in SharePoint integrated mode, restart the service by following
these steps:
1.

Go to the SharePoint Central Administration site.

2.

Click System Settings > Manage services on server.

3.

Stop the SQL Server Reporting Services service.

4.

Start the SQL Server Reporting Services service.

Microsoft Dynamics AX 2012 Installation Guide

183

Microsoft Dynamics AX
Refresh the AOD cache
Complete the following steps to refresh the application object directory (AOD) cache. This will clear
cached application object information for all items in the application object tree (AOT) of Microsoft
Dynamics AX.
1.

Open the Microsoft Dynamics AX client.

2.

Open the development workspace.

3.

Click Tools > Caches > Refresh elements.


After the cache has been cleared, the Infolog displays a message indicating that AOD elements have
been refreshed.

Instruct users to delete usage data


Instruct Microsoft Dynamics AX users to delete usage data. Selections that users make while Microsoft
Dynamics AX is running are saved as usage data. This data is used to improve the users experiences the
next time that they run Microsoft Dynamics AX.
Instruct users to delete usage data by following these steps:
1.

Open the Microsoft Dynamics AX client.

2.

Click File > Tools > Options. The Options form is displayed.

3.

Click Usage data.

4.

On the General tab, click Reset.

See Also
Administering Microsoft Dynamics AX by using Windows PowerShell
(http://technet.microsoft.com/library/96e9ae2f-447a-426e-b77f-95636ddb9f15(AX.60).aspx)
Windows PowerShell for Microsoft Dynamics AX (http://technet.microsoft.com/library/c9852f5b-0fee4b80-8317-62f014187549(AX.60).aspx)
Piping and the Pipeline in Windows PowerShell (http://go.microsoft.com/fwlink/?LinkID=187808)

Grant users access to reports


This topic explains how to give users access to reports. Two procedures are described in this topic. The
procedure that you should use depends on whether you are running Microsoft SQL Server Reporting
Services in native mode or SharePoint integrated mode.
Note:
SharePoint integrated mode is supported if you are using Microsoft Dynamics AX 2012 R2 or
later.
Assign users to the DynamicsAXBrowser role on the Report Manager site
If you are running Reporting Services in native mode, you must assign users or groups to the
DynamicsAXBrowser role on the Report Manager site. The following procedure explains how to complete
this task.
1.

Open the Report Manager website for the Reporting Services instance. By default, the URL is
http://[SSRSServerName]:80/Reports.

2.

Click the DynamicsAX folder.

Microsoft Dynamics AX 2012 Installation Guide

184

Microsoft Dynamics AX
3.

Click Folder Settings.

4.

Click Security.

5.

Click New Role Assignment.

6.

Enter the Active Directory user name or group to assign to the DynamicsAXBrowser role.

7.

Select the DynamicsAXBrowser role.

8.

Click OK.

Grant users permission to view reports in SharePoint


If you are running Reporting Services in SharePoint integrated mode, you must grant users permission to
view reports in SharePoint. To grant this permission, grant users Read permission to the document library
that stores the reports. Alternatively, if the document library inherits permissions from the site, you can
grant users Read permission to the site. The following procedure describes how to grant users Read
permission to the site.
Important:
If the SharePoint site is configured for claims-based authentication, you must also grant the
following accounts Read permission to the document library or site:
The account that is used as the Business Connector proxy
The account that is used to run the Microsoft Dynamics AX Application Object Server (AOS) service.
1.

Open your browser and navigate to the SharePoint site that contains the document library that stores
the reports.

2.

Click Site Actions > Site Permissions.

3.

Click Grant Permissions. The Grant Permissions window is displayed.

4.

In the Users/Groups field, enter the Active Directory names of the users or groups that you want to
view reports.

5.

In the Grant Permissions area, select the Grant users permission directly option.

6.

Select the Read check box.


Note:
If you want users of Enterprise Portal for Microsoft Dynamics AX to be able to filter reports by
using a custom parameter value, select the Design check box. For more information about
the permissions that are required to use Enterprise Portal, see Enable users to access
Enterprise Portal (http://technet.microsoft.com/library/2adbf75e-a599-45ca-a849765185bf7897(AX.60).aspx).

7.

Click OK.

See Also
Security settings for reports (http://technet.microsoft.com/library/fd45fcf5-f9c7-4f28-98c9be021a6cbfe2(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

185

Microsoft Dynamics AX

Configure Analysis Services


Microsoft SQL Server Analysis Services is a server-based solution that provides online analytical
processing (OLAP) functionality. Analytical reports help users examine business data and identify trends
that they might not otherwise discover when viewing data on traditional reports.
To integrate Microsoft Dynamics AX and Analysis Services, you must complete several procedures. You
must first run the Microsoft Dynamics AX Setup wizard and select the Analysis Services configuration
option. This option configures Analysis Services so that it can be used with Microsoft Dynamics AX. The
topics in this section provide step-by-step instructions.

Checklist: Configure Analysis Services and deploy cubes

Before you configure Analysis Services

Configure Analysis Services by running Setup

Complete the Analysis Services integration process

Checklist: Configure Analysis Services and deploy cubes


To configure Microsoft SQL Server Analysis Services for use with Microsoft Dynamics AX and to deploy
the cubes that are included with Microsoft Dynamics AX, complete the tasks in the following checklist.
Task

More information

Complete the prerequisite tasks:

Before you configure Analysis Services

1.

Verify that you have the permissions that are


required to configure Analysis Services.

2.

Create a domain account to run the Analysis


Services service.

3.

Assign the .NET Business Connector proxy


account to the server administrator role in
Analysis Services.

4.

Install prerequisites.

Configure Analysis Services by running the Microsoft

Configure Analysis Services by running Setup

Dynamics AX Setup Wizard.

Microsoft Dynamics AX 2012 Installation Guide

186

Microsoft Dynamics AX

Task

More information

Complete the Analysis Services integration:

Install SQL Server Shared Management Objects

1.

(http://technet.microsoft.com/library/7da728c6-9079-48fd-

2.

Install SQL Server Shared Management Objects


on Microsoft Dynamics AX client computers.

8dcb-1ce64759a412(AX.60).aspx)

Verify that information about exchange rates has

Verify that exchange rate information has been entered

been entered.
3.

Deploy the default cubes that are included with


Microsoft Dynamics AX.

4.

Update the data source for online analytical


processing (OLAP) if your Analysis Services
database is not named Dynamics AX.

9d00-162767163465(AX.60).aspx)
Deploy the default cubes
(http://technet.microsoft.com/library/581f609e-588c-45cebc10-32a863ef4589(AX.60).aspx)
Update the OLAP data source
(http://technet.microsoft.com/library/d19dbb45-bf32-4f36-

Note:

b7d2-722c149df5ae(AX.60).aspx)

If you are using Microsoft Dynamics AX

Configure an Existing SQL Server Analysis Services Project

2012 R2 or later, this step does not


apply to you.
5.

(http://technet.microsoft.com/library/0dc6d13d-abc7-411c-

Configure the cubes, based on the changes that


you have made to the Microsoft Dynamics AX
configuration or license keys.

(http://technet.microsoft.com/library/ee0aa94f-28f9-442782c6-51a18e0939be(AX.60).aspx)
Grant users access to cubes
(http://technet.microsoft.com/library/dd6bba5a-22d8-4bf09355-bee63b45818b(AX.60).aspx)

6.

Grant users access to the cubes.

Automate the processing of cubes

7.

Automate the processing of cubes.

(http://technet.microsoft.com/library/4b5e2423-fefd-490f-

8.

Create new date dimensions for the cubes.

8561-a09eccedcc78(AX.60).aspx)

9.

Add financial dimensions to the cubes.

How to: Create a Date Dimension for a Cube


(http://technet.microsoft.com/library/81508890-2f55-40d49894-53118a598f1d(AX.60).aspx)
How to: Add a Financial Dimension to a Cube
(http://technet.microsoft.com/library/507d6dab-53bb4116-971b-f834bb3192c8(AX.60).aspx)

Before you configure Analysis Services


Before you configure Microsoft SQL Server Analysis Services for use with Microsoft Dynamics AX, you
must complete the following procedures.

Verify that you have the required permissions to configure Analysis Services
To configure Analysis Services, you must have the required permissions. For more information, see Verify
that you have the required permissions for installation.

Create a domain account to run the Analysis Services service


Create a domain account that can run the Analysis Services service. For more information, see Create
service accounts.

Microsoft Dynamics AX 2012 Installation Guide

187

Microsoft Dynamics AX

Assign the Business Connector proxy account to the Analysis Services server
administrator role
The proxy account for Business Connector must be assigned to the server administrator role in Analysis
Services. To complete that task, follow these steps.
1.

Open Microsoft SQL Server Management Studio and connect to your Analysis Services instance.

2.

In the tree view, right-click the Analysis Services instance, and then click Properties. The Analysis
Services Properties window is displayed.

3.

In the Select a page area, click Security.

4.

Click Add. The Select Users or Groups form is displayed.

5.

Enter the Business Connector proxy account in the following format: [DomainName]\[UserName].
Click OK.

Install prerequisites
On the computer where Analysis Services is installed, or where you plan to install Analysis Services, run
the prerequisite validation utility to verify that system requirements have been met. For information about
how to run the prerequisite validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Configure Analysis Services by running Setup


Use this procedure to configure Microsoft SQL Server Analysis Services for use with Microsoft Dynamics
AX. You must complete this procedure on the computer that is running Analysis Services.
This procedure assumes that you are configuring Analysis Services on a dedicated server where no
Microsoft Dynamics AX components are installed. If you are installing other Microsoft Dynamics AX
components at the same time, the installation pages vary, depending on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the initial wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, select Custom installation. Click Next.

6.

On the Select components page, follow these steps:


a.

Select the Analysis Services configuration check box.

b. A message is displayed that states that you must complete the code upgrade checklist if you are
upgrading. Click OK.
c.

We recommend that you select the Management utilities check box so that you can deploy
cubes by using Windows PowerShell commands.

Microsoft Dynamics AX 2012 Installation Guide

188

Microsoft Dynamics AX
d. Click Next.
7.

On the Prerequisite Validation page, resolve any errors. For more information about how to resolve
prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location in which to install 32-bit versions of Microsoft
Dynamics AX files, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want the cubes to
access configuration information from the registry on the local computer or from a shared
configuration file. If you select to use a shared configuration file, you must enter the network location
of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that is running the
Application Object Server (AOS) instance that you want to connect to. You can optionally specify the
name of the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this page is not displayed. Subsequent installations on this
computer reuse the existing AOS connection.
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by Business Connector. Click Next.
12. On the Specify an Analysis Services instance page, select an instance of Analysis Services. Click
Next.
13. On the Connect to a SQL Server Database page, follow these steps:
a.

Select the computer that hosts your Microsoft Dynamics AX online transaction processing (OLTP)
database.

b. Select the Microsoft Dynamics AX OLTP database.


c.

Click Next.

14. The domain account that the Analysis Services service runs as must have access to the Microsoft
Dynamics AX OLTP database in order to process the cubes. The Specify user accounts page lists the
accounts that currently have access to the OLTP database. If the account that the Analysis Services
service runs as is not listed, click Add user to add it.
Click Next.
15. On the Prerequisite Validation page, resolve any errors. When no errors remain, click Next.
16. On the Ready to install page, click Install.
17. Click Finish to close the Setup wizard.
18. The Microsoft Dynamics AX 2012 Setup Summary Report is displayed. This report lists additional
procedures that you must complete to integrate Microsoft Dynamics AX and Analysis Services. For
more information about the procedures, see Complete the Analysis Services integration
(http://technet.microsoft.com/library/30576955-72a6-4a8e-9e95-e3767d6addfd(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

189

Microsoft Dynamics AX

Complete the Analysis Services integration process


After you have completed the steps of the initialization checklist in Microsoft Dynamics AX, complete the
following procedures to integrate Microsoft Dynamics AX with Microsoft SQL Server Analysis Services:
1.

Install SQL Server Shared Management Objects (http://technet.microsoft.com/library/7da728c6-907948fd-8dcb-1ce64759a412(AX.60).aspx)

2.

Verify that exchange rate information has been entered


(http://technet.microsoft.com/library/0dc6d13d-abc7-411c-9d00-162767163465(AX.60).aspx)

3.

Deploy the default cubes (http://technet.microsoft.com/library/581f609e-588c-45ce-bc1032a863ef4589(AX.60).aspx)

4.

Update the OLAP data source (http://technet.microsoft.com/library/d19dbb45-bf32-4f36-b7d2722c149df5ae(AX.60).aspx)

5.

Configure an Existing SQL Server Analysis Services Project


(http://technet.microsoft.com/library/ee0aa94f-28f9-4427-82c6-51a18e0939be(AX.60).aspx)

6.

Grant users access to cubes (http://technet.microsoft.com/library/dd6bba5a-22d8-4bf0-9355bee63b45818b(AX.60).aspx)

7.

Automate the processing of cubes (http://technet.microsoft.com/library/4b5e2423-fefd-490f-8561a09eccedcc78(AX.60).aspx)

8.

How to: Create a Date Dimension for a Cube (http://technet.microsoft.com/library/81508890-2f5540d4-9894-53118a598f1d(AX.60).aspx)

9.

How to: Add a Financial Dimension to a Cube (http://technet.microsoft.com/library/507d6dab-53bb4116-971b-f834bb3192c8(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

190

Microsoft Dynamics AX

Install Management Reporter components


Management Reporter for Microsoft Dynamics ERP is the recommended financial reporting solution for
Microsoft Dynamics AX 2012. Use Management Reporter to create, distribute, and analyze financial
statements and other financial reports.
Note:
Management Reporter components are available in the Setup wizard in AX 2012 R3 and
cumulative update 7 for Microsoft Dynamics AX 2012 R2.
The following topics explain how to install Management Reporter components by using the Setup wizard:

Install Management Reporter server components

Install Report Designer for Management Reporter

Install Management Reporter server components


This topic describes how to install Management Reporter for Microsoft Dynamics ERP by using the
Microsoft Dynamics AX Setup wizard. Management Reporter is a financial reporting tool that is used to
create, distribute, and analyze financial statements. For more information about Management Reporter,
see the Management Reporter page (http://go.microsoft.com/fwlink/?LinkId=324871) on CustomerSource
(logon is required).
Notes:
Management Reporter is available through the Microsoft Dynamics AX Setup wizard in AX 2012
R3 and cumulative update 7 for Microsoft Dynamics AX 2012 R2 (CU 7). For information about
how to install Management Reporter with CU 7, see the Installation Guide for cumulative update 7
(http://go.microsoft.com/fwlink/?LinkId=329982).
If youre not using Microsoft Dynamics AX 2012 R3 or cumulative update 7 or later for AX 2012
R2, you can use the stand-alone installation for Management Reporter. Download and run the
installation package that is available on CustomerSource. For information about how to run the
stand-alone installation, see the Management Reporter Installation Guide
(http://go.microsoft.com/fwlink/?LinkId=325393) (PDF).
When you install Management Reporter, Microsoft SQL Server change tracking is enabled on the
Microsoft Dynamics AX business database.

Before you install Management Reporter

Create the service account that will be used to run the Windows service for Management Reporter.
Additionally, create or select the account that will be used to integrate data between Microsoft
Dynamics AX and Management Reporter. For more information about the requirements for these
accounts, see Create service accounts.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.

Microsoft Dynamics AX 2012 Installation Guide

191

Microsoft Dynamics AX
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Management Reporter


Use this procedure to install Management Reporter. If you install other Microsoft Dynamics AX
components at the same time, the installation pages vary, depending on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Management Reporter, and then click Next.

7.

On the Connect Management Reporter to an AOS instance page, enter the name, TCP/IP port, and
services endpoint port of the instance of Microsoft Dynamics AX Application Object Server (AOS) to
use together with Management Reporter. By default, AOS uses port 2712 for TCP/IP communication
and port 8201 for the services endpoint.
Click Next.

8.

On the Connect Management Reporter to a database page, select the server name and database
where Microsoft Dynamics AX transaction data is located. Reporting will be enabled for the database
that you select. The Management Reporter database will also be created on the selected server.
Click Next.

9.

On the Select a service account page, enter the account to run the Management Reporter Windows
service, and then click Next.

10. On the Configure Management Reporter page, enter the following information:

The port number that the Management Reporter application server uses for communication. By
default, the application server uses port 4712.

The name of the Management Reporter database.

The name of the data mart database.

Click Next.
11. On the Configure an integration user page, enter information about the user account that is used to
integrate data between Management Reporter and Microsoft Dynamics AX. If the user does not
already exist in Microsoft Dynamics AX, select Create new account. The user will be added, and the
Microsoft Dynamics AX user ID will be AxIntUsr. If the user already exists in Microsoft Dynamics AX,
select Use existing account, and enter a user ID. Click Next.
12. On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.
13. On the Ready to install page, click Install.

Microsoft Dynamics AX 2012 Installation Guide

192

Microsoft Dynamics AX
14. After the installation is completed, click Finish to close the wizard.
Note:
The Setup wizard installs Management Reporter in two phases. First, the Management
Reporter software is installed. Then, Management Reporter is configured to connect to
Microsoft Dynamics AX. If the Setup wizard reports a failure, we recommend that you run the
Management Reporter Configuration Console to complete the configuration.

After you install Management Reporter


After installation, you must open the Report Designer client and enter registration keys. After you have
entered registration keys, additional configuration might be required before you can add report viewers
or users. For information about how to configure Management Reporter, see the Management Reporter
Installation Guide (http://go.microsoft.com/fwlink/?LinkId=325393) (PDF).
Management Reporter is available to Microsoft Dynamics AX users based on role membership in
Microsoft Dynamics AX. For information about how Management Reporter integrates with Microsoft
Dynamics AX, see the Management Reporter Integration Guide for Microsoft Dynamics AX
(http://go.microsoft.com/fwlink/?LinkId=325395) (PDF).
For information about how to use Management Reporter, see the Management Reporter technical library
(http://go.microsoft.com/fwlink/?LinkId=325396) on TechNet.

Install Report Designer for Management Reporter


This topic describes how to install Report Designer by using the Microsoft Dynamics AX Setup wizard.
Report Designer is a component of Management Reporter for Microsoft Dynamics ERP that is used to
create the building blocks that define a report. For more information about Management Reporter, see
the Management Reporter page (http://go.microsoft.com/fwlink/?LinkId=324871) on CustomerSource
(logon is required).
Notes:
Report Designer is available through the Microsoft Dynamics AX Setup wizard in AX 2012 R3 and
cumulative update 7 for Microsoft Dynamics AX 2012 R2 (CU 7). For information about how to
install Report Designer with CU 7, see the Installation Guide for cumulative update 7
(http://go.microsoft.com/fwlink/?LinkId=329982).
If youre not using Microsoft Dynamics AX 2012 R3 or cumulative update 7 or later for AX 2012
R2, you can use the stand-alone installation for Management Reporter. For more information, see
the Management Reporter Installation Guide (http://go.microsoft.com/fwlink/?LinkId=325393).

Before you install Report Designer


On the computer where you plan to install this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Microsoft Dynamics AX 2012 Installation Guide

193

Microsoft Dynamics AX

Install Report Designer


Use this procedure to install Report Designer. If you install other Microsoft Dynamics AX components at
the same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Management Reporter Report Designer, and then click
Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Ready to install page, click Install.

9.

After the installation is completed, click Finish to close the wizard.

After you install Report Designer


For information about how to use Report Designer, see the Management Reporter technical library
(http://go.microsoft.com/fwlink/?LinkId=325396) on TechNet.

Microsoft Dynamics AX 2012 Installation Guide

194

Microsoft Dynamics AX

Install client components


The topics in this section provide information about how to install the client components for Microsoft
Dynamics AX. The following topics are included:

Install the Microsoft Dynamics AX client

Install Office Add-ins

Install Remote Desktop Services integration

Install the Microsoft Dynamics AX client


The Microsoft Dynamics AX client is an interface to Microsoft Dynamics AX data and functionality. The
topics in this section provide information about how to install a Microsoft Dynamics AX client.
The following topics are included:
Install a client
Configure clients to use a shared configuration
Configure clients to access data in a partition

Install a client
When you install a Microsoft Dynamics AX client, the following components are included:

The Microsoft Dynamics AX interface that connects to an instance of Application Object Server (AOS)

The Microsoft Dynamics AX Configuration utility

You can access the Microsoft Dynamics AX Configuration utility from the Administrative Tools menu. On
computers that run Windows 7, Administrative Tools is an item in Control Panel.
If you are installing many clients, we recommend that you install them from a file server and create a
shared configuration file. For more information, see Mass deployment of the Microsoft Dynamics AX
Windows client (http://technet.microsoft.com/library/6fda1199-2236-4952-9f1988ff3fdcc92a(AX.60).aspx).
Note:
If you are upgrading clients between AX 2012, AX 2012 Feature Pack, AX 2012 R2, and AX 2012
R3, you should review Scenario: Perform in-place upgrade to Microsoft Dynamics AX 2012 R2 or
AX 2012 R3 (http://technet.microsoft.com/library/eb8193f4-0318-427f-bcc92919f47afb8f(AX.60).aspx).

Before you install a client


Complete the following tasks before you install a Microsoft Dynamics AX client.

Read Client security and protection (http://technet.microsoft.com/library/60c8d10d-9c97-43c0-b99c9bda66c8376f(AX.60).aspx) to learn about deployment best practices that can help secure the
Microsoft Dynamics AX client.

Microsoft Dynamics AX 2012 Installation Guide

195

Microsoft Dynamics AX

On the computer where you plan to install the client, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Microsoft Dynamics AX databases and AOS in the environment.

Install a client
Use this procedure to install a Microsoft Dynamics AX client by using the Setup wizard. If you install other
Microsoft Dynamics AX components at the same time, the installation pages vary, depending on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Client, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where you want to install 32-bit versions of Microsoft Dynamics AX files, and then click
Next.

9.

On the Select client preferences page, select the display language that is used in the client, and
specify whether you want Setup to create a desktop shortcut for the client. Additionally, select one of
the following installation types:

Business user The basic client is installed. This type of client installation is appropriate for most
users.

Developer The client, the developer workspace, and additional files that are required for
development tasks are installed.

Administrator The client and additional files that are required for administrative tasks are
installed. Administrative tasks include the deployment of artifacts and the creation of users.

Click Next.
10. On the Specify a location for configuration settings page, specify whether you want the client to
access configuration information from the registry on the local computer or from a shared
configuration file. If you want to use a shared configuration file, you must enter the network location
of the file.
If you use a shared configuration file, client configuration settings are not stored locally, and the
Microsoft Dynamics AX Configuration utility is not installed on the client computer.

Microsoft Dynamics AX 2012 Installation Guide

196

Microsoft Dynamics AX

Note:
If you install the client at the same time as an AOS instance, this screen is not displayed, and
configuration settings are saved in the registry automatically.
For more information about how to use a shared configuration file, see Configure clients to use a
shared configuration.
Click Next.
11. On the Connect to an AOS instance page, enter the name of the computer that runs the AOS
instance that you want to connect to. You can optionally specify the name of the AOS instance, the
TCP/IP port number, and the WSDL port for services.
If you do not know the name of the AOS instance or the port information, contact the Microsoft
Dynamics AX administrator.
Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
Click Next.
12. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
13. On the Ready to install page, click Install.
14. After the installation is completed, click Finish to close the wizard.

Configure clients to use a shared configuration


By default, the Microsoft Dynamics AX client reads configuration information from the registry on the
local computer. If you deploy many Microsoft Dynamics AX clients, it can be difficult to maintain or
troubleshoot configurations. To enhance security and simplify client administration, we recommend that
large deployments run the Microsoft Dynamics AX client as a Windows Server RemoteApp. For more
information, see the Windows Server RemoteApp documentation on Microsoft on TechNet. If your
organization cannot deploy the Microsoft Dynamics AX client as a remote application, we recommend
that you deploy the client by using one of the methods that are listed in the following table.
Deployment method

For more information

Microsoft System Center Configuration

Deploy the client by using Microsoft System Center Configuration

Manager

Manager 2007 (http://technet.microsoft.com/library/d071ca022f1d-4de0-bd65-35e8cb7a7295(AX.60).aspx)


Deploy the client by using Microsoft System Center 2012
Configuration Manager
(http://technet.microsoft.com/library/9527b874-0f9d-46cf-acef3d8b02d659fa(AX.60).aspx)

Group Policy

Deploy the client by using Group Policy


(http://technet.microsoft.com/library/ea4a6465-9c70-49a6-866e1ab3d1e46ac2(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

197

Microsoft Dynamics AX
If you deploy the Microsoft Dynamics AX client by using one of these methods, we recommend that you
configure clients to access configuration information from a file that is stored on a network share. A
shared configuration file can reduce the time that you spend administering or troubleshooting clients.

Before you begin


If your business or organization runs Microsoft Dynamics AX 2012 clients on both 32-bit and 64-bit
versions of the Windows operating system, you must create multiple configuration files. Microsoft
Dynamics AX clients that run on a 32-bit version of Windows must connect to a client configuration file
that was created on a 32-bit version of Windows. Similarly, Microsoft Dynamics AX clients that run on a
64-bit version of Windows must connect to a client configuration file that was created on a 64-bit version
of Windows.

Create a shared configuration file


1.

On a file server or the server that hosts Application Object Server (AOS), create the directory that the
clients share. Configure the directory so that all users of the Microsoft Dynamics AX client have read
access.

2.

Use the Microsoft Dynamics AX 2012 Configuration utility to save a Microsoft Dynamics AX
configuration as a file. For more information, see Manage a client configuration
(http://technet.microsoft.com/library/813ed1c9-aec5-47f5-9c1f-94e934fda5d3(AX.60).aspx). If your
business or organization runs both 32-bit and 64-bit versions of Windows, you must save a separate
configuration file for each operating system. Open the Microsoft Dynamics AX 2012 Configuration
utility on each operating system, and save a configuration as a file. We recommend that you give each
configuration a name that identifies the version, such as 32bit.axc and 64bit.axc.

3.

Copy the configuration files to the share that you created in step 1.

Set up clients to use the shared configuration file


The following table lists three methods that you can use to set up clients to use a shared configuration
file. For more information, see Install a client.
Method

For more information

In the Setup wizard, enter the path of the shared

Install a client

configuration file when you install the Microsoft Dynamics


AX client.
Log on to a client computer, and use the Set Configuration

Manage a client configuration

Store option in the Microsoft Dynamics AX 2012

(http://technet.microsoft.com/library/813ed1c9-aec5-

Configuration utility to specify the new shared configuration 47f5-9c1f-94e934fda5d3(AX.60).aspx)


file. This method is useful when a client is already installed
and configured to read configurations from the registry on
the local computer.

Microsoft Dynamics AX 2012 Installation Guide

198

Microsoft Dynamics AX

Method

For more information

Use the ClientConfigFile setup parameter, and specify the

Run Setup in silent mode

path of the shared configuration file. This method can be


used for client installations that are run in silent mode. The
following example shows the format of the parameter.
ClientConfigFile="%Drive%:\<name of configuration
file>.axc"
Tip:
If you want to install clients, but you do not want
to install the Microsoft Dynamics AX 2012
Configuration utility, set the ClientConfig
parameter to 0 (zero).

See Also
Mass deployment of the Microsoft Dynamics AX Windows client
(http://technet.microsoft.com/library/6fda1199-2236-4952-9f19-88ff3fdcc92a(AX.60).aspx)
Client security and protection (http://technet.microsoft.com/library/60c8d10d-9c97-43c0-b99c9bda66c8376f(AX.60).aspx)

Configure clients to access data in a partition


Microsoft Dynamics AX 2012 R2 enables data isolation by using data partitions. Data partitions provide a
logical separation of data in the Microsoft Dynamics AX database. Partitions are defined in the Partitions
form, where the system administrator creates the partition and provides a partition key. A partition key
identifies a partition by using a unique string value that the system administrator specifies. Microsoft
Dynamics AX displays the partition key in the title bar of the client application. For more information
about partitions, see Data partitioning architecture (http://technet.microsoft.com/library/27ba6c51-7ea74403-867a-46ccc1ee053a(AX.60).aspx).
This topic describes two ways to configure Microsoft Dynamics AX clients to access data in a specific
partition.

Before you begin


Before you configure clients to access data in a partition, verify the following.
1.

You are an administrator in Microsoft Dynamics AX.

2.

You are an administrator on the local client computer where you will create a configuration by using
the Microsoft Dynamics AX 2012 Configuration utility. This requirement is only necessary if you use
the configuration file procedure later in this section.

3.

You have the partition key(s) from the System administration > Setup > Partitions form.

4.

All users who require access to a designated partition are listed on the Users form for that partition.

Microsoft Dynamics AX 2012 Installation Guide

199

Microsoft Dynamics AX

Configure clients to access data in a partition by using a configuration file


This procedure describes how to configure clients to access data in a partition by using a Microsoft
Dynamics AX client configuration file. If your business or organization has only one partition, you can
create a partition-specific configuration and then deploy the configuration by using a sharedconfiguration file. For more information, see Configure clients to use a shared configuration. If your
business or organization has multiple partitions, you can create multiple client configurations and then
deploy those configurations by using the system tools available for mass-client deployments. For more
information, see Mass deployment of the Microsoft Dynamics AX Windows client
(http://technet.microsoft.com/library/6fda1199-2236-4952-9f19-88ff3fdcc92a(AX.60).aspx). For multiple
partitions, you can also configure clients to access data in a partition by creating multiple client shortcuts
as described in the next procedure in this topic.
1.

Open the configuration utility. Click Start > Control Panel > Administrative Tools > Microsoft
Dynamics AX 2012 Configuration.

2.

In the Configuration target list, select Local client.

3.

Click Manage, and then click Create configuration.

4.

In the Create configuration dialog box, in the Name box, type a name.

5.

You can copy settings from either the active configuration or the original configuration, which is the
default configuration. Select the configuration that you want to copy settings from, and then click OK.

6.

On the General tab, enter a partition key in the Partition field. Click OK to save your changes or save
your changes to a file for shared-configuration client deployments.

7.

Open the Microsoft Dynamics AX client and verify that you see the partition key in the title bar.

Configure clients to access data in a partition by using a Windows shortcut


You can also configure clients to access data in a specific partition by adding the partition= key
argument to the Microsoft Dynamics AX client shortcut.
1.

On a computer where the Microsoft Dynamics AX client is installed, click Start > All Programs, and
then right-click the Microsoft Dynamics AX 2012 shortcut.

2.

Click Properties.

3.

In the Target field, add the partition= key argument to the end of the path.
For example: "C:\Program Files (x86)\Microsoft Dynamics AX\60\Client\Bin\Ax32.exe" -partition=test

4.

Click OK, and then double-click the shortcut to verify that the client opens in the specified partition.

5.

Repeat this procedure to create shortcuts to different partitions.

Microsoft Dynamics AX 2012 Installation Guide

200

Microsoft Dynamics AX

Install Office Add-ins


This topic describes how to install Microsoft Office Add-ins by using the Microsoft Dynamics AX Setup
wizard. In Microsoft Dynamics AX 2012 R3 and cumulative update 7 for Microsoft Dynamics AX 2012 R2,
the Microsoft Project client add-in is included with the Office Add-ins.
Use the Office Add-ins for Microsoft Dynamics AX to integrate the Microsoft Dynamics AX client with
Microsoft Excel or Microsoft Word. When you install the Office Add-ins, a new contextual tab for
Microsoft Dynamics AX is created on the ribbon in Excel and Word. Users can use the controls on this tab
to create and update data in an Excel spreadsheet or a Word document.
With the Microsoft Project client add-in, users can take advantage of features in both Microsoft Dynamics
AX and Microsoft Project to manage a project. These features include assigning workers to projects and
managing work breakdown structures.

Before you install the Office Add-ins


On the computer where you are installing this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Office Add-ins


Use this procedure to install the files for the Office Add-ins on a client computer. If you install other
Microsoft Dynamics AX components at the same time, the installation screens vary, depending on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Office Add-ins. When you select Office Add-ins, Remote
Desktop Services integration is selected automatically. Click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing the Office Add-ins on a 64-bit operating system, the Select a file location page is
displayed. Select the location where you want 32-bit versions of Microsoft Dynamics AX files to be
installed, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want the Office
Add-ins to access configuration information from the registry on the local computer or from a shared

Microsoft Dynamics AX 2012 Installation Guide

201

Microsoft Dynamics AX
configuration file. If you want to use a shared configuration file, you must enter the network location
of the file.
If you use a shared configuration file, client configuration settings are not stored locally, and the
Microsoft Dynamics AX Configuration utility is not installed on the client computer.
For more information about how to use a shared configuration file, see Configure clients to use a
shared configuration.
Click Next.
10. On the Connect to an AOS instance page, enter the name of the computer that runs the Application
Object Server (AOS) instance that you want to connect to. You can optionally specify the name of the
AOS instance, the TCP/IP port number, and the WSDL port for services.
If you do not know the name of the AOS instance or the port information, contact the Microsoft
Dynamics AX administrator.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this page is not displayed. Subsequent installations on the
same computer reuse the existing AOS connection.
Click Next.
11. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
12. On the Ready to install page, click Install.
13. After the installation is completed, click Finish to close the wizard.
14. The first time that you open Excel or Word on a computer where the Office Add-ins component was
installed, you are prompted to install the add-in. Click Install to continue with the installation.

After you install the Office Add-ins


For information about how to configure Office Add-ins in Microsoft Dynamics AX, see Set up integration
with Microsoft Office Add-ins (http://technet.microsoft.com/library/c78ade1c-a85e-4519-893ae56fab51c3b2(AX.60).aspx). For information about how to configure the Microsoft Project client add-in,
see Specify options for Microsoft Project integration (http://technet.microsoft.com/library/7bb3f5b97b6c-484c-9b1d-99626062b08f(AX.60).aspx).

See Also
Integrating Microsoft Dynamics AX with Microsoft Office (http://technet.microsoft.com/library/6f34c60c87cc-4f2a-a808-ca4e6b9b2804(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

202

Microsoft Dynamics AX

Install Remote Desktop Services integration


The Remote Desktop Services integration components for Microsoft Dynamics AX support integration
with local applications, such as Microsoft Word and Microsoft Excel, when Microsoft Dynamics AX is
hosted on a Remote Desktop server. Install the Remote Desktop Services integration components on local
client computers. The Remote Desktop Services integration components are selected automatically when
you install the Office Add-ins for Microsoft Dynamics AX.

Before you install the Remote Desktop Services integration


components
On the computer where you plan to install the components, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Remote Desktop Services integration components


Use this procedure to install the Remote Desktop Services integration components on a client computer.
If you install other Microsoft Dynamics AX components at the same time, the installation screens vary,
depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Specify a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Remote Desktop Services integration, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Ready to install page, click Install.

9.

After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

203

Microsoft Dynamics AX

Install developer tools


The topics in this section provide information about how to install the developer tools.
Use the developer tools to customize Microsoft Dynamics AX. For example, you can use the developer
tools to create customizations or extensions to Enterprise Portal for Microsoft Dynamics AX, and to create
advanced production reports by using Microsoft SQL Server Reporting Services. The developer tools
include the debugger, Microsoft Visual Studio Tools, and the Trace Parser.
The following topics are included in this section:

Install the debugger

Install Visual Studio Tools

Install the Trace Parser

Install the debugger


The debugger tool provides debugging capabilities for X++ developers. The debugger tool
communicates with the Microsoft Dynamics AX client, .NET Business Connector, or batch jobs that run on
the Microsoft Dynamics AX server.
Note:
To use the Help documentation for the debugger, the Microsoft Dynamics AX client must also be
installed.

Before you install the debugger


On the computer where you plan to install this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the debugger


Use this procedure to install the debugger. If you install other Microsoft Dynamics AX components at the
same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

204

Microsoft Dynamics AX
6.

On the Select components page, select Debugger, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where you want to install 32-bit versions of Microsoft Dynamics AX files, and then click
Next.

9.

On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.

10. On the Ready to install page, click Install.


11. After the installation is completed, click Finish to close the wizard.

After you install the debugger


To use the debugger, users must belong to the Microsoft Dynamics AX Debugging Users local group
on the computer. The person who installed the debugger is automatically added to this group.

Install Visual Studio Tools


Visual Studio Tools integrate the development of Microsoft Dynamics AX with Microsoft Visual Studio.
Developers can use these tools to create managed code that accesses X++ objects. Developers can also
use the tools to create or modify controls for Enterprise Portal for Microsoft Dynamics AX and reports for
Microsoft SQL Server Reporting Services. For more information about Visual Studio Tools, see Visual
Studio Development for Microsoft Dynamics AX (http://msdn.microsoft.com/library/3b2cfb0f-4211-42caa514-55af7ff11dcd(AX.60).aspx).
Note:
If you want to have access to all the development capabilities, we recommend that you install the
Microsoft Dynamics AX client on the same computer as Visual Studio Tools.

Before you install Visual Studio Tools


Complete the following tasks before you install Visual Studio Tools:

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

If Visual Studio is running, we recommend that you close it before you install Visual Studio Tools.

Install Visual Studio Tools


Use this procedure to install Visual Studio Tools. If you install other Microsoft Dynamics AX components
at the same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

Microsoft Dynamics AX 2012 Installation Guide

205

Microsoft Dynamics AX
3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Visual Studio Tools. When you select Visual Studio Tools,
the Management utilities component is selected automatically. Click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where you want to install 32-bit versions of Microsoft Dynamics AX files, and then click
Next.

9.

On the Specify a location for configuration settings page, specify whether you want Visual Studio
Tools to access configuration information from the registry on the local computer or from a shared
configuration file. If you want to use a shared configuration file, you must enter the network location
of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that runs the instance of
Application Object Server (AOS) that you want to connect to. You can optionally specify the name of
the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
11. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
12. On the Ready to install page, click Install.
13. After the installation is completed, click Finish to close the wizard.

See Also
Visual Studio Integration (http://msdn.microsoft.com/library/f7c6e32a-be2c-41ec-98ea4a1e7ff9b342(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

206

Microsoft Dynamics AX

Install the Trace Parser


The Trace Parser consolidates information from multiple sources, such as RPC and SQL, to provide an
integrated view of the applications performance at run time.

Before you install the Trace Parser


On the computer where you plan to install this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Trace Parser


Use this procedure to install the Trace Parser. If you install other Microsoft Dynamics AX components at
the same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Trace Parser. When you select Trace Parser, .NET Business
Connector is automatically selected. Click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where you want to install 32-bit versions of Microsoft Dynamics AX files, and then click
Next.

9.

On the Select a display language page, select the language in which you want to run Microsoft
Dynamics AX for the first time.
Note:
.NET Business Connector is a kind of Microsoft Dynamics AX client. Therefore, if .NET Business
Connector is the first client that you install on a computer, Setup requires that you set the
display language.

10. On the Specify a location for configuration settings page, specify whether you want .NET Business
Connector to access configuration information from the registry on the local computer or from a
shared configuration file. If you want to use a shared configuration file, you must enter the network
location of the file. Click Next.

Microsoft Dynamics AX 2012 Installation Guide

207

Microsoft Dynamics AX
11. On the Connect to an AOS instance page, enter the name of the computer that runs the instance of
Application Object Server (AOS) that you want to connect to. You can optionally specify the name of
the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
12. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by .NET Business Connector. Click Next.
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

208

Microsoft Dynamics AX

Install integration components


The topics in this section provide information about how to install the integration components for
Microsoft Dynamics AX.
Integration components enable Microsoft Dynamics AX to be integrated with external applications. The
integration components include web services on Internet Information Services (IIS), .NET Business
Connector, and the synchronization proxy and synchronization service for Microsoft Project Server.
The following topics are included in this section:

Install web services on IIS

Install the .NET Business Connector

Install the synchronization proxy for Microsoft Project Server

Install the synchronization service for Microsoft Project Server

Install web services on IIS


This topic describes installation of the Microsoft Dynamics AX web services on Internet Information
Services (IIS).
Note:
Web services on IIS is an optional component. The Application Object Server (AOS) is the
Windows Communication Foundation (WCF) service host for Microsoft Dynamics AX services. The
AOS-hosted services are available to users and applications across an intranet. To consume
services over the Internet, you must host services on Internet Information Services (IIS). Skip this
procedure if you do not need to expose the Microsoft Dynamics AX services over the Internet.

Before you install the Web services on IIS


Verify that the following steps are completed before you install the Microsoft Dynamics AX web services
on IIS:

On the computer where you will install the web services, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).
Caution:
Do not install web services on IIS on a server that is a network domain controller.

Create a domain account that will be used as the Business Connector proxy account. For more
information, see Create service accounts.

Make sure that you have the required permissions to install the web services. For more information,
see Verify that you have the required permissions for installation.

Microsoft Dynamics AX 2012 Installation Guide

209

Microsoft Dynamics AX

Install and configure the Web Server (IIS) Role


Use the following steps to verify that the Web Server role is configured properly:
1.

2.

When you ran the prerequisite validation utility in the preceding section, it configured the Web Server
role. However, the prerequisite validation utility does not install the ASP.NET role service. Use the
following steps to install the ASP.NET role service. For more information about role services, see
Available Role Services by Category (http://technet.microsoft.com/en-us/library/cc753473.aspx).

Start Server Manager. Expand the Server Manager (computer_name) node. Right-click Web
Server (IIS), and then click Add Role Services.

On the Select Role Services dialog, expand the Web Server (Installed) > Application
Development (Installed) node, and then select ASP.NET. Click Next and step through the
wizard pages. Restart the server.

Create a website that Setup will use to install the Microsoft Dynamics AX web services. You can create
a new website or use an existing one, such as Default Web Site on IIS. See the IIS documentation for
instructions about how to create a new website.
Tip:
For ease of administration, we recommend that you create a new website before installing
Microsoft Dynamics AX web services.

Install the web services on IIS


Use this procedure to install the Microsoft Dynamics AX web services on IIS. If you are installing other
Microsoft Dynamics AX components at the same time, the installation pages vary based on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the initial wizard pages.

3.

If the setup support files have not yet been installed, the Select a file location page is displayed. The
setup support files are required for installation. Provide a file location or accept the default location
and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Web services on IIS, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where 32-bit versions of Microsoft Dynamics AX files should be installed and then click
Next.

Microsoft Dynamics AX 2012 Installation Guide

210

Microsoft Dynamics AX
9.

On the Connect to an AOS instance page, enter the name of the computer that is running the AOS
instance that you want to connect to. You can optionally specify the name of the AOS instance, the
TCP/IP port number, and the Web Services Description Language (WSDL) port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this page is not displayed. Subsequent installations on this
computer reuse the existing AOS connection.

10. On the Specify Business Connector proxy account information page, enter the password for the
proxy account used by the .NET Business Connector. Click Next.
11. On the Configure IIS for Web services page, accept default values or provide information for the
website, application pool, and virtual directory. Setup will create a virtual directory and an application
pool for the Microsoft Dynamics AX web services under the selected website. The application pool will
run as the .NET Business Connector proxy user that you entered in the previous step.
Important:
You must restart IIS after Setup installs the web services. Select Restart IIS after installation
is complete to automatically restart IIS.
Click Next to continue.
12. On the Specify an AOS account page, provide the service accounts for the AOS instances that you
will use with web services on IIS. For more information about AOS accounts, see, Create service
accounts.
Click Next to continue.
13. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
14. On the Ready to install page, click Install.
15. After the installation is complete, click Finish to close the wizard.

After you install the Web services on IIS


This section provides instructions for how to configure and test web services on IIS.

Configure IIS
For IIS 7.0, use the following steps to configure the application pool that is associated with Microsoft
Dynamics AX web services. This step is required to set the correct version of the .NET Framework.
1.

In Server Manager, Expand the Server Manager > Roles > Web Server (IIS) node and then click
Internet Information Services (IIS) Manager.

2.

In the Connections pane, expand the node for your server name and then click Application Pools.

3.

In the Application Pools pane, right-click the application pool that is associated with the Microsoft
Dynamics AX web services and click Basic Settings.

4.

In the Edit Application Pool dialog box, select .NET Framework 4.0 or a later version, such as
V4.0.30319. Select Integrated from the Managed pipeline mode list. Notice that the Start
application pool immediately option is selected. Click OK to return to Server Manager.

5.

Restart the server.

Microsoft Dynamics AX 2012 Installation Guide

211

Microsoft Dynamics AX

Verify the website registration in Microsoft Dynamics AX


Use the following steps to register the website in Microsoft Dynamics AX.
1.

Click System administration > Setup > Services and Application Integration Framework > Web
sites.

2.

On the Web sites form, verify that the website was created and has appropriate values for the Name,
Virtual directory share path, Description, and URL fields. The default name is computernameDefault Web Site-MicrosoftDynamicsAXAif60. The default URL is
http://computername:8101/MicrosoftDynamicsAXAif60. The default share path for the virtual directory
is \\computername\MicrosoftDynamicsAXAif60.

3.

Click Validate. Verify that the Infolog dialog confirms:

The website is configured properly.

You can access the computer and the website.

For information about how to add or configure websites, see Add or configure websites
(http://technet.microsoft.com/library/5b1f0280-ee34-45b7-a688-298f00163715(AX.60).aspx).
Note:
When you install web services on IIS, a record for the new website is added to AifWebsites table.
If you uninstall web services on IIS, this record is not deleted from the table. This record may
cause a warning to be displayed if you reinstall web services on IIS. You can manually delete the
record from the AifWebsites table or simply ignore the warning.

Create an enhanced integration port


For information about managing integration ports, see Services and AIF operations
(http://technet.microsoft.com/library/72e9566c-ce49-4321-a80f-5a9455ad9108(AX.60).aspx).

See Also
Walkthrough: Exchanging documents by using the HTTP adapter

Microsoft Dynamics AX 2012 Installation Guide

212

Microsoft Dynamics AX

Install the .NET Business Connector


The .NET Business Connector for Microsoft Dynamics AX enables applications to interact with instances of
Application Object Server (AOS). .NET Business Connector provides a set of managed classes that make it
easier for applications to access X++ functionality.
The .NET Business Connector is installed automatically for Microsoft Dynamics AX components that
require it. The .NET Business Connector can also be installed as a stand-alone component and used to
develop third-party applications that can be integrated with Microsoft Dynamics AX. You must install .NET
Business Connector on each computer where the integrated application is installed. The application then
communicates with AOS through the instance of .NET Business Connector on the local computer.
Some components require that .NET Business Connector be configured to connect to Microsoft Dynamics
AX by using a proxy account. When a proxy account is used, .NET Business Connector can connect to an
AOS instance on behalf of Microsoft Dynamics AX users. For more information, see Specify the .NET
Business Connector proxy account (http://technet.microsoft.com/library/3e46dc0a-2ff4-4a06-ae61041e52dcc774(AX.60).aspx).
When you install .NET Business Connector, the Microsoft Dynamics AX Configuration utility is also
installed.
Note:
Windows Communication Foundation (WCF) services are the preferred method for integration
with Microsoft Dynamics AX. The .NET Business Connector installation is provided for backward
compatibility.

Before you install .NET Business Connector


Complete the following tasks before you install .NET Business Connector.

On the computer where you plan to install .NET Business Connector, run the prerequisite validation
utility to verify that system requirements have been met. For information about how to run the
prerequisite validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Microsoft Dynamics AX databases and AOS in the environment. Alternatively, you can
install these components when you install .NET Business Connector.

Install .NET Business Connector


Use this procedure to install .NET Business Connector. If you install other Microsoft Dynamics AX
components at the same time, the installation pages vary, depending on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

Microsoft Dynamics AX 2012 Installation Guide

213

Microsoft Dynamics AX
3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select .NET Business Connector, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where you want to install 32-bit versions of Microsoft Dynamics AX files, and then click
Next.

9.

On the Select a display language page, select the language in which you want to run Microsoft
Dynamics AX for the first time.
Note:
.NET Business Connector is a kind of Microsoft Dynamics AX client. Therefore, if .NET Business
Connector is the first client that you install on a computer, Setup requires that you set the
display language.

10. On the Specify a location for configuration settings page, specify whether you want .NET Business
Connector to access configuration information from the registry on the local computer or from a
shared configuration file. If you want to use a shared configuration file, you must enter the network
location of the file. Click Next.
11. On the Connect to an AOS instance page, enter the name of the computer that runs the instance of
Application Object Server (AOS) that you want to connect to. You can optionally specify the name of
the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
12. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
13. On the Ready to install page, click Install.
14. After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

214

Microsoft Dynamics AX

Install the synchronization proxy for Microsoft Project


Server
The synchronization proxy for Microsoft Project helps support the synchronization of project data in
Microsoft Dynamics AX with data in Microsoft Project Server.
To use this functionality, you must install both the synchronization proxy and the synchronization service.
You can install the synchronization service and the synchronization proxy at the same time. This topic
explains only how to install the synchronization proxy.
The synchronization proxy uses Message Queuing to connect to Project Server and Microsoft Dynamics
AX. You must install the synchronization proxy on the same computer as Project Server.

Before you install the synchronization proxy


Complete the following tasks before you install the synchronization proxy:

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Verify that you have the permissions that are required to install the synchronization proxy. For more
information, see Verify that you have the required permissions for installation.

Install the synchronization proxy


Use this procedure to install the synchronization proxy. If you install other Microsoft Dynamics AX
components at the same time, the installation pages vary, depending on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Synchronization proxy for Microsoft Project Server, and
then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where you want to install 32-bit versions of Microsoft Dynamics AX files, and then click
Next.

Microsoft Dynamics AX 2012 Installation Guide

215

Microsoft Dynamics AX
9.

On the Specify a location for configuration settings page, specify whether you want the
synchronization proxy to access configuration information from the registry on the local computer or
from a shared configuration file. If you want to use a shared configuration file, you must enter the
network location of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that runs the instance of
Application Object Server (AOS) that you want to connect to. You can optionally specify the name of
the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by .NET Business Connector. Click Next.
12. On the Synchronization proxy/Message Queuing: Enter the service account information page,
enter the domain user account for the synchronization service, and then click Next.
13. On the Connect to Microsoft Project Server page, enter the name of the Project Server and the
name of the database that is used for Project Server reporting. In the Project web access URL box,
enter the URL of the website that is used to access Project Server.
Note:
If the synchronization proxy must connect to multiple URLs for Project Server, use the first
URL when you install the synchronization proxy. However, you must then uninstall and
reinstall the synchronization proxy. When you reinstall the synchronization proxy, use a
different URL. Uninstalling the proxy does not affect the proxys ability to synchronize with
URLs that were specified during previous installations.
Click Next.
14. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
15. On the Ready to install page, click Install.
16. After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

216

Microsoft Dynamics AX

Install the synchronization service for Microsoft


Project Server
The Microsoft Project synchronization service synchronizes project data in Microsoft Dynamics AX with
data in Microsoft Project Server.
To use this functionality, you must install both the synchronization proxy and the synchronization service.
You can install the synchronization service and the synchronization proxy at the same time. This topic
explains only how to install the synchronization service.
If Project Server uses a Microsoft Database Engine (MSDE) database or a Microsoft SQL Server Express
Edition database, install the synchronization service on the computer that runs Project Server.
When you install the synchronization service, Setup configures a message queue for the service. Setup
also installs and starts the synchronization service.

Before you install the synchronization service


Complete the following tasks before you install the synchronization service:

On the computer where you are installing this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Microsoft Dynamics AX databases and Application Object Server (AOS) in the environment.

Configure a domain account that the synchronization service can run as. For more information, see
Create service accounts.

Install the synchronization service


Use the following procedure to install the synchronization service. If you install other Microsoft Dynamics
AX components at the same time, the installation screens vary, depending on the components that you
are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Synchronization service for Microsoft Project Server, and
then click Next.

Microsoft Dynamics AX 2012 Installation Guide

217

Microsoft Dynamics AX
7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing the synchronization service on a 64-bit operating system, the Select a file
location page is displayed. Select the location where you want 32-bit versions of Microsoft Dynamics
AX files to be installed, and then click Next.

9.

On the Specify a location for configuration settings page, specify whether you want the
synchronization service to access configuration information from the registry on the local computer or
from a shared configuration file. If you want to use a shared configuration file, you must enter the
network location of the file. Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that runs the AOS
instance that you want to connect to. You can optionally specify the name of the AOS instance, the
TCP/IP port number, and the WSDL port for services. Click Next.
Note:
If you entered AOS connection information for other Microsoft Dynamics AX components
that are installed on this computer, this page is not displayed. Subsequent installations on the
same computer reuse the existing AOS connection.
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by .NET Business Connector. Click Next.
12. On the Enter the password for the service account page, enter the account information for the
synchronization service. Click Next.
13. On the Connect to a message queue page, specify whether you want to create a new message
queue or connect to an existing message queue.

If you want to create a new queue, Setup creates a private queue by default. Private queues can
be accessed only from the local computer. Select Make this a public queue to allow other
computers to access the queue.

If you want to connect to an existing queue, enter the queue address.

Click Next.
14. On the Specify service accounts for synchronization message queues page, enter the service
accounts that communicate through message queues. You must provide a domain account that is
used by the Project Server eventing service, and the service account of at least one AOS instance.
Otherwise, Setup cannot configure the correct permissions. Click Next.
15. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
16. On the Ready to install page, click Install.
17. After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

218

Microsoft Dynamics AX

Install management utilities


Management utilities let you configure and manage Microsoft Dynamics AX components and artifacts.
Use these utilities to deploy artifacts, such as reports and Web controls, from the metadata store.

Before you install management utilities

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Make sure that the Windows Update service is running on the computer where you will install this
component.

Install management utilities


Use this procedure to install the Microsoft Dynamics AX management utilities. If you install other
Microsoft Dynamics AX components at the same time, the installation pages vary, depending on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Management utilities, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location where you want to install 32-bit versions of Microsoft Dynamics AX files, and then click
Next.

9.

On the Specify client configuration options page, specify whether you want management utilities
to access configuration information from the registry on the local computer or from a shared
configuration file. If you want to use a shared configuration file, enter the network location of the file.
Click Next.

10. On the Connect to an AOS instance page, enter the name of the computer that runs the instance of
Application Object Server (AOS) that you want to connect to. You can optionally specify the name of
the AOS instance, the TCP/IP port number, and the WSDL port for services. Click Next.
Microsoft Dynamics AX 2012 Installation Guide

219

Microsoft Dynamics AX

Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
11. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
12. On the Ready to install page, click Install.
13. After the installation is complete, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

220

Microsoft Dynamics AX

Install retail components


The topics in this section provide information about how to install the retail components for Microsoft
Dynamics AX.
Note:
Retail components are available with Microsoft Dynamics AX 2012 R3, AX 2012 R2, and AX 2012
Feature Pack.
Retail provides mid-market and large retailers a complete solution for the head office and point of sale
(POS). Retail can help retailers increase financial returns, improve service, manage growth, and streamline
efficiencies. Retail consists of several components that are typically distributed across multiple computers
and locations.
Important:
To use the retail components in Microsoft Dynamics AX 2012 Feature Pack, you must select the
Extensions model file when you install the Microsoft Dynamics AX database. For more
information about how to install model files, see Install the Microsoft Dynamics AX databases.
In AX 2012 R3, we recommend that you install Retail components in the following order:
1.

Install Retail headquarters

2.

Install Commerce Data Exchange: Real-time Service (Retail Transaction Service)

3.

Install Commerce Data Exchange: Async Server

4.

Install a retail channel database

5.

Install Commerce Data Exchange: Async Client

6.

Install the point of sale components that you require:

7.

Install Retail POS (point of sale)

Install Retail Server

Install Retail Hardware Station

Install a Microsoft Dynamics AX Retail online store (e-commerce)

Install Modern POS

Install optional components:

Install Commerce Data Exchange: Synch Service (Retail Store Connect)

Install retail mass deployment toolkit

Install Retail SDK (Retail POS Plug-ins)

Install the Retail Channel Configuration Utility (Retail Store Database Utility)

Note:
In AX 2012 R2 and AX 2012 Feature Pack, the available components differ from AX 2012 R3. Most
importantly, you must install Synch Service instead of installing Async Client and Async Server.

Microsoft Dynamics AX 2012 Installation Guide

221

Microsoft Dynamics AX

Deployment topologies for Retail


The following table lists the types of computers that are used in a typical Retail deployment.
Deployment location

Types of computers

Head office

AOS computer

Database server
You must modify the Microsoft Dynamics AX database server only if the
settings for Microsoft SQL Server do not comply with the Payment Card
Industry (PCI) Data Security Standard. For more information about PCIcompliant settings, see the Implementation Guide for PCI Compliance
(http://go.microsoft.com/fwlink/?LinkId=237283).

Communications server that hosts Commerce Data Exchange: Real-time


Service and Commerce Data Exchange: Synch Service.
If you prefer, you can have two communications servers, one for each of
these applications.

Brick-and-mortar stores

Microsoft Dynamics AX client computers

Web servers that host the online store

Database server

Communications server that hosts Synch Service

Point of sale (POS) registers

With the exception of the communications server, the computers at the head office are all standard in a
Microsoft Dynamics AX deployment. Depending on the requirements of your organization, a particular
computer can be used for more than one of the purposes in the previous table. We recommend that you
load balance across multiple computers whenever load balancing is possible.
Typically, head office and store computers on which Synch Service is installed also have SQL Server
Express Edition installed. However, this instance of SQL Server is used only for the Synch Service message
database.
Note:
For development and testing, you can install the complete Retail system on a single computer.
However, a deployment of this kind is not a supported production scenario.

Microsoft Dynamics AX 2012 Installation Guide

222

Microsoft Dynamics AX

Topology diagrams for POS


The following figures illustrate typical deployment topologies for a POS system.

Each component of a POS system is hosted on a dedicated computer


In Figure 1, each component is hosted on a dedicated physical computer or virtual machine. Components
that support multiple instances, such as AOS and Synch Service, could be installed on additional
computers for load balancing. This deployment topology is appropriate for a large retailer.

Figure 1 Hosting of Retail POS components on dedicated computers

Microsoft Dynamics AX 2012 Installation Guide

223

Microsoft Dynamics AX

POS components are hosted on shared servers


In Figure 2, on the head office side, the Synch Service instance, Real-time Service, and Enterprise Portal for
Microsoft Dynamics AX have been combined on a single computer. A midsize retailer might want to
consolidate these services on one computer or run them on virtual machines on a single physical server.
On the store side, Synch Service is installed on the same computer as the store database server.

Figure 2 Shared hosting of Retail POS components

Store-side database topologies


Retail supports the following store-side database topologies:

POS registers have offline databases that are synchronized with the store database when the POS
registers are connected.

POS registers do not have databases and must always be connected to the store database.

Figure 3 illustrates the two supported topologies. In the POS portable topology, the POS register uses
the store database by default, and synchronizes its local database and the store database. If the store
database becomes inaccessible, the POS register uses its offline database until the connection to the store
database is re-established. In the POS always online topology, the POS register must always be online to
connect with the store database.

Microsoft Dynamics AX 2012 Installation Guide

224

Microsoft Dynamics AX

Figure 3 Supported database topologies for Retail POS registers


Note:
Synch Service and Real-time Service have been omitted from Figure 3, because they are not
affected.

Microsoft Dynamics AX 2012 Installation Guide

225

Microsoft Dynamics AX

Topology diagrams for online stores


The following figures illustrate typical deployment topologies for an online store system.

Each component of an online store is hosted on a dedicated computer


In Figure 4, each component is hosted on a dedicated physical computer or virtual machine. Components
that support multiple instances, such as AOS, Synch Service, and online store sites, could be installed on
additional computers for load balancing.

Figure 4 Hosting of Retail online store components on dedicated computers

Microsoft Dynamics AX 2012 Installation Guide

226

Microsoft Dynamics AX

Online store components are hosted on shared servers


In Figure 5, Synch Service, Real-time Service, and Enterprise Portal have been combined on a single
computer. A midsize retailer might want to consolidate these services on one computer or run them on
virtual machines on a single physical server.

Figure 5 Shared hosting of online store components

Install Retail headquarters


The Retail headquarters component installs runtime components that are required to enable key aspects
of Retail functionality, such as the screen layout designer. This component must be installed on the
Application Object Server (AOS) computer and on Microsoft Dynamics AX client computers.
Note:
Retail components are available with Microsoft Dynamics AX 2012 R3, AX 2012 R2, and AX 2012
Feature Pack.

Before you install Retail headquarters

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Microsoft Dynamics AX 2012 Installation Guide

227

Microsoft Dynamics AX

Before you install Retail headquarters, we recommend that you install the AOS, Microsoft Dynamics
AX clients, and the Microsoft Dynamics AX databases with all required models.

Install Retail headquarters


Use this procedure to install Retail headquarters. If you install other Microsoft Dynamics AX components
at the same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

On the Modify Microsoft Dynamics AX installation page, click Add or modify components, and
then click Next.

4.

On the Add or modify components page, select Retail headquarters, and then click Next.

5.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

6.

On the Ready to install page, click Install.

7.

After the installation is completed, click Finish to close the wizard.

After you install Retail headquarters


After you install the Retail headquarters component on AOS computers and Microsoft Dynamics AX
client computers, you must initialize the retail configuration.
1.

Open the Microsoft Dynamics AX client.

2.

Click Retail > Setup > Parameters > Retail parameters.

3.

Click Initialize.

4.

Close the Microsoft Dynamics AX client.

5.

In Windows, open the Services control panel.

6.

Restart the Microsoft Dynamics AX Object Server service.

Install Commerce Data Exchange: Real-time Service


(Retail Transaction Service)
This topic explains how to install Commerce Data Exchange: Real-time Service. Real-time Service is an
integrated service that provides real-time communication between Microsoft Dynamics AX and retail
channels. Real-time Service enables individual point of sale (POS) computers and online stores to retrieve
specific data from Microsoft Dynamics AX in real time.
Note:
Components of Microsoft Dynamics AX 2012 for Retail are available with Microsoft Dynamics AX
2012 R3, Microsoft Dynamics AX 2012 R2, and Microsoft Dynamics AX 2012 Feature Pack.
At the head office, install Real-time Service on the communications server. Deployment steps vary
depending on the version that you are installing:

Microsoft Dynamics AX 2012 Installation Guide

228

Microsoft Dynamics AX

In AX 2012 R3 and AX 2012 R2, Real-time Service is a Windows Communication Foundation (WCF)
service that must be installed on a website in Internet Information Services (IIS).

In AX 2012 Feature Pack, Real-time Service is a Windows service that is called Retail Transaction
Service.

When you install this component, the Retail Salt Utility is also installed. The Retail Salt Utility provides
extra encryption for the passwords and credentials that are associated with the Retail system.
The following sections are included in this topic:

Before you install Real-time Service

Install Real-time Service by using Setup (AX 2012 R3)

Install Real-time Service by using Windows PowerShell (AX 2012 R3)

Install Real-time Service (AX 2012 Feature Pack or AX 2012 R2)

Deploy Real-time Service (required for AX 2012 R2 only)

After you install and deploy Real-time Service

Before you install Real-time Service

Create the service account that will be used as the application pool identity for the Real-time Service
website. In AX 2012 Feature Pack, this account is used as the identity for the Windows service. For
more information about the requirements for this account, see Create service accounts.

Because this component uses Secure Sockets Layer (SSL) encryption, you must install a server
certificate that was issued by a trusted certification authority. (For test environments, you can create a
self-signed certificate in IIS.) When you run Setup, you will need to enter the thumbprint for the
certificate. To view the thumbprint in IIS Manager, double-click the certificate and click the Details
tab.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Real-time Service requires .NET Business Connector. .NET Business Connector enables Real-time
Service to interact with instances of Application Object Server (AOS). If .NET Business Connector is not
already installed, it is selected automatically when you select to install Real-time Service.

Install Real-time Service by using Setup (AX 2012 R3)


Use this procedure to install Real-time Service for AX 2012 R3. If you install other Microsoft Dynamics AX
components at the same time, the installation pages vary, depending on the components that you are
installing.
To deploy Real-time Service on multiple computers in a cluster, you can run Setup on each computer.
Alternatively, you can use the Retail mass deployment toolkit to deploy Real-time Service from a central
location. For information about how to set up an IIS cluster, see the Network Load Balancing Deployment
Guide (http://technet.microsoft.com/en-us/library/cc754833(v=WS.10).aspx). For more information about

Microsoft Dynamics AX 2012 Installation Guide

229

Microsoft Dynamics AX
mass deployment, see Mass deploy Retail components (http://technet.microsoft.com/library/15ded62af6d3-44a4-8fe6-93e7f19ea558(AX.60).aspx).
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics AX, and then click Next.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Real-time Service, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location in which to install 32-bit versions of Microsoft Dynamics AX files, and then click Next.

9.

On the Select a display language page, select the language in which to run Microsoft Dynamics AX
for the first time.
Note:
.NET Business Connector is a kind of Microsoft Dynamics AX client. Therefore, if .NET Business
Connector is the first client that you install on a computer, Setup requires that you set the
display language.

10. On the Specify a location for configuration settings page, specify whether you want .NET Business
Connector to access configuration information from the registry on the local computer or from a
shared configuration file. If you want to use a shared configuration file, you must enter the network
location of the file. Click Next.
11. On the Connect to AOS instance page, enter the name of the computer that runs the instance of
AOS to connect to. You can optionally specify the name of the AOS instance and the TCP/IP port
number. Click Next.
Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
12. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by .NET Business Connector. Click Next.
13. On the Configure Real-time Service page, select the check box to configure Real-time Service by
using Setup. If you clear this check box, the application files are installed, but Real-time Service is not
configured.
If youre configuring Real-time Service, enter the following information:

Application name The name of the web application that hosts Real-time Service.

Website name The name of the website that hosts Real-time Service.

App pool name The name of the application pool that Real-time Service runs in.

Microsoft Dynamics AX 2012 Installation Guide

230

Microsoft Dynamics AX
We recommend that you specify separate application pools if multiple Retail components are
installed on the same computer. Multiple web applications can share an application pool if
resources on the computer are limited. However, if the shared application pool fails, all of the
applications that use it will stop responding. In addition, if one application is heavily used, it can
negatively affect the performance of the other applications in the pool.

User name and Password The credentials for the application pool identity.

HTTPS port The port on which Real-time Service receives secure HTTP requests. You can specify
any available port. Verify that the port is open in Windows Firewall.
Warning:
To avoid conflicts with the Default Web Site on the computer, we recommend that you
do not use the default HTTPS port (443). A nonstandard port number also helps make the
website more secure.

TCP port The port on which Real-time Service receives TCP requests. You can specify any
available port. Verify that the port is open in Windows Firewall.

SSL certificate thumbprint The thumbprint for your Secure Sockets Layer (SSL) encryption
certificate. You must obtain a valid, registered certificate from a provider.

14. On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.
15. On the Ready to install page, click Install.
16. After the installation is completed, click Finish to close the wizard.

Install Real-time Service by using Windows PowerShell (AX 2012 R3)


Use this procedure to manually install Real-time Service for AX 2012 R3 by using Windows PowerShell. To
install multiple instances of Real-time Service on the same computer, you must use a manual installation.
Manual installations are often performed by businesses and organizations that automate deployments by
using scripts.

Extract installation files


Use Microsoft Dynamics AX Setup to extract the files that are required for manual installation.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

On the Modify Microsoft Dynamics AX installation page, click Add or modify components, and
then click Next.

3.

On the Add or modify components page, select Real-time Service, and then click Next.

4.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

5.

On the Configure Real-time Service page, clear the Configure Real-time Service option.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Ready to install page, click Install.

8.

After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

231

Microsoft Dynamics AX

Configure settings in the rts-settings.xml file


After you extract the installation files by using Setup, you must configure settings in the rts-settings.xml
file.
1.

Open the folder where the Windows PowerShell scripts are installed. By default, the files are located at
C:\Program Files (x86)\Microsoft Dynamics AX\60\CDX\Real-time Services\Tools.

2.

Create a copy of the rts-settings.xml file for each instance of Real-time Service that you plan to
deploy. We recommend that you not change the original file.

3.

Open your copy of the rts-settings.xml file in Microsoft Visual Studio or a text editor, such as
Notepad.

4.

Enter a value for the following parameters.


Parameter

Enter this value

Default value

WebAppPoolName

The name of the application pool that hosts the

CDXRealtimeServiceAppPool

Real-time Service web application.


WebSiteName

The name of the website that hosts Real-time

CDXRealtimeServiceWebsite

Service.
WebSiteHttpsPort

The port on which Real-time Service receives

None

secure HTTP requests. You can specify any


available port. Verify that the port is open in
Windows Firewall.
Warning:
To avoid conflicts with the Default Web
Site on the computer, we recommend
that you do not use the default HTTPS
port (443). A nonstandard port number
also helps make the website more secure.
WebSiteTcpPort

The port on which Real-time Service receives TCP

None

requests. You can specify any available port. Verify


that the port is open in Windows Firewall.
WebApplicationName

The name of the web application that hosts Real-

None

time Service.
WebAppPoolUser

The user name for the account that is used as the

None

application pool identity.


WebSiteSSLCertificateT The thumbprint for your SSL encryption certificate.
humbprint

None

You must obtain a valid, registered certificate from


a provider.

Microsoft Dynamics AX 2012 Installation Guide

232

Microsoft Dynamics AX

Parameter

Enter this value

Default value

WebSiteSSLCertificate

The name of the root store where the SSL

LocalMachine

RootStore

certificate that is used to help secure the website is


installed.

WebSiteSSLCertificateS

The name of the certificate store where the SSL

tore

certificate that is used to help secure the website is

My

installed.
WebApplicationService

The location where the installer copied binary

BinarySourceFolder

components. By default, the files are located at

None

C:\Program Files (x86)\Microsoft Dynamics


AX\60\CDX\Real-time Services\6.3.
WebApplicationAOSSe

Not applicable

None

The path of the physical folder where website files

None

rver
WebSiteWorkingFolder

are stored.
EnableMetadataExchan

A value that indicates whether the WCF service

ge

returns debugging information. In a production

false

environment, this option should be set to false.

5.

WebApplicationWorki

The path of the physical folder where web

[WebSiteWorkingFolder]\[Web

ngFolder

application files are stored.

ApplicationName]

Save your changes.

Run Windows PowerShell scripts to configure Real-time Service


After you configure the parameters in the rts-settings.xml file, you can run the Windows PowerShell
scripts that configure Real-time Service.
Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.
1.

On the server where you want to run the script, open Windows PowerShell to the folder where the
scripts are installed. By default, the files are located at C:\Program Files (x86)\Microsoft Dynamics
AX\60\Real-time Services\Tools.

If youre using Windows Server 2012 or a later operating system, use Windows Explorer to open
the folder where the scripts are installed. Then click File > Open Windows PowerShell > Open
Windows PowerShell as administrator.

Microsoft Dynamics AX 2012 Installation Guide

233

Microsoft Dynamics AX

2.

If youre using Windows Server 2008 R2 or an earlier operating system, start Windows PowerShell
as the administrator. Then, change the directory by using the following command: CD <Path to
directory>.

In the Windows PowerShell console, run the following command to create a credential object for the
application pool identity.
$Cred = @((New-Object System.Management.Automation.PSCredential('domain\user',(ConvertToSecureString 'password' -AsPlainText -Force))))

3.

Run the following command to configure Real-time Service.


\DeployRealtimeService.ps1 -SettingsXmlFilePath .\rts-settings.xml -TopologyXmlFilePath
.\rts-topology.xml -Credentials $Cred Verbose $true

Example:
.\DeployRealtimeService.ps1 -SettingsXmlFilePath "C:\Program Files (x86)\Microsoft Dynamics
AX\60\CDX\Real-time Services\Tools\rts-settings.xml" -TopologyXmlFilePath "C:\Program Files
(x86)\Microsoft Dynamics AX\60\CDX\Real-time Services\Tools\rts-topology.xml" -Credentials $Cred Verbose $true

Install Real-time Service (AX 2012 Feature Pack or AX 2012 R2)


Use this procedure to install Real-time Service for AX 2012 Feature Pack or AX 2012 R2. If you install other
Microsoft Dynamics AX components at the same time, the installation pages vary, depending on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select installation type page, click Custom installation, and then click Next.

5.

On the Select components page, select Real-time Service, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

If you are installing on a 64-bit operating system, the Select a file location page is displayed. Select
the location in which to install 32-bit versions of Microsoft Dynamics AX files, and then click Next.

8.

On the Select a display language page, select the language in which to run Microsoft Dynamics AX
for the first time.
Note:
.NET Business Connector is a kind of Microsoft Dynamics AX client. Therefore, if .NET Business
Connector is the first client that you install on a computer, Setup requires that you set the
display language.

9.

On the Specify a location for configuration settings page, specify whether you want .NET Business
Connector to access configuration information from the registry on the local computer or from a
shared configuration file. If you want to use a shared configuration file, you must enter the network
location of the file. Click Next.

Microsoft Dynamics AX 2012 Installation Guide

234

Microsoft Dynamics AX
10. On the Connect to an AOS instance page, enter the name of the computer that runs the instance of
AOS to connect to. You can optionally specify the name of the AOS instance, the TCP/IP port number,
and the WSDL port for services. Click Next.
Note:
If you entered information about the AOS connection for other Microsoft Dynamics AX
components that are installed on this computer, this page is not displayed. Subsequent
installations on the same computer reuse the existing AOS connection.
11. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by .NET Business Connector. Click Next.
12. On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.
13. On the Ready to install page, click Install.
14. After the installation is completed, click Finish to close the wizard.

Deploy Real-time Service (required for AX 2012 R2 only)


After you install Real-time Service for Microsoft Dynamics AX 2012 R2, you must deploy and configure the
web service.
Note:
If you are not using AX 2012 R2, you can skip this procedure. In AX 2012 Feature Pack, Real-time
Service is not a web service. In AX 2012 R3, Setup performs these steps for you.
When you install Real-time Service for AX 2012 R2 by using the Setup wizard, the following resources are
installed:

A folder that contains the binaries and configuration files for the WCF service

A folder that contains sample Windows PowerShell scripts

Use these resources to manually deploy and configure the WCF service that is used by Real-time Service.

Request and install a server certificate for the website


Because this component uses SSL encryption, you must install a server certificate that was issued by a
trusted certification authority. (For test environments, you can create a self-signed certificate in IIS.) When
you run the script to install Real-time Service, you have to enter the thumbprint for the certificate. To view
the thumbprint in IIS Manager, double-click the certificate and then click the Details tab. We recommend
that you first copy the thumbprint, paste it into a text file, and remove all spaces. Then copy the
reformatted thumbprint, and paste it into Windows PowerShell.
Caution:
The beginning of the thumbprint value can contain hidden characters. You must delete these
extra characters before you paste the thumbprint.

Microsoft Dynamics AX 2012 Installation Guide

235

Microsoft Dynamics AX
Install a certificate by using Windows PowerShell
If you have already received a certificate from your provider, or if you are migrating a certificate from a
different server, the file might be in .pfx format. In this case, you can use a sample Windows PowerShell
script to install the certificate.
1.

Open a Windows PowerShell session that has Administrator permissions.

2.

At the Windows PowerShell command prompt, run the InstallServerCertificate.ps1 script. For example,
enter the following command:
& "C:\Program Files (x86)\Microsoft Dynamics AX\60\Commerce Data Exchange\Real-time
Services\6.2\Sample Deployment Scripts\InstallServerCertificate.ps1"

3.

When you are prompted, enter the path of the .pfx file and the private key password.

Deploy the web service by using Windows PowerShell


A sample Windows PowerShell script is provided to help you deploy the WCF service for Real-time
Service.
1.

Open a Windows PowerShell session that has Administrator permissions.

2.

At the Windows PowerShell command prompt, run the


InstallCommerceDataExchangeRealtimeService.ps1 script. For example, enter the following command:
& "C:\Program Files (x86)\Microsoft Dynamics AX\60\Commerce Data Exchange\Real-time
Services\6.2\Sample Deployment Scripts\ InstallCommerceDataExchangeRealtimeService.ps1"

3.

When you are prompted, enter the following information:

User account The user account to run the service as. Enter the user account in the following
format: domain\user. This user account must be a Microsoft Dynamics AX user who has the
appropriate permissions.

Password The password for the user account.

Service binary source folder path The location of the .dll files for Real-time Service. By default,
the path is C:\Program Files (x86)\Microsoft Dynamics AX\60\Commerce Data Exchange\Realtime Services\6.2\.. The .dll files are copied to the website that is created.
Tip:
Do not include the bin subfolder in the path.

Server certificate thumbprint The thumbprint of the certificate that is installed on the IIS
server. Enter only the characters that are included in the thumbprint value. Omit all spaces.
To obtain the thumbprint, in IIS Manager, double-click IIS, and then click > Server Certificates.
Double-click the certificate, and then select Details.

Test and troubleshoot Real-time Service


For more information about how to configure, test, and troubleshoot the installation of Real-time Service,
see the following posts on the AX Support Blog:

AX for Retail 2012 R2: Installing the Real-time Service


(http://blogs.msdn.com/b/axsupport/archive/2012/12/18/ax-for-retail-2012-r2-installing-the-realtime-service.aspx)

Microsoft Dynamics AX 2012 Installation Guide

236

Microsoft Dynamics AX

AX for Retail 2012 R2: Troubleshooting the Real-time Service


(http://blogs.msdn.com/b/axsupport/archive/2012/12/31/ax-for-retail-2012-r2-troubleshooting-thereal-time-service.aspx)

After you install and deploy Real-time Service


Next, set up profiles for Real-time Service, and assign the profiles to channels. For more information, see
Set up a Real-time Service profile (http://technet.microsoft.com/library/4abdd0b8-813d-4216-8bae0b66de66e5d3(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

237

Microsoft Dynamics AX

Install Retail POS (point of sale)


Retail POS is a component that is required for the day-to-day operation of Retail at a store. When you
install the Retail POS component, the Retail Salt Utility is also installed. The Retail Salt Utility provides
extra encryption for the passwords and credentials that are associated with the Retail system.
Note:
Retail components are available with Microsoft Dynamics AX 2012 R3, AX 2012 R2, and AX 2012
Feature Pack.
At the store, install this component on each register computer. If you plan to use a stand-alone database
server at the store, you must also install Retail POS on the database server, even if Retail POS will not be
used on that computer. This step is required to set up the database. Additionally, install Retail POS on a
communications server if that computer will also be used to process transactions.
In AX 2012 R3, you can use the Retail mass deployment toolkit to deploy Retail POS to a large number of
client computers. For more information, see Mass deploy Retail components
(http://technet.microsoft.com/library/15ded62a-f6d3-44a4-8fe6-93e7f19ea558(AX.60).aspx).
Note:
If you are upgrading Retail POS, you should review Scenario: Upgrade a Retail system
(http://technet.microsoft.com/library/82b5489f-750d-4bde-a5c7-ab1cc8798c57(AX.60).aspx).

Before you install Retail POS


On the computer where you plan to install this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Retail POS


Use this procedure to install Retail POS. If you install other Microsoft Dynamics AX components at the
same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Retail POS, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

Microsoft Dynamics AX 2012 Installation Guide

238

Microsoft Dynamics AX
8.

On the Ready to install page, click Install.

9.

After the installation is completed, click Finish to close the wizard.

After you install Retail POS


1.

If an offline database is required, create and configure the offline database for each POS register by
using the Retail Channel Configuration Utility. For more information, see Create a channel database or
an offline database (AX 2012 R3) (http://technet.microsoft.com/library/e12bd6ab-e41f-494e-8b3498abcee0217a(AX.60).aspx) or Create a store database or an offline database (AX 2012 R2 and AX
2012 Feature Pack) (http://technet.microsoft.com/library/99ba8d75-d3ef-457d-a71495dd894fccc5(AX.60).aspx).

2.

Configure Retail POS database connections by using the Retail Channel Configuration Utility. For
more information, see Configure database connections for a POS register
(http://technet.microsoft.com/library/ab65600e-155a-4d63-971f-84e71d1aea79(AX.60).aspx).

3.

Configure Retail POS for your business. For more information, see Point of Sale
(http://technet.microsoft.com/library/2051b6fa-b8a1-4254-a115-a3480ad31143(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

239

Microsoft Dynamics AX

Install Modern POS


Modern POS (point of sale) provides the services that enable Windows 8.1 clients to interface with Retail.
POS.
Important:
The Retail Modern POS is comprised of pre-release components. All pre-release
features and functionality are preliminary based on current expectations, and are subject to
change without notice.

Before you install Modern POS

Modern POS clients must be able to connect to a computer that is running Microsoft Dynamics
AX Retail Server. Verify that Retail Server is installed on a computer in your place of business.

Locate the URL for your Retail Server installation. You must specify this URL Setup for device
activation. By default, the URL is in the format: https://<server name>:port/<name of web
application> as it will be required for device activation.

You do not have to install Modern POS in a domain. You can install it as part of a work group on a
single computer.

Verify that WinJS and VCLibs libraries are installed on the device where you want to install this
component. For more information, see Manually install Modern POS prerequisites
(http://technet.microsoft.com/library/661dc32b-0eae-470e-a21e-085d48e5b384(AX.60).aspx).

Install Modern POS


Use this procedure to install the default Microsoft Dynamics AX Modern POS app on a supported device.
If you install other Microsoft Dynamics AX components at the same time, the installation pages vary,
depending on the components that you are installing. For information about how to install a customized
Modern POS app on a supported device, see the next section in this topic.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select installation type page, click Custom installation, and then click Next.

5.

On the Select components page, select Retail Modern POS, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Ready to install page, click Install.

9.

After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

240

Microsoft Dynamics AX

Note:
If you install Modern POS on a Windows 8.1 Professional or non-domain joined computer, Setup
might prompt you to provide an enterprise side-loading key. This key is included with your
Enterprise Volume License.

Install a customized Modern POS app on a client


The Retail SDK includes source samples and tools to help you customize the Microsoft Dynamics
AX Modern POS app for Windows 8.1 and Windows Phone. If you customize a Modern POS app then you
must side-load it to supported devices by using one of the following methods.

Windows Intune (http://go.microsoft.com/fwlink/?LinkId=397194)

Windows System Center

A third-party mobile device management service

Create a custom installer to deploy the app

Install the app by using Windows PowerShell scripts

For more information about customizing and installing a customized Modern POS app see Extend in the
Modern POS documentation roadmap.

After you install Modern POS


Start the Microsoft Dynamics AX Modern POS app. In the Device Activation page, enter the URL for the
Retail Server. After you enter the URL, the device is queued in the Microsoft Dynamics AX client where it
must be approved. After the device has been approved, the client is ready to use.

See Also
Modern Point of Sale (http://technet.microsoft.com/library/a670f147-1648-4077-9c39dc032079f8bb(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

241

Microsoft Dynamics AX

Install a retail channel database


This topic explains how to create a retail channel database by using Setup or Windows PowerShell.
Channel databases hold retail data for one or more retail channels, such as online stores or brick-andmortar stores. The data for a channel can be included in more than one channel database.
You can also use the Retail Channel Configuration Utility to create a channel database. For more
information, see Create a channel database or an offline database (AX 2012 R3)
(http://technet.microsoft.com/library/e12bd6ab-e41f-494e-8b34-98abcee0217a(AX.60).aspx).
Note:
Channel databases are used only with Microsoft Dynamics AX 2012 R3.
To deploy channel databases from a central location, use the Retail mass deployment toolkit together
with System Center Configuration Manager. For more information, see Mass deploy Retail components
(http://technet.microsoft.com/library/15ded62a-f6d3-44a4-8fe6-93e7f19ea558(AX.60).aspx).

Before you install a retail channel database

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Make sure that Microsoft SQL Server is set up correctly for Retail databases. For more information, see
Configure SQL Server for the Retail databases (http://technet.microsoft.com/library/826d3038-b41d425d-83e7-f439846a4f90(AX.60).aspx).

We recommend that you install Commerce Data Exchange: Async Server and Commerce Data
Exchange: Real-time Service in the environment before you install channel databases.

Install a retail channel database by using Setup


Use this procedure to install a retail channel database by using the Setup wizard. If you install other
Microsoft Dynamics AX components at the same time, the installation pages vary, depending on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Retail channel database, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

Microsoft Dynamics AX 2012 Installation Guide

242

Microsoft Dynamics AX
8.

On the Create a channel database page, select the Configure Retail Channel database option to
configure a channel database by using Setup. If you clear this option, the application files are
installed, but a channel database is not configured.
If youre configuring a channel database, enter the name of the server on which to create the
database and the name of the database.
Note:
If youre using a named instance of SQL Server, enter the server name in the format
ServerName\InstanceName.

9.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

10. On the Ready to install page, click Install.


11. After the installation is completed, click Finish to close the wizard.

Install a retail channel database by using Windows PowerShell


Use this procedure to install a retail channel database manually by using Windows PowerShell. Manual
installations are often performed by businesses and organizations that automate deployments by using
scripts.

Extract installation files


Use Microsoft Dynamics AX Setup to extract the files that are required for manual installation.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

On the Modify Microsoft Dynamics AX installation page, click Add or modify components, and
then click Next.

3.

On the Add or modify components page, select Retail channel database, and then click Next.

4.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

5.

On the Create a channel database page, clear the Configure retail channel database option.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Ready to install page, click Install.

8.

After the installation is completed, click Finish to close the wizard.

Configure settings in the channeldb-settings.xml file


After you extract the installation files by using Setup, you must configure settings in the channeldbsettings.xml file.
1.

Open the folder where the installation files are installed. By default, the files are located at C:\Program
Files (x86)\Microsoft Dynamics AX\60\Retail Channel Database\Tools.

2.

Create a copy of the channeldb-settings.xml file for each channel database that you are deploying.
We recommend that you not change the original file.

Microsoft Dynamics AX 2012 Installation Guide

243

Microsoft Dynamics AX
3.

Open your copy of the channeldb-settings.xml file in Microsoft Visual Studio or a text editor, such as
Notepad.

4.

Enter a value for the following parameters.


Parameter

Enter this value

Default value

ChannelDatabaseServerName

The name of the server that hosts the channel

None

database. The script is case-sensitive. For


example, enter value="DatabaseServer" />
ChannelDatabaseServerNamedInstance

The name of the SQL Server instance that hosts

Name

the channel database.

None

Note:
The format for a SQL Server instance
name is either the server name or the
full instance name. For example, valid
names are "localhost",
"localhost\instance2", "server1", and
"server1\instance2.
ChannelDatabaseName

5.

The name of the channel database.

None

Save your changes.

Run Windows PowerShell scripts to configure a channel database


After you configure the parameters in the channeldb-settings.xml file, you can run the Windows
PowerShell scripts that configure a channel database.
Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.
1.

On the server where you want to run the script, open Windows PowerShell to the folder where the
scripts are installed. By default, the files are located at C:\Program Files (x86)\Microsoft Dynamics
AX\60\Retail Channel Database\Tools.

If youre using Windows Server 2012 or a later operating system, use Windows Explorer to open
the folder where the scripts are installed. Then click File > Open Windows PowerShell > Open
Windows PowerShell as administrator.

If youre using Windows Server 2008 R2 or an earlier operating system, start Windows PowerShell
as the administrator. Then, change the directory by using the following command: CD <Path to
directory>.

Microsoft Dynamics AX 2012 Installation Guide

244

Microsoft Dynamics AX
2.

Run the following command to create the channel database:


.\Deploy-Databases.ps1 -SettingsXmlFilePath .\channeldb-settings-updated.xml TopologyXmlFilePath .\channeldb-topology.xml Verbose $true

Example:
.\DeployDatabases.ps1 -SettingsXmlFilePath C:\Program Files (x86)\Microsoft Dynamics AX\60\Retail
Channel Database\Tools \channeldb-settings-updated.xml -TopologyXmlFilePath C:\Program Files
(x86)\Microsoft Dynamics AX\60\Retail Channel Database\Tools\channeldb-topology.xml" Verbose
$true

After you install a retail channel database


After you install a channel database, you must complete the following tasks.

Set up a Retail scheduler profile for the database. For more information, see Set up a channel
database profile (http://technet.microsoft.com/library/03e67a5d-792b-4d3f-912221eab9cd6b61(AX.60).aspx).

Optional: Add the database to a data group. For more information, see Create a channel data group
(http://technet.microsoft.com/library/9fe5c16a-0119-471a-b466-b4511a5d052d(AX.60).aspx).

Install Commerce Data Exchange: Synch Service (Retail


Store Connect)
Commerce Data Exchange: Synch Service is a service that shares data among retail components. These
components include the head office, stores, and individual point of sale (POS) terminals. When you install
Synch Service, the Retail Salt Utility is also installed. The Retail Salt Utility provides extra encryption for the
passwords and credentials that are associated with the Microsoft Dynamics AX 2012 for Retail system.
Note:
Retail components are available with Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX
2012 R2, and Microsoft Dynamics AX 2012 Feature Pack. In AX 2012 Feature Pack, Synch Service is
called Retail Store Connect.
In AX 2012 R3, deploy this component only if you must support earlier versions of Microsoft Dynamics AX
for Retail POS while you upgrade (N-1). For more information, see Scenario: Upgrade a Retail system
(http://technet.microsoft.com/library/82b5489f-750d-4bde-a5c7-ab1cc8798c57(AX.60).aspx).
To deploy Synch Service on multiple computers in an environment, you can run Setup on each computer.

Before you install Synch Service

Determine how many instances of Synch Service you want to install, and on which computers.
In a basic deployment of Retail, one instance of Synch Service is installed at the head office, and one
instance is installed at each store. In this scenario, the head-office instance communicates with AOS,
and a store instance communicates with the store database.
Operations in a large organization might scale more efficiently if you install multiple Synch Service
instances at each site, either on a single server or on multiple servers. For more information, see Run

Microsoft Dynamics AX 2012 Installation Guide

245

Microsoft Dynamics AX
multiple instances of Synch Service (http://technet.microsoft.com/library/07c47aa8-3be8-4b63-b2d65d942b03a8be(AX.60).aspx).
Caution:
Although a single instance of Synch Service can manage all communications for the
organization, excessive load or network latency might decrease performance.
If Retail Scheduler will be used on a Microsoft Dynamics AX client computer to run jobs and send data
to stores, install Synch Service on the client system.

Determine whether you want to use Network Load Balancing (NLB) and Internet Protocol security
(IPsec). Retail supports NLB for data that comes from the store to Microsoft Dynamics AX, but not for
outgoing data. If youre using multiple instances of Synch Service, NLB can distribute incoming data
among them, but all instances must have the same service name. If IPsec is enabled, we recommend
that you not use NLB.

Select a service account for the Synch Service service. For information about the requirements for
service accounts, see Create service accounts.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

At the head office, .NET Business Connector must be installed on the same computer as Synch Service.
Synch Service uses .NET Business Connector to communicate with the AOS.

Install Synch Service


Use this procedure to install Synch Service. If you install other Microsoft Dynamics AX components at the
same time, the installation pages vary, depending on the components that youre installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, on the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Synch Service, and then click Next.

7.

On the Configure Commerce Data Exchange: Synch Service page, select the check box to configure
Synch Service by using Setup. If you clear this check box, the application files are installed, but Synch
Service is not configured.

To create a message database for Synch Service, enter the name of the server on which to create
the database, and then enter a name for the new database.

To configure the service account for Synch Service, enter a user name and password.

Microsoft Dynamics AX 2012 Installation Guide

246

Microsoft Dynamics AX
If you want to change this information later or configure other settings, such as a port and a service
name, you must use the Synch Service Settings Wizard. For more information, see Configure settings
for Synch Service (http://technet.microsoft.com/library/06302927-ef14-4fd3-8d543825679137ce(AX.60).aspx).
8.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

9.

On the Ready to install page, click Install.

10. After the installation is completed, click Finish to close the wizard.

Install Commerce Data Exchange: Async Server


Commerce Data Exchange: Async Server is part of the asynchronous system that shares data between the
Microsoft Dynamics AX database and channel databases. Async Server is installed at headquarters and
communicates with Microsoft Dynamics AX. In addition to Async Server, Commerce Data Exchange
includes Commerce Data Exchange: Async Client, which is installed at channels and communicates with
the channel database.
When you install Async Server, the Retail Salt Utility is also installed. The Retail Salt Utility provides extra
encryption for the passwords and credentials that are associated with the Retail system.
Note:
Async Server is available only with Microsoft Dynamics AX 2012 R3.
To deploy Async Server on multiple computers in a cluster, you can run Setup on each computer.
Alternatively, you can use the Retail mass deployment toolkit to deploy Async Server from a central
location. For information about how to set up an Internet Information Services (IIS) cluster, see the
Network Load Balancing Deployment Guide (http://technet.microsoft.com/enus/library/cc754833(v=WS.10).aspx). For information about how to use the mass deployment toolkit, see
Mass deploy Retail components (http://technet.microsoft.com/library/15ded62a-f6d3-44a4-8fe693e7f19ea558(AX.60).aspx).
The following sections are included in this topic:

Before you install Async Server

Install Async Server by using Setup

Install Async Server by using Windows PowerShell

After you install Async Server

Before you install Async Server

Determine how many instances of Async Server you want to install, and on which computers.
In a basic deployment of Retail, one instance of Async Server is installed at headquarters. Operations
in a large organization may scale more efficiently if you install multiple Async Server instances, either
on a single server or on multiple servers. For more information, see Deployment topologies for Retail.
Caution:
Although a single instance of Async Server can manage all communications for the
organization, excessive load or network latency might decrease performance.

Microsoft Dynamics AX 2012 Installation Guide

247

Microsoft Dynamics AX

Select a service account to run the application pool for Async Server. For information about the
requirements for this account, see Create service accounts.

Because this component uses Secure Sockets Layer (SSL) encryption, you must install a server
certificate that was issued by a trusted certification authority. (For test environments, you can create a
self-signed certificate in IIS.) When you run Setup, you will need to enter the thumbprint for the
certificate. To view the thumbprint in IIS Manager, double-click the certificate and click the Details
tab.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Async Server by using Setup


Use this procedure to install Async Server by using the Setup wizard. If you install other Microsoft
Dynamics AX components at the same time, the installation pages vary, depending on the components
that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Async Server, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Configure Async Server page, select the check box to configure Async Server by using Setup.
If you clear this check box, the application files are installed, but Async Server is not configured.
If youre configuring Async Server, enter the following information:

Application name The name of the web application that hosts Async Server.

App pool name The name of the application pool that the web application runs under.
We recommend that you specify separate application pools if multiple Retail components are
installed on the same computer. Multiple web applications can share an application pool if
resources on the computer are limited. However, if the shared application pool fails, all of the
applications that use it will stop responding. In addition, if one application is heavily used, it can
negatively affect the performance of the other applications in the pool.

Website name The name of the website that Async Server runs on.

User name and Password The credentials for the application pool identity.

HTTPS port The port on which Async Server receives HTTPS requests. You can specify any
available port. Verify that the port is open in Windows Firewall, and record the port number. The

Microsoft Dynamics AX 2012 Installation Guide

248

Microsoft Dynamics AX
port is used to create the URL for Async Server in the following format: https://<server
name>:port/<web application name>. This URL is required when you configure instances of
Async Client that connect to this instance of Async Server.
Warning:
To avoid conflicts with the Default Web Site on the computer, we recommend that you
do not use the default HTTPS port (443). A nonstandard port number also helps make the
website more secure.

9.

TCP port (optional) The port on which Async Server receives TCP requests. Specify a TCP port if
your environment uses high-performance data synchronization. You can specify any available
port. Verify that the port is open in Windows Firewall.

AOS service user The user account that the instance of Application Object Server (AOS) runs as.

SSL certificate thumbprint The thumbprint for the Secure Sockets Layer (SSL) encryption
certificate. You must obtain a valid, registered certificate from a provider.

On the Select a database to use with Async Server page, create a new message database for Async
Server. If you install a subsequent instance of Async Server for load balancing, you must select the
same message database.
Note:
You must set up a separate message database for each partition in Microsoft Dynamics AX.

10. On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.
11. On the Ready to install page, click Install.
12. After the installation is completed, click Finish to close the wizard.

Install Async Server by using Windows PowerShell


Use this procedure to install Async Server manually by using Windows PowerShell. To install multiple
instances of Async Server on the same computer, you must use a manual installation. Manual installations
are often performed by businesses and organizations that automate deployments by using scripts.

Extract installation files


Use Microsoft Dynamics AX Setup to extract the files that are required for manual installation.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

On the Modify Microsoft Dynamics AX installation page, click Add or modify components, and
then click Next.

3.

On the Add or modify components page, select Async Server, and then click Next.

4.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

5.

On the Configure Async Server page, clear the Configure Async Server option.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Ready to install page, click Install.

Microsoft Dynamics AX 2012 Installation Guide

249

Microsoft Dynamics AX
8.

After the installation is completed, click Finish to close the wizard.

Configure settings in the ss-settings.xml file


After you extract the installation files by using Setup, you must configure settings in the ss-settings.xml
file.
1.

Open the folder where the Windows PowerShell scripts are installed. By default, the files are located at
C:\Program Files (x86)\Microsoft Dynamics AX\60\CDX\Async Server\Tools.

2.

Create a copy of the ss-settings.xml file for each instance of Async Server that you plan to deploy. We
recommend that you not change the original file.

3.

Open your copy of the ss-settings.xml file in Microsoft Visual Studio or a text editor, such as Notepad.

4.

Enter a value for the following parameters.


Parameter

Enter this value

Default value

HQMessageDatabaseServerN

The name of the server that hosts the message

None

ame

database for Async Server. The script is case


sensitive. For example, enter
value="DatabaseServer" />

HQMessageDatabaseServerN

The name of the SQL Server instance that hosts the

amedInstanceName

message database.

None

The format for a SQL Server instance name is


either the server name or the full instance name.
For example, valid formats are "localhost",
"localhost\instance2", "server1", and
"server1\instance2".
HQMessageDatabase

The name of the message database.

None

HQMessageDatabaseServerO

(Optional) The name of the database server that is

[HQMessageDatabaseSe

verride

used to connect to the message database. By

rverName]

default, the computer name that was used to


deploy the database is used.
WebSiteName

The name of the website that hosts Async Server.

AsyncServerSite

AppPoolName

The name of the application pool for the Async

AsyncServer

Server web application.


AppPoolUser

The credentials for the application pool identity.

None

AOSServiceUser

The user account that the AOS instance runs as.

NT Authority\Network
Service

WebApplicationName

The name of the web application that hosts Async

AsyncServer

Server.

Microsoft Dynamics AX 2012 Installation Guide

250

Microsoft Dynamics AX

Parameter

Enter this value

WebApplicationServiceBinaryS The location where the installer copied binary


ourceFolder

Default value
None

components. By default, the files are located at


C:\Program Files (x86)\Microsoft Dynamics
AX\60\CDX\Async Server\6.3.

WebSiteHttpsPort

The port on which Async Server receives HTTPS

None

requests.
WebSiteTcpPort

The port on which Async Server receives TCP

808

requests. Specify a TCP port if your environment


uses high-performance data synchronization.
WebSiteSSLCertificateThumbp

The thumbprint for the SSL encryption certificate.

rint

You must obtain a valid, registered certificate from

None

a provider.
WebSiteSSLCertificateRootSto

The name of the root store where the SSL

re

certificate that is used to help secure the website is

LocalMachine

installed.
WebSiteSSLCertificateStore

Enter the name of the certificate store where the

My

SSL certificate that is used to help secure the


website is installed.
WebSiteWorkingFolder

5.

The path of the physical folder where website files

%SystemDrive%\inetpub

are stored.

\AsyncServerSite

WebApplicationWorkingFolde

The path of the physical folder where web

[WebSiteWorkingFolder]

application files are stored.

\[WebApplicationName]

Save your changes.

Run Windows PowerShell scripts to configure Async Server


After you configure the parameters in the ss-settings.xml file, you can run the Windows PowerShell scripts
that configure Async Server.
Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.
1.

On the server where you want to run the script, open Windows PowerShell to the folder where the
scripts are installed. By default, the files are located at C:\Program Files (x86)\Microsoft Dynamics
AX\60\Async Server\Tools.

Microsoft Dynamics AX 2012 Installation Guide

251

Microsoft Dynamics AX

2.

If youre using Windows Server 2012 or a later operating system, use Windows Explorer to open
the folder where the scripts are installed. Then click File > Open Windows PowerShell > Open
Windows PowerShell as administrator.

If youre using Windows Server 2008 R2 or an earlier operating system, start Windows PowerShell
as the administrator. Then, change the directory by using the following command: CD <Path to
directory>.

In the Windows PowerShell console, run the following command to create a secure credential object
for the application pool identity.
$Cred = @((New-Object System.Management.Automation.PSCredential(domain\user,
(ConvertTo-SecureString password -AsPlainText -Force))))

3.

Run the following command to deploy Async Server.


.\DeployAsyncServer.ps1 -TopologyXmlFilePath $topologyFileName -SettingsXmlFilePath
$updatedSettingsFileName -Credentials $Cred

Example:
.\DeployAsyncServer.ps1 -SettingsXmlFilePath "C:\Program Files (x86)\Microsoft Dynamics
AX\60\CDX\Async Server\Tools\ss-settings.xml" -TopologyXmlFilePath "C:\Program Files
(x86)\Microsoft Dynamics AX\60\CDX\Async Server\Tools\ss-topology.xml" -Credentials $Cred
Verbose $true

After you install Async Server


After you install Async Server, you must complete the following tasks.

Set message database information in the Retail scheduler parameters form. Then click the Sync
metadata button. For more information, see Enter parameters for Retail Scheduler
(http://technet.microsoft.com/library/bfe69872-8fb9-41d9-8f61-d206055dbd87(AX.60).aspx).

Create a scheduler profile for Async Server. For more information, see Set up a profile for Async Server
(http://technet.microsoft.com/library/008f91db-9179-48b7-8a2f-f23e10ed8c5a(AX.60).aspx).

Set up working folders. For more information, see Specify working folders for Commerce Data
Exchange (http://technet.microsoft.com/library/7287752d-5b02-4f95-9ff2-1fb8a3f9685d(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

252

Microsoft Dynamics AX

Install Commerce Data Exchange: Async Client


Commerce Data Exchange: Async Client is part of the asynchronous system that shares data between the
Microsoft Dynamics AX database and channel databases. Async Client is installed at the channel and
communicates with the channel database. In addition to Async Client, Commerce Data Exchange includes
Commerce Data Exchange: Async Server. Async Server is installed at headquarters and communicates with
the Microsoft Dynamics AX database.
When you install Async Client, the Retail Salt Utility is also installed. The Retail Salt Utility provides extra
encryption for the passwords and credentials that are associated with the Retail system.
The Async Client Configuration Tool is also installed together with Async Client. This tool lets you test
connections and specify whether to use streaming. The streaming option is ideal for initial high-speed
data synchronization. However, for ongoing synchronization, the non-streaming option is more reliable.
For more information, see Configure settings for Async Client
(http://technet.microsoft.com/library/3356c7a4-6c49-4a4d-932d-1954dfe413d6(AX.60).aspx).
Note:
Async Client is available only with Microsoft Dynamics AX 2012 R3.
To deploy Async Client on multiple computers in an environment, you can use the Retail mass
deployment toolkit to deploy Async Client from a central location. For more information, see Mass deploy
Retail components (http://technet.microsoft.com/library/15ded62a-f6d3-44a4-8fe693e7f19ea558(AX.60).aspx).

Before you install Async Client

Determine how many instances of Async Client you want to install, and on which computers.
In a basic deployment of Retail, one instance of Async Client is installed for each channel database. If
you want to install more than one instance of Async Client on a single computer, you must run the
Windows PowerShell installation scripts manually for subsequent installations. For more information,
see Install Async Client by using Windows PowerShell.

Select a service account for Async Client. For information about the requirements for service accounts,
see Create service accounts.

Create the channel database that will be used with this instance of Async Client. When you install a
channel database, the groups that have permissions on the database are created. During the Async
Client installation, the service user is added to this group. For more information, see Install a retail
channel database.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Microsoft Dynamics AX 2012 Installation Guide

253

Microsoft Dynamics AX

Install Async Client by using Setup


Use this procedure to install Async Client by using the Setup wizard. If you install other Microsoft
Dynamics AX components at the same time, the installation pages vary, depending on the components
that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Async Client, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Configure Async Client page, select the check box to configure Async Client by using Setup.
If you clear this check box, the application files are installed, but Async Client is not configured.
If youre configuring Async Client, enter the following information:

Async Server URL The URL for the instance of Async Server. Typically, the URL is in the format
https://<server name>:port/<web application name>.
If Async Server is installed in a cluster that has a load balancer, enter the URL to the service on the
load balancer.

Channel database ID The identifier in Microsoft Dynamics AX for the channel database that is
used by the selected instance of Async Client.

User name and Password (Async Server connection) The credentials for the user that connects
to Async Server. These credentials must match the credentials that are specified in the channel
database profile. Credentials are case sensitive. The credentials are used to identify and
authenticate Async Client.

User name and Password (Async Client) The credentials for the user that runs the Windows
service for Async Client. The user does not have to be a domain account. The user can be a
member of a workgroup on the local computer. Credentials are case sensitive.

Optionally, click Test connection to verify that Async Client is configured correctly. For information
about how to troubleshoot errors that you might encounter, see Troubleshoot configuration issues
for Async Client (http://technet.microsoft.com/library/5c841baa-605f-47fe-809e030c43d5caa8(AX.60).aspx).
Click Next.
9.

On the Select or specify a database to use with Async Client page, enter server and database
information for the message database and the channel database that will be used by Async Client.
Then click Next.
You can connect to an existing channel database only. Setup does not create a new channel database
if you enter a channel database name that doesnt exist. If you specify a message database name that
doesnt exist, Setup creates a new message database.

Microsoft Dynamics AX 2012 Installation Guide

254

Microsoft Dynamics AX
10. On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.
11. On the Ready to install page, click Install.
12. After the installation is completed, click Finish to close the wizard.

Install Async Client by using Windows PowerShell


Use this procedure to install Async Client manually by using Windows PowerShell. To install multiple
instances of Async Client on the same computer, you must use a manual installation. Manual installations
are often performed by businesses and organizations that automate deployments by using scripts.

Extract installation files


Use Microsoft Dynamics AX Setup to extract the files that are required for manual installation.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

On the Select installation type page, click Custom installation, and then click Next.

3.

On the Select components page, select Async Client, and then click Next.

4.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

5.

On the Configure Async Client page, clear the Configure Async Client option.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Ready to install page, click Install.

8.

After the installation is completed, click Finish to close the wizard.

Configure settings in the sc-settings.xml file


After you extract the installation files by using Setup, you must configure settings in the sc-settings.xml
file.
1.

Open the folder where the Windows PowerShell scripts are installed. By default, the files are located at
C:\Program Files (x86)\Microsoft Dynamics AX\60\CDX\Async Client\Tools.

2.

Create a copy of the sc-settings.xml file for each instance of Async Client that you plan to deploy. We
recommend that you not change the original file.

3.

Open your copy of the sc-settings.xml file in Microsoft Visual Studio or a text editor, such as Notepad.

Microsoft Dynamics AX 2012 Installation Guide

255

Microsoft Dynamics AX
4.

Enter a value for each of the following parameters.


Parameter

Enter this value

Default value

ChannelMessageDatabaseServe

The name of the server that hosts the message

None

database. The script is case sensitive. For example,


enter value="DatabaseServer" />

ChannelMessageDatabaseServe

The name of the Microsoft SQL Server instance

rNamedInstanceName

that hosts the message database.

None

The format for a SQL Server instance name is


either the server name or the full instance name.
For example, valid formats are "localhost",
"localhost\instance2", "server1", and
"server1\instance2".
ChannelMessageDatabaseName

The name of the message database.

None

ChannelDatabaseServer

The name of the server that hosts the channel

None

database.
ChannelDatabaseServerNamedI

The name of the SQL Server instance that hosts the

nstanceName

channel database.

None

The format for a SQL Server instance name is


either the server name or the full instance name.
For example, valid formats are "localhost",
"localhost\instance2", "server1", and
"server1\instance2".
ChannelDatabaseName

The name of the channel database.

None

ServiceName

The name that is displayed for the service in the

CommerceDataExchan

Services control panel item.

geAsyncClientService

The URL for the instance of Async Server. Typically,

None

SynchServiceHeadOfficeURL

the URL is in the format https://<server


name>:port/<web application name>.
ServiceUser

The account that will be used to run the Async

None

Client service. Enter the account in the form


value="Domain or Computer Name\User".
ServiceBinarySourceFolder

The folder where the .dll files for Async Client are

None

installed. By default, the folder is located at


C:\Program Files (x86)\Microsoft Dynamics
AX\60\CDX\Async Client\Package.
ServiceInstallFolder

The folder where Async Client files will be installed.

%SystemDrive%\Asyn
cClientService

Microsoft Dynamics AX 2012 Installation Guide

256

Microsoft Dynamics AX

Parameter

What to enter

Default value

DataStoreName

The channel database ID in Microsoft Dynamics AX

None

for the channel database that is used by the


selected instance of Async Client.
To find or set the channel database name, use the
Channel database form in Microsoft Dynamics AX.
(Click Retail > Setup > Retail scheduler >
Channel integration > Channel database.)
DataStoreUserName

The user name that Async Client uses to connect

None

to Async Server.
To find or set the user name, use the Channel
database form in Microsoft Dynamics AX. (Click
Retail > Setup > Retail scheduler > Channel
integration > Channel database.)
Credentials are case sensitive.

5.

ChannelMessageDatabaseServe

The name of the channel database server, if the

[ChannelMessageData

rOverride

name differs from what was specified.

baseServer]

Save your changes.

Run Windows PowerShell scripts to configure Async Client


After you configure the parameters in the sc-settings.xml file, you can run the Windows PowerShell scripts
that configure Async Client.
Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.
1.

On the server where you want to run the script, open Windows PowerShell to the folder where the
scripts are installed. By default, the files are located at C:\Program Files (x86)\Microsoft Dynamics
AX\60\Async Client\Tools.

If youre using Windows Server 2012 or a later operating system, use Windows Explorer to open
the folder where the scripts are installed. Then click File > Open Windows PowerShell > Open
Windows PowerShell as administrator.

If youre using Windows Server 2008 R2 or an earlier operating system, start Windows PowerShell
as the administrator. Then, change the directory by using the following command: CD <Path to
directory>.

Microsoft Dynamics AX 2012 Installation Guide

257

Microsoft Dynamics AX
2.

In the Windows PowerShell console, run the following command to create a Windows PowerShell
credential object on the local computer for the application pool identity.
$Cred = @((New-Object
System.Management.Automation.PSCredential('domain\username',(ConvertTo-SecureString
'password' -AsPlainText -Force))

For more information about how to create credential objects, see Create Windows PowerShell Scripts
that Accept Credentials (http://go.microsoft.com/fwlink/?LinkID=394381).
3.

Run the following command to create a credential object for the account that is used to connect to
Async Server.
$Cred = @((New-Object
System.Management.Automation.PSCredential('domain\username',(ConvertTo-SecureString
'password' -AsPlainText -Force))

4.

Run the following command to deploy Async Client.


\DeployAsyncClient.ps1 -SettingsXmlFilePath <path> -TopologyXmlFilePath <path> Credentials $Cred Verbose $true

Example:
.\DeployAsyncClient.ps1 -SettingsXmlFilePath "C:\Program Files (x86)\Microsoft Dynamics
AX\60\CDX\Async Client\Tools\sc-settings.xml" -TopologyXmlFilePath "C:\Program Files
(x86)\Microsoft Dynamics AX\60\CDX\Async Client\Tools\sc-topology.xml" -Credentials $Cred
Verbose $true

After you install Async Client


1.

Use the Async Client Configuration Tool to test the connections to Async Server, the channel
database, and the channel message database. You can also use the utility to set advanced options. For
more information, see Configure settings for Async Client
(http://technet.microsoft.com/library/3356c7a4-6c49-4a4d-932d-1954dfe413d6(AX.60).aspx).

2.

After you have determined that all connections are working, run the distribution schedule that sends
data to each channel database. Click Retail > Setup > Retail scheduler > Channel integration >
Channel database. Click Full data sync, and then select the Full sync distribution schedule.

Microsoft Dynamics AX 2012 Installation Guide

258

Microsoft Dynamics AX

Install the Retail Channel Configuration Utility (Retail


Store Database Utility)
This topic explains how to install the Retail Channel Configuration Utility by using the Setup wizard.
Note:
Retail components are available only with Microsoft Dynamics AX 2012 R3, AX 2012 R2, and AX
2012 Feature Pack. In AX 2012 R2 and AX 2012 Feature Pack, Retail Channel Configuration Utility
was called Retail Store Database Utility.
The Retail Channel Configuration Utility can be used to complete the following tasks:

Configure Retail POS and Offline Sync Service

Create a channel database

Create or re-provision an offline database

Install the Retail Channel Configuration Utility on computers where you must create a channel database. A
channel database may be created either on a stand-alone database server or on a POS computer.

Before you install the Retail Channel Configuration Utility


On the computer where you plan to install this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Retail Channel Configuration Utility (AX 2012 R3)


Use this procedure to install the Retail Channel Configuration Utility for AX 2012 R3. If you install other
Microsoft Dynamics AX components at the same time, the installation pages vary, depending on the
components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics AX, and then click Next.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Retail Channel Configuration Utility, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Ready to install page, click Install.

9.

After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

259

Microsoft Dynamics AX

Install the Retail Store Database Utility (AX 2012 Feature Pack and AX
2012 R2)
Use this procedure to install the Retail Store Database Utility for AX 2012 Feature Pack or AX 2012 R2. If
you install other Microsoft Dynamics AX components at the same time, the installation pages vary,
depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select installation type page, click Custom installation, and then click Next.

5.

On the Select components page, select Retail Store Database Utility, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Configure Retail store databases and POS page, select the check box if you want to create
store databases and associate them with a POS system.

To create a store database, enter the name of the server where you want to create the database,
and then enter a name for the new database.
When creating a shared store database, do not enter anything in the Offline database name or
Offline server name fields. After you have created the shared store database, you can open the
Retail Store Database Utility to designate this database as an offline database, but you cannot
perform both actions at the same time.

To create an offline database, enter the name of the server where you want to create the
database, and then enter a name for the new database.

Enter POS identification information.


Important:
Dummy values are required in the Identification fields because of a known issue.
In the Store ID field, type the ID of the store that the POS terminal is associated with. The store
record does not need to be created before you complete this step. However, the ID must match
later when the record is created and the profile is linked.
In the Terminal ID field, type a unique ID for the POS terminal. The terminal ID that you enter
must be listed in the POS terminals form.
In the Company field, type the applicable company code.

8.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

9.

On the Ready to install page, click Install.

10. After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

260

Microsoft Dynamics AX

After you install the Retail Channel Configuration Utility


For information about how to use the Retail Channel Configuration Utility, see the following topics:

Create a channel database or an offline database (AX 2012 R3)


(http://technet.microsoft.com/library/e12bd6ab-e41f-494e-8b34-98abcee0217a(AX.60).aspx)

Create a store database or an offline database (AX 2012 R2 and AX 2012 Feature Pack)
(http://technet.microsoft.com/library/99ba8d75-d3ef-457d-a714-95dd894fccc5(AX.60).aspx)

Configure database connections for a POS register (http://technet.microsoft.com/library/ab65600e155a-4d63-971f-84e71d1aea79(AX.60).aspx)

Install Retail Server


Retail Server provides services and business logic for Modern POS (point of sale) clients. To deploy Retail
Server on multiple computers in a cluster, you can run Setup on each computer or you can manually copy
the web application to each computer. Alternatively, you can use Retail mass deployment toolkit with
System Center Configuration Manager to deploy Retail Server from a central location. For more
information, see Mass deploy Retail components (http://technet.microsoft.com/library/15ded62a-f6d344a4-8fe6-93e7f19ea558(AX.60).aspx).
This topic includes the following sections.

Before you install Retail Server

Install Retail Server by using Setup

Install Retail Server by using Windows PowerShell


Note:
Retail Server is available only with Microsoft Dynamics AX 2012 R3.

Before you install Retail Server

Be aware that you do not have to install Retail Server in a domain. You can install it as part of a work
group on a single computer.

Create a service account. This service account is used for the identity of the application pool for Retail
Server. This account does not have to be a domain account. It can be a work group account. For more
information, see Create service accounts.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Because this component uses Secure Sockets Layer (SSL) encryption, you must install a server
certificate that was issued by a trusted certification authority. (For test environments, you can create a
self-signed certificate in IIS.) When you run Setup, you will need to enter the thumbprint for the
certificate. To view the thumbprint in IIS Manager, double-click the certificate and click the Details
tab.

Microsoft Dynamics AX 2012 Installation Guide

261

Microsoft Dynamics AX

Install Retail Server by using Setup


Use this procedure to install Retail Server. If you install other Microsoft Dynamics AX components at the
same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select installation type page, click Custom installation, and then click Next.

5.

On the Select components page, select Retail Server, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Configure Retail Server page, enter the following information about the web site where
Retail Server will run.

Configure Retail Server: On the Configure Retail Server page, select the check box to
configure Retail Server by using Setup. If you clear this option, the application files are installed,
but Retail Server is not configured. If youre configuring Retail Server, enter the following
information:

Application name The name of an existing web application in your server environment or the
name of an application that you want Setup to create.

Website name The name of an existing web site in your server environment or the name of a
site that you want Setup to create.

App pool name The name of an existing web application pool in your server environment or
the name of an application pool that you want Setup to create.

User name and Password The credentials for the application pool identity. The user does not
have to be a domain account. It can be a member of a work group on the local computer.

HTTP port and HTTPS port You can specify any available ports. Verify that these ports are
open in Windows firewall. Also, make a note of these port numbers. The port is used to create the
URL for Retail Server in the format: https://<ServerName>:Port/<WebApplicationName>. This
URL is required to activate Modern POS devices that connect to Retail Server.
Warning:
To avoid conflicts with the Default Web Site on the computer, we recommend that you
do not use the default HTTPS port (443). A nonstandard port number also helps make the
website more secure.

SSL certificate thumbprint The thumbprint for your Secure Sockets Layer (SSL) encryption
certificate.

8.

On the Select a database to use with Retail Server page, select an existing database. To create a
new channel database you must install the Retail channel database component.

9.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

Microsoft Dynamics AX 2012 Installation Guide

262

Microsoft Dynamics AX
10. On the Ready to install page, click Install.
11. After the installation is completed, click Finish to close the wizard.

Install Retail Server by using Windows PowerShell


Use this procedure to install Retail Server manually by using Windows PowerShell. Manual installations are
often performed by businesses and organizations that automate deployments by using scripts.

Extract installation files


Use Microsoft Dynamics AX Setup to extract the files that are needed for manual installation.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

On the Select installation type page, click Custom installation, and then click Next.

3.

On the Select components page, select Retail Server, and then click Next.

4.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

5.

On the Configure Retail Server page, clear the Configure Retail Server option.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Ready to install page, click Install.

8.

After the installation is completed, click Finish to close the wizard.

Configure settings in the rs-settings.xml file


After you extract the installation files by using Setup, you must configure settings in the rs-settings.xml
file.
1.

Open the folder where the installation files are installed. By default, the files are located at C:\Program
Files (x86)\Microsoft Dynamics AX\60\Retail Server\Tools.

2.

Create a copy of the rs-settings.xml file. We recommend that you do not change the original file.

3.

Open the rs-settings.xml file in Microsoft Visual Studio or a text editor, such as Notepad.

4.

Enter a value for the following parameters:


Parameter

What to enter

Default value

ChannelDatabaseServerName

The name of the server that hosts the channel

None

database. The script is case-sensitive. For


example, value="DatabaseServer" />
ChannelDatabaseServerNamed The name of the SQL Server instance that hosts
InstanceName

None

the channel database. The format for a SQL


Server instance name is either the server name or
the full instance name. For example, valid names
are "localhost", "localhost\instance2", "server1",
and "server1\instance2.

Microsoft Dynamics AX 2012 Installation Guide

263

Microsoft Dynamics AX

Parameter

What to enter

Default value

ChannelDatabaseName

The name of the channel database.

None

RetailServerWebAppPoolNam

The name of an existing web application or the

RetailServerAppPool

name of an application that you want Setup to


create.

RetailServerWebSiteName

The name of an existing web site or the name of a RetailServerWebsite


site that you want Setup to create.

RetailServerWebSiteHttpPort

You can specify any available port. Verify that the

None

port is open in Windows firewall. Also, note the


port number. The port is used to create the URL
for Retail Server in the format: https://<server
name>:port/<web application name>. This URL is
required to activate Modern POS devices that
connect to Retail Server.
RetailServerWebSiteHttpsPort

You can specify any available port. Verify that the

None

port is open in Windows firewall. Also, note the


port number. The port is used to create the URL
for Retail Server in the format: https://<server
name>:port/<web application name>. This URL is
required to activate Modern POS devices that
connect to Retail Server.
RetailServerWebApplicationN

The name of an existing web application or the

ame

name of an application that you want Setup to

RetailServer

create.
RetailServerWebSiteSSLCertifi

The Certificates store specified when the

My

cateStore

certificate was created or imported.

RetailServerWebSiteSSLCertifi

The server where the certificate is stored.

LocalMachine

RetailServerWebSiteWorkingF

The folder where you want PowerShell to create a

%SystemDrive%\inetpub

older

new IIS virtual directory.

\wwwroot

RetailServerWebAppPoolUser

Enter a domain account for the application pool.

None

cateRootStore

Enter the account in the form


value="Domain\User".

Microsoft Dynamics AX 2012 Installation Guide

264

Microsoft Dynamics AX

Parameter

What to enter

Default value

RetailServerWebSiteSSLCertifi

The thumbprint for your Secure Sockets Layer

None

cateThumbprint

(SSL) encryption certificate. You must obtain a


valid, registered certificate from a provider.
Because this component uses Secure Sockets
Layer (SSL) encryption, you must install a server
certificate that was issued by a trusted
certification authority. (For test environments, you
can create a self-signed certificate in IIS.) You will
need to paste the thumbprint for the certificate
into the settings file. To view the thumbprint in IIS
Manager, double-click the certificate and click the
Details tab. We recommend that you paste the
thumbprint into a text file and remove all spaces
before you paste it into the settings file.

RetailServerWebApplicationSe

This folder contains required files for deploying

rviceBinarySourceFolder

Retail ServerBy default this folder is:

None

C:\Program Files (x86)\Microsoft Dynamics


AX\60\Retail Server\Package folder
RetailServerWebApplicationW

The folder from where the web service will run.

[RetailServerWebSiteWo

orkingFolder

You can specify the

rkingFolder]\[RetailServe

RetailServerWebApplicationServiceBinarySourceF

rWebApplicationName]

older or any available folder.


RetailServerAllownAnonymou

This setting controls OData $metadata

sMetadata

accessibility for anonymous users.

False

In a developer environment, we recommend


setting this parameter to true. Setting this to true
enables the system to reference the OData
$metadata service to generate client proxy code.
In a production environment, this setting should
be false.
RetailServerRequireSSL

This option can be used to bypass the SSL

True

requirement in a demonstration environment. In a


production environment, you must set the option
to true and specify values for the other SSL
properties in the configuration file.

Microsoft Dynamics AX 2012 Installation Guide

265

Microsoft Dynamics AX
5.

Save your changes.


Important:
If you deployed Retail Server in a web farm with a load balancer, you must specify a machine key
to ensure that client connections retain session. For more information, see WIF and Web Farms
(http://go.microsoft.com/fwlink/?LinkId=397516).

Run PowerShell scripts to deploy and configure Retail Server


After you configure the parameters in the rs-settings.xml file, you can run the Windows PowerShell scripts
that deploy and configure Retail Server.
1.

On the server where you want to run the script, open the folder where the PowerShell scripts are
installed. By default, the files are located at C:\Program Files (x86)\Microsoft Dynamics AX\60\Retail
Server\Tools

2.

If youre using Windows Server 2012 or a later operating system, use Windows Explorer to open the
folder where the scripts are installed. Then click File > Open Windows PowerShell > Open Windows
PowerShell as administrator.
If youre using Windows Server 2008 R2 or an earlier operating system, start Windows PowerShell as
the administrator. Then, change the directory by using the following command: CD <Path to directory>.

3.

In the Windows PowerShell console, run the following command to create a credential object in
Active Directory for the service account. Replace domain\useraccount and password with
credentials that have permission to create sites in IIS:
$Cred = @((New-Object
System.Management.Automation.PSCredential(domain\useraccount',(ConvertTo-SecureString
'password' -AsPlainText -Force))))

4.

Run the following command to deploy and configure Retail Server:


.\DeployRetailServer.ps1 -SettingsXmlFilePath .\rs-settings.xml -TopologyXmlFilePath
.\rs-topology.xml -Credentials $Cred Verbose $true

For example:
.\DeployRetailServer.ps1 -SettingsXmlFilePath "C:\Program Files (x86)\Microsoft Dynamics
AX\60\Retail Server\Tools\rs-settings.xml" -TopologyXmlFilePath "C:\Program Files (x86)\Microsoft
Dynamics AX\60\Retail Server\Tools\rs-topology.xml" -Credentials $Cred Verbose $true

After you install Retail Server


You must create a channel profile and a channel database profile for Retail Server in the Microsoft
Dynamics AX client. For more information, see Set up a channel profile
(http://technet.microsoft.com/library/4ef00ad9-9da2-4d21-b3e1-637f77cab208(AX.60).aspx) and Set up a
channel database profile (http://technet.microsoft.com/library/03e67a5d-792b-4d3f-912221eab9cd6b61(AX.60).aspx).
After you create the channel and channel database profiles, you can verify Retail Server configurations by
opening a store in the Retail channels > Retail stores form. In the Profiles section, verify that the
Channel profile and the Live channel database fields display the correct channel profile values.

Microsoft Dynamics AX 2012 Installation Guide

266

Microsoft Dynamics AX
After Retail Server is deployed and configured, you can deploy Microsoft Dynamics AX Modern POS on
supported clients. For more information, see Install Modern POS.

Install Retail Hardware Station


Microsoft Dynamics AX Retail Hardware Station provides services for Microsoft Dynamics
AX Retail Modern POS (point of sale) clients and peripherals such as printers, cash drawers, or payment
devices that enable these devices to communicate with Microsoft Dynamics AX Retail Server. This section
includes the following information about how to install and configure Hardware Station.

Before you begin

Install Hardware Station by using Setup

Install Hardware Station by using Windows PowerShell


Note:
Hardware Station is available only with Microsoft Dynamics AX 2012 R3.

Before you begin

Be aware that you do not have to install Hardware Station in a domain. You can install it as part of a
work group on a single computer.

Create a service account. This service account is used for the identity of the application pool for
Hardware Station. This account does not have to be a domain account. It can be a work group
account. For more information, see Create service accounts.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Because this component uses Secure Sockets Layer (SSL) encryption, you must install a server
certificate that was issued by a trusted certification authority. (For test environments, you can create a
self-signed certificate in IIS.) When you run Setup, you will need to enter the thumbprint for the
certificate. To view the thumbprint in IIS Manager, double-click the certificate and click the Details
tab.

Install Hardware Station by using Setup


Use this procedure to install Hardware Station. If you install other Microsoft Dynamics AX components at
the same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select installation type page, click Custom installation, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

267

Microsoft Dynamics AX
5.

On the Select components page, select Retail Hardware Station, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Configure Retail Hardware Station page, enter the following information about the web site
where Hardware Station will run.

Configure Hardware Station: On the Configure Hardware Station page, select the check box
to configure Hardware Station by using Setup. If you clear this option, the application files are
installed, but Hardware Station is not configured. If youre configuring Hardware Station, enter
the following information:

Application name The name of an existing web application or the name of an application that
you want Setup to create.

Website name The name of an existing web site or the name of a site that you want Setup to
create.

App pool name The name of an existing web application pool in your server environment or
the name of an application pool that you want Setup to create.

User name and Password The credentials for the application pool identity. The user does not
have to be a domain account. It can be a member of a work group on the local computer.

HTTP port and HTTPS port You can specify any available ports. Verify that these ports are
open in Windows firewall.
Warning:
To avoid conflicts with the Default Web Site on the computer, we recommend that you
do not use the default HTTPS port (443). A nonstandard port number also helps make the
website more secure.

SSL certificate thumbprint The thumbprint for your Secure Sockets Layer (SSL) encryption
certificate.

Retail Server URL The URL specified when Retail Server was installed. By default, the URL is
created by using the following parameters:
https://.<ServerName>:Port/<WebApplicationName>

8.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

9.

On the Ready to install page, click Install.

10. After the installation is completed, click Finish to close the wizard.

Install Hardware Station by using Windows PowerShell


Use this procedure to install Hardware Station manually by using Windows PowerShell. Manual
installations are often performed by businesses and organizations that automate deployments by using
scripts.

Microsoft Dynamics AX 2012 Installation Guide

268

Microsoft Dynamics AX

Extract installation files


Use Microsoft Dynamics AX Setup to extract the files that are needed for manual installation.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

On the Select installation type page, click Custom installation, and then click Next.

3.

On the Select components page, select Retail Hardware Station, and then click Next.

4.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

5.

On the Configure Retail Hardware Station page, clear the Configure Retail Server option.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Ready to install page, click Install.

8.

After the installation is completed, click Finish to close the wizard.

Configure settings in the hs-settings.xml file


After you extract the installation files by using Setup, you must configure settings in the hs-settings.xml
file.
1.

Open the folder where the installation files are installed. By default, the files are located at C:\Program
Files (x86)\Microsoft Dynamics AX\60\HardwareStation\Tools.

2.

Create a copy of the hs-settings.xml file. We recommend that you do not change the original file.

3.

Open the hs-settings.xml file in Microsoft Visual Studio or a text editor, such as Notepad.

4.

Enter a value for the following parameters:


Parameter

What to enter

Default value

WebAppPoolName

The name of an existing web application or the

HardwareStationAppPool

name of an application that you want Setup to


create.
WebSiteName

The name of an existing web site or the name of a

HardwareStationWebsite

site that you want Setup to create.


WebSiteHttpPort

You can specify any available port. Verify that the

None

port is open in Windows firewall. Also, note the port


number. The port is used to create the URL for Retail
Server in the format: https://<server
name>:port/<web application name>. This URL is
required to activate Modern POS devices that
connect to Retail Server.

Microsoft Dynamics AX 2012 Installation Guide

269

Microsoft Dynamics AX

Parameter

What to enter

Default value

WebSiteHttpsPort

You can specify any available port. Verify that the

None

port is open in Windows firewall. Also, note the port


number. The port is used to create the URL for Retail
Server in the format: https://<server
name>:port/<web application name>. This URL is
required to activate Modern POS devices that
connect to Retail Server.
WebApplicationName

The name of an existing web application or the name

HardwareStation

of an application that you want Setup to create.


WebSiteSSLCertificateSto

The Certificates store specified when the certificate

My

re

was created or imported.

WebSiteSSLCertificateRo

The server where the certificate is stored.

LocalMachine

The folder where you want PowerShell to create a

%SystemDrive%\inetpub\H

new IIS virtual directory.

ardwareStation

Enter a domain account for the application pool.

None

otStore
WebSiteWorkingFolder

WebAppPoolUser

Enter the account in the form


value="Domain\User".
WebSiteSSLCertificateTh

The thumbprint for your Secure Sockets Layer (SSL)

umbprint

encryption certificate. You must obtain a valid,

None

registered certificate from a provider.


Because this component uses Secure Sockets Layer
(SSL) encryption, you must install a server certificate
that was issued by a trusted certification authority.
(For test environments, you can create a self-signed
certificate in IIS.) You will need to paste the
thumbprint for the certificate into the settings file. To
view the thumbprint in IIS Manager, double-click the
certificate and click the Details tab. We recommend
that you paste the thumbprint into a text file and
remove all spaces before you paste it into the
settings file.
WebApplicationServiceBi

By default, this folder is:

narySourceFolder

C:\Program Files (x86)\Microsoft Dynamics

None

AX\60\HardwareStation\Package folder
WebApplicationWorking

The folder from where the web service will run. You

[RetailServerWebSiteWorki

Folder

can specify the

ngFolder]\[RetailServerWe

WebApplicationServiceBinarySourceFolder or any

bApplicationName]

available folder.

Microsoft Dynamics AX 2012 Installation Guide

270

Microsoft Dynamics AX

Parameter

What to enter

Default value

RetailServerURL

The URL specified when Retail Server was installed.

None

By default, the URL uses the following format:


https://<ServerName>:Port/<WebApplicationName>

5.

Save your changes .

Run PowerShell scripts to deploy and configure Hardware Station


After you configure the parameters in the hs-settings.xml file, you can run the Windows PowerShell scripts
that deploy and configure Hardware Station.
1.

On the server where you want to run the script, open the folder where the PowerShell scripts are
installed. By default, the files are located at C:\Program Files (x86)\Microsoft Dynamics
AX\60\HardwareStation\Tools

2.

If youre using Windows Server 2012 or a later operating system, use Windows Explorer to open the
folder where the scripts are installed. Then click File > Open Windows PowerShell > Open Windows
PowerShell as administrator.
If youre using Windows Server 2008 R2 or an earlier operating system, start Windows PowerShell as
the administrator. Then, change the directory by using the following command: CD <Path to directory>.

3.

In the Windows PowerShell console, run the following command to create a credential object in
Active Directory for the service account. Replace domain\useraccount and password with
credentials that have permission to create sites in IIS:
$Cred = @((New-Object
System.Management.Automation.PSCredential(domain\useraccount',(ConvertTo-SecureString
'password' -AsPlainText -Force))))

4.

Run the following command to deploy and configure Hardware Station:


.\DeployHardwareStation.ps1 -SettingsXmlFilePath .\hs-settings.xml -TopologyXmlFilePath
.\hs-topology.xml -Credentials $Cred Verbose $true

For example:
.\DeployHardwareStation.ps1 -SettingsXmlFilePath "C:\Program Files (x86)\Microsoft Dynamics
AX\60\HardwareStation\Tools\hs-settings.xml" -TopologyXmlFilePath "C:\Program Files
(x86)\Microsoft Dynamics AX\60\HardwareStation\Tools\hs-topology.xml" -Credentials $Cred
Verbose $true

After you install Hardware Station


For information about how to install Modern POS, see Install Modern POS. To install Retail Server, see
Install Retail Server.

Microsoft Dynamics AX 2012 Installation Guide

271

Microsoft Dynamics AX

Install a Microsoft Dynamics AX Retail online store (ecommerce)


This topic describes how to install a Microsoft Dynamics AX Retail online store. The Retail online store is
also called the Microsoft Dynamics AX e-commerce store. This topic includes procedures for single server
and server farm deployments. You can install the online store by using Setup.exe or by using PowerShell
scripts. Both options are described in this topic. After you complete the installation procedures described
in this topic, a starter store is deployed in your computing environment. You can then configure,
customize, and rebrand the starter store to meet your needs.
This topic includes the following sections.

Before you begin

Install the Retail online store by using Setup

Deploy the Retail online store by using Windows PowerShell

Verify deployment

Next steps for developers

Before you begin


You must complete the following tasks before you deploy the Microsoft Dynamics AX Retail online store.
Task

Details

Verify that your computing environment

meets all system requirements

Verify that the SharePoint server(s) that will host the Retail
online store meet the following requirements: 16 GB of RAM
recommended; 10 GB of RAM and 4 processors, minimum.

Verify that the SQL server is not running SQL Express. The retail
online store is not supported with SQL Express.

Verify that the server is not a domain controller. Deployment


fails if the server is a domain controller.

For more information about system requirements, see Hardware and


software requirements
(http://technet.microsoft.com/library/9119f383-fc94-48c2-8e774eb83c656779(AX.60).aspx).
Install URL Rewrite

Verify that you installed the URL Rewrite Module 2.0


(http://go.microsoft.com/fwlink/?LinkID=277134&clcid=0x409) (64bit) on each SharePoint server.

Microsoft Dynamics AX 2012 Installation Guide

272

Microsoft Dynamics AX

Task

Details

Deploy and configure SharePoint

Deploy and configure SharePoint Server 2013, Service Pack 1 or


later (Enterprise Edition). For more information, see Overview of
SharePoint 2013 installation and configuration
(http://go.microsoft.com/fwlink/?LinkId=286388)

Download and install all cumulative updates for SharePoint


Server 2013. To improve update installation times, use the
PowerShell script described in this MSDN blog
(http://go.microsoft.com/fwlink/?LinkId=393181).

Verify that Microsoft Dynamics AX and all

Install Microsoft Dynamics AX 2012

updates are installed in your computing

(http://technet.microsoft.com/library/fbe52b68-1294-4398-

environment

b233-f8ec37c6d531(AX.60).aspx)

Apply updates and hotfixes


(http://technet.microsoft.com/library/7ff68f32-bb5e-4572-a2059fb759ebd0ba(AX.60).aspx)

Verify that Microsoft Dynamics AX Retail

You must install the following Retail features:

features are installed in your computing

Retail headquarters

Commerce Data Exchange components

Retail SDK

Retail channel database

environment

For more information, see Install retail components


Prepare the developer environment

Set up the development environment for a Retail online store

Verify that SharePoint application pools are

Verify that all SharePoint application pools are running in IIS

running in IIS

Manager.
Important:
If the SharePoint Web Services Root application pool is
stopped, you must start it.

Verify that required SharePoint services are

In SharePoint Central Administration, click Application

running

Management > Service Applications > Manage Services on


Server and verify that, at a minimum, the following services are
running:

Central Administration

Managed Metadata Web Service

Microsoft SharePoint Foundation Workflow Timer Service

Microsoft SharePoint Foundation Web Application

Search Host Controller Service

Search Query and Site Settings Service

SharePoint Server Search

Microsoft Dynamics AX 2012 Installation Guide

273

Microsoft Dynamics AX

Task

Details

Verify role requirements

If you did not install and configure Microsoft Dynamics AX,


verify that you are a member of the system administrator role in
Microsoft Dynamics AX.

If you did not install and configure SharePoint, verify that you
are a member of the farm administrator role in SharePoint and
that you have administrator access to each site collection in the
farm.

If you did not install and configure Microsoft SQL Server,


Microsoft Dynamics AX, or SharePoint, verify that you are a
member of the sysadmin role on the Microsoft Dynamics AX
databases and all SharePoint databases.

Create domain user accounts

Verify or create the following domain accounts. You will specify these
accounts when you deploy the Retail online store later in this topic.

Product Catalog Web App Pool User: This account must be a


member of the SharePoint Farm Administrators group so that it
can edit properties in the root web site. This account will be
specified later in this topic.

StoreFront Web App Pool User: This account must be a


member of the SharePoint Farm Administrators group so that it
can edit properties in the root web site. This account will be
specified later in this topic.

STS Web App Pool User: This account must be a member of


the SharePoint Farm Administrators group so that it can edit
properties in the root web site. This account was specified when
you installed SharePoint. It is the account under which the
Security Token Service application pool runs in IIS Manager.

Retail Job User: This account was specified when you installed
SharePoint. It is the account under which the SharePoint Timer
Service runs.

Acquire Secure Sockets Layer (SSL)

Encryption settings: The Retail store publishing portal uses SSL

certificates

encryption. For production environments, you must register your


domain and obtain a valid, registered SSL certificate from a provider.
For developer and evaluation environments, you can use a selfsigned certificate (http://go.microsoft.com/fwlink/?LinkId=235235).
For information about how to work with certificates see Certificate
Overview (http://go.microsoft.com/fwlink/?LinkId=282620).

Microsoft Dynamics AX 2012 Installation Guide

274

Microsoft Dynamics AX

Verify SharePoint Managed Metadata connection properties


You must verify that the SharePoint Managed Metadata connection required options are enabled.
1.

In SharePoint Central Administration, under Application Management, click Manage service


applications.

2.

Highlight the Managed Metadata Service Connection row and then click Properties.

3.

Verify that the following options are selected:

4.

Save your changes.

Microsoft Dynamics AX 2012 Installation Guide

275

Microsoft Dynamics AX

Prepare your developer environment for signing updated source code


After you install the online store as described in this topic, you will be ready to customize the store you
deployed. The process of customizing the Retail online store requires that you recompile the source code
in the Visual Studio projects. After you recompile, the fully-qualified name of the rebuilt assemblies will be
different than the assemblies originally provide by Microsoft. Before you can recompile the assemblies,
you must provide a code signing key file (also called a strong name key file) to sign the customized code.
If your business has a code signing key file (.snk file), you can reuse this file. If you do not have a code
signing key file, Visual Studio can create one for you. You must create a new project and enable code
signing. Then, create a second project that references the .dll of the output of the first project. You can
locate the thumbprint in the assembly reference of the .csproj file in the second project. Once you have
the .snk file, you must do the following:
1.

Save the file in the Retail SDK folder and give it a name Name.snk.

2.

Edit the UpdateAssemblyIdentities.ps1 file in the Retail SDK folder. You must update the version
number and the thumbprint of the key file (lines 97, 98).

3.

Update the source code to use the strong name certificate by executing the
UpdateAssemblyIdentities.ps1 script. This script can take several minutes to complete.

Additional steps and recommendations for developers are described in the Next steps for developers
section in this topic.

Install the Retail online store by using Setup


You can install the Retail online store by using Microsoft Dynamics AX Setup or by using Windows
PowerShell scripts. If you prefer to install the Retail online store manually, see Install the Retail online store
by using Windows PowerShell in this topic.
If you install other Microsoft Dynamics AX components at the same time, the installation pages vary,
depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select installation type page, click Custom installation, and then click Next.

5.

On the Select components page, select Retail online channel, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Configure a Microsoft Dynamics AX Retail online store page, enter the following
information about the web site where Retail Server will run.

Configure Retail online store: On the Configure the Retail online channel page, select the
check box to configure online store by using Setup. If you clear this option, the application files
are installed, but the online store is not deployed or configured.
If youre configuring Retail Server, enter the following information:

Microsoft Dynamics AX 2012 Installation Guide

276

Microsoft Dynamics AX

Storefront to deploy: Select a Retail starter store to deploy. The Contoso starter store is modeled
after an online electronics retailer. The Fabrikam starter store is modeled after an online clothing
retailer.

Database server: The name of the server that will host the Retail online store databases

Channel database name: The name of the Retail channel database. If this database does not
exist, you must cancel Setup and install a Retail channel database.

User name and Password: The credentials for a domain account that has permission to create
web applications and execute PowerShell scripts in SharePoint.

Pfx file path: The path to the Pfx file for the SSL certificate.
Important:
This path cannot contain any special characters. If the path contains a special character
deployment fails.

Password: The password for the Pfx file.

Channel operating unit number: A channel operating unit number is specified when you create
an online channel in the Microsoft Dynamics AX client. You must create the channel before you
deploy the Retail online store. To locate this operating unit number, click Retail > Retail
channels > Online Stores.

8.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

9.

On the Ready to install page, click Install.

10. After the installation is completed, click Finish to close the wizard.
If the deployment succeeded, proceed to the Verify deployment section in this document. If the
deployment failed check the Microsoft Dynamics AX log file and the Windows event logs for information.

Deploy the Retail online store by using Windows PowerShell


Use this procedure to install the Retail online store manually by using Windows PowerShell. Manual
installations are often performed by businesses and organizations that automate deployments by using
scripts.

Extract installation files


Use Microsoft Dynamics AX Setup to extract the files that are needed for manual installation. Perform this
procedure on the SharePoint server that will host the online store.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select installation type page, click Custom installation, and then click Next.

5.

On the Select components page, select Retail online channel, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

277

Microsoft Dynamics AX
6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Configure a Microsoft Dynamics AX Retail online store page, clear the Configure Retail
online store option. Click Next.

8.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

9.

On the Ready to install page, click Install.

10. After the installation is completed, click Finish to close the wizard. Setup extracts files and creates the
following folder on the local server:
C:\Program Files (x86)\Microsoft Dynamics AX\60\Retail Online Channel

Configure settings in the Retail online store xml file


After you extract the installation files by using Setup, you must configure settings in the oob-settings.xml
file.

Before you begin


If you deployed SharePoint on Windows Server 2012, then you must complete the following procedure to
ensure that the Microsoft.Web.Administration.dll is not overwritten in the global assembly cache when
you execute deployment scripts later in this topic. You do not need to perform this procedure on
Windows Server 2008 R2.
1.

Open the manifest.xml file in the following directory on the SharePoint server:
C:\...\Retail Online Channel\StoreFront\SP

2.

Delete the following line of code from the manifest.xml file:


<Assembly Location="Microsoft.Web.Administration.dll" DeploymentTarget="GlobalAssemblyCache"
/>

3.

Save and close the file.

The Microsoft.Web.Administration.dll in the global assembly cache will not be overwritten when you
execute PowerShell commands later in this topic.
Configure settings in the oob-settings.xml file
This section describes how to configure settings in the oob-settings.xml file.
1.

Open the following directory:


C:\Program Files (x86)\Microsoft Dynamics AX\60\Retail Online Channel\tools

2.

Open the oob-settings.xml file in Microsoft Visual Studio or a text editor, such as Notepad.

Microsoft Dynamics AX 2012 Installation Guide

278

Microsoft Dynamics AX
3.

Enter a value for the following parameters:


Parameter

What to enter

Default

StoreFront_Name

Enter the name of the online store to deploy. You must

Contoso

enter either Contoso or Fabrikam.


StoreFront_Design

Microsoft Dynamics AX uses this value to determine which

Default

customizations to apply to the publishing portal. Change


this value if, for example, a developer creates a new design
template.
StoreFront_CountryCode

Enter an ISO country code. This code displays the country

USA

string, for example, when a customer places an order.


Customers of your site do not see this code. This value is
not published.
StoreFront_CountryName

Enter the name of the country. Customers of your site do

United States

not see this code. This value is not published.


StoreFront_Currency

Enter a currency template. This template determines how

${0}

Template

currency amounts are displayed in the online store.

SharepointPackageInstance

Enter any alpha-numeric value to uniquely identify this

None, but we

Identifier

deployment. This value must be unique across all Retail

recommend a

online store deployments in the server farm.

value of 1

StoreFront_ItemAvailability

Enter a threshold value for the number of items in stock for

10

Threshold

any product. If the number of items in stock for a specific


product is below this value, the system could display a
banner to the customer that lets them know how many
items are left in stock. A developer would need to
customize the store to create a banner.

StoreFront_ShoppingCart

Enter the number of days to retain a shopping cart. If no

ExpiryTerm

value is entered, the store deletes the shopping cart after 24

None

hours.
StoreFront_LanguageId

Enter a language code identifier (LCID). This ID must match

1033

the language pack for your SharePoint deployment. For


more information about deploying the online store in
multiple languages, see Install multiple Microsoft Dynamics
AX Retail online stores
(http://technet.microsoft.com/library/eaaf0114-934b-46448d77-16e39cace6d2(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

279

Microsoft Dynamics AX

Parameter

What to enter

Default

StoreFront_DeviceChannels

This value is the name of a SharePoint Design Manager list

Device Channels

ListName

that stores device channels. For more information about


device channel lists, see SharePoint 2013 Design Manager
device channels
(http://go.microsoft.com/fwlink/?LinkId=394743). The name
of this value varies based on locale. For example, if you are
deploying the online store by using the en-US locale then
the name should be Device Channels. If you are deploying
for an online store for fr-FR (French) locale then this name
should be Canaux des appareils.
Note:
The value of this property and the value of the
previous property
(StoreFront_DeviceChannelsListName) work
together. For example, an en-US online store uses
the 1033, Device Channels values and an fr-FR
online store uses the 1036, Canaux des appareils
values.

LoggingServiceName

The name of the logging service for this deployment as it

Dynamics AX

appears in SharePoint Central Administration. You can

Retail Logging

change the default string value (Dynamics AX Retail

Service

Logging Service) if you want. However, we recommend that

[SharepointPacka

you do not change the place holder value

geInstanceIdentifi

([SharepointPackageInstanceIdentifier]) unless you are a

er]

developer and understand the repercussions of making a


change.
LoggingCategoryName

The SharePoint diagnostics logging category where events

General Logging

for this deployment will be logged. We recommend that

[SharepointPacka

you do not change the place holder value

geInstanceIdentifi

([SharepointPackageInstanceIdentifier]) unless you are a

er]

developer and understand the repercussions of making a


change.
MonitoringEventLogSource

For events logged in the Windows NT Event Viewer, this

Dynamics AX

Name

parameter identifies the source of the event. You can

Retail Monitoring

change the string value (Dynamics AX Retail Monitoring) if

[SharepointPacka

you want. However, we recommend that you do not change

geInstanceIdentifi

the place holder value

er]

([SharepointPackageInstanceIdentifier]) unless you are a


developer and understand the repercussions of making a
change.
--------------------

Microsoft Dynamics AX 2012 Installation Guide

280

Microsoft Dynamics AX

Parameter

What to enter

Default

The port for the public online store site: You can specify

40002

any available port.

50002 for the

PORTS and URLS


-------------------StoreFrontUrlPort_Public

Fabrikam starter
store
StoreFrontUrlPort_SSL_Publ The port for the public online store site for encrypted

40004

ic

50004 for the

communications: You can specify any available port.

Fabrikam starter
store
StoreFrontUrlPort_Internal

The port for the internal online store site: You can specify 40003
any available port. This URL is only accessed by domain
users with permission to make changes to the site collection
by using SharePoint site settings. It is not required, but you
can change this port value if you want the internal online

50003 for the


Fabrikam starter
store

store to use a different port.


ProductCatalogUrlPort_Inte

The port for the internal product catalog site: You can

40001

rnal

specify any available port. This URL is only accessed by

50001 for the

domain users with permission to make changes to the site


collection by using SharePoint site settings. It is not
required, but you can change this port value if you want the

Fabrikam starter
store

internal product catalog to use a different port.


ResetSearchIndex

Setting this parameter to true clears the SharePoint index

False

cache and initiates a full crawl across the farm.


StoreFrontSiteCollectionRo

The local web address of the Retail online store (as opposed

http://%COMPUT

otUrl_FormsAuth

to a public address like www.contoso.com.) Enter a valid

ERNAME%:[Store

server name and remove the % signs. We recommend that

FrontUrlPort_Publ

you do not change the place holder value

ic]

([StoreFrontUrlPort_Public]) unless you are a developer and


understand the repercussions of making a change.
StoreFrontSiteCollectionRo

The local web address of the 40003 site. Enter a valid server

http://%COMPUT

otUrl_WindowsAuth

name and remove the % signs. We recommend that you do

ERNAME%:[Store

not change the place holder value

FrontUrlPort_Inter

([StoreFrontUrlPort_Internal]) unless you are a developer

nal]

and understand the repercussions of making a change.


StoreFrontSiteCollectionRo

This is the customer facing URL. For example with a port 80

http://www.[Store

otUrl_FormsAuth_Public

site, it could be http://www.contoso.com. With a port 3000

Front_Name].com

site it could be http://www.contoso.com:3000.

:[StoreFrontUrlPor
t_Public]

Microsoft Dynamics AX 2012 Installation Guide

281

Microsoft Dynamics AX

Parameter

What to enter

Default

StoreFrontSiteCollectionRo

The internal URL for the online store encrypted

https://%COMPU

otUrl_SSL_FormsAuth

communications site: Enter a valid server name and

TERNAME%:[Stor

remove the % signs. We recommend that you do not

eFrontUrlPort_SSL

change the place holder value

_Public]

-------------------SSL
--------------------

([StoreFrontUrlPort_SSL_Public]) unless you are a developer


and understand the repercussions of making a change.
StoreFrontSiteCollectionRo

The public URL for the online store encrypted

https://www.[Stor

otUrl_SSL_FormsAuth_Publi

communications site: The https site customers use for

eFront_Name].co

secure transactions and processing.

m:[StoreFrontUrlP
ort_SSL_Public]

PublishingPortalRelativePa

This relative path is combined with URLs specified earlier to

/sites/RetailPublis

th

create a complete path for the publishing portal. We

hingPortal

recommend that you do not leave this blank and use a


format similar to /sites/XYZ. Leaving this field blank would
require customizations to the oob-topology.xml file, and
should be attempted by advanced users only.
StoreFrontPublicSSLCertTh

The thumbprint for your Secure Sockets Layer (SSL)

umbprint

encryption certificate. You must obtain a valid, registered

None

certificate from a provider.


Because this component uses Secure Sockets Layer (SSL)
encryption, you must install a server certificate that was
issued by a trusted certification authority. (For test
environments, you can create a self-signed certificate in IIS.)
You will need to paste the thumbprint for the certificate into
the settings file. To view the thumbprint in IIS Manager,
double-click the certificate and click the Details tab. We
recommend that you paste the thumbprint into a text file
and remove all spaces before you paste it into the settings
file.
StoreFrontPublicSSLCertDir

The source directory where Microsoft Dynamics AX retrieves

ectory

the .pfx file for the SSL certificate. This value can be a

None

network share.
Important:
This path cannot contain any special
characters. If the path contains a special
character deployment fails.

Microsoft Dynamics AX 2012 Installation Guide

282

Microsoft Dynamics AX

Parameter

What to enter

Default

StoreFrontPublicSSLCertLo

The destination folder where Microsoft Dynamics AX stores

None

calDirectory

a local copy of the certificate. This location cannot be the


same as the StoreFrontPublicSSLCertDirectory value.
Important:
This path cannot contain any special
characters. If the path contains a special
character deployment fails.

StoreFrontPublicSSLCertPf

Enter the file name and extension. By default the extension

xFileName

is .pfx.

None

To create a .pfx file for a self-signed certificate, you must


export the certificate from IIS Manager. To do this, rightclick the certificate, click Export, and then complete the
export wizard. You must then import the .pfx file into the
local certificate store. Right-click the .pfx file in the directory
where you just created it, click Import, and then complete
the import wizard.
StoreFrontPublicSSLCertPf

Enter the password of the .pfx file. This password cannot

xPassword

contain any restricted XML characters such as the following:

None

exclamation point (!), greater than sign (<), less than sign
(>), ampersand (&), apostrophe (), or a quotation mark ().
-------------------DOMAIN ACCOUNTS and
MISCELLANEOUS
-------------------StoreFrontWebAppPoolUse

Enter a domain account for the application pool of the

online store. Enter the account in the form

None

value="Domain\User". This account must be a member of


the SharePoint Farm Administrators group because it must
edit properties in the root web site.
ProductCatalogSiteCollecti

The local web address of the product catalog. Enter a valid

http://%COMPUT

onRootUrl_WindowsAuth

server name and remove the % signs. We recommend that

ERNAME%:[Produ

you do not change the place holder value

ctCatalogUrlPort_I

([ProductCatalogUrlPort_Internal]) unless you are a

nternal]

developer and understand the repercussions of making a


change.

Microsoft Dynamics AX 2012 Installation Guide

283

Microsoft Dynamics AX

Parameter

What to enter

Default

ProductCatalogWebAppPo

Enter a domain account for the application pool of the

None

olUser

catalog site. Enter the account in the form


value="Domain\User". This account must be a member of
the SharePoint Farm Administrators group because it must
edit properties in the root web site.

ProductCatalogName

STSWebAppPoolUser

Enter any name for the product catalog. This value is not

Retail Product

displayed to customers.

Catalog

This account must be a member of the SharePoint Farm

None

Administrators group. Also, this is the domain account used


by the Security Token Service Application Pool. You
specified this account when you installed SharePoint. To
locate the account in IIS Manager, click Application Pools,
right-click SecurityTokenServiceApplicationPool, and
then click Advanced Settings. The account for this
application pool is listed under Process Model > Identity.
Enter the account in the form value="Domain\User".
RetailJobUser

This account must be a member of the SharePoint Farm

None

Administrators group. Also, this is the account used by the


SharePoint Timer service. You specified this account when
you installed SharePoint. Enter the account in the form
value="Domain\User".
ChannelOperatingUnitNum

A channel operating unit number is specified when you

ber

create an online channel in the Microsoft Dynamics AX

None

client. You must create the channel before you deploy the
Retail online store. To locate this operating unit number,
click Retail > Retail channels > Online Stores.
DestinationId

A value that uniquely identifies an endpoint to Commerce

None

Runtime (CRT). This value must be a GUID. If necessary,


create a GUID by using Visual Studio.
PublishingConnectorServic

A comma-separated list of servers where the Retail online

eInstanceServers

store publishing job must run. The PowerShell script is case

None

sensitive. For example, value="RetailTestOne,


RetailTestTwo" />.
FarmAdministratorAlias

Enter a domain account and alias of a SharePoint farm

None

administrator. Enter the account in the form


value="Domain\User".
FarmAdministratorEmail

Enter the e-mail address of a SharePoint farm administrator.

None

Enter the address in the form


value="Username@ YourDomain .com".

Microsoft Dynamics AX 2012 Installation Guide

284

Microsoft Dynamics AX

Parameter

What to enter

SharePointRelyPartyUrl

Default
https://www.[Stor
eFront_Name].co
m:[StoreFrontUrlP
ort_SSL_Public]/_t
rust/

-------------------DATABASE DETAILS
-------------------ChannelDatabaseServerNa

If you have not already done so, use Microsoft Dynamics AX

me

Setup.exe to deploy a Retail channel database. For this

None

parameter, enter the server name. The PowerShell script is


case sensitive. For example, value="RetailTestOne" />.
ChannelDatabaseServerNa

If you installed the retail channel database as part of a SQL

medInstanceName

named instance, enter the named instance. This parameter

None

cannot be empty. The format for a SQL instance name is


either the server name or the full instance name. For
example, valid names are: "localhost", "localhost\instance2",
"server1", "server1\instance2".
ChannelDatabaseName

If you have not already done so, use Microsoft Dynamics AX

None

Setup.exe to deploy a Retail channel database. For this


parameter, enter the database name.
IdentityProviderDatabaseS

The identity provider database is used for authentication

erverName

and authorization of online store registered users. If there

None

are multiple Retail online store deployments in the same


farm, then the IdentityProviderDatabase and
CustomClaimsProviderDatabase must be the same for all
Retail online store deployments in the farm. Enter a server
name. The PowerShell script is case sensitive. For example,
value="RetailTestOne" />.
IdentityProviderDatabaseS

The identity provider database is used for authentication

erverNamedInstanceName

and authorization of online store registered users. If there

None

are multiple Retail online store deployments in the same


farm, then the IdentityProviderDatabase and
CustomClaimsProviderDatabase must be the same for all
Retail online store deployments in the farm. Enter a server
name. The PowerShell script is case sensitive. For example,
value="RetailTestOne" />.

Microsoft Dynamics AX 2012 Installation Guide

285

Microsoft Dynamics AX

Parameter

What to enter

Default

CustomClaimsProviderData

The custom claims provider database is used for

None

baseServerName

authentication and authorization of online store registered


users. If there are multiple Retail online store deployments
in the same farm, then the IdentityProviderDatabase and
CustomClaimsProviderDatabase must be the same for all
Retail online store deployments in the farm. Enter a server
name. The PowerShell script is case sensitive. For example,
value="RetailTestOne" />.

CustomClaimsProviderData

If you installed the custom claims provider database as part

baseServerNamedInstance

of a SQL named instance, enter the named instance. You

Name

can leave this parameter empty if the database is not part

None

of a named instance.
BingMapsId

If you want your Retail online store to work with Bing Maps,

None

then you must register with Bing Maps. Specify the Bing
Maps ID here.
ShowDebugErrorMessages

For a testing environment, set this value to True to see

None

detailed error messages in the online store. For production


sites set the value to False.

Important:
To keep a record of the settings and parameters you specified, we recommend that you make a
copy of the oob-settings.xml file after you finished entering parameters.
Configure Facebook integration
The Retail online store can authenticate users who sign in to your site by using their Facebook credentials.
This section describes how to configure your environment for Facebook authentication.
Important:
Facebook integration is optional. However, if you do not want to use Facebook authentication,
then you must disable this feature in the oob-topology.xml file. If you do not disable it, the
deployment scripts fail. For more information, see Disable Facebook integration later in this
topic.
Create a Facebook application: Use the following procedure to create a Facebook application that
enables Facebook logon to your site.
1.

Logon to the Facebook developer site (https://developers.facebook.com/apps)

2.

Register as a developer on the Facebook developer site.

3.

Click Create New App and then follow the prompts to create a new application.

4.

In the Select how your application integrates with Facebook section, click the Website with
Facebook Login option and specify the Site URL.

5.

Click Save Changes.

Microsoft Dynamics AX 2012 Installation Guide

286

Microsoft Dynamics AX
6.

On the applications landing page, select the application that you just created.

7.

In the oob-settings.xml file, search for FacebookApplicationId. Replace the value with the Facebook
ID. Retain the quotation marks.

8.

In the oob-settings.xml file, search for FacebookApplicationSecret. Replace the value with the secret
you created for your Facebook application. Retain the quotation marks.

9.

Save your changes in the oob-settings.xml file.

Certificates: Use the following procedure to create certificates for Facebook authentication. For
production environments, you must register your domain and obtain a valid, registered SSL certificate
from a provider. For developer and evaluation environments, you can use a self-signed certificate
(http://go.microsoft.com/fwlink/?LinkId=235235). For information about how to work with certificates see
Certificate Overview (http://go.microsoft.com/fwlink/?LinkId=282620).
1.

Search in the oob-settings.xml file for the parameters listed in the following table. Enter a value for
each parameter. For each value, retain quotation marks () but remove percent signs (%).
Parameter

What to enter

FacebookApplicationId

The ID created when you registered a Facebook application.

FacebookApplicationSecret

The secret specified when you registered a Facebook application.

FacebookCertificateDirectory

The source directory where Microsoft Dynamics AX retrieves the .pfx


file for the SSL certificate. This value can be a network share.

FacebookCertificateLocalCopyDirect

The destination folder where Microsoft Dynamics AX stores a local

ory

copy of the certificate. This location cannot be the same as the


StoreFrontPublicSSLCertDirectory value.

FacebookSigningCertificateCerFileNa

Enter a value with the name of the certificate .cer file in the form

me

value=" CertificateName .cer".

FacebookSigningCertificatePfxFileNa

Enter a value with the name of the certificate .pfx file in the form

me

value=" CertificateName .pfx".

FacebookSigningCertificatePfxPassw

This is a password for a test certificate. For production environments,

ord

do not enter a password here. It will be prompted during deployment.


This password cannot contain any restricted XML characters such as
the following: exclamation point (!), greater than sign (<), less than
sign (>), ampersand (&), apostrophe (), or a quotation mark ().

Microsoft Dynamics AX 2012 Installation Guide

287

Microsoft Dynamics AX

Parameter

What to enter

FacebookSigningCertificateThumbpri The thumbprint for your Secure Sockets Layer (SSL) encryption
nt

certificate. You must obtain a valid, registered certificate from a


provider.
Because this component uses Secure Sockets Layer (SSL) encryption,
you must install a server certificate that was issued by a trusted
certification authority. (For test environments, you can create a selfsigned certificate in IIS.) You will need to paste the thumbprint for the
certificate into the settings file. To view the thumbprint in IIS Manager,
double-click the certificate and click the Details tab. We recommend
that you paste the thumbprint into a text file and remove all spaces
before you paste it into the settings file.

FacebookSignInUrl

The page that will contact Facebook to authenticate users. For


example:
http://www.[StoreFront_Name].com:[StoreFrontUrlPort_Public][Publish
ingPortalRelativePath]/pages/Login.aspx

FacebookSslCertificateAuthorityCerFi Enter the file name.


leName
FacebookSslCertificateAuthorityThu

Enter the thumbprint. Remove all spaces.

mbprint

2.

Save your changes in the oob-settings.xml file.


Note:
You can enable Facebook integration in developer environments that are not using a fully
registered domain name (for example, www.DomainName.com). To do this, you must create host
file entries on each computer that will browse the online store. The URL for host file entries must
be in the form: http://www.DomainName.com/sites/RetailPublishingPortal.

Update the prerequisite script for Facebook


A known issue in this version of the Microsoft Dynamics AX Retail online store can cause an installation to
fail if you configure Facebook as an identity provider. If you plan to use Facebook as an identity provider,
perform the following procedure before you install the online store. If you do not plan to use Facebook as
an identity provider, you can skip this procedure.
1.

Open the following folder:


C:\Program Files (x86)\Microsoft Dynamics AX\60\Retail Online Channel\tools

2.

Open the Install-Prerequistes.ps1 file in Microsoft Visual Studio.

3.

Search for line 155:


RoboCopy $trustedIdentityTokenIssuerConfig.CertificateDirectory
$certificateLocalCopyDirectory
$trustedIdentityTokenIssuerConfig.SigningCertificateCerFileName
$trustedIdentityTokenIssuerConfig.SigningCertificatePfxFileName

Microsoft Dynamics AX 2012 Installation Guide

288

Microsoft Dynamics AX
4.

Replace that line with the following:


RoboCopy $trustedIdentityTokenIssuerConfig.CertificateDirectory
$certificateLocalCopyDirectory
$trustedIdentityTokenIssuerConfig.SigningCertificateCerFileName
$trustedIdentityTokenIssuerConfig.SigningCertificatePfxFileName
$trustedIdentityTokenIssuerConfig.SslCertificateAuthorityCerFileName

5.

Save your changes.

Disable Facebook integration


If you do not want to enable Facebook authentication for your Retail online store you must disable it, as
described in the following procedure. If you previously enabled and configured Facebook authentication
you can also use this procedure to disable it.
1.

Open the oob-topology.xml file in Microsoft Visual Studio or a text editor, such as Notepad.

2.

Search in the oob-topology.xml file for the parameter listed in the following table. Enter a value for
each parameter. For each value, retain quotation marks () but remove percent signs (%).
Search for

Enter

<TrustedIdentityTokenIssuer id="Facebook"

Change both flags to false. For example:

install="true" deleteifexists="true">

<TrustedIdentityTokenIssuer id="Facebook"
install="false" deleteifexists="false">

3.

Save your changes in the oob-topology.xml file.

Run PowerShell scripts to create and configure the online store


After you configure the parameters in the oob-settings.xml file, you can run the Windows PowerShell
scripts that deploy and configure the online store.
In this section, you will execute the following scripts to create and configure the online store.
InstallPrereqs-SPFarm
Generate-WSP
Deploy-FarmSolutions
Toggling options if re-running scripts
If you re-run the PowerShell deployment scripts in this section, by default, existing databases, web
applications, features, and settings are deleted. You can, however, toggle different parameters in the oobtopology.xml file to preserve databases, web applications, features, and settings. Preserving an object
means that you change a true flag to false. For example, in the oob-topology file, in the <Channel>
section, the Database is configured as follows.
<Database install="true" dropifexists="true">
By changing each flag to false the deployment scripts preserve the existing databases.

Microsoft Dynamics AX 2012 Installation Guide

289

Microsoft Dynamics AX

InstallPrereqs-SPFarm.ps1
This script performs the following actions on the server.
Area

Actions

Database actions performed by this script

Create Windows NT user groups

If you re-run the PowerShell deployment scripts in this

Add process users to Windows NT user groups

section, by default, existing Retail online store

Create SQL Server logins for Windows NT user groups

Creates trusted identity token issuer for Facebook

databases, web applications, features, and settings are


deleted. You can, however, toggle different
parameters in the oob-topology.xml file to preserve
databases, web applications, features, and settings, as
described earlier in this topic.
SharePoint Server actions performed by this script

integration (on every web front-end server, when


executed in a server farm)

Creates SharePoint web applications

Creates SSL binding (on every web front-end server,


when executed in a server farm)

Creates SharePoint sites

Configures sites and web application properties

Disables versioning of the Retail Online Store


Publishing Portal web application

Configures site URLS (for different zones)

Enables trusted authentication providers for Facebook


(if option was configured)

If you re-run this script, the system performs the following


actions before creating or configuring SharePoint. You can,
however, toggle options to preserve settings, as described
earlier in this document.

Deactivates Retail online store features

Removes WSP solution files, if installed

Deletes Retail online store sites

Removes SSL bindings (on every web front-end server,


when executed in a server farm)

Deletes Retail online store web applications

Deletes trusted identity token issuer (on every web


front-end server, when executed in a server farm)

Microsoft Dynamics AX 2012 Installation Guide

290

Microsoft Dynamics AX

Area

Actions

Other actions performed by the script

topology.xml and oob-settings.xml files exist

The script performs the following pre-deployment


checks, by default. You can customize which checks

Verifies that the folders and files referenced in the oob-

are performed.

Verifies that the configured database server can be


pinged.

Verifies that the SharePoint server names configured


for the publishing job are correct and that they are
joined to the current SharePoint farm.

Verifies that the SharePoint installation is of the correct


version. SharePoint 2013 is required.

Verifies that every SharePoint server that acts as an


application server has the URL Rewrite module
installed.

Verifies that any ports are not already used by web


applications with different names.

If any of these checks fail, the script will not perform the installation.
Run InstallPrereqs-SPFarm.ps1: Use the following procedures to run this script.
Warning:
SQL Server work-around for cumulative update 1
Cumulative update 1 has a known issue where the InstallPrereqs-SPFarm.ps1 script fails if SQL
Server is not installed on the server where you are running this script. If SQL Server is not installed
on the server and if you do not intend to install any databases, complete the following steps
before you run the InstallPrereqs-SPFarm.ps1 script.
1.

Open the following folder:


C:\Program Files (x86)\Microsoft Dynamics AX\60\Retail Online Channel\tools

2.

Open the Custom-Scripts.ps1 file in Microsoft Visual Studio or a text editor, such as Notepad.

3.

Search for and delete the following line of code:


(if((Test-Connection $value -Count 1 -Quiet) -ne $True))

4.

Save your changes.

Run the script


Note:
Windows PowerShell includes a security setting called the execution policy that determines how
scripts are run. By default, the execution policy is set to Restricted, which prevents any scripts
from running. To run the installation scripts for Microsoft Dynamics AX components, we
recommend that you set the execution policy to RemoteSigned by using Set-ExecutionPolicy
cmdlet. This setting allows you to run scripts that youve written and scripts that have been signed
by a trusted publisher.

Microsoft Dynamics AX 2012 Installation Guide

291

Microsoft Dynamics AX
1.

On the server where you want to run the script, open your copy of the tools folder where the
PowerShell scripts are installed.

2.

If youre using Windows Server 2012 or a later operating system, use Windows Explorer to open the
folder where the scripts are installed. Then click File > Open Windows PowerShell > Open Windows
PowerShell as administrator.
If youre using Windows Server 2008 R2 or an earlier operating system, start pw_wps as the
administrator. Then, change the directory by using the following command: CD <Path to
directory>.

3.

Run the following command to verify prerequisites for the online store:
.\InstallPrereqs-SPFarm.ps1 oob-topology.xml oob-settings.xml

When the system finishes the operation, you can run the next script.

Generate-WSP.ps1
This script creates a SharePoint solution package (.WSP file) for your computing environment. The
solution package includes properties such as connection strings, URLS, and ports from the oobtopology.xml and oob-settings.xml files. The solution package also includes binaries and static web files
that were deployed by Microsoft Dynamics AX Setup to the Retail Online Channel directory.
Run Generate-WSP.ps1:
In the Windows PowerShell console, run the following command to generate the WSP file for the online
store:
.\Generate-WSP.ps1 oob-topology.xml oob-settings.xml

Important:
Due to a known issue, the following script can fail with a file access error. If the script fails, re-run
it. It should finish successfully the second time.
When the system finishes the operation, you can execute the next script.

Deploy-FarmSolutions.ps1
This script performs the following actions on the server.

Deploys the new SharePoint solution package

Activates features

Runs post-deployment custom scripts (deploy mode)

If you re-run this script, the system performs the following actions before deploying the solution package
or activating features. You can toggle options to preserve settings, as described earlier in this document.
1.

Deactivates features

2.

Uninstalls solution packages

3.

Runs post-deployment custom scripts (retract mode)

Run Deploy-FarmSolutions.ps1:
In the Windows PowerShell console, run the following command to deploy the solution to SharePoint.
.\Deploy-FarmSolutions.ps1 oob-topology.xml oob-settings.xml

Microsoft Dynamics AX 2012 Installation Guide

292

Microsoft Dynamics AX
When the system finishes the operation, you can verify the deployment.

Verify deployment
If all deployment scripts completed without errors, use this section to help verify the online store
deployment.
Verify that the Connector Service is running: After a successful deployment, the Dynamics AX
Publishing Connector Service is running in SharePoint Central Administration. At this point, the service
displays an error No channel configuration could be found in the database, which means that the
channel has not been configured in Microsoft Dynamics AX yet. For information about configuring a
channel, see the section titled Set up the online store in Microsoft Dynamics AX in Online Store
(http://technet.microsoft.com/library/56364854-9730-4afa-8cf7-ae337ce2257a(AX.60).aspx).
Use the following procedure to verify that the Dynamics AX Publishing Connector service is running.
1.

In SharePoint Central Administration under System Settings, click Manage services on server.

2.

Verify that the Dynamics AX Publishing Connector service is running.

3.

In SharePoint Central Administration, click Monitoring, and then click Job Status.

4.

Verify that you see jobs listed for the C1 Application for Retail Store Front Internal and the Out
of box Store front Public.

Verify that site collections exist and can be browsed: After a successful deployment, you can view the
Retail online store web applications and site collections in SharePoint Central Administration. If you
specified different URLs for your web applications, you must adjust the URLS below accordingly.
Note:
If you installed the Fabrikam starter store, change port values below from the 40,000 range to the
50,000 range. For example: The Contoso starter store product catalog site is
http://ServerName:40001/sites/RetailProductCatalog. The Fabrikam starter store product catalog
site is http://ServerName:50001/sites/RetailProductCatalog.
1.

In SharePoint Central Administration, click Application Management, and then click View all site
collections.

2.

On the C1 Application for Retail Store Front Internal web application, copy the
http://ServerName:40001/sites/RetailProductCatalog URL and paste it into a browser. Verify that the
Welcome to your product catalog site displays.

3.

In SharePoint Central Administration, click the Web application drop-down list and then click
Change web application.

4.

Click the Out of box Store front Public web application.

5.

In the URL section, verify that you see the following URLs:
http://ServerName:40002/sites/RetailPublishingPortal
http://ServerName:40002

6.

Copy and paste each URL into a browser. Verify that you see the Contoso electronic superstore site
and the Contoso electronic superstore sign-in site. If the sign-in site displays a certificate warning,
click Continue to this web site. This warning appears if you used a self-signed certificate.

Microsoft Dynamics AX 2012 Installation Guide

293

Microsoft Dynamics AX
Verify that you can create and sign-in with a new forms-based user account: You should be able to
register a new user account and logon from the public URL. By completing the sign-up process you verify
SQL Server connectivity, SSL port settings, and SSL certificate bindings.
1.

Paste the public URL into a browser and press Enter. For example:
http://ServerName:40002/sites/RetailPublishingPortal

2.

Click Register a new account.

3.

Enter an email address and a strong password in the required fields and then click Create account.
Note that if you see more than one email and password field on the page, it means that you executed
the Deploy-FarmSolutions.ps1 script multiple times on this server. This is a known issue. To create the
forms-based user account, you must enter the email address and strong password in each field. Also
note that you receive an error after you register the account because the online channel has not been
configured in Microsoft Dynamics AX.

4.

Browse the public portal site again (http:// ServerName:40002/sites/RetailPublishingPortal).

5.

Click the Sign In link and enter the information for the account that you just created. The system logs
you onto the Contoso electronics site as a registered user.

Verify that you can browse the public URL: If you registered a domain, you should be able to browse
the web address for your site. For example, you should be able to browse
http://www.<your_domain>.com/sites/RetailPublishingPortal. If you have not yet registered the domain
then you must create a hosts file entry and disable proxy settings in your browser (if applicable) before
you attempt to browse the web address.

Next steps for developers


Step

Detail

Review the quick guide for

See Quick Guide: How to customize a Microsoft Dynamics AX for Retail

customizing the online store.

online store (http://technet.microsoft.com/library/bf349222-f278-446fbc27-e2fb2bf53ba0(AX.60).aspx).

Set up the online channel

After you deploy the Microsoft Dynamics AX Retail online store, you must
setup the online channel in Microsoft Dynamics AX. See the Online store
setup checklist. The checklist is available in the Microsoft Dynamics AX
client: Retail > Setup > Online store setup checklist.
Note:
If the online channel has already been set up in Microsoft
Dynamics AX then you only need to publish the channel and
publish a catalog. For information, see Publish an online store in
Set up an online store
(http://technet.microsoft.com/library/7150615f-3c60-498c-be7640e07d0c0ce6(AX.60).aspx) and Publish a catalog in Key tasks:
Create retail product catalogs
(http://technet.microsoft.com/library/e0af4c3e-0908-4bf9-8193522a102bb772(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

294

Microsoft Dynamics AX

Step

Detail

Customize and rebrand the starter

See the Extend section of the Online Store

store

(http://technet.microsoft.com/library/56364854-9730-4afa-8cf7ae337ce2257a(AX.60).aspx).

Deploy a second online store

Install multiple Microsoft Dynamics AX Retail online stores


(http://technet.microsoft.com/library/eaaf0114-934b-4644-8d7716e39cace6d2(AX.60).aspx)

Deploy to production

See Deploy your solution to a production environment in Quick Guide: How


to customize a Microsoft Dynamics AX for Retail online store
(http://technet.microsoft.com/library/bf349222-f278-446f-bc27e2fb2bf53ba0(AX.60).aspx).

Install retail mass deployment toolkit


The Retail mass deployment toolkit lets you use System Center Configuration Manager to deploy retail
components. Install the toolkit on the computer where the Configuration Manager console is installed.
To export retail topologies from Microsoft Dynamics AX, the toolkit must be able to connect to Microsoft
Dynamics AX via .NET Business Connector. To run all other toolkit operations that require Configuration
Manager, you must install the toolkit on the same computer as the central administration site for
Configuration Manager, if Configuration Manager has multiple primary sites. If Configuration Manager
has only one primary site, install the toolkit on the same computer as the primary site. You cant use the
toolkit on the computer for a secondary site.
Note:
The Retail mass deployment toolkit is available only with Microsoft Dynamics AX 2012 R3.

Before you install the Retail mass deployment toolkit


On the computer where you plan to install this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install the Retail mass deployment toolkit


Use this procedure to install the Retail mass deployment toolkit. If you install other Microsoft Dynamics
AX components at the same time, the installation pages vary, depending on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

Microsoft Dynamics AX 2012 Installation Guide

295

Microsoft Dynamics AX
3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Retail mass deployment toolkit, and then click Next.

7.

On the Connect to an AOS instance page, enter information about the AOS instance to connect to.
Click Next.

8.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

9.

On the Ready to install page, click Install.

10. After the installation is completed, click Finish to close the wizard.

After you the install Retail mass deployment toolkit


Follow these steps to initialize the toolkit.
1.

Share the content root folder. By default, the folder is located at C:\Program Files (x86)\Microsoft
Dynamics AX\60\Retail Scaleout Deployment\ConfigManagerContent. Note the folder location. You
must enter the Universal Naming Convention (UNC) path of this location when you run the
initialization command.

2.

Run the following command in the toolkit:


RetailConfigMgrToolkit.exe -o CreateApplications -contentRootFolder <UNC Path to the
content root folder>

3.

You are prompted to confirm that the application will open specific ports on your behalf on target
computers. Press Y to confirm.

See Also
Mass deploy Retail components (http://technet.microsoft.com/library/15ded62a-f6d3-44a4-8fe693e7f19ea558(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

296

Microsoft Dynamics AX

Install Retail SDK (Retail POS Plug-ins)


The Retail Software Development Kit (SDK) includes sample code and templates that can be used to
customize Retail for Microsoft Dynamics AX. For information about how to customize your Retail
implementation, see the Microsoft Dynamics AX developer documentation
(http://msdn.microsoft.com/en-us/library/aa155304.aspx) on MSDN.
Note:
Retail components are available only with Microsoft Dynamics AX 2012 R3, AX 2012 R2, and AX
2012 Feature Pack. In AX 2012 Feature Pack, the Retail SDK component is called Retail POS Plugins.

Before you install Retail SDK


On the computer where you plan to install this component, run the prerequisite validation utility to verify
that system requirements have been met. For information about how to run the prerequisite validation
utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see the
system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Retail SDK


Use this procedure to install Retail SDK. If you install other Microsoft Dynamics AX components at the
same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Retail SDK, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Ready to install page, click Install.

9.

After the installation is completed, click Finish to close the wizard.

Microsoft Dynamics AX 2012 Installation Guide

297

Microsoft Dynamics AX

Install Retail Essentials at headquarters


This topic explains how to install Retail essentials at headquarters.
Retail essentials is a retail-centric configuration option for Microsoft Dynamics AX. Retail essentials
provides a simplified, streamlined user experience that is optimized for organizations that use only the
retail management functions of Microsoft Dynamics AX.
Install and configure Retail essentials at headquarters before you install and configure Retail essentials at
the store. For more information about how to install Retail essentials at the store, see Install Retail
Essentials at the store or at the point of sale.
By default, the following components are included in the headquarters installation option for Retail
essentials.
Component

Description

Databases

Microsoft Dynamics AX Application Object Server (AOS)


connects to the Microsoft Dynamics AX database to process
transactions. AOS connects to the model store to display forms
and reports.

AOS

AOS is a Windows service that controls communications among


Microsoft Dynamics AX clients, databases, and applications.

Client

The Microsoft Dynamics AX client is the interface that is used to


connect to an AOS instance.

Web services on Internet Information Services (IIS)

Web services on IIS are not used in Retail essentials. You can
clear the check box for this component.

.NET Business Connector

.NET Business Connector for Microsoft Dynamics AX enables


applications to interact with AOS instances. .NET Business
Connector is required for Commerce Data Exchange: Real-time
Service.

Retail essentials

Retail essentials includes components that are required to use


Retail functionality in Microsoft Dynamics AX.

Commerce Data Exchange: Async Server

Async Server is part of the asynchronous system that shares


data between the Microsoft Dynamics AX database and channel
databases. Async Server is installed at headquarters and
communicates with Microsoft Dynamics AX.

Real-time Service

Real-time Service is an integrated service that provides realtime communication between Microsoft Dynamics AX and retail
channels. Real-time Service enables individual point of sale
(POS) computers to retrieve certain data from Microsoft
Dynamics AX in real time.

Microsoft Dynamics AX 2012 Installation Guide

298

Microsoft Dynamics AX

Component

Description

Data Import/Export Framework

The Data Import/Export Framework for Microsoft Dynamics AX


2012 is an extension that helps you import and export data in
Microsoft Dynamics AX.
This component is required if you plan to migrate data from
another system.

To view reports in Retail essentials, you must install Microsoft SQL Server Reporting Services and the
Reporting Services extensions for Microsoft Dynamics AX. For more information, see Checklist: Install the
Reporting Services extensions and deploy reports.

Before you install Retail essentials at headquarters

Select service accounts for AOS, the .NET Business Connector proxy, Real-time Service, Async Server,
and the Data Import/Export Framework. For information about the requirements for these accounts,
see Create service accounts.

On the computer where you plan to install these components, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Retail essentials at headquarters


Use this procedure to install Retail essentials at headquarters. If you select to install additional
components, or if you clear the default selections, the installation steps will vary.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next.

4.

On the Ready to install page, click Install.

5.

On the Select an installation option page, click Microsoft Dynamics Retail essentials. Select the
Headquarters option, and then click Next.

6.

On the Add or modify components page, the components that are required to install Retail
essentials at headquarters are automatically selected. Review and change the selections as you
require, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

On the Select a file location page, select the location in which to install 32-bit versions of Microsoft
Dynamics AX files, and then click Next.

9.

On the Select databases page, select whether you want to create new databases by using Setup, or
whether you want to configure existing databases.

Microsoft Dynamics AX 2012 Installation Guide

299

Microsoft Dynamics AX
10. If you want Setup to create the databases, on the Create new databases page, in the Server name
list, select the name of the computer that runs Microsoft SQL Server. Provide database names, or
accept the default database names. By default, the transaction database is named
MicrosoftDynamicsAX. The baseline database is optional. By default, the baseline database is named
MicrosoftDynamicsAXBaseline.
If you want to connect to an existing database, on the Connect to the databases page, select the
name of the computer that runs SQL Server, and then select the names of the existing databases to
configure.
Important:
The database name must not include any spaces or any of the following characters:
backslashes (\), slashes (/), periods (.), commas (,), colons (:), brackets ([ ]), parentheses (( )), or
hyphens (-). For more information about characters that are allowed by SQL Server, see the
Identifiers (http://go.microsoft.com/fwlink/?LinkId=214698) topic on MSDN.
Click Next.
11. On the Select additional models page, select models in the Available Models list. Setup lists all the
models that are contained in the Models folder and its subfolders. Required models are selected by
default, and you cannot clear the selection.
Note:
You may have models, or .axmodel files, that are not electronically signed. The Setup program
cannot verify the publisher of an unsigned model file. If you import an unsigned model file
into the model store, you create a security risk. Setup displays an error message if a selected
model file does not have a digital signature. Before you decide whether you want to continue
or cancel the installation, carefully review the models that you have selected.
If you install models other than the Foundation models, you must complete the Compile application
task when you run the initialization checklist. If you do not complete the Compile application task,
you encounter errors when you run the Synchronize database task in the initialization checklist. For
more information about the initialization checklist, see Initialize Microsoft Dynamics AX
(http://technet.microsoft.com/library/ba7f64a8-c5c3-4a9a-927b-21afc16f92af(AX.60).aspx).
Click Next to continue.
12. On the Configure an Application Object Server (AOS) instance page, assign a name to the AOS
instance. Optionally, you can specify the ports that are listed in the following table.
Port

Purpose

Default value

TCP/IP port

Other Microsoft Dynamics AX components use this port to

2712

communicate with AOS.


Services WSDL port

External applications use this port to access the WSDL for AOS-

8101

based Microsoft Dynamics AX web services.


Services endpoint port

External applications use this port to access AOS-based Microsoft

8201

Dynamics AX web services.

Microsoft Dynamics AX 2012 Installation Guide

300

Microsoft Dynamics AX
13. On the Specify an AOS account page, select the Network Service account of the local computer
(recommended only for development environments), a managed service account, or a domain
account for the AOS service. If you select to use a managed service account, make sure that you
specify the account in the format Domain\AccountName$.
Warning:
The process of manually changing the service account for an AOS instance is complex and
prone to error. Therefore, if you must change the service account for an AOS instance, we
recommend that you uninstall and reinstall the AOS instance by using Setup.exe. For more
information, see Change the account used by AOS
(http://technet.microsoft.com/library/87aaf2fa-1190-4036-9d39-c1252c48da88(AX.60).aspx).
14. On the Select client preferences page, select the display language that is used in the client, and
specify whether you want Setup to create a desktop shortcut for the client. Additionally, select one of
the following installation types:

Business user The basic client is installed. This type of client installation is appropriate for most
users.

Developer The client, the developer workspace, and additional files that are required for
development tasks are installed.

Administrator The client and additional files that are required for administrative tasks are
installed. Administrative tasks include the deployment of artifacts and the creation of users.

Click Next.
15. On the Specify Business Connector proxy account information page, enter the password for the
proxy account that is used by .NET Business Connector. Click Next.
16. On the Configure Async Server page, select the check box to configure Async Server by using Setup.
Enter the following information:

Application name The name of the web application that hosts Async Server.

App pool name The name of the application pool that the web application runs under.
We recommend that you specify separate application pools if multiple Retail components are
installed on the same computer. Multiple web applications can share an application pool if
resources on the computer are limited. However, if the shared application pool fails, all of the
applications that use it will stop responding. In addition, if one application is heavily used, it can
negatively affect the performance of the other applications in the pool.

Website name The name of the website that Async Server runs on.

User name and Password The credentials for the application pool identity.

Microsoft Dynamics AX 2012 Installation Guide

301

Microsoft Dynamics AX

HTTPS port The port on which Async Server receives HTTPS requests. You can specify any
available port. Verify that the port is open in Windows Firewall, and also record the port number.
The port is used to create the URL for Async Server in the following format: https://<server
name>:port/<web application name>. This URL is required when you configure instances of
Commerce Data Exchange: Async Client that connect to this instance of Async Server.
Warning:
To avoid conflicts with the Default Web Site on the computer, we recommend that you
do not use the default HTTPS port (443). A nonstandard port number also helps make the
website more secure.

TCP port (optional) The port on which Async Server receives TCP requests. Specify a TCP port if
your environment uses high-performance data synchronization. You can specify any available
port. Verify that the port is open in Windows Firewall.

AOS service user The user account that the AOS instance runs as.

SSL certificate thumbprint The thumbprint for the Secure Sockets Layer (SSL) encryption
certificate. You must obtain a valid, registered certificate from a provider.

Click Next to continue.


17. On the Select a database to use with Async Server page, create a new message database for Async
Server. If you install a subsequent instance of Async Server for load balancing, you must select the
same message database.
Note:
You must set up a separate message database for each partition in Microsoft Dynamics AX.
Click Next.
18. On the Configure Real-time Service page, select the check box to configure Real-time Service by
using Setup.
Enter the following information:

Application name The name of the web application that hosts Real-time Service.

Website name The name of the website that hosts Real-time Service.

App pool name The name of the application pool that Real-time Service runs in.
We recommend that you specify separate application pools if multiple Retail components are
installed on the same computer. Multiple web applications can share an application pool if
resources on the computer are limited. However, if the shared application pool fails, all of the
applications that use it will stop responding. In addition, if one application is heavily used, it can
negatively affect the performance of the other applications in the pool.

User name and Password The credentials for the application pool identity.

HTTPS port The port on which Real-time Service receives secure HTTP requests. You can specify
any available port. Verify that the port is open in Windows Firewall.
Warning:
To avoid conflicts with the Default Web Site on the computer, we recommend that you
do not use the default HTTPS port (443). A nonstandard port number also helps make the
website more secure.

Microsoft Dynamics AX 2012 Installation Guide

302

Microsoft Dynamics AX

TCP port The port on which Real-time Service receives TCP requests. You can specify any
available port. Verify that the port is open in Windows Firewall.

SSL certificate thumbprint The thumbprint for your SSL encryption certificate. You must obtain
a valid, registered certificate from a provider.

Click Next to continue.


19. On the Configure the Data Import/Export Framework service page, specify the service account
that will run the Data Import/Export Framework service. Click Next.
20. On the Configure the Data Import/Export Framework extensions page, specify the name of the
computer where the Data Import/Export Framework service is installed. By default, the local computer
is used. Click Next.
21. On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.
22. On the Ready to install page, click Install.
23. After the installation is completed, click Finish to close the wizard.
The AOS service can take several minutes to start the first time after it is installed. To determine
whether the AOS service has started, click Administrative tools > Services, and review the status of
the Microsoft Dynamics AX Object Server service.

After you install Retail essentials at headquarters


Open the Microsoft Dynamics AX client. The initialization checklist opens automatically. You must
complete the checklist before you can complete any tasks in Retail essentials. For more information, see
Initialization checklists (http://technet.microsoft.com/library/f7b239e1-2b59-4016-aa62819fe54471da(AX.60).aspx).
Install Retail essentials at the store and at the point of sale. For more information, see Install Retail
Essentials at the store or at the point of sale.

Microsoft Dynamics AX 2012 Installation Guide

303

Microsoft Dynamics AX

Install Retail Essentials at the store or at the point of


sale
This topic explains how to install Retail essentials on the store server and on point-of-sale registers.
Retail essentials is a retail-centric configuration option for Microsoft Dynamics AX. Retail essentials
provides a simplified, streamlined user experience that is optimized for organizations that will use only the
retail management functions of Microsoft Dynamics AX.
Install and configure Retail essentials at headquarters before you install and configure Retail essentials at
the store. For more information, see Install Retail Essentials at headquarters.
By default, the following components are included in the point of sale installation option for Retail
essentials.
Component

Description

Retail POS

Retail POS is a component that is required for day-to-day operations at


a store. Install this component on each register computer at the store.

Commerce Data Exchange: Async Client

Async Client is part of the asynchronous system that shares data


between the Microsoft Dynamics AX database and channel databases.
Async Client is installed at the channel and communicates with the
channel database.
Important:
You are required to install Async Client on only one computer
at the store. You can clear this check box if you are installing on
register computers.
The Async Client Configuration Tool is installed with Async Client. This
tool enables you to test connections and specify whether to use
streaming. The streaming option is ideal for initial high speed data
synchronization, but for ongoing synchronization, the non-streaming
option is more reliable. For more information, see Configure settings for
Async Client (http://technet.microsoft.com/library/3356c7a4-6c49-4a4d932d-1954dfe413d6(AX.60).aspx).

Retail Channel Configuration Utility

The Retail Channel Configuration Utility can be used to configure Retail


POS and Offline Sync Service, create a channel database, and create or
re-provision an offline database.
Install the Retail Channel Configuration Utility on computers that host a
retail database or an instance of Retail POS.
A channel database may be created either on a stand-alone database
server or on a POS computer.

Microsoft Dynamics AX 2012 Installation Guide

304

Microsoft Dynamics AX

Before you install Retail essentials at the point of sale

Select service accounts for Async Client. Youll need an account to run the Async Client Windows
service and an account to connect to Async Server. For information about the requirements for service
accounts, see Create service accounts.

Create the channel database that will be used with this instance of Async Client. When you install a
channel database, the groups that have permissions on the database are created. During the Async
Client installation, the service user is added to this group. For more information, see Install a retail
channel database.

On the computer where you plan to install these components, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Retail essentials at the point of sale


Use this procedure to install Retail essentials in the store or at the point of sale. If you select to install
additional components, or if you clear the default selections, the installation steps will vary.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the initial wizard pages.

3.

If the Setup Support files have not yet been installed on the computer, the Select a file location page
is displayed. The Setup Support files are required for installation. Enter a file location or accept the
default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics Retail essentials. Select the
Point of sale option, and then click Next.

5.

On the Add or modify components page, the components that are required to install Retail
essentials at the point of sale are automatically selected. Review and change the selections as needed,
and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Configure Async Client page, select the check box to configure Async Client by using Setup.
Enter the following information:

Async Server URL The URL for the instance of Async Server. Typically, the URL is in the format
https://<server name>:port/<web application name>.
If Async Server is installed in a cluster with a load balancer, enter the URL to the service on the
load balancer.

Channel database ID The identifier in Microsoft Dynamics AX for the channel database that is
used by the selected instance of Async Client.

User name and Password (Async Server connection) The credentials for the user that connects
to Async Server. These credentials must match the credentials that are specified in the channel
database profile. Credentials are case sensitive. The credentials are used to identify and
authenticate Async Client.

Microsoft Dynamics AX 2012 Installation Guide

305

Microsoft Dynamics AX

User name and Password (Async Client) The credentials for the user that runs the Windows
service for Async Client. The user does not have to be a domain account. It can be a member of a
workgroup on the local computer. Credentials are case sensitive.

Optionally, click Test connection to verify that Async Client is configured correctly. For information
about how to troubleshoot any errors that you encounter, see Troubleshoot configuration issues for
Async Client (http://technet.microsoft.com/library/5c841baa-605f-47fe-809e030c43d5caa8(AX.60).aspx).
Click Next.
8.

On the Select or specify a database to use with Async Client page, enter server and database
information for the message database and the channel database that will be used by Async Client.
You can connect to only an existing channel database. Setup does not create a new channel database
if you enter a channel database name that doesnt exist. If you specify a message database name that
doesnt exist, Setup creates a new message database.
Click Next.

9.

On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.

10. On the Ready to install page, click Install.


11. After the installation is complete, click Finish to close the wizard.

After you install Retail essentials at the point of sale

Configure data distribution settings. For more information, see Configure and schedule retail data
distribution (http://technet.microsoft.com/library/65b29a72-c7a7-453e-8f978281548df0a6(AX.60).aspx).

Use the Async Client Configuration Tool to test the connections to Async Server, the channel
database, and the channel message database. You can also use the utility to set advanced options. For
more information, see Configure settings for Async Client
(http://technet.microsoft.com/library/3356c7a4-6c49-4a4d-932d-1954dfe413d6(AX.60).aspx).

After you have determined that all connections are working, run the distribution schedule that sends
data to each channel database. Click Retail > Setup > Retail scheduler > Channel integration >
Channel database. Then click Full data sync and select the Full sync distribution schedule.

Microsoft Dynamics AX 2012 Installation Guide

306

Microsoft Dynamics AX

Install the RapidStart Connector


The Rapid Start Connector for Microsoft Dynamics AX enables RapidStart Services for Microsoft Dynamics
ERP to communicate with an on-premise Microsoft Dynamics AX implementation.
Note:
The RapidStart Connector is available through the Microsoft Dynamics AX Setup wizard in
Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, and Microsoft Dynamics AX
2012 Feature Pack.
RapidStart Services is an online service that provides a questionnaire-based framework to configure and
set up Microsoft Dynamics ERP products. This service is extensible and customizable to fit the business
processes that must be configured. For more information about RapidStart Services, see
http://www.dynamicsonline.com.
Install the RapidStart Connector on the server where the Application Object Server (AOS) is installed.

Before you install the RapidStart Connector

Register your organization for RapidStart Services. Contact your partner or register yourself through
http://www.dynamicsonline.com.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Create a domain account to use for the RapidStart Connector Windows service. For more information,
see Create service accounts.

Install the RapidStart Connector


Use this procedure to install the RapidStart Connector. If you install other Microsoft Dynamics AX
components at the same time, the installation pages vary, depending on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Modify Microsoft Dynamics AX installation page, click Add or modify components, and
then click Next.

5.

On the Add or modify components page, select RapidStart Connector, and then click Next.

Microsoft Dynamics AX 2012 Installation Guide

307

Microsoft Dynamics AX
6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Microsoft Dynamics ERP RapidStart Connector page, enter the domain user account for the
RapidStart Connector Windows service, and then click Next.

8.

On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.

9.

On the Ready to install page, click Install.

10. After the installation is completed, click Finish to close the wizard.

After you install the RapidStart Connector


Additional configuration is required after you install the RapidStart Connector. For more information, see
Configure Projects for Microsoft Dynamics AX ERP - RapidStart Services
(http://go.microsoft.com/fwlink/?LinkId=238738).
For information about how to use RapidStart Services, see Help for Microsoft Dynamics ERP RapidStart
Services users (http://go.microsoft.com/fwlink/?LinkId=225970).

Microsoft Dynamics AX 2012 Installation Guide

308

Microsoft Dynamics AX

Install Warehouse Mobile Devices Portal


Warehouse Mobile Devices Portal lets users complete tasks in a warehouse facility by using mobile
devices. Warehouse Mobile Devices Portal includes a website that can be accessed by mobile devices, and
therefore must be installed on a server that runs Internet Information Services (IIS).
Warehouse Mobile Devices Portal communicates with Microsoft Dynamics AX Application Object Server
(AOS) by using Windows Communication Foundation (WCF) services.
If youre using Warehouse Mobile Devices Portal with multiple companies in Microsoft Dynamics AX, you
must install an instance of Warehouse Mobile Devices Portal for each company. Each instance must use a
different service account. If the instances are installed on the same computer, they must use different port
numbers.

Before you install Warehouse Mobile Devices Portal

Create service accounts. You must create a separate service account for each instance of Warehouse
Mobile Devices Portal that you plan to install. Each service account is used as the application pool
identity for a Warehouse Mobile Devices Portal website. For more information, see Create service
accounts.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Warehouse Mobile Devices Portal


Use this procedure to install Warehouse Mobile Devices Portal. If you install other Microsoft Dynamics AX
components at the same time, the installation pages vary, depending on the components that you are
installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Select an installation option page, click Microsoft Dynamics AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Warehouse Mobile Devices Portal, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

Microsoft Dynamics AX 2012 Installation Guide

309

Microsoft Dynamics AX
8.

9.

On the Configure the Warehouse Mobile Devices Portal page, enter information in the following
fields:

Domain, User name, and Password Enter information about the service account that will run
the application pool for the website. If you are installing multiple instances of Warehouse Mobile
Devices Portal to support multiple companies in Microsoft Dynamics AX, each instance must use a
different service account.

Website port Enter the port number that the website will run on. If multiple instances of
Warehouse Mobile Devices Portal are installed on the same computer, use a different port
number for each instance.

On the Best practices checklist page, read about each recommended best practice. Select the
corresponding check box to indicate that an item is completed.
Important:
We strongly recommend that you follow the security best practices on this page. However,
the list of best practices is included in Setup as a reminder only. You can continue the
installation regardless of your selections on this page.

10. On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.
11. On the Ready to install page, click Install.
12. After the installation is completed, click Finish to close the wizard.

After you install Warehouse Mobile Devices Portal


Complete the following tasks to complete the setup of Warehouse Mobile Devices Portal.

Connect Warehouse Mobile Devices Portal to an AOS instance


You can install Warehouse Mobile Devices Portal on either the same server as the AOS instance that it
connects to or a separate server.
By default, Warehouse Mobile Devices Portal is configured to connect to an AOS instance that is installed
on the same computer. If the AOS instance is installed on a separate computer, you must modify the
web.config file for the instance of Warehouse Mobile Devices Portal. Use this procedure to modify the
web.config file.
1.

On the web server, open Internet Information Services (IIS) Manager.

2.

Right-click the website for an instance of Warehouse Mobile Devices Portal. Click Explore to open the
physical folder for the site.

3.

Before you make any changes, we recommend that you make a copy of the web.config file. You can
then easily revert to the previous version if you have to undo your changes.

4.

Open the web.config file in a text editor.

5.

Locate the net.tcp binding that is named NetTcpBinding_WHSMobileDevicesService.

6.

Update the endpoint address that is associated with the net.tcp binding.

7.

Save and close the web.config file.

Microsoft Dynamics AX 2012 Installation Guide

310

Microsoft Dynamics AX

Configure mobile devices


After you install Warehouse Mobile Devices Portal, complete the configuration procedures for mobile
devices. For more information, see Setting up mobile devices
(http://technet.microsoft.com/library/39c9afe8-4198-4564-9e84-d8a37b01917e(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

311

Microsoft Dynamics AX

Install the VSS writer for Microsoft Dynamics AX


The Volume Shadow Copy Service writer for Microsoft Dynamics AX (AX VSS writer) can be used together
with Microsoft System Center 2012 Data Protection Manager (DPM) to help protect Microsoft Dynamics
AX data and servers.
The AX VSS writer coordinates backup and restore operations. For more information, see Protecting
Microsoft Dynamics AX environments with System Center 2012 Data Protection Manager (DPM)
(http://technet.microsoft.com/library/0c68fed3-93b5-4738-b45c-2c249ea99ce6(AX.60).aspx).
Note:
The AX VSS writer is available through the Microsoft Dynamics AX Setup wizard in AX 2012 R3
and cumulative update 7 for Microsoft Dynamics AX 2012 R2 (CU 7). For information about how
to install the AX VSS writer with CU 7, see the Installation Guide for cumulative update 7
(http://go.microsoft.com/fwlink/?LinkId=329982).

Before you install the AX VSS writer

Ensure that a System Center 2012 Data Protection Manager server is installed and configured.
Important:
Agents cannot be installed on the Data Protection Manager server. Do not install AX 2012 R2
components on the same server.

Create a folder that the AX VSS writer will use to store temporary backup files. This folder should not
be used for any other purpose, and access should be limited to the service account for the AX VSS
writer.

Create a service account for the AX VSS writer. This account must be a local administrator on all the
computers that you plan to protect by using this component. Additionally, the account must have
read/write permission to the location where temporary backup files are stored.

Install a DPM agent on all the computers that you plan to protect by using this component. For more
information about Data Protection Manager, see Installing and Configuring Protection Agents
(http://technet.microsoft.com/en-us/library/hh758039.aspx).

On the computers where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Microsoft Dynamics AX 2012 Installation Guide

312

Microsoft Dynamics AX

Install the AX VSS writer


Use this procedure to install the AX VSS writer. If you install other Microsoft Dynamics AX components at
the same time, the installation pages vary, depending on the components that you are installing.
1.

On every computer that you plan to protect, start Microsoft Dynamics AX Setup. Under Install, select
Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

On the Modify Microsoft Dynamics AX installation page, click Add or modify components, and
then click Next.

5.

On the Add or modify components page, select VSS writer, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

Enter the requested information for the component that you are installing.
Component

Required information

Microsoft Dynamics AX Application Object

The AOS instance

Server (AOS)
Database

The Microsoft SQL Server instance


The database name for the business database

Microsoft SQL Server Analysis Services

The name of the Analysis Services instance

Microsoft SQL Server Reporting Services

The name of the Reporting Services instance


The name of the reporting database server
The name of the Report Server database

All

The name of the DPM server


The name of the AX VSS writer service account
The password for the AX VSS writer service account
The temporary file location that is used to temporarily hold
copies of protected media.
Note:
This location can contain important data. We strongly
recommend that you limit access to this location to
the AX VSS writer service account, and that you use
the location only to store temporary VSS files.

8.

On the Ready to install page, click Install.

Microsoft Dynamics AX 2012 Installation Guide

313

Microsoft Dynamics AX
9.

After the installation is completed, click Finish to close the wizard.

10. Repeat these steps for all other components that you plan to protect.

Next steps
The following topics describe the next steps:

Protect a Microsoft Dynamics AX 2012 R2 environment with System Center 2012 Data Protection
Manager (http://technet.microsoft.com/library/b5b01674-f894-4dd6-9694ab5bc1a8351a(AX.60).aspx)

Recover a Microsoft Dynamics AX 2012 R2 environment with System Center 2012 Data Protection
Manager (http://technet.microsoft.com/library/6016640f-782d-489e-983b9cb9b33badbe(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

314

Microsoft Dynamics AX

Install Connector for Microsoft Dynamics


This topic describes how to install Connector for Microsoft Dynamics by using the Microsoft Dynamics AX
Setup wizard. Use Connector to integrate data between Microsoft Dynamics CRM and Microsoft Dynamics
AX. For example, you can integrate Microsoft Dynamics AX customers with Microsoft Dynamics CRM
accounts. This integration gives you access to up-to-date customer and account information in both
systems. For more information about Connector, see the Connector page
(http://go.microsoft.com/fwlink/?LinkId=324872) on CustomerSource (logon is required).
Notes:
Connector is available through the Microsoft Dynamics AX Setup wizard in cumulative update 7
for Microsoft Dynamics AX 2012 R2 (CU 7) and AX 2012 R3. For information about how to install
Connector with CU 7, see the Installation Guide for cumulative update 7
(http://go.microsoft.com/fwlink/?LinkId=329982).
If youre not using Microsoft Dynamics AX 2012 R3 or cumulative update 7 or later for AX 2012
R2, you can use the stand-alone installation for Connector. Download and run the .msi file that is
available on CustomerSource. For information about how to run the stand-alone installation, see
Installation Guide (http://go.microsoft.com/fwlink/?LinkId=325397) (PDF) for Connector.
You must install Connector on a computer where Microsoft Dynamics AX Application Object Server (AOS),
the Microsoft Dynamics AX client, and .NET Business Connector are installed. If these components have
not been installed, they will be selected automatically in Setup when you install Connector.

Before you install Connector for Microsoft Dynamics

Create or select the user accounts that will be used to run the Connector service and to integrate data
between Microsoft Dynamics AX and Microsoft Dynamics CRM. For more information about the
requirements for these accounts, see Create service accounts.

On the computer where you plan to install this component, run the prerequisite validation utility to
verify that system requirements have been met. For information about how to run the prerequisite
validation utility, see Check prerequisites.
For more information about the hardware and software requirements for Microsoft Dynamics AX, see
the system requirements (http://go.microsoft.com/fwlink/?LinkId=165377).

Install Connector for Microsoft Dynamics


Use this procedure to install Connector. If you install other Microsoft Dynamics AX components at the
same time, the installation pages vary, depending on the components that you are installing.
1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

Microsoft Dynamics AX 2012 Installation Guide

315

Microsoft Dynamics AX
4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Custom installation, and then click Next.

6.

On the Select components page, select Connector for Microsoft Dynamics, and then click Next.

7.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

8.

If you are installing Connector on a 64-bit operating system, the Select a file location page is
displayed. Select the location where you want 32-bit versions of Microsoft Dynamics AX files to be
installed, and then click Next.

9.

On the Configure the CRM connector installation page, enter the name of the Microsoft SQL Server
instance that will host the Microsoft Dynamics Integration (MSDI) database.
Note:
The MSDI database doesnt have to be on the same physical server as Connector for
Microsoft Dynamics.

10. On the Enter server and port information to connect CRM Connector to an AOS instance page,
enter the name of the server where the AOS instance is installed, and enter the port number that the
AOS instance uses for TCP/IP communication.
11. On the Configure an integration user page, enter information about the user account that is used to
integrate data between Microsoft Dynamics CRM and Microsoft Dynamics AX. If the user does not
already exist in Microsoft Dynamics AX, select Create new account. The user will be added, and the
Microsoft Dynamics AX user ID will be AxIntUsr. If the user already exists in Microsoft Dynamics AX,
select Use existing account, and enter a user ID.
12. On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.
13. On the Ready to install page, click Install.
14. After the installation is completed, click Finish to close the wizard.

After you install Connector for Microsoft Dynamics


After you have installed Connector, you must configure the adapter settings for Microsoft Dynamics CRM
and Microsoft Dynamics AX. For more information about how to configure adapter settings for Microsoft
Dynamics CRM, see the Installation Guide (http://go.microsoft.com/fwlink/?LinkId=325397) (PDF) for
Connector. For more information about how to configure adapter settings for Microsoft Dynamics AX, see
the Configuration Guide (http://go.microsoft.com/fwlink/?LinkId=325398) (PDF) for the Microsoft
Dynamics AX adapter.

Microsoft Dynamics AX 2012 Installation Guide

316

Microsoft Dynamics AX

Install the Data import/export framework (DIXF,


DMF)
This topic describes how to install the Microsoft Dynamics AX 2012 Data Import/Export Framework.
The Data Import/Export Framework is an extension that helps you export data and import it into Microsoft
Dynamics AX. Examples of the data that you can import include master data, open stock, and balances.
Components of the Data Import/Export Framework must be installed on computers that are running
Integration Services, on a computer that is running an instance of Microsoft Dynamics AX Application
Object Server (AOS), and on a computer that is running the Microsoft Dynamics AX client. You must run
the installer locally on each computer.
Warning:
If you have previously installed the Data Import/Export Framework from InformationSource, you
must fully uninstall it and then reinstall it for cumulative update 7 for Microsoft Dynamics AX 2012
R2. As part of this full uninstallation, you must remove all binary files by using Add/Remove
Programs and uninstall the Data Import/Export Framework model. For more information, see How
to: Remove (Uninstall) a Model (http://msdn.microsoft.com/library/6552673a-a386-4349-943864c0de94ca7d(AX.60).aspx).

Before you install the Data Import/Export Framework


Before you begin, your environment must include the following components:

A running version of AX 2012 that has been configured for your business

A running version of Microsoft SQL Server Integration Services that is running the same version of
SQL Server that is hosting the Microsoft Dynamics AX business and model store database
Important:
Because the staging environment is highly normalized and might require significant processing
bandwidth, we recommend that you increase the Maximum buffer size setting for your
environment while you migrate data. Use the Server configuration utility to set the value. For
more information, see Tune data access settings (http://technet.microsoft.com/library/f799430e56b0-4b77-abdc-517820390dd2(AX.60).aspx).

Microsoft Dynamics AX 2012 Installation Guide

317

Microsoft Dynamics AX

Install the Data Import/Export Framework


Use the following procedures to install the Data import/export framework. If you install other Microsoft
Dynamics AX components at the same time, the installation pages vary, depending on the components
that you are installing.

Install the Data Import/Export Framework on the computer that is


running Integration Services
1.

On the computer that is running Integration Services, right-click Setup.exe, and then click Run as
administrator.
Important:
If you do not run Setup as an administrator, the Data Import/Export Framework DLLs will not
be copied to the correct locations or registered.

2.

In the Setup wizard, accept the license terms, and then, on the Select components to install page,
click Data Import/Export Framework service.

3.

On the Prerequisite validation page, if the computer passes the validations that are required, click
Next.
If the computer does not pass the validations, install the prerequisites, and then restart Setup.

4.

On the Specify a service account page, enter the same account that is used for the AOS service, and
then click Next.

5.

On the Select version of Microsoft SQL Server page, select the appropriate version, and then click
Next.
Warning:
This page appears only if Setup detects that versions of Integration Services for both SQL
Server 2008 and SQL Server 2012 are installed on the computer.

6.

On the Ready to install page, click Install.

7.

On the Installation completed page, select Show logs to display the log files, and then click Finish.

Install the Data Import/Export Framework on an AOS instance


1.

On a computer that is running an AOS instance, right-click Setup.exe, and then click Run as
administrator.
Important:
If you do not run Setup as an administrator, the Data Import/Export Framework DLLs will not
be copied to the correct locations or registered.

2.

In the Setup wizard, accept the license terms, and then, on the Select components to install page,
click Application Object Server (AOS) component.

3.

On the Prerequisite validation page, if the computer passes the validations that are required, click
Next.
If the computer does not pass the validations, install the prerequisites, and then restart Setup.

Microsoft Dynamics AX 2012 Installation Guide

318

Microsoft Dynamics AX
4.

On the Specify SQL Server Integration Services location page, select the computer that is running
the version of SQL Server Integration Services that you installed the Data Import/Export Framework
service on, and then click Next.

5.

On the Ready to install page, click Install.

6.

On the Installation completed page, select Show logs to display the log files, and then click Finish.

Install the Data Import/Export Framework on a client


1.

On a computer that is running a Microsoft Dynamics AX client, right-click Setup.exe, and then click
Run as administrator.
Important:
If you do not run Setup as an administrator, the Data Import/Export Framework DLLs will not
be copied to the correct locations or registered.

2.

In the Setup wizard, accept the license terms, and then, on the Select components to install page,
click Client component.

3.

On the Prerequisite validation page, if the computer passes the validations that are required, click
Next.
If the computer does not pass the validations, install the prerequisites, and then restart Setup.

4.

On the Ready to install page, click Install.

5.

On the Installation completed page, select Show logs to display the log files, and then click Finish.

Microsoft Dynamics AX 2012 Installation Guide

319

Microsoft Dynamics AX

Perform a single-computer installation of


Microsoft Dynamics AX
You can set up Microsoft Dynamics AX on a single computer to create a development, test, pilot, or trial
environment.
When you select a single-computer installation, the complete Microsoft Dynamics AX system is
automatically installed and configured on the local computer.
The topics in this section provide information about how to install Microsoft Dynamics AX on a single
computer. The following topics are included:
Perform a single-computer installation
Considerations for installing multiple instances on a computer

Perform a single-computer installation


Use the information in this topic to perform a single-computer installation of Microsoft Dynamics AX. Use
this type of installation to install a complete Microsoft Dynamics AX system on a single computer for
development, demonstration, or testing. For more information about the components that are included in
a single-computer installation, see Installation types.
Setup uses default settings to configure all components. User names and passwords are the only input
that is required. For more information about individual components, see the corresponding topics in this
guide.
Important:
We do not recommend that you perform a single-computer installation in a production
environment. Use this type of installation only for development and testing.

Before you perform a single-computer installation


Prerequisites for all components that are included in the single-server installation must be installed before
you can use this type of installation. On the computer where you plan to perform the installation, run the
prerequisite validation utility to verify that system requirements have been met. For information about
how to run the prerequisite validation utility, see Check prerequisites. For more information about the
hardware and software requirements for Microsoft Dynamics AX, see the system requirements
(http://go.microsoft.com/fwlink/?LinkId=165377).
Note:
Reports and online analytical processing (OLAP) cubes may display errors if the computer is not
connected to a domain.

Microsoft Dynamics AX 2012 Installation Guide

320

Microsoft Dynamics AX

Perform a single-computer installation


1.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.

2.

Advance through the first wizard pages.

3.

If the Setup Support files have not yet been installed on this computer, the Select a file location
page is displayed. The Setup Support files are required for installation. Provide a file location or accept
the default location, and then click Next. On the Ready to install page, click Install.

4.

If youre installing AX 2012 R3, in the Select an installation option page, click Microsoft Dynamics
AX.

5.

On the Select installation type page, click Single-computer installation, and then click Next.

6.

On the Prerequisite validation results page, resolve any errors. For more information about how to
resolve prerequisite errors, see Check prerequisites. When no errors remain, click Next.

7.

On the Specify an AOS account page, select whether you want to use the Network Service account
of the local computer or a domain account to run the Application Object Server (AOS) service. Click
Next.

8.

On the Specify Business Connector proxy account information page, enter the name and
password for the proxy account that is used for .NET Business Connector. Click Next.

9.

On the Prerequisite validation results page, resolve any errors. When no errors remain, click Next.

10. On the Ready to install page, click Install.


11. After the installation is completed, click Finish to close the wizard.
Note:
If you install Help Server at the same time as other Microsoft Dynamics AX components, the Help
Server installation may fail. In the Setup log, you see the following error: Component installation
task stopped due to an error. To resolve this issue, uninstall and then reinstall the Help Server
component.

Considerations for installing multiple instances on a


computer
In a single environment, you can install multiple instances of Application Object Server (AOS) and the
Microsoft Dynamics AX database.
You can install multiple instances of Microsoft Dynamics AX components on separate computers or on the
same computer. AOS instances and databases cannot be shared among instances of Microsoft Dynamics
AX.
Multiple Microsoft Dynamics AX instances are primarily used in development environments that support
multiple customers.
Caution:
We do not recommend or support the installation of multiple versions of Microsoft Dynamics AX
components on the same computer in a production environment.

Microsoft Dynamics AX 2012 Installation Guide

321

Microsoft Dynamics AX
The following table lists the considerations when you install a second instance of a component.
Component

Considerations

AOS

Each AOS instance is automatically assigned a number between 01 and


99. This number is displayed in the Programs and Features item in
Control Panel.
We recommend that you create a group in Active Directory Domain
Services to manage permissions for the AOS accounts. For more
information, see Install an Application Object Server (AOS) instance.

Database

During initialization, you can import existing data into the database.

Components that require .NET Business

You can install only one instance of .NET Business Connector on a

Connector

computer. In an environment that has multiple AOS instances, use the


Microsoft Dynamics AX Configuration utility to make sure that the
instance of .NET Business Connector on the local computer connects to
the correct AOS instance for the component that you are installing.
In the utility, in the Configuration Target list, select Business
Connector (non-interactive use only). On the Connection tab, verify
that the correct AOS instance is displayed.
For more information about how to use the Microsoft Dynamics AX
Configuration utility, click the Help button in the utility.

Reporting Services extensions

You can install multiple instances of Microsoft SQL Server Reporting


Services on the same computer. In this kind of deployment environment,
each instance of Reporting Services is connected to an independent
Microsoft Dynamics AX installation. You may want to install multiple
instances of Reporting Services on the same computer to support
development and production installations of Microsoft Dynamics AX, or
to support multiple production installations of Microsoft Dynamics AX.
For information about how to install multiple instances of Reporting
Services, see Install multiple instances of Reporting Services on the same
computer (for use with Microsoft Dynamics AX)
(http://technet.microsoft.com/library/0aca4bf4-aac9-4acd-93237547a8583c9f(AX.60).aspx).

Enterprise Portal

You can install multiple Enterprise Portal instances on the same


computer. Portals can be configured to access the same or different
Microsoft Dynamics AX AOS instances. For more information, see Install
multiple Enterprise Portals on the same server.

Microsoft Dynamics AX 2012 Installation Guide

322

Microsoft Dynamics AX

Install Microsoft Dynamics AX in silent mode


When you run the Setup wizard, Setup runs in interactive mode. In other words, a graphical user interface
(GUI) prompts you for the required information. Alternatively, you can run Setup in silent mode. When
Setup runs in silent mode, no GUI is displayed. Instead, you supply the required information at the
command prompt or in a parameter file. You can install any Microsoft Dynamics AX component in silent
mode.
Use the following topics to run Setup in silent mode.
Topic

Description

Run Setup in silent mode

Provides the procedures to run the Setup wizard without the


graphical user interface.

Setup parameters reference

Lists the parameters that can be used for silent installation. This

(http://technet.microsoft.com/library/474f9d72-

topic is available on TechNet.

e1e5-433a-840e-d9eb00753e94(AX.60).aspx)

Run Setup in silent mode


When you run the Setup wizard, Setup is running in interactive mode. In other words, a graphical user
interface (GUI) prompts you for the required information. Alternatively, you can run Setup in silent mode.
When Setup runs in silent mode, no GUI is displayed. Instead, you supply the required information at the
command prompt or in a parameter file. You can install any Microsoft Dynamics AX component in silent
mode.
Note:
A silent installation is especially useful when you deploy multiple clients at the same time. For
more information, see Mass deployment of the Microsoft Dynamics AX Windows client
(http://technet.microsoft.com/library/6fda1199-2236-4952-9f19-88ff3fdcc92a(AX.60).aspx).

Determine which parameters to use


The same parameters are available whether you enter them at the command prompt or create a
parameter file.
To determine which Microsoft Dynamics AX Setup parameters you want to use, we recommend that you
review the example parameter file that is included on the Microsoft Dynamics AX DVD. The file is located
at <Path to DVD or shared directory>\Support\ExampleParmFile.txt. For more information about individual
parameters, see the Setup parameters reference (http://technet.microsoft.com/library/474f9d72-e1e5433a-840e-d9eb00753e94(AX.60).aspx) on TechNet.
Microsoft Dynamics AX Setup can configure some required prerequisites, such as operating system
features and roles and redistributable components that are on the Microsoft Dynamics AX installation
media. If you want Setup to automatically configure these prerequisites, include the parameter
ConfigurePrerequisites=1.

Microsoft Dynamics AX 2012 Installation Guide

323

Microsoft Dynamics AX
You can install other prerequisites silently by running the individual programs from the command line. To
determine the command-line parameters that you want to use, we recommend that you run the standalone prerequisite validation utility on a representative client. When you use the utility to configure
prerequisites, the log file indicates the commands that were used. By default, the log file is located at
<Drive>\Users\<UserName>\AppData\Local\Microsoft Dynamics AX 6\Prerequisite Utility Logs\Date
Time\Log.txt.

Specify installation parameters at the command prompt


Use the following procedure to run the installation by entering parameters at the command prompt.
1.

Open a Command Prompt window.

2.

At the command prompt, type the following command:


<Path to DVD or shared directory>\Setup.exe parameter1="value" parameter2="value"
When you use multiple parameters, insert a single space between parameters.
Warning:
If you enter duplicate parameters, Setup fails silently.

3.

After you have listed all parameters, press ENTER.

Specify installation parameters by using a parameter file


Use the following procedure to run the installation by specifying a parameter file at the command
prompt.
1.

Create a text file that lists the appropriate installation parameters and their values. In the parameter
file, the Name=Value combination for each parameter must be on a separate line.
Warning:
If you enter duplicate parameters, Setup fails silently.
Do not include double quotation marks in parameter files. Because the carriage return is used as a
delimiter in a parameter file, values that usually require double quotation marks do not require them
here.
To prevent a line in a parameter file from being read, type a number sign (#) before the line. The line
is now treated as a comment instead of a command or parameter.

2.

Open a Command Prompt window.

3.

At the command prompt, type the following command:


<Path to DVD or shared directory>\Setup.exe ParmFile=<path of file\FileName.txt>
The path can be fully qualified or relative to the location of the Setup.exe file. Relative paths can
include upward qualifiers such as "..\..\".

4.

Press ENTER.

Microsoft Dynamics AX 2012 Installation Guide

324

Microsoft Dynamics AX

Firewall settings for Microsoft Dynamics AX


components
If you use Windows Firewall to help protect your computers, Microsoft Dynamics AX components require
the settings in the following table. For more information about Windows Firewall, see the Windows
documentation.
Component

Computer

Firewall setting

Notes

Setup

Any

Allow outbound HTTP connections.

To access the documentation that is


available from the Setup wizard, you
must be able to connect to the
Internet from the computer where you
are running Setup.

Databases

Database server

Exclude the port that is used by

For more information, see the SQL

Microsoft SQL Server. By default, SQL

Server documentation.

Server uses port 1433.


Application

AOS server

Exclude the TCP/IP port that is

Windows Firewall must be enabled on

Object Server

used by the AOS instance. By

the computer. Each AOS instance

(AOS)

default, AOS uses port 2712.

must use a different port number.

Setup automatically creates the


inbound rule "Dynamics AX 6.0
MicrosoftDynamicsAX (RPC)" for
the TCP/IP port.

Exclude the services WSDL port


that is used by the AOS instance.
By default, AOS uses port 8101.

Note:
By default, every time that
you install an additional AOS
instance on a computer, the
TCP/IP port number and the
services endpoint port
numbers are incremented by

Setup automatically creates the

1. For example, by default,

inbound rule "Dynamics AX 6.0

the second AOS instance on

MicrosoftDynamicsAX (WSDL)"

a computer is assigned to

for the WSDL port.

TCP/IP port 2713.

Exclude the services endpoint


port that is used by the AOS
instance. By default, AOS uses
port 8201.
Setup automatically creates the
inbound rule "Dynamics AX 6.0
MicrosoftDynamicsAX (NetTCP)"
for the services endpoint port.

Client

Client

Exclude Ax32.exe.

workstation

Microsoft Dynamics AX 2012 Installation Guide

The client uses a TCP port to connect


to the AOS instance.

325

Microsoft Dynamics AX

Component

Computer

Firewall setting

Notes

Microsoft SQL

Report server

Exclude the port that is used by

If you are installing Reporting Services

Server

Reporting Services virtual directories,

extensions in a perimeter network,

Reporting

if Reporting Services uses a port other

you may need to add a firewall policy

Services

than port 80.

that enables you to connect to the

extensions

Microsoft Dynamics AX database. For


example, if you are using Forefront
Threat Management Gateway (TMG),
you must add a Non-Web Server
Protocol Rule. For more information,
see Configuring SQL Server publishing
(http://technet.microsoft.com/enus/library/cc441596.aspx) in the
Forefront TMG documentation.

Microsoft SQL

Exclude the port that is used by

For more information about how to

Server Analysis

Analysis server

Analysis Services. By default,

configure access to Analysis Services

Services

Analysis Services uses port 2383.

through Windows Firewall, see the

If you are using SQL Server

SQL Server documentation on MSDN.

integration

Browser, you must also exclude


port 2382.
Management

Exclude the port that is used by the

Reporter

Management Reporter application


server. By default, the application
server uses port 4712.

Debugger

Developer

Exclude AxDebug.exe and its target

The debugger uses a dynamically

workstation

programs, such as Ax32.exe and

allocated TCP port.

AxServ32.exe.
Enterprise

Web server

Portal for
Microsoft

Enable the Web Server (HTTP).

If you do not enable the Web Server

Exclude the port that is used by

in Windows Firewall, you can view the

the Enterprise Portal website, if

Dynamics AX

site only from the local server.

the site uses a port other than


port 80.

Help Server

Web server

Exclude the port that is used by the


Help Server web site, if the site uses a
port other than port 80.

Enterprise
Search

Web server

Exclude the port that is used by the


Search web site, if the site uses a port
other than port 80.

Microsoft Dynamics AX 2012 Installation Guide

326

Microsoft Dynamics AX

Component

Computer

Firewall setting

Notes

Web services

Web server

Exclude the port that is used by the

External programs use this port to

services web site, if the site uses a port consume the Microsoft Dynamics AX
other than port 80.

web services that are based on


Internet Information Services (IIS).

Management

Remotely

Enable Remote Administration.

You must enable Remote

utilities

managed

Administration on computers that are

computer

administered remotely by using


Windows PowerShell. For example,
enable Remote Administration on a
computer if you deploy reports to that
computer from another computer
where Windows PowerShell is
installed.

Synch Service

Head-office

Exclude the port that is used by

For instructions, see the PCI

communications

Microsoft SQL Server. By default,

Implementation Guide for Microsoft

server

SQL Server uses port 1433.

Dynamics AX 2012 Feature Pack

Exclude the port that is used by

(http://go.microsoft.com/fwlink/?LinkI

Synch Service. By default, Synch

d=237283).

Service uses port 16750.

Exclude the port that is used by


Real-time Service. By default,
Real-time Service uses port 1239.

Synch Service

Store

communications
server

Enable Internet Protocol security

For more information, see the PCI

(IPsec).

Implementation Guide for Microsoft

Exclude the port that is used by

Dynamics AX 2012 Feature Pack

Microsoft SQL Server. By default,


SQL Server uses port 1433.

(http://go.microsoft.com/fwlink/?LinkI
d=237283).

Exclude the port that is used by


Synch Service. By default, Synch
Service uses port 16750.

Real-time

Exclude the port that is used by Real-

For more information, see the PCI

Service

time Service, if the site uses a port

Implementation Guide for Microsoft

other than port 80.

Dynamics AX 2012 Feature Pack


(http://go.microsoft.com/fwlink/?LinkI
d=237283).

Async Server

Exclude the HTTPS port that is used by


Async Server.
Exclude the TCP port, if Async Server
uses the TCP protocol.

Microsoft Dynamics AX 2012 Installation Guide

327

Microsoft Dynamics AX

Component

Computer

Firewall setting

Notes

Retail POS

Store

Exclude the port that is used by

For more information, see the PCI

communications

Microsoft SQL Server. By default, SQL

Implementation Guide for Microsoft

server

Server uses port 1433.

Dynamics AX 2012 Feature Pack

Exclude the port that is used by Synch

(http://go.microsoft.com/fwlink/?LinkI

Service. By default, Synch Service uses

d=237283).

port 16750.
Retail POS

Store database

Exclude the port that is used by

For more information, see the PCI

server

Microsoft SQL Server. By default, SQL

Implementation Guide for Microsoft

Server uses port 1433.

Dynamics AX 2012 Feature Pack

On a register that has its own local

(http://go.microsoft.com/fwlink/?LinkI

database, you only need to open the

d=237283).

firewall to SQL Server if Synch Service


is on a computer other than the
register.
Retail Server

Retail Server

Exclude the port that is used by the


Retail Server web site.

Retail Hardware

Retail Server

Station
Retail online
store

Exclude the port that is used by the


Hardware Station web site.

Web server

Exclude the ports that are used by the


Retail online store web site. For a
production environment, the online
store uses ports 80 and 443, by
default. For a developer environment,
the online store uses the following
ports, by default.

40002: The online store (this is


the port 80 site in production
environments)

40004: The online store (this is


the port 443 site in production
environments with encrypted
communications)

40003: The internal online store


site (for changing site settings in
SharePoint

40001: The internal product


catalog site

Microsoft Dynamics AX 2012 Installation Guide

328

Microsoft Dynamics AX

Component

Computer

Firewall setting

Microsoft

Microsoft

Dynamics ERP

Dynamics ERP

Microsoft Dynamics ERP

RapidStart

RapidStart

RapidStart Connector service. By

Connector

Services host

default, the file is installed in this

machine

location:

Notes

Exclude the executable file for the

%SystemDrive%\Program
Files\Microsoft Dynamics
AX\60\RapidStartConnectorServic
e\Microsoft.Dynamics.AX.AppCon
fig.ConnectorLoaderService.exe

Exclude the endpoint port that is


used by the Microsoft Dynamics
ERP RapidStart Connector service.
By default, the service
communicates with the Windows
Azure Service Bus on ports 93509354, 80, and 443.

Exclude the Windows Azure


Cloud Services Protocols.

Microsoft Dynamics AX 2012 Installation Guide

329

Microsoft Dynamics AX

Troubleshoot the installation


The following topics can help you find solutions for issues that may occur when you install Microsoft
Dynamics AX:

Troubleshoot general installation issues (http://technet.microsoft.com/library/86d9537d-2e3540e6-9fff-2a0a208ccbdd(AX.60).aspx)

Troubleshoot prerequisite issues (http://technet.microsoft.com/library/e3771aed-bde7-4610-bff2aa64212a8352(AX.60).aspx)

Troubleshoot installation issues with AOS (http://technet.microsoft.com/library/e5b619c0-a99c4841-bfc4-5d78ac5e1975(AX.60).aspx)

Troubleshoot installation issues with client components


(http://technet.microsoft.com/library/8318ff7c-8f7b-4372-b417-483dc81bda1e(AX.60).aspx)

Troubleshoot issues when running the Setup wizard to install the Reporting Services extensions
(http://technet.microsoft.com/library/df0437d7-d50e-4acf-9354-e6c8f68af661(AX.60).aspx)

Troubleshoot issues when running the Setup wizard to configure Analysis Services
(http://technet.microsoft.com/library/d3e32164-d488-4729-b9d5-67778e6f824b(AX.60).aspx)

Troubleshoot installation issues with Enterprise Portal and Role Centers


(http://technet.microsoft.com/library/e0cee771-4fcb-42e3-9213-5b297c8f6fe5(AX.60).aspx)

Troubleshoot installation issues with Enterprise Search


(http://technet.microsoft.com/library/7d38c40f-3ae5-4a10-b159-9519c6ed9150(AX.60).aspx)

Troubleshoot installation issues with the developer tools


(http://technet.microsoft.com/library/0374a349-062b-4ae5-8edb-359013038f99(AX.60).aspx)

Microsoft Dynamics AX 2012 Installation Guide

330