Set up a Retail topology to use with deployment tools
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.
Before you can use deployment tools to mass deploy retail components, you must enter information about the topology of the retail environment in Microsoft Dynamics AX. You’ll also specify settings for each component that will be deployed.
Note
The information in this topic applies only to Microsoft Dynamics AX 2012 R3.
This topic contains the following sections:
Step 1: Import or enter computer information in Microsoft Dynamics AX
Step 2: Set up a deployment plan in Microsoft Dynamics AX
Step 3: Export the retail deployment plan from Microsoft Dynamics AX
Step 1: Import or enter computer information in Microsoft Dynamics AX
First, specify the computers to include in the deployment. You can use two methods to create the list of computers in Microsoft Dynamics AX. We recommend that you bulk import computer entities from Microsoft System Center Configuration Manager. If Configuration Manager isn’t available, you can manually enter information about individual computers in Microsoft Dynamics AX.
Note
Computer entities that you define in Microsoft Dynamics AX must already be discovered in Configuration Manager before you import the topology to Configuration Manager.
Bulk import computer entities from Configuration Manager (recommended)
If your environment includes System Center Configuration Manager, you can use the following procedure to import computer information into Microsoft Dynamics AX. Office Add-ins for Microsoft Dynamics AX, the Retail mass deployment toolkit, and the Configuration Manager console must be installed to complete this procedure.
For information about how to install the toolkit, see Install the Retail mass deployment toolkit. For information about how to install Office Add-ins, see Install Office Add-ins.
Open a Command Prompt window, and change the directory to the folder where RetailConfigMgrToolkit.exe is located. By default, the file is located at <Drive>:\Program Files (x86)\Microsoft Dynamics AX\60\Retail Scaleout Deployment\ConfigManagerToolKit.
Run the following command to export discovered computers to a CSV file:
RetailConfigMgrToolkit.exe -o ExportMachines -f <file name.csv>
All computers discovered by Configuration Manager are exported to the CSV file.
Open the Microsoft Dynamics AX client.
Click Retail > Setup > Retail mass-deployment > Target computers > Computers.
On the ribbon, click Export to Microsoft Excel. A new Microsoft Excel document opens, in which the column names correspond to the fields in the form.
In Excel, open the CSV file that you created earlier.
Copy the records from the CSV file, and paste them into the Excel file.
In Excel, on the ribbon, on the Dynamics AX tab, click Publish to publish the new records to Microsoft Dynamics AX. Computer records are created in the Computers form.
Define security credentials
To set up and secure communication among the various Retail components, you must provide credentials and obtain certificates. During deployment, you need a way to provide this information without allowing too many people access to it. You can do this by saving credentials and certificate information in a clear-text xml file that is stored on a secure file share at headquarters. This type of file is called a security file. By allowing only deployment tools and a limited number of users access to security files, you help make your credentials and certificates more secure.
Note
The deployment tools for Retail components support security files starting in Microsoft Dynamics AX 2012 R3 Cumulative Update 8.
A security file is required when you use mass deployment tools to deploy the following components.
Component |
Requires a certificate |
Requires credentials |
|---|---|---|
Channel database |
No |
Yes |
Commerce Data Exchange: Real-time Service |
Yes |
Yes |
Commerce Data Exchange: Async Client |
No |
Yes |
Commerce Data Exchange: Async Server |
Yes |
Yes |
Retail POS |
No |
Yes |
Retail Server |
Yes |
Yes |
Retail Hardware Station |
Yes |
Yes |
For information about how to create and connect to a security file, see: Create a security file for Retail deployment.
Optional. Manually enter log and computer information in Microsoft Dynamics AX
Use the following procedure to enter individual computer records in Microsoft Dynamics AX.
Note
This step is only available on AX 2012 R3 CU8.
Under Retail Mass-deployment > Security > Retail deployment log shares, enter a location to store log files.
Click Retail > Setup > Retail mass-deployment > Target computers > Computers.
Click Retail computer to add a new record.
Enter a unique name to identify the computer record in Microsoft Dynamics AX.
Enter identifying information about the computer, such as the computer name, and the domain or workgroup that the computer belongs to.
If you are creating a topology for AX 2012 R3 CU8 and have defined a log share, you can also select it for each Retail computer.
Set up retail computer clusters
Create one or more clusters of retail computers. Each cluster can contain one or more computers. You use a cluster to deploy a component to a group of servers for load balancing.
Clusters are used only to deploy components to web servers.
Click Retail > Setup > Retail mass-deployment > Target computers > Retail computer clusters.
Enter a name and description for the cluster.
Add retail computers to the cluster.
Step 2: Set up a deployment plan in Microsoft Dynamics AX
After you have identified the computers to include in the deployment, you must specify the deployment settings for each Retail component that you want to deploy.
Tip
Avoid the use of spaces in configuration parameters when completing forms.
Create a deployment profile for a channel database
Define a deployment profile for each channel database that you plan to deploy.
Click Retail > Setup > Retail mass-deployment > Deployable components > Channel database deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Channel database
Select a channel database profile to use with this deployment profile.
A channel database profile defines the retail channels that use a particular channel database. For more information about channel database profiles, see Set up a channel database profile.
Computer name
Select the computer where the channel database will be created.
Database server instance
Enter the name of the Microsoft SQL Server instance that will host the channel database.
If you are using the default instance of SQL Server, you can leave this field blank.
Database name
Enter the name of the channel database.
Create a deployment profile for Real-time Service
Define a deployment profile for each computer cluster where you plan to deploy Real-time Service.
Click Retail > Setup > Retail mass-deployment > Deployable components > Real-time Service deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Web application name
Enter the name of the web application that hosts Real-time Service.
Website name
Enter the name of the website that hosts Real-time Service.
Retail computer cluster
Select the cluster of retail computers where Real-time Service will be deployed. A cluster contains one or more retail computers.
Application pool name
Enter the name of the application pool for the Real-time Service web application.
HTTPS port
Enter the port that the website uses for Secure Sockets Layer (SSL) communication.
Business Connector deployment profile
Select the Business Connector deployment profile to use with this deployment profile.
Website install folder
Enter the path of the physical folder where website files are stored.
TCP port
Enter the port that the website uses for TCP/IP communication.
Service Credential ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the credential ID and security file location to use when Real-time Service is deployed.
For more information about security files, see Create a security file for Retail deployment.
Certificate ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the certificate ID and security file location to use when Real-time Service is deployed.
For more information about security files, see Create a security file for Retail deployment.
If you’re using a version of AX 2012 R3 that is earlier than AX 2012 R3 CU8, enter certificate information in the Certificate root store, Certificate store, and Certificate thumbprint fields instead.
Certificate root store
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the name of the root store where the SSL certificate that is used to help secure the website is installed. By default, the root store is set to LocalMachine.
Certificate store
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the name of the certificate store where the SSL certificate that is used to help secure the website is installed. By default, the certificate store is set to My.
Certificate thumbprint
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the thumbprint for the SSL certificate that is used to help secure the website.
Note
The certificate must be installed on the target computer before you attempt to deploy this component.
Create a deployment profile for Async Client
Define one or more deployment profiles for Async Client.
Click Retail > Setup > Retail mass-deployment > Deployable components > Async Client deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Async Server deployment
Select the Async Server deployment profile to use with this deployment profile.
Channel database deployment
Select the channel database deployment profile to use with this deployment profile.
Channel database credential ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the credential ID and security file location for the channel database credentials.
For more information about security files, see Create a security file for Retail deployment.
Sync interval (in minutes)
Enter the interval at which Async Client will look for updates from Async Server.
Working folder
Enter the path of the working folder where data packages are stored and picked up by Async Client.
Note
We recommend that you use a folder on the computer where Async Client is being installed, instead of a remote shared location.
Service Credential ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the credential ID and security file location to use when Async Client is deployed.
For more information about security files, see Create a security file for Retail deployment.
Computer name
Enter the name of the server that will host the message database for Async Client.
Database server instance
Enter the name of the SQL Server instance that will host the message database for Async Client.
If you are using the default instance of SQL Server, you can leave this field blank.
Database name
Enter the name of the database where Async Client messages are stored.
Create a deployment profile for Async Server
Define a deployment profile for each computer cluster where you plan to deploy Async Server.
Click Retail > Setup > Retail mass-deployment > Deployable components > Async Server deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Web application name
Enter the name of the web application that hosts Async Server.
Website name
Enter the name of the website that hosts Async Server.
Application pool name
Enter the name of the application pool for the Async Server web application.
HTTPS port
Enter the port that the website uses for SSL communication.
TCP port
Enter the port that the website uses for TCP/IP communication.
File storage provider
Select a set of working folders where data packages will be stored. For more information, see Specify working folders for Commerce Data Exchange.
Retail computer cluster
Select the cluster of retail computers where Async Server will be deployed. A cluster contains one or more retail computers.
Website install folder
Enter the path of the physical folder where website files are stored.
Service Credential ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the credential ID and security file location to use when Async Server is deployed.
For more information about security files, see Create a security file for Retail deployment.
Base URL
Enter the URL that Async Client uses to contact Async Server.
Computer name
Enter the name of the server that will host the message database.
Database server instance
Enter the name of the SQL Server instance that will host the message database.
If you are using the default instance of SQL Server, you can leave this field blank.
Database name
Enter the name of the database where Async Server messages are stored.
Certificate ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the certificate ID and security file location to use when Async Server is deployed.
For more information about security files, see Create a security file for Retail deployment.
If you’re using a version of AX 2012 R3 that is earlier than to AX 2012 R3 CU8, enter certificate information in the Certificate root store, Certificate store, and Certificate thumbprint fields instead.
Certificate root store
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the name of the root store where the SSL certificate that is used to help secure the website is installed. By default, the root store is set to LocalMachine.
Certificate store
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the name of the certificate store where the SSL certificate that is used to help secure the website is installed. By default, the certificate store is set to My.
Certificate thumbprint
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the thumbprint for the certificate that is used to help secure the website.
Note
The certificate must be installed on the target computer before you attempt to deploy this component.
Database server
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Optionally, enter 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.
Create a deployment profile for Retail POS
Define a deployment profile for each device where you plan to deploy Retail POS.
Click Retail > Setup > Retail mass-deployment > Deployable components > Retail POS deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Computer name
Select the computer where Retail POS will be deployed.
Register number
Select a register number for the selected computer.
Channel database deployment
Select the channel database deployment profile to use with this deployment profile.
Real-time Service deployment
Select the Real-time Service deployment profile to use with this deployment profile.
Database server instance
Enter the name of the SQL Server instance that will host the offline database.
If you are using the default instance of SQL Server, you can leave this field blank.
Note
The Builtin\Administrators group must belong to the sysadmin server role on the SQL Server instance where the offline database is deployed.
Database name
Enter the name of the offline database.
Credential ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the credential ID and security file location to use when Retail POS is deployed.
For more information about security files, see Create a security file for Retail deployment.
Database server
Optionally, enter the name of the database server that is used to connect to the offline database. By default, the computer name that was used to deploy the database is used.
Create a deployment profile for Retail Modern POS
Define a deployment profile for each device where you plan to deploy Retail Modern POS.
Click Retail > Setup > Retail mass-deployment > Deployable components > Modern POS deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Register number
Select a register number.
Computer name
Select the computer or device where Retail Modern POS will be deployed.
Retail Server deployment
Select a Retail Server deployment profile to use with this deployment profile. The Retail Modern POS client will connect to the Retail Server that is specified in the profile.
Side loading key
Enter a sideloading key.
Apps that aren't signed by Windows Store can be installed only on devices that are enabled for sideloading. To enable sideloading on a computer, you must use a sideloading product activation key. For more information about how to sideload apps, see Try It Out: Sideload Windows Store Apps.
Create a deployment profile for Retail Server
Define a deployment profile for each computer cluster where you plan to deploy Retail Server.
Click Retail > Setup > Retail mass-deployment > Deployable components > Retail Server deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Web application name
Enter the name of the web application that hosts Retail Server.
Website name
Enter the name of the website that hosts Retail Server.
Retail computer cluster
Select the cluster of retail computers where Retail Server will be deployed. A cluster contains one or more retail computers.
Application pool name
Enter the name of the application pool for the Retail Server web application.
HTTP port
Enter the port that the website uses for HTTP communication.
HTTPS port
Enter the port that the website uses for SSL communication.
Real-time Service deployment
Select the Real-time Service deployment profile to use with this deployment profile.
Channel database deployment
Select the channel database deployment profile to use with this deployment profile.
Website install folder
Enter the path of the physical folder where website files are stored.
Service Credential ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the credential ID and security file location to use when Retail Server is deployed.
For more information about security files, see Create a security file for Retail deployment.
Base URL
This field is available only if AX 2012 R3 CU8 is installed.
Enter the URL that Retail Modern POS clients use to contact Retail Server.
Certificate ID
This field is available only if AX 2012 R3 CU8 is installed.
Select the certificate ID and security file location to use when Retail Server is deployed.
For more information about security files, see Create a security file for Retail deployment.
If you’re using a version of AX 2012 R3 that is earlier than AX 2012 R3 CU8, enter certificate information in the Certificate root store, Certificate store, and Certificate thumbprint fields instead.
Certificate root store
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the name of the root store where the SSL certificate that is used to help secure the website is installed. By default, the root store is set to LocalMachine.
Certificate store
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the name of the certificate store where the SSL certificate that is used to help secure the website is installed. By default, the certificate store is set to My.
Certificate thumbprint
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Enter the thumbprint for the SSL certificate that is used to help secure the website.
Note
The certificate must be installed on the target computer before you attempt to deploy this component.
Database server
This control is available only in versions of Microsoft Dynamics AX 2012 prior to AX 2012 R3 Cumulative Update 8.
Optionally, enter the name of the database server that is used to connect to the channel database. By default, the computer name that was used to deploy the database is used.
Create a deployment profile for .NET Business Connector
Define a deployment profile for each instance of .NET Business Connector in the environment.
Click Retail > Setup > Retail mass-deployment > Deployable components > Business Connector deployment profile.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
AOS Server
Enter the name of the server where the instance of Microsoft Dynamics AX Application Object Server (AOS) is installed.
AOS instance
Enter the name of the AOS instance.
TCP port
Enter the TCP port for the AOS instance.
WSDL port
Enter the WSDL port for the AOS instance.
Create a deployment profile for Retail Hardware Station
Define a deployment profile for each computer where you plan to deploy Retail Hardware Station.
Note
This deployment profile type is available only with Microsoft Dynamics AX 2012 R3 Cumulative Update 8.
Click Retail > Setup > Retail mass-deployment > Deployable components > Retail Hardware Station deployment.
Enter a name and description for the profile.
Enter or select the following information.
Field
Description
Web application name
Enter the name of the web application that hosts Retail Hardware Station.
Website name
Enter the name of the website that hosts Retail Hardware Station.
Computer name
Select the computer where Hardware Station will be installed.
Application pool name
Enter the name of the application pool for the web application where Hardware Station runs.
HTTP port
Enter the port that the website uses for HTTP communication.
HTTPS port
Enter the port that the website uses for SSL communication.
Retail Server deployment
Select a Retail Server deployment profile to use with this deployment profile. Retail Hardware Station will connect to the Retail Server that is specified in the profile.
Website install folder
Enter the path of the physical folder where website files are stored.
Service Credential ID
This control is available only if AX 2012 R3 CU8 is installed.
Select the credential ID and security file location to use when Hardware Station is deployed.
For more information about security files, see Create a security file for Retail deployment.
Certificate ID
This control is available only if AX 2012 R3 CU8 is installed.
Select the certificate ID and security file location to use when Hardware Station is deployed.
For more information about security files, see Create a security file for Retail deployment.
Retail Channel
Select the retail channel that will use this instance of Hardware Station.
Step 3: Export the retail deployment plan from Microsoft Dynamics AX
After computers and deployment information have been defined in Microsoft Dynamics AX, you can export the deployment plan by using the Retail mass deployment toolkit.
Note
To run the ExportRetailTopology command, the toolkit must be able to connect to Microsoft Dynamics AX via .NET Business Connector, regardless of whether the Application Object Server (AOS) is locally or remotely installed.
Open a Command Prompt window, and change the directory to the folder where RetailConfigMgrToolkit.exe is located. By default, the file is located at <Drive>:\Program Files (x86)\Microsoft Dynamics AX\60\Retail Scaleout Deployment\ConfigManagerToolKit.
Run the following command to export the topology that you defined to an XML file:
RetailConfigMgrToolkit.exe -o ExportRetailTopology -f <file name.xml>
Import the topology XML file into the deployment tool that you’re using. For more information, see Mass deploy Retail components by using System Center Configuration Manager or Set up a self-service Retail deployment.
Use the Retail deployment visualizer to work with a graphical view of the topology
Click Retail > Setup > Retail mass-deployment > Retail deployment visualizer.
The retail deployment visualizer shows the deployment profiles that have been set up for each retail component.
The retail topology is arranged in a hierarchy, with the organization at the top, and a branch for each type of retail component. To list the deployment profiles that have been set up for each component, click a component node and then click the Search button in the right pane. To add a new deployment profile, select the related component node and then click Insert > (Component). The deployment profile form for that component opens.