Install Commerce Data Exchange: Async Server

Article
11/29/2021

Important

This content is archived and is not being updated. For the latest documentation, see Microsoft Dynamics 365 product documentation. For the latest release plans, see Dynamics 365 and Microsoft Power Platform release plans.

Applies To: Microsoft Dynamics AX 2012 R3

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 Microsoft Dynamics AX 2012 for 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. For information about how to use the mass deployment toolkit, see Mass deploy Retail components by using System Center Configuration Manager.

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 AsyncServer

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 might 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.

Warning

Although a single instance of Async Server can manage all communications for the organization, excessive load or network latency might decrease performance.
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.

If you deploy Async Server with a self-signed certificate, this certificate must be trusted by the computer running the corresponding Async Client component
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.
The SQLCMD utility is required to install Async Server. This utility is typically installed with Microsoft SQL Server. If a version of SQL Server is not installed on the computer where you install Async Server, you can download and install Microsoft Command Line Utilities 11 for SQL Server to meet this requirement.

Option 1: 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.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.
Advance through the first wizard pages.
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.
On the Select an installation option page, click Microsoft Dynamics AX.
On the Select installation type page, click Custom installation, and then click Next.
On the Select components page, select Async Server, and then click Next.
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.
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 you’re 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 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.
- 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 Microsoft Dynamics AX 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.
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.
On the Ready to install page, click Install.
After the installation is completed, click Finish to close the wizard.

Option 2: 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.

Start Microsoft Dynamics AX Setup. Under Install, select Microsoft Dynamics AX components.
On the Modify Microsoft Dynamics AX installation page, click Add or modify components, and then click Next.
On the Add or modify components page, select Async Server, and then click Next.
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.
On the Configure Async Server page, clear the Configure Async Server option.
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.
On the Ready to install page, click Install.
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.

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.
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.
Open your copy of the ss-settings.xml file in Microsoft Visual Studio or a text editor, such as Notepad.

Enter a value for the following parameters.

Parameter	Enter this value	Default value
HQMessageDatabaseServerName	The name of the server that hosts the message database for Async Server. The script is case sensitive. For example, enter value=“DatabaseServer” />.	None
HQMessageDatabaseServerNamedInstanceName	The name of the Microsoft SQL Server instance that hosts the message database. 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.	None
HQMessageDatabase	The name of the message database.	None
HQMessageDatabaseServerOverride	(Optional) The name of the database server that is used to connect to the message database. By default, the computer name that was used to deploy the database is used.	[HQMessageDatabaseServerName]
WebSiteName	The name of the website that hosts Async Server.	AsyncServerSite
AppPoolName	The name of the application pool for the Async Server web application.	AsyncServer
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 Server.	AsyncServer
WebApplicationServiceBinarySourceFolder	The location where the installer copied binary components. By default, the files are located at C:\Program Files (x86)\Microsoft Dynamics AX\60\CDX\Async Server\6.3.	None
WebSiteHttpsPort	The port on which Async Server receives HTTPS requests.	None
WebSiteTcpPort	The port on which Async Server receives TCP requests. Specify a TCP port if your environment uses high-performance data synchronization.	808
WebSiteSSLCertificateThumbprint	The thumbprint for the SSL encryption certificate. You must obtain a valid, registered certificate from a provider.	None
WebSiteSSLCertificateRootStore	The name of the root store where the SSL certificate that is used to help secure the website is installed.	LocalMachine
WebSiteSSLCertificateStore	Enter the name of the certificate store where the SSL certificate that is used to help secure the website is installed.	My
WebSiteWorkingFolder	The path of the physical folder where website files are stored.	%SystemDrive%\inetpub\AsyncServerSite
WebApplicationWorkingFolder	The path of the physical folder where web application files are stored.	[WebSiteWorkingFolder]\[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 you’ve written and scripts that have been signed by a trusted publisher.

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\CDX\Async Server\Tools.
- If you’re 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 you’re 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))))

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.
Create a scheduler profile for Async Server. For more information, see Set up a profile for Async Server.
Set up working folders. For more information, see Specify working folders for Commerce Data Exchange.