Mass deploy Retail components

  • 项目

Applies To: Microsoft Dynamics AX 2012 R3

The Retail mass deployment toolkit is a command-line tool that you can use with System Center Configuration Manager to automate and centralize the deployment of the retail components of Microsoft Dynamics AX.

备注

The information in this topic applies only to Microsoft Dynamics AX 2012 R3 and Microsoft Dynamics AX 2012 R2.

Configuration Manager enables secure and scalable software deployment, management of compliance settings, and comprehensive asset management for servers, desktops, portable computers, and mobile devices. For more information about Configuration Manager, see the System Center Configuration Manager TechCenter on TechNet.

The Retail mass deployment toolkit lets you set up topology and configuration information in Microsoft Dynamics AX, and then deploy the configuration to designated computers by using Configuration Manager. Therefore, you do not have to run Setup on each computer in your Retail implementation. The toolkit also lets you apply Microsoft Dynamics AX context to computers in Configuration Manager. For example, you can specify which computers are point of sale (POS) registers and then deploy the appropriate software to those computers.

提示

To see the full list of commands that are available for the toolkit, open a Command Prompt window in the folder where RetailConfigMgrToolkit.exe is installed, and type RetailConfigMgrToolkit.exe. To see the parameters that are available for a command, run the command RetailConfigMgrToolkit.exe -o <command> -?.

This topic includes the following information:

  • Components that can be mass deployed

  • Step 1: Import or enter computer information into Microsoft Dynamics AX

  • Step 2: Set up retail deployment profiles in Microsoft Dynamics AX

  • Step 3: Export the retail deployment plan from Microsoft Dynamics AX and import it into System Center

  • Step 4: Deploy retail components by using System Center

Components that can be mass deployed

You can configure the following components for mass deployment in Microsoft Dynamics AX:

  • Commerce Data Exchange: Real-time Service

  • Commerce Data Exchange: Async Server

  • Commerce Data Exchange: Async Client

  • Channel databases

  • Microsoft Dynamics AX for Retail POS (includes offline databases and Offline Sync Service)

  • Retail Server

  • Modern POS

  • .NET Business Connector (required for some Retail components)

Step 1: Import or enter computer information in Microsoft Dynamics AX

The first step in mass deploying Retail components is to 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 Configuration Manager. Alternatively, you can manually enter information about individual computers in Microsoft Dynamics AX.

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 before you can complete this procedure.

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

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

  3. Open the Microsoft Dynamics AX client.

  4. Click Retail > Setup > Retail mass-deployment > Target computers > Computers.

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

  6. In Excel, open the CSV file that you created earlier.

  7. Copy the records from the CSV file, and paste them into the Excel file.

    备注

    To prevent issues with the worksheet, we recommend that you copy and paste the first column of data, and then copy and paste the remaining columns.

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

Manually enter computer information in Microsoft Dynamics AX (optional)

If necessary, use the following procedure to enter individual computer records in Microsoft Dynamics AX.

  1. Click Retail > Setup > Retail mass-deployment > Target computers > Computers.

  2. Click Retail computer to add a new individual record.

  3. Enter a unique name to identify the computer record in Microsoft Dynamics AX.

  4. Enter identifying information about the computer, such as the computer name, and the domain or workgroup that the computer belongs to.

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.

Create a deployment profile for a channel database

Define a deployment profile for each channel database that you plan to deploy.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Channel database deployment.

  2. Enter a name and description for the profile.

  3. 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 设置渠道数据库配置文件.

    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.

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.

  1. Click Retail > Setup > Retail mass-deployment > Target computers > Retail computer clusters.

  2. Enter a name and description for the cluster.

  3. Add retail computers to the cluster.

Create a deployment profile for Real-time Service

Define a deployment profile for each computer cluster where you plan to deploy Real-time Service.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Real-time Service deployment.

  2. Enter a name and description for the profile.

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

    Certificate root store

    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

    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

    Enter the thumbprint for the SSL certificate that is used to help secure the website.

    > [!NOTE]  
> <p>The certificate must be installed on the target computer before you attempt to deploy this component.</p>

Create a deployment profile for Async Server

Define a deployment profile for each computer cluster where you plan to deploy Async Server.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Async Server deployment.

  2. Enter a name and description for the profile.

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

    Base URL

    Enter the URL that Async Client uses to contact 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.

    File storage provider

    Select a set of working folders where data packages will be stored. For more information, see 指定 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.

    TCP port

    Enter the port that the website uses for TCP/IP communication.

    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 root store

    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

    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

    Enter the thumbprint for the certificate that is used to help secure the website.

    > [!NOTE]  
> <p>The certificate must be installed on the target computer before you attempt to deploy this component.</p>

    Database server

    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 Async Client

Define one or more deployment profiles for Async Client.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Async Client deployment.

  2. Enter a name and description for the profile.

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

    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.

    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 Client messages are stored.

    Channel database server

    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.

    Message database server

    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 Server

Define a deployment profile for each computer cluster where you plan to deploy Retail Server.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Retail Server deployment.

  2. Enter a name and description for the profile.

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

    Location

    Enter the path of the physical folder where website files are stored.

    Certificate root store

    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

    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

    Enter the thumbprint for the SSL certificate that is used to help secure the website.

    > [!NOTE]  
> <p>The certificate must be installed on the target computer before you attempt to deploy this component.</p>

    Database server

    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 Modern POS

Define a deployment profile for each device where you plan to deploy Modern POS.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Modern POS deployment.

  2. Enter a name and description for the profile.

  3. Enter or select the following information.

    Field

    Description

    Register number

    Select a register number.

    Computer name

    Select the computer or device where Modern POS will be deployed.

    Retail Server deployment

    Select a Retail Server deployment profile to use with this deployment profile. The 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 POS

Define a deployment profile for each device where you plan to deploy Retail POS.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Retail POS deployment.

  2. Enter a name and description for the profile.

  3. 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]  
> <p>The Builtin\Administrators group must belong to the sysadmin server role on the SQL Server instance where the offline database is deployed.</p>

    Database name

    Enter the name of the offline database.

    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 .NET Business Connector

Define a deployment profile for each instance of .NET Business Connector in the environment.

  1. Click Retail > Setup > Retail mass-deployment > Deployable components > Business Connector deployment profile.

  2. Enter a name and description for the profile.

  3. Enter or select the following information.

    Field

    Description

    Server name

    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.

Step 3: Export the retail deployment plan from Microsoft Dynamics AX and import it into Configuration Manager

After computers and deployment information have been defined in Microsoft Dynamics AX, you can export the deployment plan and import it into Configuration Manager.

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

  2. Run the following command to export the topology that you defined to an XML file:

    RetailConfigMgrToolkit.exe -o ExportRetailTopology -f <file name.xml>

    备注

    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.

  3. Copy the XML file to the computer that is running the Configuration Manager console.

  4. In the toolkit, run the following command to import the file:

    RetailConfigMgrToolkit.exe -o -ImportRetailTopology -f <file name>

    By default, the file is imported to the Retail root collection. To specify a different collection, run the command –targetCollection <unique name for the topology>.

Step 4: Deploy retail components by using Configuration Manager

  1. Create a shared folder where deployment logs will be saved. Make sure that the administrator who manages deployments has access to the folder. In addition, Configuration Manager clients must have access to upload deployment logs to the shared folder.

  2. On the computer where the Configuration Manager console is installed, run the toolkit to set the log share for a target collection. Run the following command:

    RetailConfigMgrToolkit.exe -o SetRetailLogShare -LogShare <UNC path of shared folder> LogShareAccount <Account to access the share> LogSharePassword <Password for the account> targetCollection <targetCollection name>

  3. Install prerequisites on the target computers. You can create applications, packages, or task sequences in Configuration Manager to deploy prerequisites.

    > [!IMPORTANT]  
> <P>On computers where channel, offline, or message databases will be created, the built-in <STRONG>LocalSystem</STRONG> account must belong to the <STRONG>sysadmin</STRONG> server role in SQL Server.</P>

  4. Create Retail applications in Configuration Manager. Run the following command:

    RetailConfigMgrToolkit.exe -o CreateRetailApplications –contentRoot <UNC path of shared folder where retail application files are>

    This path can be obtained by sharing the following folder: C:\Program Files (x86)\Microsoft Dynamics AX\60\Retail Scaleout Deployment\ConfigManagerContent.

  5. Distribute content for the task sequences to the desired distribution point. The Retail installation files can be deployed only if they are copied to the distribution point.

  6. Set up user accounts for Retail components. User names and passwords must be set up for the following components:

    • Real-time Service application pool

    • Retail Server application pool

    • Async Server application pool

    • Async Client (Windows service)

    • Async Client data store

    • Offline sync service

    • Channel database for Retail POS

    For example, run the following command to set user accounts and passwords for Real-time Service and Retail Server:

    RetailConfigMgrToolkit.exe -o SetCredentials -collection <target collection> -rtsaccount <AccountName> -rtspassword <Password> -retailserveraccount <AccountName> -retailserverpassword <Password>

    提示

    To see the full list of parameters for accounts and passwords, run the command RetailConfigMgrToolkit.exe –o SetCredentials /?.

  7. In Configuration Manager, schedule a deployment for the following task sequences for the target collection of the Retail topology. You can find these tasks in the Configuration Manager console, under Software Library > Operation Systems > Task Sequences.

    备注

    When you run a task sequence, only one user must be logged on to the computer.

    • Retail Role Manager

      备注

      You must deploy this task sequence first.

    • Update group membership

    • Install and configure Retail components

    • Uninstall Retail components

    • Collect Retail Logs

    • Configure offline database

  8. In Configuration Manager, schedule a deployment for the Modern POS application.

    备注

    Only the Modern POS application can be run directly. Do not deploy any other Configuration Manager applications or packages directly.

  9. You can deploy offline databases after Async Server, Async Client, and the channel database have been deployed.

    Before you deploy offline databases, on the computer that hosts the channel database, use SQL Server Management Studio to assign the local OfflineSyncServiceUsers group to the sysadmin server role in SQL Server. Alternatively, you can assign the OfflineSyncServiceUsers group to the dbo schema in SQL Server.

    To synchronize data between Microsoft Dynamics AX and the channel database, in Microsoft Dynamics AX, run all distribution schedules. (Click Retail > Periodic > Data distribution > Distribution schedule. Select a distribution schedule, and then click Run now.)

    After the distribution schedule has finished running, and data has been sent to the channel database, the “Configure offline database” task sequence provisions offline databases and triggers the synchronization between the channel database and offline databases.

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